API Docs / Schemas / DueDateConfigDto

DueDateConfigDto

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

  • RelativeToStart: IntervalValue + IntervalUnit (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: IntervalValue + IntervalUnit (Due = Statutory - interval) - requires TaskDateBasis=StatutoryDate

Properties

Name Type Description
typeenum

RelativeToStart SpecificDate ClientKeyDate DayOfMonth MonthDay RelativeToStatutory

RelativeToStart SpecificDate ClientKeyDate DayOfMonth MonthDay RelativeToStatutory

intervalValueinteger

Numeric value for the interval. Required when Type is RelativeToStart (Due is set this many
units after the Start) or RelativeToStatutory (Due is set this many units before the Statutory date).

Numeric value for the interval. Required when Type is RelativeToStart (Due is set this many
units after the Start) or RelativeToStatutory (Due is set this many units before the Statutory date).

intervalUnitenum

Day Week Month Year

Day Week Month Year

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 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

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.

JSON Example

{
  "type": "RelativeToStart",
  "intervalValue": 0,
  "intervalUnit": "Day",
  "fixedMonth": 0,
  "fixedDay": 0
}

Contained in Schemas