TaskStartConfigDto

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

SpecificDate: DaysOfMonth specifies which days (1-31) to run on
WeekDay: Day specifies which day of the week to run on
MonthDay: WeekDayPatterns specifies positional patterns like "First Monday"
ClientDate: ClientDateType, Timing, and Offset configure client-relative dates

Properties

Name	Type	Description
type	enum	SpecificDate WeekDay MonthDay ClientDate
SpecificDate WeekDay MonthDay ClientDate
weekDayPatterns	array of WeekDayPatternDto	Positional weekday patterns. Required when Type is MonthDay. Example: [{ Position: "First", Day: "Monday" }, { Position: "Last", Day: "Friday" }]
Positional weekday patterns. Required when Type is MonthDay. Example: [{ Position: "First", Day: "Monday" }, { Position: "Last", Day: "Friday" }]
daysOfMonth	array of integer	Days of month (1-31). Used when Type is SpecificDate. Example: [1, 15] for 1st and 15th
Days of month (1-31). Used when Type is SpecificDate. Example: [1, 15] for 1st and 15th
day	enum	Workday Monday Tuesday Wednesday Thursday Friday Saturday Sunday
Workday Monday Tuesday Wednesday Thursday Friday Saturday Sunday
clientDateType	enum	IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue NextPayeCisFilingDue PensionReEnrolmentDate
IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue NextPayeCisFilingDue PensionReEnrolmentDate
timing	enum	OnActualDate DaysBefore DaysAfter
OnActualDate DaysBefore DaysAfter
offset	integer	The number of days before or after the client date. Used when Type is ClientDate and Timing is DaysBefore or DaysAfter.
The number of days before or after the client date. Used when Type is ClientDate and Timing is DaysBefore or DaysAfter.
date	string	Specific start date. Used when Type is SpecificDate. This is when the recurring task should first start generating tasks.
Specific start date. Used when Type is SpecificDate. This is when the recurring task should first start generating tasks.

JSON Example

{
  "type": "SpecificDate",
  "weekDayPatterns": [
    {
      "position": "...",
      "day": "..."
    }
  ],
  "daysOfMonth": [
    0
  ],
  "day": "Workday",
  "clientDateType": "IncorporationDate"
}

TaskStartConfigDto

Properties

JSON Example

Contained in Schemas