Skip to main content
POST
JavaScript

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Body

application/json
​
name
string
required

The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two customers could both have the name "Website Redesign Project", but they could have unique fullName values, such as "ABC Corporation:Website Redesign Project" and "Baker:Website Redesign Project".

Maximum length: 41 characters.

Maximum string length: 41
Example:

"Website Redesign Project"

​
isActive
boolean
default:true

Indicates whether this customer is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
classId
string

The customer's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

Maximum string length: 36
Example:

"80000001-1234567890"

​
parentId
string

The parent customer one level above this one in the hierarchy. For example, if this customer has a fullName of "ABC Corporation:Website Redesign Project", its parent has a fullName of "ABC Corporation". If this customer is at the top level, this field will be null.

Maximum string length: 36
Example:

"80000001-1234567890"

​
companyName
string

The name of the company associated with this customer. This name is used on invoices, checks, and other forms.

Maximum length: 41 characters.

Maximum string length: 41
Example:

"Acme Corporation"

​
salutation
string

The formal salutation title that precedes the name of the contact person for this customer, such as "Mr.", "Ms.", or "Dr.".

Maximum length: 15 characters.

Maximum string length: 15
Example:

"Dr."

​
firstName
string

The first name of the contact person for this customer.

Maximum length: 25 characters.

Maximum string length: 25
Example:

"John"

​
middleName
string

The middle name of the contact person for this customer.

Maximum length: 5 characters.

Maximum string length: 5
Example:

"A."

​
lastName
string

The last name of the contact person for this customer.

Maximum length: 25 characters.

Maximum string length: 25
Example:

"Doe"

​
jobTitle
string

The job title of the contact person for this customer.

Maximum length: 41 characters.

Maximum string length: 41
Example:

"Purchasing Manager"

​
billingAddress
object

The customer's billing address.

​
shippingAddress
object

The customer's shipping address.

​
alternateShippingAddresses
object[]

A list of additional shipping addresses for this customer. Useful when the customer has multiple shipping locations.

Minimum array length: 1
​
phone
string

The customer's primary telephone number.

Maximum length: 21 characters.

Maximum string length: 21
Example:

"+1-555-123-4567"

​
alternatePhone
string

The customer's alternate telephone number.

Maximum length: 21 characters.

Maximum string length: 21
Example:

"+1-555-987-6543"

​
fax
string

The customer's fax number.

Maximum length: 21 characters.

Maximum string length: 21
Example:

"+1-555-555-1212"

​
email
string

The customer's email address.

Maximum length: 1023 characters.

Maximum string length: 1023
Example:

"customer@example.com"

​
ccEmail
string

An email address to carbon copy (CC) on communications with this customer.

Maximum length: 1023 characters.

Maximum string length: 1023
Example:

"manager@example.com"

​
contact
string

The name of the primary contact person for this customer.

Maximum length: 41 characters.

Maximum string length: 41
Example:

"Jane Smith"

​
alternateContact
string

The name of a alternate contact person for this customer.

Maximum length: 41 characters.

Maximum string length: 41
Example:

"Bob Johnson"

​
customContactFields
object[]

Additional custom contact fields for this customer, such as phone numbers or email addresses.

Minimum array length: 1
​
additionalContacts
object[]

Additional alternate contacts for this customer.

Minimum array length: 1
​
customerTypeId
string

The customer's type, used for categorizing customers into meaningful segments, such as industry or region.

Maximum string length: 36
Example:

"80000001-1234567890"

​
termsId
string

The customer's payment terms, defining when payment is due and any applicable discounts.

Maximum string length: 36
Example:

"80000001-1234567890"

​
salesRepresentativeId
string

The customer's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Maximum string length: 36
Example:

"80000001-1234567890"

​
openingBalance
string

The opening balance of this customer's account, indicating the amount owed by this customer, represented as a decimal string.

Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45").

Example:

"1000.00"

​
openingBalanceDate
string<date>

The date of the opening balance of this customer, in ISO 8601 format (YYYY-MM-DD).

Example:

"2023-01-01"

​
salesTaxCodeId
string

The default sales-tax code for transactions with this customer, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Maximum string length: 36
Example:

"80000001-1234567890"

​
salesTaxItemId
string

The sales-tax item used to calculate the actual tax amount for this customer's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

Maximum string length: 36
Example:

"80000001-1234567890"

​
salesTaxCountry
enum<string>

The country for which sales tax is collected for this customer.

Available options:
australia,
canada,
uk,
us
Example:

"us"

​
resaleNumber
string

The customer's resale number, used if the customer is purchasing items for resale. This number does not affect sales tax calculations or reports in QuickBooks.

Maximum length: 15 characters.

Maximum string length: 15
Example:

"123456789"

​
accountNumber
string

The customer's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.

Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.

Maximum length: 99 characters.

Maximum string length: 99
Example:

"1010"

​
creditLimit
string

The customer's credit limit, represented as a decimal string. This is the maximum amount of money this customer can spend before being billed. If null, there is no credit limit.

Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45").

Example:

"5000.00"

​
preferredPaymentMethodId
string

The customer's preferred payment method (e.g., cash, check, credit card).

Maximum string length: 36
Example:

"80000001-1234567890"

​
creditCard
object

The customer's credit card information, including card type, number, and expiration date, used for processing credit card payments.

​
jobStatus
enum<string>
default:none

The status of this customer's job, if this object is a job (i.e., sub-customer).

Available options:
awarded,
closed,
in_progress,
none,
not_awarded,
pending
Example:

"in_progress"

​
jobStartDate
string<date>

The date when work on this customer's job began, if applicable, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-01-15"

​
jobProjectedEndDate
string<date>

The projected completion date for this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-12-31"

​
jobEndDate
string<date>

The actual completion date of this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-11-30"

​
jobDescription
string

A brief description of this customer's job, if this object is a job (i.e., sub-customer).

Maximum length: 99 characters.

Maximum string length: 99
Example:

"Kitchen renovation project for residential client."

​
jobTypeId
string

The type or category of this customer's job, if this object is a job (i.e., sub-customer). Useful for classifying into meaningful segments (e.g., repair, installation, consulting).

Maximum string length: 36
Example:

"80000001-1234567890"

​
note
string

A note or comment about this customer.

Maximum length: 4095 characters.

Maximum string length: 4095
Example:

"Our favorite customer."

​
additionalNotes
object[]

Additional notes about this customer.

Minimum array length: 1
​
preferredDeliveryMethod
enum<string>
default:none

The preferred method for delivering invoices and other documents to this customer.

Available options:
email,
mail,
none
Example:

"email"

​
priceLevelId
string

The customer's custom price level that QuickBooks automatically applies to calculate item rates in new transactions (e.g., invoices, sales receipts, sales orders, and credit memos) for this customer. While applied automatically, this can be overridden when creating individual transactions. Note that transactions will not show the price level itself, only the final rate calculated from it.

Maximum string length: 36
Example:

"80000001-1234567890"

​
externalId
string<uuid>

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
taxRegistrationNumber
string

The customer's tax registration number, for use in Canada or the UK.

Maximum length: 30 characters.

Maximum string length: 30
Example:

"GB123456789"

​
currencyId
string

The customer's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Maximum string length: 36
Example:

"80000001-1234567890"

Response

200 - application/json

Returns the newly created customer.

​
id
string
required

The unique identifier assigned by QuickBooks to this customer. This ID is unique across all customers but not across different QuickBooks object types.

Example:

"80000001-1234567890"

​
objectType
string
required

The type of object. This value is always "qbd_customer".

Allowed value: "qbd_customer"
Example:

"qbd_customer"

​
createdAt
string
required

The date and time when this customer was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
required

The date and time when this customer was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this customer object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

​
name
string
required

The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two customers could both have the name "Website Redesign Project", but they could have unique fullName values, such as "ABC Corporation:Website Redesign Project" and "Baker:Website Redesign Project".

Example:

"Website Redesign Project"

​
fullName
string
required

The case-insensitive fully-qualified unique name of this customer, formed by combining the names of its hierarchical parent objects with its own name, separated by colons. For example, if a customer is under "ABC Corporation" and has the name "Website Redesign Project", its fullName would be "ABC Corporation:Website Redesign Project".

NOTE: Unlike name, fullName is guaranteed to be unique across all customer objects. However, fullName can still be arbitrarily changed by the QuickBooks user when they modify the underlying name field.

IMPORTANT: If this object is a job (i.e., a sub-customer), this value would likely be the job's name prefixed by the customer's name.

Example:

"ABC Corporation:Website Redesign Project"

​
isActive
boolean
required

Indicates whether this customer is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
class
object | null
required

The customer's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

Example:
​
parent
object | null
required

The parent customer one level above this one in the hierarchy. For example, if this customer has a fullName of "ABC Corporation:Website Redesign Project", its parent has a fullName of "ABC Corporation". If this customer is at the top level, this field will be null.

Example:
​
sublevel
number
required

The depth level of this customer in the hierarchy. A top-level customer has a sublevel of 0; each subsequent sublevel increases this number by 1. For example, a customer with a fullName of "ABC Corporation:Website Redesign Project" would have a sublevel of 1. When sublevel is 0, this object is a customer; when sublevel is greater than 0, this object is typically a job (i.e., a sub-customer).

Example:

1

​
companyName
string | null
required

The name of the company associated with this customer. This name is used on invoices, checks, and other forms.

Example:

"Acme Corporation"

​
salutation
string | null
required

The formal salutation title that precedes the name of the contact person for this customer, such as "Mr.", "Ms.", or "Dr.".

Example:

"Dr."

​
firstName
string | null
required

The first name of the contact person for this customer.

Example:

"John"

​
middleName
string | null
required

The middle name of the contact person for this customer.

Example:

"A."

​
lastName
string | null
required

The last name of the contact person for this customer.

Example:

"Doe"

​
jobTitle
string | null
required

The job title of the contact person for this customer.

Example:

"Purchasing Manager"

​
billingAddress
The Address object · object | null
required

The customer's billing address.

​
shippingAddress
The Address object · object | null
required

The customer's shipping address.

​
alternateShippingAddresses
The Shipping Address object · object[] | null
required

A list of additional shipping addresses for this customer. Useful when the customer has multiple shipping locations. If excludeAlternateShippingAddresses=true is set on a customer list request, this field is null because the addresses were not fetched.

​
phone
string | null
required

The customer's primary telephone number.

Example:

"+1-555-123-4567"

​
alternatePhone
string | null
required

The customer's alternate telephone number.

Example:

"+1-555-987-6543"

​
fax
string | null
required

The customer's fax number.

Example:

"+1-555-555-1212"

​
email
string | null
required

The customer's email address.

Example:

"customer@example.com"

​
ccEmail
string | null
required

An email address to carbon copy (CC) on communications with this customer.

Example:

"manager@example.com"

​
contact
string | null
required

The name of the primary contact person for this customer.

Example:

"Jane Smith"

​
alternateContact
string | null
required

The name of a alternate contact person for this customer.

Example:

"Bob Johnson"

​
customContactFields
The Custom Contact Field object · object[]
required

Additional custom contact fields for this customer, such as phone numbers or email addresses.

​
additionalContacts
The Contact object · object[]
required

Additional alternate contacts for this customer.

​
customerType
object | null
required

The customer's type, used for categorizing customers into meaningful segments, such as industry or region.

Example:
​
terms
object | null
required

The customer's payment terms, defining when payment is due and any applicable discounts.

Example:
​
salesRepresentative
object | null
required

The customer's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Example:
​
balance
string | null
required

The current balance owed by this customer, excluding balances from any jobs (i.e., sub-customers), represented as a decimal string. Compare with totalBalance. A positive number indicates money owed by the customer.

Example:

"1000.00"

​
totalBalance
string | null
required

The combined balance of this customer and all of this customer's jobs (i.e., sub-customers), represented as a decimal string. If there are no sub-customers, totalBalance and balance are equal. A positive number indicates money owed by the customer.

Example:

"5000.00"

​
salesTaxCode
object | null
required

The default sales-tax code for transactions with this customer, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Example:
​
salesTaxItem
object | null
required

The sales-tax item used to calculate the actual tax amount for this customer's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

Example:
​
salesTaxCountry
string | null
required

The country for which sales tax is collected for this customer.

Example:

"us"

​
resaleNumber
string | null
required

The customer's resale number, used if the customer is purchasing items for resale. This number does not affect sales tax calculations or reports in QuickBooks.

Example:

"123456789"

​
accountNumber
string | null
required

The customer's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.

Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.

Example:

"1010"

​
creditLimit
string | null
required

The customer's credit limit, represented as a decimal string. This is the maximum amount of money this customer can spend before being billed. If null, there is no credit limit.

Example:

"5000.00"

​
preferredPaymentMethod
object | null
required

The customer's preferred payment method (e.g., cash, check, credit card).

Example:
​
creditCard
The Credit Card object · object | null
required

The customer's credit card information, including card type, number, and expiration date, used for processing credit card payments.

​
jobStatus
enum<string> | null
required

The status of this customer's job, if this object is a job (i.e., sub-customer).

Available options:
awarded,
closed,
in_progress,
none,
not_awarded,
pending
Example:

"in_progress"

​
jobStartDate
string<date> | null
required

The date when work on this customer's job began, if applicable, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-01-15T00:00:00.000Z"

​
jobProjectedEndDate
string<date> | null
required

The projected completion date for this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-12-31T00:00:00.000Z"

​
jobEndDate
string<date> | null
required

The actual completion date of this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-11-30T00:00:00.000Z"

​
jobDescription
string | null
required

A brief description of this customer's job, if this object is a job (i.e., sub-customer).

Example:

"Kitchen renovation project for residential client."

​
jobType
object | null
required

The type or category of this customer's job, if this object is a job (i.e., sub-customer). Useful for classifying into meaningful segments (e.g., repair, installation, consulting).

Example:
​
note
string | null
required

A note or comment about this customer.

Example:

"Our favorite customer."

​
additionalNotes
The Note object · object[]
required

Additional notes about this customer.

​
preferredDeliveryMethod
enum<string> | null
required

The preferred method for delivering invoices and other documents to this customer.

Available options:
email,
mail,
none
Example:

"email"

​
priceLevel
object | null
required

The customer's custom price level that QuickBooks automatically applies to calculate item rates in new transactions (e.g., invoices, sales receipts, sales orders, and credit memos) for this customer. While applied automatically, this can be overridden when creating individual transactions. Note that transactions will not show the price level itself, only the final rate calculated from it.

Example:
​
externalId
string | null
required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
taxRegistrationNumber
string | null
required

The customer's tax registration number, for use in Canada or the UK.

Example:

"GB123456789"

​
currency
object | null
required

The customer's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Example:
​
customFields
The Custom Field object · object[]
required

The custom fields for the customer object, added as user-defined data extensions, not included in the standard QuickBooks object.