addBusinessDay

addBusinessDay()

Overview

The addBusinessDay() function takes dateTimeValue and numberOfBusinessDays as arguments. It returns the dateTimeValue after adding the specified number of business days to it.

Note: Monday to Friday, irrespective of any day being a holiday, are considered as business days.

The date-time value will be returned in the format specified in Application Settings.

Return Type

  • Date-Time

Syntax

<variable> = <dateTimeValue>.addBusinessDay(<numberOfBusinessDays>,[<weekends>],[<holidays>]);

(OR)

<variable>=addBusinessDay(<dateTimeValue>,<numberOfBusinessDays>,[<weekends>],[<holidays>]);
ParameterData typeDescription
variableDATE-TIMEVariable which will contain the returned date-time value.
dateTimeValueDATE-TIME

The date-time value to which the specified number of business days will be added.

The date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value.

If the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00.

A runtime error will be encountered if:

  • the hour value, or minute value, or second value, is specified in more than 2 digits.
  • the date value exceeds the number of days in that month.
  • an incorrect month value is specified.
  • the year value has more than 4 digits.

Refer this help document to learn about the supported date-time formats.

numberOfBusinessDaysNUMBER

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

  • By default, the weekends list is {Saturday, Sunday}
  • This param is supported in all services except Zoho Creator
holidays
(optional)
COLLECTION
(OF DATES)

The list of holidays that should be considered while adding business days.

Note

  • If no holidays are provided, any day (except weekends) will be considered a working day.
  • This param is supported in all services except Zoho Creator

Examples

currentDate = '15-Mar-2019';                                    // is a Friday
newDate = currentDate.addBusinessDay(1);           // returns '18-Mar-2019' which is Monday

 

newDate = zoho.currentdate.addBusinessDay(5, {"Sunday"}, {'25-May-2020'});          
// assuming the current date is 23-May-2020, this task returns '30-May-2020'
// the additional params are not supported in Zoho Creator

 

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohodeluge.com