POST
/
customers

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Body

application/json
legalName
string
required

Legal name

address
object
required

Address

url
string

URL

label
string

Label

taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
customerAliases
string[]

Customer aliases

integrationIds
object[]

IDs in external integrations

parentId
string

ID of a parent customer. Populate this field to create a new customeras a child customer of another, existing customer.

contacts
object[]
required

Contacts to create for this customer. This will replace all existing contacts for this customer.

pushToIntegrations
enum<string>[]

Automatically create customer in these linked integrations

Available options:
Xero

Response

201 - application/json
id
string
required

Unique ID

createdAt
string
required

Time at which the customer was initially created, in ISO 8601 format

organizations
object[]
required

Organizations that this customer is a member of

legalName
string
required

Legal name

address
object
required

Address

url
string

URL

domain
string

Customer's primary domain name

label
string

Label

integrationIds
object[]
required

External services which are linked to this customer

taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
contacts
object[]
required

Contacts for this customer

List customersGet customer