AddMonths

Returns the UTC date and time for the month that is the number of months specified earlier than or later than the specified date and time.

Syntax

AddMonths(numMonths, 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

Parameters

Parameter Description
numMonths (Optional) The number of intervals. If not specified, uses the default interval which is 0. Can be either a positive integer, to indicate months in the future, or a negative integer, to indicate months 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.
timeZone

(Optional) The time zone, in IANA format.

Returns

DateTime value in UTC time.

If the application 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 Neurons for ITSM.

If the return value would not be a valid date, the function returns the last day of the month. For example, in the following function: $(AddMonths(4, mydate)), if the value of the mydate parameter is October 31, 2014, this function would have returned February 31, 2015, but because that is not a valid date, the function returns February 28, 2015 because that is the last day of the month.

Example

$(AddMonths(4))

If today is April 10, 2014, this function returns the DateTime value for August 10, 2014 at the same time of day.

 

$(AddMonths(3, mydate))

If the value of the mydate parameter is April 10, 2014, this function returns the DateTime value for 3 months later, which is July 10, 2014, at the same time of day.

 

$(AddMonths(-1, mydate))

If the value of the mydate parameter is April 10, 2014, this function returns the DateTime value for March 10, 2014 at the same time of day.