DueDateConfigDto

Configuration for the projected DueDate on tasks created from a recurring task.
Different properties are required based on the Type value:

  • RelativeToStart: Interval (e.g., 2 weeks after StartDate)
  • SpecificDate: FixedMonth + FixedDay (DD/MM annual; invalid days clamped to end-of-month)
  • ClientKeyDate: ClientDateSourceType + Timing + OffsetDays + OffsetMonths, plus ClientDateType (KeyDate) or CustomFieldDefinitionCode (CustomField)
  • DayOfMonth: DayOfMonth (1-31, clamped to end-of-month for shorter months) - requires monthly cadence
  • MonthDay: MonthDayPatterns (positional weekday list, e.g. First Monday) - requires monthly/yearly cadence
  • RelativeToStatutory: Interval (Due = Statutory - interval) - requires TaskDateBasis=StatutoryDate
  • Sequence: SequenceSeedDate + Recurrence.Sequence (Due advances through the repeating periods
    from the seed) - requires TaskDateBasis=DueDate

Properties

Name Type Description
typeenum

RelativeToStart SpecificDate ClientKeyDate DayOfMonth MonthDay RelativeToStatutory Sequence

RelativeToStart SpecificDate ClientKeyDate DayOfMonth MonthDay RelativeToStatutory Sequence

intervalRelativeIntervalDto
fixedMonthinteger

Month (1-12). Required when Type is SpecificDate.

Month (1-12). Required when Type is SpecificDate.

fixedDayinteger

Day of month (1-31). Required when Type is SpecificDate. Clamped to last day of month at projection time.

Day of month (1-31). Required when Type is SpecificDate. Clamped to last day of month at projection time.

clientDateSourceTypeenum

KeyDate CustomField

KeyDate CustomField

clientDateTypeenum

IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDueAnnual NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate CharityAnnualReturnDue CharityAccountsDue CharityLastAnnualReturnReceived CharityLastAccountsReceived CharityFinancialYearEnd

IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDueAnnual NextVatPeriodEndQuarterly NextVatReturnDueQuarterly NextVatPeriodEndMonthly NextVatReturnDueMonthly NextTaxQuarterPeriodEnd NextTaxQuarterSubmissionDeadline NextPayeCisFilingDue PensionReEnrolmentDate CharityAnnualReturnDue CharityAccountsDue CharityLastAnnualReturnReceived CharityLastAccountsReceived CharityFinancialYearEnd

customFieldDefinitionCodestring

Custom field code. Required when Type is ClientKeyDate and ClientDateSourceType is CustomField.

Custom field code. Required when Type is ClientKeyDate and ClientDateSourceType is CustomField.

customFieldDefinitionLabelstring

Custom field label. Populated in responses only.

Custom field label. Populated in responses only.

timingenum

OnActualDate DaysBefore DaysAfter

OnActualDate DaysBefore DaysAfter

offsetDaysinteger

Number of days before or after the client date. Required when Type is ClientKeyDate.
Paired with OffsetMonths for composite offsets like "9 months + 1 day" (CT payment).

Number of days before or after the client date. Required when Type is ClientKeyDate.
Paired with OffsetMonths for composite offsets like "9 months + 1 day" (CT payment).

offsetMonthsinteger

Number of months before or after the client date. Paired with OffsetDays. NULL when no months
portion is needed. Used when Type is ClientKeyDate.

Number of months before or after the client date. Paired with OffsetDays. NULL when no months
portion is needed. Used when Type is ClientKeyDate.

dayOfMonthinteger

Day of month (1-31). Required when Type is DayOfMonth. Clamped to end-of-month for shorter
months (e.g. 31 -> 28 in non-leap February). Requires monthly cadence.

Day of month (1-31). Required when Type is DayOfMonth. Clamped to end-of-month for shorter
months (e.g. 31 -> 28 in non-leap February). Requires monthly cadence.

monthDayPatternsarray of WeekDayPatternDto

Positional weekday patterns within each occurrence's month. Required when Type is MonthDay.
Example: [{ Position: "First", Day: "Monday" }, { Position: "Last", Day: "Friday" }].
Requires monthly or yearly cadence.

Positional weekday patterns within each occurrence's month. Required when Type is MonthDay.
Example: [{ Position: "First", Day: "Monday" }, { Position: "Last", Day: "Friday" }].
Requires monthly or yearly cadence.

sequenceSeedDatestring

The first Due date of the repeating cycle (the sequence seed). Required when Type is
Sequence; the Due advances from here through Recurrence.Sequence, wrapping indefinitely.

The first Due date of the repeating cycle (the sequence seed). Required when Type is
Sequence; the Due advances from here through Recurrence.Sequence, wrapping indefinitely.

holidayAdjustmentenum

None Skip MoveBefore MoveAfter

None Skip MoveBefore MoveAfter

timestring

Time of day stamped onto every projected Due date. Omit for 09:00; always populated in
responses.

Time of day stamped onto every projected Due date. Omit for 09:00; always populated in
responses.

JSON Example

{
  "type": "RelativeToStart",
  "interval": {
    "value": 0,
    "unit": "..."
  },
  "fixedMonth": 0,
  "fixedDay": 0,
  "clientDateSourceType": "KeyDate"
}

Contained in Schemas