RecurrenceConfigDto

Configuration for how often a recurring task repeats.

Properties

Name Type Description
everyinteger

Interval value (e.g., 1 for every month, 2 for every 2 months). Required unless Sequence is
supplied; omitted from responses when the schedule runs on a Sequence.

Interval value (e.g., 1 for every month, 2 for every 2 months). Required unless Sequence is
supplied; omitted from responses when the schedule runs on a Sequence.

unitenum

Day Week Month Year

Day Week Month Year

inMonthsarray of enum

Which months to run in. Only valid when Unit is Year.
Example: ["January", "April", "July", "October"] for quarterly

None January February March April May June July SemiAnnual August September October Quarterly November December AllMonths

Which months to run in. Only valid when Unit is Year.
Example: ["January", "April", "July", "October"] for quarterly

None January February March April May June July SemiAnnual August September October Quarterly November December AllMonths

weekDaysOnlyboolean

If true, skip weekends for daily patterns. Only valid when Unit is Day.

If true, skip weekends for daily patterns. Only valid when Unit is Day.

sequencearray of RelativeIntervalDto

Repeating variable-length cycle: the driving date advances by each period in order and wraps
back to the first (e.g. [4 Weeks, 4 Weeks, 5 Weeks] for a hospitality 4-4-5 cycle). When
supplied, replaces Every/Unit entirely. The driving side (per Basis: Start,
Due, or Statutory) must set Type=Sequence and carry its SequenceSeedDate - the first
occurrence of that date.

Repeating variable-length cycle: the driving date advances by each period in order and wraps
back to the first (e.g. [4 Weeks, 4 Weeks, 5 Weeks] for a hospitality 4-4-5 cycle). When
supplied, replaces Every/Unit entirely. The driving side (per Basis: Start,
Due, or Statutory) must set Type=Sequence and carry its SequenceSeedDate - the first
occurrence of that date.

JSON Example

{
  "every": 0,
  "unit": "Day",
  "inMonths": [
    "None"
  ],
  "weekDaysOnly": false,
  "sequence": [
    {
      "value": "...",
      "unit": "..."
    }
  ]
}

Contained in Schemas