Sign in
Suppliers

Get supplier

The Get supplier endpoint returns a single supplier for a given supplierId.

Suppliers are people or organizations that provide something, such as a product or service.

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

get/companies/{companyId}/data/suppliers/{supplierId}

Response

Success

idstring

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

supplierNamestring nullable

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

contactNamestring nullable

Name of the main contact for the supplier.

emailAddressstring nullable

Email address that the supplier may be contacted on.

phonestring nullable

Phone number that the supplier may be contacted on.

addressesItems[] nullable— unresolved $ref

An array of Addresses.

registrationNumberstring nullable

Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.

taxNumberstring nullable

Supplier's company tax number.

statusSupplierStatus required— unresolved $ref
defaultCurrencystring nullable

Default currency the supplier's transactional data is recorded in.

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>.

Example response

{
  "id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
  "supplierName": "Kelly's Industrial Supplies",
  "contactName": "Kelly's Industrial Supplies",
  "emailAddress": "sales@kellysupplies.com",
  "phone": "07999 999999",
  "addresses": [
    {
      "type": "Billing",
      "line1": "Unit 51",
      "line2": "Bakersfield Industrial Estate",
      "city": "Bakersfield",
      "region": "California",
      "country": "USA",
      "postalcode": "93308"
    }
  ],
  "registrationNumber": "string",
  "taxNumber": "string",
  "status": "Unknown",
  "defaultCurrency": "string",
  "metadata": {
    "isDeleted": true
  },
  "supplementalData": {
    "content": {
      "property1": {
        "property1": null,
        "property2": null
      },
      "property2": {
        "property1": null,
        "property2": null
      }
    }
  },
  "modifiedDate": "2022-10-23T00:00:00Z",
  "sourceModifiedDate": "2022-10-23T00:00:00Z"
}