TaskStartConfigDto

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

SpecificDate: Date specifies the start date seed
WeekDay: Day specifies which day of the week to run on
MonthDay: WeekDayPatterns specifies positional patterns like "First Monday"
ClientDate: ClientDateType (or CustomFieldDefinitionCode), Timing, OffsetDays, OffsetMonths
RelativeToDue: Start derives from Due via IntervalValue + IntervalUnit (Due-driven mode)

Properties

Name	Type	Description
type	enum	SpecificDate WeekDay MonthDay ClientDate RelativeToDue
SpecificDate WeekDay MonthDay ClientDate RelativeToDue
intervalValue	integer	Numeric value for the interval between the Start and Due dates. Required when Type is RelativeToDue: the Start is set this many units before the Due.
Numeric value for the interval between the Start and Due dates. Required when Type is RelativeToDue: the Start is set this many units before the Due.
intervalUnit	enum	Day Week Month Year
Day Week Month Year
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
clientDateSourceType	enum	KeyDate CustomField
KeyDate CustomField
clientDateType	enum	IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate
IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate
customFieldDefinitionCode	string	The code of the custom field definition. Required when Type is ClientDate and ClientDateSourceType is CustomField. Only DATE-type custom fields are valid.
The code of the custom field definition. Required when Type is ClientDate and ClientDateSourceType is CustomField. Only DATE-type custom fields are valid.
customFieldDefinitionLabel	string	The label of the custom field definition. Populated in responses only.
The label of the custom field definition. Populated in responses only.
timing	enum	OnActualDate DaysBefore DaysAfter
OnActualDate DaysBefore DaysAfter
offsetDays	integer	The number of days before or after the client date. Used when Type is ClientDate and Timing is DaysBefore or DaysAfter. Paired with OffsetMonths for composite offsets like "1 month + 7 days".
The number of days before or after the client date. Used when Type is ClientDate and Timing is DaysBefore or DaysAfter. Paired with OffsetMonths for composite offsets like "1 month + 7 days".
offsetMonths	integer	The number of months before or after the client date. Paired with OffsetDays. NULL when no months portion is needed. Used when Type is ClientDate.
The number of months before or after the client date. Paired with OffsetDays. NULL when no months portion is needed. Used when Type is ClientDate.
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",
  "intervalValue": 0,
  "intervalUnit": "Day",
  "weekDayPatterns": [
    {
      "position": "...",
      "day": "..."
    }
  ],
  "daysOfMonth": [
    0
  ]
}

TaskStartConfigDto

Properties

JSON Example

Contained in Schemas