workday()
Table of Contents
Overview
The workday() function takes dateTimeValue and numberOfBusinessDays as arguments. It returns the dateTimeValue after adding the specified number of business days to it.
The date value (without time value) will be returned in the format specified in Application Settings.
Return Type
- Date-Time
Syntax
(OR)
Parameter | Data type | Description |
---|---|---|
<variable> | DATE-TIME | Variable which will contain the returned date value. |
<dateTimeValue> | DATE-TIME | The date-time value to which the specified number of business days will be added. The time value is not taken into account while using this function. A runtime error will be encountered if:
Please refer this help document to learn about the supported date-time formats. |
<numberOfBusinessDays> | NUMBER | The number of business days to be added to dateTimeValue. A negative number will return the given date-time value as it is. |
weekends (optional) | COLLECTION (OF TEXT) | The list of weekends that should be considered while adding business days. Note
|
holidays (optional) | COLLECTION (OF DATES) | The list of holidays that should be considered while adding business days. Note
|
Examples
currentDate = '15-Mar-2019'; newDate = currentDate.workday(1); // returns '18-Mar-2019';
newDate = zoho.currentdate.workday(5, {"Sunday"}, {'25-May-2020'}); // assuming the current date is 23-May-2020, this task returns '30-May-2020'