Explore Suppliers endpoints in Swagger.

Overview

A supplier is a person or organisation that provides a product or service. From the Suppliers endpoints, you can retrieve a list of all the suppliers for a company. Suppliers' data links to accounts payable bills.

Data model

Field	Type	Description
id	string	Identifier for the supplier, unique to the company in the accounting platform.
supplierName	string	Name of the supplier as recorded in the accounting system, typically the company name.
contactName	string	Name of the main contact for the supplier.
emailAddress	string	Email address that the supplier may be contacted on.
phone	string	Phone number that the supplier may be contacted on.
addresses		An array of Addresses.
registrationNumber	string	Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.
taxNumber	string	Supplier's company tax number.
defaultCurrency	string See currency	Default currency the supplier's transactional data is recorded in.
status	string	Status of the supplier,either: `Unknown` `Active` `Archived`
modifiedDate	string See date	Date the record was last updated in the Codat system.
sourceModifiedDate	string See date	Date the record was last changed in the accounting system.

Addresses

Field	Type	Description
type	string	Type of the address, either: `Unknown` `Billing` `Delivery`
line1	string	Line 1 of the supplier address.
line2	string	Line 2 of the supplier address.
city	string	City address of the supplier.
region	string	Regional address of the supplier.
country	string	Country address of the supplier.
postalCode	string	Postal code or zip code.

Supplier reference

Data types that reference a supplier, for example bills and bill payments, use a supplierRef that includes the ID and name of the linked supplier.

Field	Type	Description
id	string	Unique identifier for the supplier in the accounting platform.
name	string	Name of the supplier in the accounting platform.

Example data

{
  "results": [
    {
        "id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F",
        "supplierName": "Kelly's Industrial Supplies",
        "contactName": "Kelly's Industrial Supplies",
        "emailAddress": "[email protected]",
        "phone": "07999 999999",
        "addresses": [
          {
            "type": "Billing",
            "line1": "Unit 51",
            "line2": "Bakersfield Industrial Estate",
            "city": "Bakersfield",
            "region": "California",
            "country": "USA",
            "postalcode": "93308"
          }
        ],
        "registrationNumber": "8409314368",
        "taxNumber": "6845012202",
        "status": "Active"
      },
      {
        "id": "21C99A58-7565-4DC8-8FDF-BA7DF5280F25",
        "supplierName": "EDD",
        "contactName": "EDD",
        "emailAddress": "[email protected]",
        "phone": null,
        "addresses": [
          {
            "type": "Billing",
            "line1": "3731 Burwell Heights Road",
            "line2": "",
            "city": "Nederland",
            "region": "Texas",
            "country": "USA",
            "postalcode": "77627"
          },
          {
            "type": "Delivery",
            "line1": "2760 Lynn Ogden Lane",
            "line2": "",
            "city": "Nederland",
            "region": "Texas",
            "country": "USA",
            "postalcode": "77627"
          }
        ],
        "registrationNumber": "5562326086",
        "taxNumber": "7413198580",
        "status": "Active"
      }
  ],
  "pageNumber": 1,
  "pageSize": 100,
  "totalResults": 2,
  "_links": {
    "current": {
      "href": "/companies/919371ab-763c-4bc7-99a4-9723cade34d3/data/suppliers?page=1"
    },
    "self": {
      "href": "/companies/919371ab-763c-4bc7-99a4-9723cade34d3/data/suppliers"
    }
  }
}