BeginningOfYear

Returns the UTC date and time for the beginning of the local year based on the local date and time of the current session.

Syntax

BeginningOfYear(numYears, baseDateTime)

Enabled for

Search/Dashboard	Yes
Business Rules	Yes
Quick Actions	Yes
Workflow Objects	No
Reports	No

Parameters

numYears	(Optional) The number of intervals. If not specified, uses the default interval which is 0. Can be either a positive integer, to indicate years in the future, or a negative integer, to indicate years in the past.
baseDateTime	(Optional) The base date for the function. If not specified, uses the default date which is the current date and time.

Return Value

DateTime value in UTC time.

If the system has to display the return value, it implicitly converts it to text, thereby allowing the display format to change depending on your culture code. See Available Languages and Cultures for a list of the culture codes used by HEAT.

In this release of HEAT, there is a known issue, where if the time zone offset between the current date and time and the DateTime value returned by the function is different, the return value is off by one hour. This happens when the current date is before daylight savings time and the DateTime value that is returned is after daylight savings time, or vice versa.

Example

$(BeginningOfYear(0))

If today is August 10, 2014 and your time zone is Pacific time (which is UTC-7 during daylight savings time but UTC-8 during standard time), this function returns January 1, 2014 at 07:00:00 AM UTC. However, because of the bug mentioned above, because the current date and the return date are in different time zone offsets, it should return January 1, 2014 8:00:00 AM UTC.