Skip to main content

Supplier

A supplier the merchant orders stock from, as set up in Bookkeep Inventory. The contact and address fields can identify a person, so treat them as personal data: keep only what you need and store it securely.

uuidstring

The supplier's unique identifier. Use it in the supplier path.

Example: 6d1f2a3b-4c5d-4e7f-8091-a2b3c4d5e6f7
namestring

The supplier's name as the merchant sees it in Bookkeep.

Example: Acme Supply
company_namestringnullable

The supplier's registered company name.

Example: Acme Supply Co.
contact_namestringnullable

Name of the merchant's contact at the supplier. Personal data.

Example: Jane Doe
contact_emailstringnullable

Email address of the contact. Personal data.

Example: jane@acmesupply.example
phonestringnullable

Phone number of the supplier or contact. Personal data.

Example: +1-555-0100
websitestringnullable
Example: https://acmesupply.example
currency_codestringnullable

ISO 4217 code of the currency the merchant pays this supplier in.

Example: USD
address1stringnullable
Example: 123 Main St
address2stringnullable
Example: null
citystringnullable
Example: Springfield
province_codestringnullable
Example: IL
country_namestringnullable
Example: United States
zipstringnullable
Example: 62701
payment_termsstringnullable

Default payment terms for this supplier. Typically one of prepaid, upon_receipt, net_7, net_15, net_30, net_45, net_60, net_90 or net_120, but it is free text.

Example: net_30
payment_methodstringnullable

How the merchant usually pays this supplier.

Example: null
is_hiddenboolean

Whether the merchant hid the supplier in Bookkeep.

Example: false
created_atstring<date-time>
Example: 2026-01-12T16:20:00.000Z
updated_atstring<date-time>
Example: 2026-08-30T10:05:00.000Z
Supplier
{
"uuid": "6d1f2a3b-4c5d-4e7f-8091-a2b3c4d5e6f7",
"name": "Acme Supply",
"company_name": "Acme Supply Co.",
"contact_name": "Jane Doe",
"contact_email": "jane@acmesupply.example",
"phone": "+1-555-0100",
"website": "https://acmesupply.example",
"currency_code": "USD",
"address1": "123 Main St",
"address2": null,
"city": "Springfield",
"province_code": "IL",
"country_name": "United States",
"zip": "62701",
"payment_terms": "net_30",
"payment_method": null,
"is_hidden": false,
"created_at": "2026-01-12T16:20:00.000Z",
"updated_at": "2026-08-30T10:05:00.000Z"
}