Due-date schedule (due_date_schedule)

Schedule of milestones relative to a due date, used to emit time stages without embedding reminder logic.

Role

Schedule of milestones relative to a due date, used to emit time stages without embedding reminder logic.

This page describes the canonical functional concept. Detailed endpoints, HTTP parameters, and response formats belong in the API & events.

Nature in the model

Ressource This resource has its own identifier and can be durably referenced by other objects and processes that need it.

Key fields

The fields below capture the most important functional distinctions of the object.

ChampTypeRole
target_typeinvoice | receivableBusiness type to which this schedule applies.
days_from_due_dateinteger[]Signed thresholds relative to the due date: negative before, zero on the due date, positive after.
activebooleanWhether the schedule is active for this merchant and `target_type`.
source_referencestring | nullOptional external reference of the schedule.
metadataobjectFlat map of `string | number | boolean` scalars, following the API metadata convention.

Invariants

  • Only one `due_date_schedule` may be active per merchant and `target_type`.
  • `days_from_due_date` is normalized, sorted, and deduplicated.
  • The schedule describes no action, channel, or template: processes react to stage events to decide what to do.
  • A value of -10 means ten days before the due date; 0 means the due date; 10 means ten days after.