Retrieve the list of Customers for a given filter

get

https://api.staging.adfin.com/api/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

onlyCustomersWithActivity

string

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

searchText

string

Fuzzy search a customer based on a text

ddMandateSignedStartTime

string

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

ddMandateSignedEndTime

string

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

ddMandateStatuses

string

The status of the latest direct debit mandate

includeCustomerFinancialDetails

string

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

financialStatuses

string

The financial statuses of the payment situation of the customer

lastUpdatedStartTime

string

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

tagIds

string

The tag ids of the customer

customerIds

string

The ids of the customers

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 20

The size of the page to be returned

sort

array of strings

Defaults to creationTime,DESC

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

sort

Responses

400

A problem reading or understanding the request. Ensure that the request complies with the required format and includes all necessary parameters.

401

Authentication required - Invalid or missing authorization headers.

422

A request validation error.

500

The server could not process the request.

200The list of customers for the specified filter.