Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Body

application/json

Create customer request model.

source_id
string
required

Identifier for the customer in the source system. Can't be blank. For a customer that a Taxwire integration also syncs, use the same source_id the integration stores, or a second customer is created.

Maximum string length: 255
Example:

"CUS-1042"

source
enum<string>
default:taxwire

Source system of the customer. Defaults to taxwire.

Available options:
business_central,
campfire,
chargebee,
maxio,
measure,
monetizenow,
netsuite,
quickbooks,
ramp,
rillet,
salesbricks,
shopify,
stripe,
taxwire,
xero
Example:

"taxwire"

source_account_id
string
default:__default__

Account in the source system that the customer belongs to. Required for sources that keep customers per account, and __default__ for every other source. The wrong form returns 422 with the form the source needs.

Maximum string length: 255
Example:

"__default__"

name
string | null

Name of the customer. A blank name reads as null. When a batch updates an existing customer, null clears it and omitting it keeps the current name. If an integration also syncs the customer, a later sync can set it again.

Maximum string length: 500
Example:

"Acme Wholesale"

email
string | null

Email address of the customer. Does not need to be unique. A blank email reads as null. When a batch updates an existing customer, null clears it and omitting it keeps the current email address. If an integration also syncs the customer, a later sync can set it again.

Maximum string length: 320
Example:

"ap@acme.example"

source_updated_at
string<date-time> | null

Date at which the customer was last updated in the source system. Recommended for every source except taxwire. An update with an older date doesn't change the customer. Omit it or send null to keep the current date: it can't be cleared.

Example:

"2026-09-14T19:58:12Z"

exemption
CustomerExemptionRequest · object | null

Exemption data to set on the customer. For an existing customer, omitted fields keep their current value. See Marking a customer exempt.

Response

Successful Response

Customer response model.

id
string
required

Unique identifier for the customer.

Example:

"cust_01J9Z8Q4E7K2M3N4P5R6S7T8U9"

source_id
string
required

Identifier for the customer in the source system.

Example:

"CUS-1042"

source
enum<string>
required

Source system of the customer. taxwire for customers created in Taxwire rather than in another system.

Available options:
business_central,
campfire,
chargebee,
maxio,
measure,
monetizenow,
netsuite,
quickbooks,
ramp,
rillet,
salesbricks,
shopify,
stripe,
taxwire,
xero
Example:

"taxwire"

source_account_id
string
required

Account in the source system that the customer belongs to. __default__ if the source system has no account or tenant ID.

Example:

"__default__"

created_at
string<date-time>
required

Date at which the customer record was created.

Example:

"2026-09-14T20:00:00Z"

updated_at
string<date-time>
required

Date at which the customer record was last updated.

Example:

"2026-09-14T20:00:00Z"

name
string | null

Name of the customer.

Example:

"Acme Wholesale"

email
string | null

Email address of the customer. Does not need to be unique.

Example:

"ap@acme.example"

merged_into_customer_id
string | null

Unique identifier of the customer this customer was merged into, when the source system reports a merge. null otherwise.

Example:

"cust_01J9ZC4D7F2G8H3J5K6L9M1N0P"

source_updated_at
string<date-time> | null

Date at which the customer was last updated in the source system. null if unknown.

Example:

"2026-09-14T19:58:12Z"