Year

Returns the UTC date and time interval of the entire year that is the number of years specified earlier than or later than the specified date and time.

Syntax

Year(numYears, baseDateTime, timeZone)

Enabled For

For a description of the business object categories, see Notes on "Enabled For".

Business Object Category Yes/No
Business Rules: Before-Save Rules Yes
Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load) Yes
Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load) Yes
Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load) Yes
Business Rules: Editing Rules Yes
Business Rules: Initialization Rules Yes
Business Rules: Read Only Rules Yes
Business Rules: Required Rules Yes
Business Rules: Validation Rules Yes
Client Expressions Yes
Object Permissions Yes
Services Yes
LDAP Yes
Mobile Yes
Quick Actions (except UI Quick Actions) Yes
UI Quick Actions Yes
Reports Yes
Search/Dashboard without field references Yes
Search/Dashboard with field references Yes

Parameter

Parameter Description

numYears

(Optional) The number of years before or after the date and time specified by the baseDateTime parameter. If not specified or 0, uses the interval containing the date and time specified by the baseDateTime parameter. Can be either a positive integer, to indicate years after the default interval, or a negative integer, to indicate years before the default interval.

baseDateTime (Optional) The base date for the function. If not specified, uses the default date which is the current date and time.
timeZone

(Optional) The time zone, in IANA format.

Return Value

DateTime interval in UTC time.

Example

See Day() for examples.