Contents x
    Get payment reminders filtered and paged
    • 23 May 2025
    • 4 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get payment reminders filtered and paged

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

    Post
    /api/v1/invoices/paymentreminders/filter

    [PREVIEW] Get a paged list of existing payment reminders, optionally filtered to the given parameters.

    Description

    Retrieve a paged list of existing payment reminders, filtered to the given parameters.

    Use Case

    The user may retrieve reminders linked to a specific customer or contract in order to display them within a customer portal or during support interactions, enhancing service quality and transparency. Additionally, the API can be used to identify accounts with a high number of overdue reminders, supporting escalation processes such as legal action or transfer to a collection agency.   

    Request fields

    The request contains the following fields:

    FieldDescription
    paging.pageSizeThe maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number).
    paging.pageNumberThis allows the requesting party to specify which of the pages they want to receive.
    sorting.columnNameThe data field based on which sorting is applied. For example, if the results are sorted based on ascending name, columnName will contain the value 'name'.
    sorting.orderBased on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a).
    filter.referenceThis pertains to the reference of the specific payment reminder. This reference can be used to obtain further information regarding the payment reminder through the GET operation.
    filter.ownerReferenceThis pertains to the reference of the owner of the object.
    filter.relationReferenceThis is the reference of the relation associated with the reminder. It can refer to any relation type within the system and is not necessarily a tenant. For example, it may also refer to an owner who has an outstanding debt with another owner.
    filter.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.

    filter.showAsActionRequiredFrom.fromThis 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. This defines the lower border of the range.
    filter.showAsActionRequiredTo.toThis 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. This defines the upper border of the range.
    filter. lastActionOn.onThis 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. This defines the lower border of the range.
    filter.lastActionOn.toThis 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. This defines the upper border of the range.
    filter.totalOutstandingAmount.fromThis 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. This defines the lower border of the range.
    filter.totalOutstandingAmount.toThis 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. This defines the upper border of the range.
    filter.totalOutstandingAmountReacalculateDate.from
    		The date on which the outstanding debt was last updated. This value is generated by Bloxs. This defines the lower border of the range.
    filter.totalOutstandingAmountReacalculateDate.to
    		The date on which the outstanding debt was last updated. This value is generated by Bloxs. This defines the upper border of the range.


    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)
    Valid values[ \0\, \1\ ]
    filter
    object (PaymentReminderSearchRequestFilter)
    reference
    string | null
    ownerReference
    string | null
    relationReference
    string | null
    paymentReminderPhase
    integer (int32) | null
    Valid values[ \0\, \1\, \2\, \3\, \4\, \5\, \6\, \7\, \8\ ]
    showAsActionRequiredFrom
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    lastActionOn
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    totalOutstandingAmount
    object (CompareFilterModelDecimal)
    from
    number (double) | null
    to
    number (double) | null
    totalOutstandingAmountRecalculateDate
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    Responses
    200

    OK

    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)
    Valid values[ \0\, \1\ ]
    paymentReminders
    Array of object (PaymentReminderSearchResultFilter) | null
    object
    reference
    string | null
    ownerReference
    string | null
    relationReference
    string | null
    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)
    What's Next