Skip to main content
Update a supplier

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Maximum string length: 500
organization_number
string | null

Organization number, at most 100 characters. Numbers from recognized countries must have a valid format and checksum. Null or blank clears it.

Maximum string length: 100
org_country
string | null

Country that issued the organization number. Inferred from the number or address when omitted; null clears it.

Pattern: ^([A-Za-z]{2})?$
email
string | null
Maximum string length: 320
website
string | null
Maximum string length: 2000
address
object | null

Response

The party record. Editing it does not change the party details printed on invoices (invoiced_as).

id
string<uuid>
required
name
string
required
organization_number
string | null
required
org_country
string | null
required

Country issuing the organization number; null when unknown.

email
string | null
required
website
string | null
required
address
object
required
domain
string | null
required

Company domain, derived from the website or email. Read-only.

relationships
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required