> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a payment reminders > Get an existing payment reminders. ## OpenAPI ````json GET /api/v1/invoices/paymentreminders { "openapi": "3.0.4", "info": { "title": "Invoices V1", "description": "Welcome to BETA version of the new Invoices API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Budgets" }, { "name": "Compactions" }, { "name": "ConceptPurchaseInvoices" }, { "name": "JournalPosts" }, { "name": "Journals" }, { "name": "LedgerAccounts" }, { "name": "Metadata" }, { "name": "PaymentReminders" }, { "name": "PurchaseInvoices" }, { "name": "PurchaseOrders" }, { "name": "SalesInvoices" }, { "name": "SalesInvoiceServices" } ], "paths": { "/api/v1/invoices/paymentreminders": { "get": { "tags": [ "PaymentReminders" ], "summary": "Get a payment reminders", "description": "Get an existing payment reminders.", "operationId": "GetPaymentReminder", "parameters": [ { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentReminderDetail" } } } }, "404": { "description": "The requested payment reminders was not found." } }, "x-d360-narrative-url": "

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.

" } } }, "components": { "schemas": { "PaymentReminderDetail": { "required": [ "ownerReference", "paymentReminderPhase", "reference", "relationReference" ], "type": "object", "properties": { "reference": { "maxLength": 100, "minLength": 0, "type": "string" }, "ownerReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "relationReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "paymentReminderPhase": { "type": "integer", "description": "None = 0\nFirstReminderSent = 1\nSecondReminderSent = 2\nThirdReminderSent = 3\nExcluded = 4\nClosed = 5\nInProgress = 6\nSentToDebtCollectingAgency = 7\nArchived = 8", "format": "int32", "x-enumNames": [ "None", "FirstReminderSent", "SecondReminderSent", "ThirdReminderSent", "Excluded", "Closed", "InProgress", "SentToDebtCollectingAgency", "Archived" ] }, "showAsActionRequiredFrom": { "type": "string", "format": "date-time" }, "lastActionOn": { "type": "string", "format": "date-time", "nullable": true }, "totalOutstandingAmount": { "type": "number", "format": "double" }, "totalOutstandingAmountRecalculateDate": { "type": "string", "format": "date-time" }, "salesInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentReminderSalesInvoiceDetail" }, "nullable": true } }, "additionalProperties": false }, "PaymentReminderSalesInvoiceDetail": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "maxLength": 100, "minLength": 0, "type": "string" }, "subject": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "totalAmountExcl": { "type": "number", "format": "double" }, "totalAmountVAT": { "type": "number", "format": "double" }, "totalAmountIncl": { "type": "number", "format": "double" }, "outstandingAmount": { "type": "number", "format": "double" } }, "additionalProperties": false } } } } ````