> ## 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 payment reminders filtered and paged > Get a paged list of existing payment reminders, optionally filtered to the given parameters. ## OpenAPI ````json POST /api/v1/invoices/paymentreminders/filter { "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/filter": { "post": { "tags": [ "PaymentReminders" ], "summary": "Get payment reminders filtered and paged", "description": "Get a paged list of existing payment reminders, optionally filtered to the given parameters.", "operationId": "GetPaymentRemindersFilteredPaged", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentReminderSearchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentReminderSearchResult" } } } } }, "x-d360-narrative-url": "

Get payment reminders filtered and paged (POST)

This endpoint retrieves a paginated list of existing payment reminders, optionally filtered by owner, relation, reminder phase, outstanding amount, or action dates.

A developer calls this endpoint to build an overview of debtors currently in the reminder process, to prioritise collection follow-up by phase or outstanding amount, or to export reminder data for reporting.

Filtering by paymentReminderPhase makes it possible to isolate reminders that require action or have already been escalated.

Request Fields

Field

Type

Required

Description

paging.pageSize

integer

No

Number of results per page. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number to retrieve. Minimum 1, maximum 9999.

sorting.columnName

string

No

Name of the field to sort results by.

sorting.order

integer

No

Sort direction. Enum: 0 = Ascending, 1 = Descending.

filter.reference

string

No

Filters results to the payment reminder with this internal reference.

filter.ownerReference

string

No

Filters results to reminders raised for this owner.

filter.relationReference

string

No

Filters results to reminders concerning this relation.

filter.paymentReminderPhase

integer

No

Filters results to reminders in this phase. Enum: 0 = None, 1 = FirstReminderSent, 2 = SecondReminderSent, 3 = ThirdReminderSent, 4 = Excluded, 5 = Closed, 6 = InProgress, 7 = SentToDebtCollectingAgency, 8 = Archived.

filter.showAsActionRequiredFrom.from

datetime

No

Lower bound (inclusive) for the action-required date. ISO 8601 format.

filter.showAsActionRequiredFrom.to

datetime

No

Upper bound (inclusive) for the action-required date. ISO 8601 format.

filter.lastActionOn.from

datetime

No

Lower bound (inclusive) for the last action date. ISO 8601 format.

filter.lastActionOn.to

datetime

No

Upper bound (inclusive) for the last action date. ISO 8601 format.

filter.totalOutstandingAmount.from

decimal

No

Lower bound (inclusive) for the reminder's total outstanding amount.

filter.totalOutstandingAmount.to

decimal

No

Upper bound (inclusive) for the reminder's total outstanding amount.

filter.totalOutstandingAmountRecalculateDate.from

datetime

No

Lower bound (inclusive) for the last outstanding amount recalculation. ISO 8601 format.

filter.totalOutstandingAmountRecalculateDate.to

datetime

No

Upper bound (inclusive) for the last outstanding amount recalculation. ISO 8601 format.

Response Fields

Field

Type

Required

Description

paging.pageSize

integer

Yes

Number of results per page, as applied to this response.

paging.pageNumber

integer

Yes

Page number returned in this response.

sorting.columnName

string

Yes

Field the results were sorted by.

sorting.order

integer

Yes

Sort direction applied. Enum: 0 = Ascending, 1 = Descending.

paymentReminders

array of objects

No

Collection of payment reminders matching the filter for this page. See the fields below.

paymentReminders[].reference

string

No

Internal reference of the payment reminder.

paymentReminders[].ownerReference

string

No

Reference to the owner the payment reminder was raised for.

paymentReminders[].relationReference

string

No

Reference to the relation the payment reminder concerns.

paymentReminders[].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.

paymentReminders[].showAsActionRequiredFrom

datetime

Yes

Date and time from which this reminder should be shown as requiring action. ISO 8601 format.

paymentReminders[].lastActionOn

datetime

No

Date and time the last action was taken on this reminder. ISO 8601 format.

paymentReminders[].totalOutstandingAmount

decimal

Yes

Total outstanding amount across all sales invoices covered by this reminder.

paymentReminders[].totalOutstandingAmountRecalculateDate

datetime

Yes

Date and time at which totalOutstandingAmount was last recalculated. ISO 8601 format.

" } } }, "components": { "schemas": { "PaymentReminderSearchRequest": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "filter": { "$ref": "#/components/schemas/PaymentReminderSearchRequestFilter" } }, "additionalProperties": false }, "PaymentReminderSearchResult": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "paymentReminders": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentReminderSearchResultFilter" }, "nullable": true } }, "additionalProperties": false }, "PagingInfo": { "type": "object", "properties": { "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SortingInfo": { "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "order": { "type": "integer", "description": "Ascending = 0\nDescending = 1", "format": "int32", "x-enumNames": [ "Ascending", "Descending" ] } }, "additionalProperties": false }, "PaymentReminderSearchRequestFilter": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "paymentReminderPhase": { "type": "integer", "description": "None = 0\nFirstReminderSent = 1\nSecondReminderSent = 2\nThirdReminderSent = 3\nExcluded = 4\nClosed = 5\nInProgress = 6\nSentToDebtCollectingAgency = 7\nArchived = 8", "format": "int32", "nullable": true, "x-enumNames": [ "None", "FirstReminderSent", "SecondReminderSent", "ThirdReminderSent", "Excluded", "Closed", "InProgress", "SentToDebtCollectingAgency", "Archived" ] }, "showAsActionRequiredFrom": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "lastActionOn": { "$ref": "#/components/schemas/CompareFilterModelDateTime" }, "totalOutstandingAmount": { "$ref": "#/components/schemas/CompareFilterModelDecimal" }, "totalOutstandingAmountRecalculateDate": { "$ref": "#/components/schemas/CompareFilterModelDateTime" } }, "additionalProperties": false }, "PaymentReminderSearchResultFilter": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "ownerReference": { "type": "string", "nullable": true }, "relationReference": { "type": "string", "nullable": true }, "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" } }, "additionalProperties": false }, "CompareFilterModelDateTime": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CompareFilterModelDecimal": { "type": "object", "properties": { "from": { "type": "number", "format": "double", "nullable": true }, "to": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false } } } } ````