This function returns a timestamp corresponding to the start of the first day of the year containing date. The default output format will be the DateFormat set in the script.
Syntax:
YearStart(date[, period_no[, first_month_of_year]])
Return data type: dual
Arguments:
| Argument | Description |
|---|---|
| date | The date to evaluate. |
| period_no | period_no is an integer, where the value 0 indicates the year which contains date. Negative values in period_no indicate preceding years and positive values indicate succeeding years. |
| first_month_of_year | If you want to work with (fiscal) years not starting in January, indicate a value between 2 and 12 in first_month_of_year. |
Examples and results:
These examples use the date format DD/MM/YYYY. The date format is specified in the SET DateFormat statement at the top of your load script. Change the format in the examples to suit your requirements.
Example 1:
yearstart ('19/10/2001')
Returns 01/01/2001.
Example 2:
yearstart ('19/10/2001', -1)
Returns 01/01/2000.
Example 3:
yearstart ('19/10/2001', 0, 4)
Returns 01/04/2001.
Example 4:
Add the example script to your document and run it. Then add, at least, the fields listed in the results column to a sheet in your document to see the result.
This example finds the first day in the year of each invoice date in the table, where the first month in the year is specified as month 4.
TempTable:
LOAD RecNo() as InvID, * Inline [
InvDate
28/03/2012
10/12/2012
5/2/2013
31/3/2013
19/5/2013
15/9/2013
11/12/2013
2/3/2014
14/5/2014
13/6/2014
7/7/2014
4/8/2014
];
InvoiceData:
LOAD *,
YearStart(InvDate, 0, 4) AS YrStart
Resident TempTable;
Drop table TempTable;
The resulting table contains the original dates and a column with the return value of the yearstart() function. You can display the full timestamp by specifying the formatting in the chart properties.
| InvDate | YrStart |
|---|---|
| 28/03/2012 | 01/04/2011 |
| 10/12/2012 | 01/04/2012 |
| 5/2/2013 | 01/04/2012 |
| 31/3/2013 | 01/04/2012 |
| 19/5/2013 | 01/04/2013 |
| 15/9/2013 | 01/04/2013 |
| 11/12/2013 | 01/04/2013 |
| 2/3/2014 | 01/04/2013 |
| 14/5/2014 | 01/04/2014 |
| 13/6/2014 | 01/04/2014 |
| 7/7/2014 | 01/04/2014 |
| 4/8/2014 | 01/04/2014 |
