POST
/
quickbooks-desktop
/
customers
/
{id}

Authorizations

Authorization
string
headerrequired

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Path Parameters

id
string
required

The QuickBooks-assigned unique identifier of the customer to update.

Body

application/json
revisionNumber
string
required

The current revision number of the customer you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

name
string

The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its parent objects like fullName does. For example, two customers could both have the name "Kitchen-Renovation", but they could have unique fullName values, such as "Jones:Kitchen-Renovation" and "Baker:Kitchen-Renovation". Maximum length: 41 characters.

isActive
boolean
default: true

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

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.

parentId
string

The parent customer one level above this one in the hierarchy. For example, if this customer has a fullName of "Jones:Kitchen-Renovation", its parent has a fullName of "Jones". If this customer is at the top level, this field will be null.

companyName
string

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

salutation
string

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

firstName
string

The first name of the contact person for this customer.

middleName
string

The middle name of the contact person for this customer.

lastName
string

The last name of the contact person for this customer.

jobTitle
string

The job title of the contact person for this customer.

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.

phone
string

The customer's primary telephone number.

alternatePhone
string

The customer's alternate telephone number.

fax
string

The customer's fax number.

email
string

The customer's email address.

ccEmail
string

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

contact
string

The name of the primary contact person for this customer.

alternateContact
string

The name of a alternate contact person for this customer.

customContactFields
object[]

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

additionalContacts
object[]

Additional alternate contacts for this customer.

customerTypeId
string

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

termsId
string

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

salesRepresentativeId
string

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

salesTaxCodeId
string

The sales-tax code associated with this customer, determining whether items sold to this customer are taxable or non-taxable. It's used to assign a default tax status to all transactions for this customer. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

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.

salesTaxCountry
enum<string>
default: us

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

Available options:
australia,
canada,
uk,
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.

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.

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.

preferredPaymentMethodId
string

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

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
jobStartDate
string

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

jobProjectedEndDate
string

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

jobEndDate
string

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

jobDescription
string

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

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).

note
string

Additional notes or comments about this customer.

additionalNotes
object[]

Additional notes about this customer.

preferredDeliveryMethod
enum<string>
default: none

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

Available options:
email,
mail,
none
priceLevelId
string

The custom price level assigned to this customer, used to apply custom pricing in invoices, sales receipts, sales orders, or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc. Notice that the affected sales transactions do not list the price level, but instead list the rate for the item, which was set using the price level.

taxRegistrationNumber
string

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

currencyId
string

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

Response

200 - application/json
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.

objectType
string
required

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

Allowed value: "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). The time zone is the same as the user's time zone in QuickBooks.

updatedAt
string
required

The date and time when this customer was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

revisionNumber
string
required

The current revision number of this customer, 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.

name
string
required

The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its parent objects like fullName does. For example, two customers could both have the name "Kitchen-Renovation", but they could have unique fullName values, such as "Jones:Kitchen-Renovation" and "Baker:Kitchen-Renovation". Maximum length: 41 characters.

fullName
string
required

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

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.

isActive
boolean
default: truerequired

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

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.

parent
object | null
required

The parent customer one level above this one in the hierarchy. For example, if this customer has a fullName of "Jones:Kitchen-Renovation", its parent has a fullName of "Jones". If this customer is at the top level, this field will be null.

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 "Jones:Kitchen-Renovation" 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).

companyName
string | null
required

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

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.".

firstName
string | null
required

The first name of the contact person for this customer.

middleName
string | null
required

The middle name of the contact person for this customer.

lastName
string | null
required

The last name of the contact person for this customer.

jobTitle
string | null
required

The job title of the contact person for this customer.

billingAddress
object | null
required

The customer's billing address.

shippingAddress
object | null
required

The customer's shipping address.

alternateShippingAddresses
object[]
required

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

phone
string | null
required

The customer's primary telephone number.

alternatePhone
string | null
required

The customer's alternate telephone number.

fax
string | null
required

The customer's fax number.

email
string | null
required

The customer's email address.

ccEmail
string | null
required

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

contact
string | null
required

The name of the primary contact person for this customer.

alternateContact
string | null
required

The name of a alternate contact person for this customer.

customContactFields
object[]
required

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

additionalContacts
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.

terms
object | null
required

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

salesRepresentative
object | null
required

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

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.

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.

salesTaxCode
object | null
required

The sales-tax code associated with this customer, determining whether items sold to this customer are taxable or non-taxable. It's used to assign a default tax status to all transactions for this customer. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

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.

salesTaxCountry
enum<string> | null
default: usrequired

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

Available options:
australia,
canada,
uk,
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.

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.

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.

preferredPaymentMethod
object | null
required

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

creditCard
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
default: nonerequired

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
jobStartDate
string | null
required

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

jobProjectedEndDate
string | null
required

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

jobEndDate
string | null
required

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

jobDescription
string | null
required

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

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).

note
string | null
required

Additional notes or comments about this customer.

additionalNotes
object[]
required

Additional notes about this customer.

preferredDeliveryMethod
enum<string> | null
default: nonerequired

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

Available options:
email,
mail,
none
priceLevel
object | null
required

The custom price level assigned to this customer, used to apply custom pricing in invoices, sales receipts, sales orders, or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc. Notice that the affected sales transactions do not list the price level, but instead list the rate for the item, which was set using the price level.

externalId
string | null
required

A globally unique identifier (GUID) you can provide for tracking this object in your external system.

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

taxRegistrationNumber
string | null
required

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

currency
object | null
required

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

customFields
object[]
required

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