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 + Offset (days), plus ClientDateType (KeyDate) or CustomFieldDefinitionCode (CustomField)

Properties

Name Type Description
typeenum

RelativeToStart SpecificDate ClientKeyDate

RelativeToStart SpecificDate ClientKeyDate

intervalValueinteger

Numeric value for the interval. Required when Type is RelativeToStart.

Numeric value for the interval. Required when Type is RelativeToStart.

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

IncorporationDate YearEnd AccountsNextDue AccountsNextPeriodStart AccountsNextPeriodEnd AccountsLastPeriodFiled AccountsLastPeriodStart AccountsLastPeriodEnd AccountsLastMadeUpTo ConfirmationStatementDue ConfirmationStatementNextMadeUpTo LastConfirmationStatementFiled LastConfirmationStatementMadeUpTo NextVatReturnDue 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

offsetinteger

Number of days before or after the client date. Required when Type is ClientKeyDate.

Number of days before or after the client date. Required when Type is ClientKeyDate.

JSON Example

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

Contained in Schemas