v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Customers

Retrieve a list of customers by filter

get/customers

Query parameters

onlyCustomersWithActivityboolean

Filter customers that have any financial activity (invoices, direct debits)

Filter customers that have any financial activity (invoices, direct debits)

searchTextstring

Fuzzy search a customer based on a text

Fuzzy search a customer based on a text

ddMandateSignedStartTimestring date-time

Filter customers that have signed their direct debit mandate after this date

Filter customers that have signed their direct debit mandate after this date

ddMandateSignedEndTimestring date-time

Filter customers that have signed their direct debit mandate until this date

Filter customers that have signed their direct debit mandate until this date

ddMandateStatusesstring[]

The status of the latest direct debit mandate

The status of the latest direct debit mandate

includeCustomerFinancialDetailsboolean

This flag determines whether the response should include the financial status of the customer's invoices and payments

This flag determines whether the response should include the financial status of the customer's invoices and payments

financialStatusesstring[]

The financial statuses of the payment situation of the customer

The financial statuses of the payment situation of the customer

lastUpdatedStartTimestring date-time

The start time after which the customer last updated time should be, including the start time.

The start time after which the customer last updated time should be, including the start time.

tagIdsstring[]

The tag ids of the customer

The tag ids of the customer

customerIdsstring[]

The ids of the customers

The ids of the customers

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

The list of customers for the specified filter.