Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Customer

Create a new customer

post/api/customers

Request body

namestring required

The name to give the customer. Must be unique to all active customers.

customerCodestring nullable

Unique identifier for this customer

currencyCodestring nullable

Currency code/denomination associated to this customer. If not provided, default to the primary currency code for the organization.

creditLimitnumber double nullable

Credit limit

paymentTermsIdstring nullable

Payment terms.

salesPersonIdstring nullable

Payment terms.

urlstring uri nullable

The Customer's website

isTaxableboolean nullable

Whether or not this customer is taxable on Sales Orders and Quotes

taxRateIdsstring[] nullable

A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for the customer

customFieldsobject nullable

Custom fields that have been defined on this entity.

notesstring nullable

Notes associated to the customer.

hasCustomerPortalboolean nullable

Indicates if this customer is set up to use the customer portal.

Response

Customer created

idstring required

The id of the created record