Frequency Cadence Options

Input representation of the frequency cadence options for an invoice scheduler.

JSON Example 

1"frequencyCadenceOptions": {
2        "recurringSubType" : "Every",
3        "recursOn" : "First",
4        "recursOnDay" : "Sunday",
5        "shouldExcludeWkendAndHldy": true
6    }

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
recurring​Sub​TypeStringSubtype of the recurring frequency for the invoice run. Valid values are Every—Specifies if the invoice scheduler must generate the invoices on a recurring frequency on a specific cadence. Use this value to generate invoices on a specific day of the month. For example, you can specify that the invoice scheduler must generate the invoices every first Monday of the month; or SpecificDate—Specifies if the invoice scheduler must generate the invoices on a recurring frequency on a specific date. Use this value to generate invoices on a monthly basis on a specific date.Required if the frequency​Cadence property is set to Monthly.62.0
recurs​OnStringCadence that specifies when the invoice scheduler must generate the invoices on a recurring frequency. For example, you can specify that the invoice scheduler must generate the invoices every first Monday of the month. Valid values are First, Second, Third, Fourth, or Last.Required if the frequency​Cadence property is set to Monthly.62.0
recursOn​DateStringDate when the invoice scheduler must generate the invoices on a specific date. The supported values are 1 through 28—Specify any date from 1 through 28, L—Specifies that the invoice scheduler must generate the invoices on the last day of the month, L-1—Specifies that the invoice scheduler must generate the invoices on the second to last day of the month, or L-2—Specifies that the invoice scheduler must generate the invoices on the third to last day of the month.Required if the recurring​Sub​Type property is set to SpecificDate.62.0
recursOn​DayStringDay of the week when the invoice scheduler must generate the invoices on a recurring frequency. For example, you can specify that the invoice scheduler must generate the invoices every Monday or every first Monday of a month. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.Required if the frequency​Cadence property is set to Weekly or Monthly.62.0
should​Exclude​Wkend​AndHldyBooleanIndicates whether to exclude weekends and holidays from the billing schedule (true) or not (false).Required if the frequency​Cadence property is set to Monthly.62.0