ADadfin
Customers

Retrieve a customer

Changed on
get/customers/{id}

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/customers/{id}
  • 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

Path parameters

idstring required

The id of the customer to get the details for

Query parameters

idType'XERO' | 'QUICKBOOKS' | 'ACTIONSTEP' | 'EXTERNAL' required

The connector type that this ID refers to

includeCustomerFinancialDetailsboolean

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

Response

The customer with the specified ID.

idstring

The Adfin id of the customer.

externalIdstring

The id of the customer from the platform that is integrating with Adfin.

namestring

The full name of the customer.

creationTimestring date-time

The time the customer was created.

lastUpdatedTimestring date-time

The last time when the customer was updated.

timezonestring

The timezone of the customer.

tagsstring[]

The tag ids associated with the customer.

status'ACTIVE' | 'ARCHIVED'

The status of the customer (ACTIVE, ARCHIVED)

statusReasonCode'MERGED' | 'ARCHIVED_MANUALLY'

The reason as a predefined code for why the customer is in a certain status

collectionAgentIdstring uuid

The collection agent ID associated with the customer.

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