Sign in
latestOpenAPI 3.0.42026-08-234704621.6 MB

a41e60b375bc

Customer

Find customers based on search parameters.

post/api/customers/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

namestring nullable

Filter to customers who's name contains the given string

customerCodestring nullable

Unique identifier for this customer.

emailstring nullable

The email of the customer

modifiedAfterUtcstring date-time nullable

Filter to customer records modified after the given datetime (in UTC)

Response

List of customers matching the filters

idstring required

Id

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.

urlstring uri nullable

The Customer's website

creditLimitnumber double nullable

Credit limit

paymentTermsIdstring nullable

Payment terms identifier. Please reference /api/payment-terms endpoint.

salesPersonIdstring nullable

Sales person identifier. Please reference /api/users endpoint.

isTaxableboolean

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

External references associated with this entity.

customFieldsobject nullable

Custom fields that have been defined on this entity.

notesstring nullable

Notes associated to the customer.

hasCustomerPortalboolean required

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

customerTierIdstring nullable

Customer tier identifier. Please reference /api/customer-tiers endpoint.

customerTierNamestring nullable

Customer tier name.