ADadfin
Customers

Retrieve a list of customers by filter

Changed on
get/customers

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/customers
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Query parameters

onlyCustomersWithActivityboolean

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

searchTextstring

Fuzzy search a customer based on a text

ddMandateSignedStartTimestring date-time

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

ddMandateStatusesstring[]

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

financialStatusesstring[]

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.

tagIdsstring[]

The tag ids of the customer

customerIdsstring[]

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.

Changes

  • 5eb8e7e1d53cRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 1a2e874091e2Revision changes
    • info

      added the optional property /// to the response with the status