Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Customers

Retrieve a customer

get/customers/{id}

Path parameters

idstring required

The id of the customer to get the details for

The id of the customer to get the details for

Query parameters

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

The connector type that this ID refers to

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.

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