Contents x
    Get a payment reminder
    • 23 May 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get a payment reminder

    • Updated on 23 May 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/invoices/paymentreminders

    [PREVIEW] Get an existing payment reminders.

    Description

    This endpoint retrieves payment reminders which are ready to be sent or have already been sent for sales invoices that are overdue. For each object and each overdue payment, there is only one process. That is, one payment reminder and one reference.

    Use Case

    The user wants to retrieve an individual payment reminder by specifying its reference. To obtain the reference of a particular payment reminder, the user can first use the Post payment filter endpoint.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe unique identifier for this reminder within Bloxs. This is unique (per client specific environment) for all reminders. This identifier is generated by the Bloxs system.

    Response fields

    The 200 response contains the fields in the table below. For the GET operation it gives a up-to-date insight in the data that is currently registered in Bloxs.

    FieldDescription
    referenceThe unique identifier for this reminder within Bloxs. This is unique (per client specific environment) for all reminders. This identifier is generated by the Bloxs system.
    ownerReferenceThis is the reference of the owner of the object.
    paymentReminderPhase

    PaymentReminderPhase

    0 – None

    The reminder process has been newly created; no actions have been taken yet. In Bloxs, the first reminder can still be sent.

    1 – FirstReminderSent

    The first reminder has been sent to the customer. In Bloxs, the second reminder is now available for sending.

    2 – SecondReminderSent

    The second reminder has been sent to the customer. In Bloxs, the third reminder can now be sent.

    3 – ThirdReminderSent

    The third reminder has been sent to the customer. At this stage, the process is considered complete within Bloxs, and no further reminder actions are available.

    4 – Excluded

    The customer has been excluded from the reminder process. No reminder actions will be sent from Bloxs.

    5 – Closed

    The reminder process has been completed, typically because all related invoices have been paid.

    6 – InProgress

    Indicates a processing status on the Bloxs side. Correspondence is currently being generated.

    7 – SentToDebtCollectingAgency

    The reminder has been handed over to a debt collection agency or bailiff.

    8 – Archived

    A reminder process was initiated in Bloxs, but no reminders were sent. The outstanding invoice(s) were paid in the meantime.

    showAsActionRequiredFromThis is the date on which the next action is required according to Bloxs. For example, if an invoice is due in eight days, this date will reflect the invoice’s due date. Please note: the API does not specify what the next action is, only when it is expected.
    lastActionOnThis is the date of the most recent action. The date is populated by Bloxs and remains empty if the first reminder has not yet been sent.
    totalOutstandingAmountThis represents the total outstanding amount, based solely on invoiced charges. It does not include administrative or collection fees. Such additional costs may be invoiced separately and can then be included in the total debt. The amount is expressed with two decimals.
    totalOutstandingAmountRecalculateDateThe date on which the outstanding debt was last updated. This value is generated by Bloxs.
    salesInvoices

    Sales invoices that are overdue. If a tenant has multiple months of arrears, multiple sales invoices will be displayed here as separate objects.

    salesInvoices.referenceInvoice number.
    salesInvoices.subjectInvoice subject.
    salesInvoices.totalAmountExcl

    Total amount excluding VAT.

    salesInvoices.totalAmountVATTotal VAT amount.
    salesInvoices.totalAmountInclTotal amount including VAT.
    salesInvoices.outstandingAmountTotal outstanding amount for the current month only. This reflects the amount due specifically within the current month and does not include any outstanding balances from previous months.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    stringRequired

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    Responses
    200

    OK

    Expand All
    object
    reference
    string
    Min length0
    Max length100
    ownerReference
    string
    Min length0
    Max length100
    relationReference
    string
    Min length0
    Max length100
    paymentReminderPhase
    integer (int32)
    Valid values[ \0\, \1\, \2\, \3\, \4\, \5\, \6\, \7\, \8\ ]
    showAsActionRequiredFrom
    string (date-time)
    lastActionOn
    string (date-time) | null
    totalOutstandingAmount
    number (double)
    totalOutstandingAmountRecalculateDate
    string (date-time)
    salesInvoices
    Array of object (PaymentReminderSalesInvoiceDetail) | null
    object
    reference
    string
    Min length0
    Max length100
    subject
    string | null
    Min length0
    Max length512
    totalAmountExcl
    number (double)
    totalAmountVAT
    number (double)
    totalAmountIncl
    number (double)
    outstandingAmount
    number (double)
    404

    The requested payment reminders was not found.

    What's Next