Skip to main content
POST

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Body

application/json

Create Customer Request Schema

customer_name
string
default:Acme Corporation
required

Full name of the customer or company

external_id
string | null

External identifier for this customer from your system or third-party CRM (e.g., Salesforce ID)

Maximum string length: 255
custom_data
Custom Data · object | null

Custom key-value pairs for storing additional customer information (e.g., industry, account tier, sales rep)

address
Address · object | null

Primary billing address for the customer

ship_to_address
Address · object | null

Shipping address if different from billing address

tax_info
TaxId · object[] | null

List of tax identifiers for the customer (e.g., VAT number, GST number)

email
string<email> | null

Primary email address for the customer (must be unique within organization)

phone_number
string | null

Primary phone number for the customer (include country code, e.g., +1-555-0100)

connector
Connector · object | null

External connector information for integration with third-party systems

communications_enabled
boolean | null

Enable or disable email communications for this customer (invoices, receipts, etc.)

auto_charge_enabled
boolean | null

Enable or disable automatic payment charging for invoices

business_entity_id
string<uuid> | null

Business entity ID to associate with this customer

Response

Successfully created customer

Create Customer Response Schema

id
string<uuid>
required

Customer Id

external_id
string | null
required

External Customer Id

customer_name
string
required

Customer name

custom_data
Custom Data · object | null
required

Customer Custom Data

address
AddressResponse · object | null
required

Customer Address

ship_to_address
AddressResponse · object | null

Customer Ship To Address

tax_info
TaxId · object[] | null

Customer Tax Ids

email
string | null

Customer primary email address

custom_attributes
Custom Attributes · object | null

Customer Tags

phone_number
string | null

Customer Phone Number

communications_enabled
boolean | null
default:true

To enable/disable communications

auto_charge_enabled
boolean | null
default:true

To enable/disable auto-charge

business_entity_id
string<uuid> | null

Business Entity Id