Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

customer
string
required

Body

application/json

A customer's fields, for adding it or editing it. A code is letters, digits and . _ - /, starting with a letter or digit.

code
string
required
Maximum string length: 32
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
name
string
required
Maximum string length: 255
billing_address
string | null
Maximum string length: 1000
shipping_address
string | null
Maximum string length: 1000
payment_terms_days
integer | null

Days from an invoice to its due date.

Required range: 0 <= x <= 365
notes
string | null
Maximum string length: 2000
tax_treatment
enum<string> | null

taxable (the default) or exempt.

Available options:
taxable,
exempt
tax_exemption_reference
string | null

Required when the customer is exempt, such as a resale certificate number.

Maximum string length: 100
tax_rate_id
string<uuid> | null

An active tax rate of the organization, for a taxable customer; the default rate when left out.

price_list_id
string<uuid> | null

An active price list of the organization; the default list prices what the customer's own leaves out.

shelf_life_minimum
integer | null

The customer's own minimum remaining shelf life: days (up to 3650), or a percent (up to 100) of a lot's life.

Required range: 0 <= x <= 3650
shelf_life_unit
enum<string> | null

days or percent.

Available options:
days,
percent

Response

SalesCustomerResource

data
SalesCustomerResource · object
required