Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041351024.8 MB

21d41189c461

Customers

Get customer

The Get customer endpoint returns a single customer for a given customerId.

Customers are people or organizations that buy goods or services from the SMB.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/data/customers/{customerId}

Response

Success

idstring

Identifier for the customer, unique to the company in the accounting software.

customerNamestring nullable

Name of the customer as recorded in the accounting system, typically the company name.

contactNamestring nullable

Name of the main contact for the identified customer.

emailAddressstring nullable

Email address the customer can be contacted by.

defaultCurrencyCurrency — unresolved $ref
phonestring nullable

Phone number the customer can be contacted by.

addressesItems[] nullable— unresolved $ref

An array of Addresses.

contactsContact[] nullable— unresolved $ref

An array of Contacts.

registrationNumberstring nullable

Company number. In the UK, this is typically the Companies House company registration number.

taxNumberstring nullable

Company tax number.

statusCustomerStatus required— unresolved $ref
modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

  • Pulling attachments
  • The accounting software does not provide modification dates for a data type
  • A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
  • A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.