Get an existing payment reminders.
Get a payment reminder
This endpoint retrieves an existing payment reminder.
A payment reminder tracks the reminder process for one or more overdue sales invoices sent to a relation, moving through escalation phases as reminders are sent and, if needed, up to referral to a debt collecting agency.
A developer calls this endpoint to check the current reminder phase, the total outstanding amount, and which sales invoices are covered by the reminder, for example to drive a dunning dashboard or to decide whether further collection action is needed.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | Internal reference of the payment reminder to retrieve. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | Internal reference of the payment reminder. Maximum length 100 characters. |
ownerReference | string | Yes | Reference to the owner the payment reminder was raised for. |
relationReference | string | Yes | Reference to the relation the payment reminder concerns, the debtor being reminded. |
paymentReminderPhase | integer | Yes | Current phase of the reminder process. Enum: 0 = None, 1 = FirstReminderSent, 2 = SecondReminderSent, 3 = ThirdReminderSent, 4 = Excluded, 5 = Closed, 6 = InProgress, 7 = SentToDebtCollectingAgency, 8 = Archived. |
showAsActionRequiredFrom | datetime | Yes | Date and time from which this reminder should be shown as requiring action. ISO 8601 format. |
lastActionOn | datetime | No | Date and time the last action was taken on this reminder. ISO 8601 format. Null if no action has been taken yet. |
totalOutstandingAmount | decimal | Yes | Total outstanding amount across all sales invoices covered by this reminder. |
totalOutstandingAmountRecalculateDate | datetime | Yes | Date and time at which totalOutstandingAmount was last recalculated. ISO 8601 format. |
salesInvoices | array of objects | No | Collection of sales invoices covered by this payment reminder. See the fields below. |
salesInvoices[].reference | string | Yes | Internal reference of the sales invoice. Maximum length 100 characters. |
salesInvoices[].subject | string | No | Subject or short description of the sales invoice. Maximum length 512 characters. |
salesInvoices[].totalAmountExcl | decimal | Yes | Total invoice amount excluding VAT, the net amount. |
salesInvoices[].totalAmountVAT | decimal | Yes | Total VAT amount charged on the invoice. |
salesInvoices[].totalAmountIncl | decimal | Yes | Total invoice amount including VAT, the gross amount. Equal to totalAmountExcl plus totalAmountVAT. |
salesInvoices[].outstandingAmount | decimal | Yes | Amount still outstanding on this specific sales invoice. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
OK
None = 0 FirstReminderSent = 1 SecondReminderSent = 2 ThirdReminderSent = 3 Excluded = 4 Closed = 5 InProgress = 6 SentToDebtCollectingAgency = 7 Archived = 8
The requested payment reminders was not found.