Sign in
Customer

Get a specific customer

get/api/customers/{customerId}

Path parameters

customerIdstring required

Response

The customer for the given id

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.

customerTypeIdstring nullable

Customer type identifier. Read-only; assigned in the app.

customerTypeNamestring nullable

Customer type name. Read-only; assigned in the app.

Changes

Changed in 1 of the 23 revisions of this API.4

  • c002514312374See the full diff
    • ○

      added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: application/problem+json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: application/json)

      response-optional-property-added

    • ○

      added the optional property to the response with the status (media type: application/problem+json)

      response-optional-property-added