# Retrieve a list of customers by filter

Endpoint: GET /customers
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Query parameters:

  - `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)
    Zero-based page index (0..N)

  - `size` (integer)
    The size of the page to be returned

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

## Response 200 fields (application/json):

  - `customers` (array)
    The list of customers for the specified filter.

  - `customers.id` (string)
    The Adfin id of the customer.

  - `customers.externalId` (string)
    The id of the customer from the platform that is integrating with Adfin.

  - `customers.name` (string)
    The full name of the customer.

  - `customers.creationTime` (string)
    The time the customer was created.

  - `customers.lastUpdatedTime` (string)
    The last time when the customer was updated.

  - `customers.people` (array)
    The list of people assigned to the customer.

  - `customers.people.id` (string)
    The internal id of the person.

  - `customers.people.firstName` (string)
    The first name of the person.

  - `customers.people.lastName` (string)
    The last name of the person.

  - `customers.people.email` (string)
    The email of the person.

  - `customers.people.phoneNo` (string)
    The phone number of the person.

  - `customers.people.isPrimaryContact` (boolean)
    True if this person is a primary contact.

  - `customers.people.isIncludedInCommunications` (boolean)
    True if this person is included in the customers communications.

  - `customers.addresses` (array)
    The list of the addresses for the customer.

  - `customers.addresses.id` (string)
    The internal id of the address.

  - `customers.addresses.city` (string)
    The name of the city.

  - `customers.addresses.postalCode` (string)
    The postal code.

  - `customers.addresses.country` (string)
    The name of the biller country.

  - `customers.addresses.addressLine1` (string)
    The name of the street, and the house or building number.

  - `customers.directDebitMandate` (object)
    Direct Debit details.

  - `customers.directDebitMandate.id` (string)
    The id of the direct debit mandate.

  - `customers.directDebitMandate.status` (string)
    The status of the Direct Debit Mandate, if any present.
* CREATED: The Direct Debit Mandate was created with success.
* PENDING: The Direct Debit Mandate was signed and accepted by the customer and it is in the Payment Provider's accepted timeframe.
* ACTIVE: The Direct Debit Mandate was confirmed by the Payment Provider.
* CANCELLED: The Direct Debit Mandate was cancelled directly by the customer.
* MIGRATING: The Direct Debit Mandate is in process of migrating from one payment provider to another.. 
Possible values (non-exclusive): CREATED, PENDING, ACTIVE, CANCELLED, MIGRATING

  - `customers.directDebitMandate.statusReasonCode` (string)
    The reason why the direct debit mandate is in a certain status.
* PENDING_DD_CAPABILITY - The direct debit mandate was signed, but not yet submitted to the payment provider as the biller onboarding is still in progress.
* PENDING_ACTIVATION - The direct debit mandate was signed, but not yet activated by the payment provider.
* MIGRATED - The direct debit mandate was migrated to a new payment provider.
* BANK_ACCOUNT_CHANGED - The direct debit mandate was created due to a bank account change (bank switching).
* INCORRECT_BANK_DETAILS - The direct debit mandate has incorrect bank account details.
* OTHER - Unknown reason. 
Possible values (non-exclusive): PENDING_DD_CAPABILITY, PENDING_ACTIVATION, MIGRATED, BANK_ACCOUNT_CHANGED, INCORRECT_BANK_DETAILS, OTHER

  - `customers.directDebitMandate.statusReason` (string)
    Reason explaining the current status of the direct debit mandate, especially useful for failure cases.

  - `customers.directDebitMandate.creationTime` (string)
    The time when the mandate was created

  - `customers.directDebitMandate.lastUpdatedTime` (string)
    The last time when the mandate was updated

  - `customers.directDebitMandate.authorisationTime` (string)
    The time when the mandate was signed by the customer

  - `customers.directDebitMandate.submissionTime` (string)
    The time when the mandate was submitted to the payment provider

  - `customers.directDebitMandate.url` (string)
    The URL where the customer can sign the direct debit mandate.

  - `customers.timezone` (string)
    The timezone of the customer.

  - `customers.discount` (object)
    The customer discount details.

  - `customers.discount.percentage` (number)
    The discount as a percentage to be applied for the invoices.

  - `customers.discount.period` (integer)
    The period in hours until the discount expires.

  - `customers.externalData` (array)
    References about this customer from external platforms Adfin integrates with, such as ID, etc.

  - `customers.externalData.connectorType` (string, required)
    The customer connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS

  - `customers.externalData.id` (string, required)
    The ID of the Customer in the external platform.

  - `customers.externalData.name` (string)
    The name of the Customer in the external platform.

  - `customers.tags` (array)
    The tag ids associated with the customer.

  - `page` (object)
    Contains pagination information for a set of results

  - `page.page` (integer)
    The current page number One-based page index (1..N).

  - `page.size` (integer)
    The size of the page, i.e., the number of elements per page.

  - `page.totalPages` (integer)
    The total number of pages available.

  - `page.totalElements` (integer)
    The total number of elements across all pages.

  - `page.numberOfElements` (integer)
    The number of elements in the current page.

  - `page.sort` (string)
    Sorting criteria in the format: property,(asc|desc).

  - `pagination` (object)
    Contains pagination information for a set of results


## Response 400 fields

## Response 401 fields

## Response 422 fields

## Response 500 fields