x-cpod-domain: procurement

Procurement

Suppliers — the operational vendor view.

Try in explorer client.procurement

Supplier

An operational supplier.

REST path/api/v1/procurement/suppliers

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.procurement.suppliers.list()

// create:
await client.procurement.suppliers.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
name	string	Legal or registered name of the supplier organization.
display_name	string	Short display name used in the UI when the legal name is too long.
type	string	Classification of the supplier's primary business relationship.
status	string	Current engagement status. 'blacklisted' suppliers must not receive new purchase orders.
contact_name	string	Full name of the primary contact person at the supplier.
contact_email	email	Email address of the primary contact.
contact_phone	string	Phone number of the primary contact.
website	string	Supplier's public website URL.
address	json	Registered or billing address of the supplier.
payment_terms_days	number	Number of days allowed for payment after invoice receipt (e.g. 30 = Net 30).
currency	string	Preferred ISO 4217 currency for invoicing by this supplier.
tax_id	string	Tax identification number (VAT ID, EIN, etc.) for this supplier.
notes	string	Internal notes about this supplier — sourcing history, risk notes, etc.
tags	json	Free-form tags for filtering and grouping suppliers.

Docs

Supplier