Skip to main content
Update a supplier or recipient

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, and are stored without separators. A number that only a VAT register issues, such as DE811907980, is stored as the VAT number. 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})?$
vat_number
string | null

VAT number, at most 100 characters. Numbers from recognized countries must have a valid format and checksum, and are stored with their country prefix. Several parties can share one. In Norway, Sweden, Denmark and Finland the VAT number contains the organization number, so entering one for a party without an organization number stores that organization number as well, unless org_country names another country or is null. Null or blank clears it.

Maximum string length: 100
vat_country
string | null

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

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

Email addresses besides email, at most 9, so one email can reach them all. Claim emails go to email and all of these. An empty list clears them.

Maximum array length: 9
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).

company_id
string<uuid> | null
required
id
string<uuid>
required
type
enum<string>
required

supplier: issues invoices. recipient: invoices are addressed to it.

Available options:
supplier,
recipient
name
string
required
organization_number
string | null
required
org_country
string | null
required

Country issuing the organization number; null when unknown.

vat_number
string | null
required

VAT number. Not unique: companies in a VAT group share one.

vat_country
string | null
required

Country issuing the VAT number; null when unknown.

email
string | null
required
additional_emails
string[]
required

Email addresses besides email; claim emails go to all of them.

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