API Docs / Schemas / TaskStartConfigDto

TaskStartConfigDto

Configuration for when a recurring task should start.
Different properties are required based on the Type value:

  • SpecificDate: TaskStartDate must be provided on the parent object
  • WeekDay: WeekDayType must be provided
  • MonthDay: Both WeekDayType and MonthDayType must be provided
  • ClientDate: ClientDateType must be provided. ClientDateTiming and ClientDateOffset are optional (defaults to OnActualDate and 0)

Properties

Name Type Description
typeenum

SpecificDate WeekDay MonthDay ClientDate

SpecificDate WeekDay MonthDay ClientDate

weekDayTypeenum

Workday Monday Tuesday Wednesday Thursday Friday Saturday Sunday

Workday Monday Tuesday Wednesday Thursday Friday Saturday Sunday

monthDayTypeenum

First Second Third Last

First Second Third Last

clientDateTypeenum

IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue NextPayeCisFilingDue

IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue NextPayeCisFilingDue

clientDateTimingenum

OnActualDate DaysBefore DaysAfter

OnActualDate DaysBefore DaysAfter

clientDateOffsetinteger

The number of days before or after the client date. Used when Type is ClientDate and ClientDateTiming is DaysBefore or DaysAfter.
Must be a non-negative integer. Defaults to 0 if not specified.
Examples:

  • ClientDateTiming=DaysBefore, ClientDateOffset=5 → Task starts 5 days before client date
  • ClientDateTiming=DaysAfter, ClientDateOffset=10 → Task starts 10 days after client date

The number of days before or after the client date. Used when Type is ClientDate and ClientDateTiming is DaysBefore or DaysAfter.
Must be a non-negative integer. Defaults to 0 if not specified.
Examples:

  • ClientDateTiming=DaysBefore, ClientDateOffset=5 → Task starts 5 days before client date
  • ClientDateTiming=DaysAfter, ClientDateOffset=10 → Task starts 10 days after client date

JSON Example

{
  "type": "SpecificDate",
  "weekDayType": "Workday",
  "monthDayType": "First",
  "clientDateType": "IncorporationDate",
  "clientDateTiming": "OnActualDate"
}

Contained in Schemas