Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Create a customer

Creates a new customer.

post/quickbooks-desktop/customers

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Request body

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

isActiveboolean

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

classIdstring

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.

parentIdstring

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.

companyNamestring

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

Maximum length: 41 characters.

salutationstring

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

firstNamestring

The first name of the contact person for this customer.

Maximum length: 25 characters.

middleNamestring

The middle name of the contact person for this customer.

Maximum length: 5 characters.

lastNamestring

The last name of the contact person for this customer.

Maximum length: 25 characters.

jobTitlestring

The job title of the contact person for this customer.

phonestring

The customer's primary telephone number.

Maximum length: 21 characters.

alternatePhonestring

The customer's alternate telephone number.

Maximum length: 21 characters.

faxstring

The customer's fax number.

Maximum length: 21 characters.

emailstring

The customer's email address.

ccEmailstring

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

contactstring

The name of the primary contact person for this customer.

alternateContactstring

The name of a alternate contact person for this customer.

customerTypeIdstring

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

termsIdstring

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

salesRepresentativeIdstring

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

openingBalancestring

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

openingBalanceDatestring date

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

salesTaxCodeIdstring

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.

salesTaxItemIdstring

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'australia' | 'canada' | 'uk' | 'us'

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

resaleNumberstring

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.

accountNumberstring

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.

creditLimitstring

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.

preferredPaymentMethodIdstring

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

jobStatus'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending'

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

jobStartDatestring date

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

jobProjectedEndDatestring date

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

jobEndDatestring date

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

jobDescriptionstring

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

jobTypeIdstring

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

notestring

A note or comment about this customer.

preferredDeliveryMethod'email' | 'mail' | 'none'

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

priceLevelIdstring

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.

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

taxRegistrationNumberstring

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

currencyIdstring

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 request

{
  "name": "Website Redesign Project",
  "isActive": true,
  "classId": "80000001-1234567890",
  "parentId": "80000001-1234567890",
  "companyName": "Acme Corporation",
  "salutation": "Dr.",
  "firstName": "John",
  "middleName": "A.",
  "lastName": "Doe",
  "jobTitle": "Purchasing Manager",
  "billingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "shippingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "alternateShippingAddresses": [
    {
      "name": "Alternate shipping address",
      "line1": "Conductor Labs Inc.",
      "line2": "540 Market St.",
      "line3": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94110",
      "country": "United States",
      "note": "Conductor HQ",
      "isDefaultShippingAddress": true
    }
  ],
  "phone": "+1-555-123-4567",
  "alternatePhone": "+1-555-987-6543",
  "fax": "+1-555-555-1212",
  "email": "customer@example.com",
  "ccEmail": "manager@example.com",
  "contact": "Jane Smith",
  "alternateContact": "Bob Johnson",
  "customContactFields": [
    {
      "name": "Main Phone",
      "value": "555-123-4567"
    }
  ],
  "additionalContacts": [
    {
      "salutation": "Dr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "jobTitle": "Purchasing Manager",
      "customContactFields": [
        {
          "name": "Main Phone",
          "value": "555-123-4567"
        }
      ]
    }
  ],
  "customerTypeId": "80000001-1234567890",
  "termsId": "80000001-1234567890",
  "salesRepresentativeId": "80000001-1234567890",
  "openingBalance": "1000.00",
  "openingBalanceDate": "2023-01-01",
  "salesTaxCodeId": "80000001-1234567890",
  "salesTaxItemId": "80000001-1234567890",
  "salesTaxCountry": "us",
  "resaleNumber": "123456789",
  "accountNumber": "1010",
  "creditLimit": "5000.00",
  "preferredPaymentMethodId": "80000001-1234567890",
  "creditCard": {
    "number": "xxxxxxxxxxxx1234",
    "expirationMonth": 12,
    "expirationYear": 2024,
    "name": "John Doe",
    "address": "1234 Main St, Anytown, USA, 12345",
    "postalCode": "12345"
  },
  "jobStatus": "in_progress",
  "jobStartDate": "2024-01-15",
  "jobProjectedEndDate": "2024-12-31",
  "jobEndDate": "2024-11-30",
  "jobDescription": "Kitchen renovation project for residential client.",
  "jobTypeId": "80000001-1234567890",
  "note": "Our favorite customer.",
  "additionalNotes": [
    {
      "note": "This is a fun note."
    }
  ],
  "preferredDeliveryMethod": "email",
  "priceLevelId": "80000001-1234567890",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "taxRegistrationNumber": "GB123456789",
  "currencyId": "80000001-1234567890"
}

Response

Returns the newly created customer.

idstring 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'qbd_customer' required

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

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

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

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

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

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

isActiveboolean required

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

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

companyNamestring nullable required

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

salutationstring nullable required

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

firstNamestring nullable required

The first name of the contact person for this customer.

middleNamestring nullable required

The middle name of the contact person for this customer.

lastNamestring nullable required

The last name of the contact person for this customer.

jobTitlestring nullable required

The job title of the contact person for this customer.

phonestring nullable required

The customer's primary telephone number.

alternatePhonestring nullable required

The customer's alternate telephone number.

faxstring nullable required

The customer's fax number.

emailstring nullable required

The customer's email address.

ccEmailstring nullable required

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

contactstring nullable required

The name of the primary contact person for this customer.

alternateContactstring nullable required

The name of a alternate contact person for this customer.

balancestring nullable 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.

totalBalancestring nullable 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.

salesTaxCountrystring nullable required

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

resaleNumberstring nullable 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.

accountNumberstring nullable 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.

creditLimitstring nullable 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.

jobStatus'awarded' | 'closed' | 'in_progress' | 'none' | 'not_awarded' | 'pending' nullable required

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

jobStartDatestring date nullable required

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

jobProjectedEndDatestring date nullable required

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

jobEndDatestring date nullable required

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

jobDescriptionstring nullable required

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

notestring nullable required

A note or comment about this customer.

preferredDeliveryMethod'email' | 'mail' | 'none' nullable required

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

externalIdstring nullable 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.

taxRegistrationNumberstring nullable required

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

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_customer",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Website Redesign Project",
  "fullName": "ABC Corporation:Website Redesign Project",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Consulting"
  },
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "ABC Corporation"
  },
  "sublevel": 1,
  "companyName": "Acme Corporation",
  "salutation": "Dr.",
  "firstName": "John",
  "middleName": "A.",
  "lastName": "Doe",
  "jobTitle": "Purchasing Manager",
  "billingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "shippingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "alternateShippingAddresses": [
    {
      "name": "Alternate shipping address",
      "line1": "Conductor Labs Inc.",
      "line2": "540 Market St.",
      "line3": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94110",
      "country": "United States",
      "note": "Conductor HQ",
      "isDefaultShippingAddress": true
    }
  ],
  "phone": "+1-555-123-4567",
  "alternatePhone": "+1-555-987-6543",
  "fax": "+1-555-555-1212",
  "email": "customer@example.com",
  "ccEmail": "manager@example.com",
  "contact": "Jane Smith",
  "alternateContact": "Bob Johnson",
  "customContactFields": [
    {
      "name": "Main Phone",
      "value": "555-123-4567"
    }
  ],
  "additionalContacts": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_contact",
      "createdAt": "2025-01-01T12:34:56+00:00",
      "updatedAt": "2025-02-01T12:34:56+00:00",
      "revisionNumber": "1721172183",
      "name": "Jane Smith",
      "salutation": "Dr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "jobTitle": "Purchasing Manager",
      "customContactFields": [
        {
          "name": "Main Phone",
          "value": "555-123-4567"
        }
      ]
    }
  ],
  "customerType": {
    "id": "80000001-1234567890",
    "fullName": "Retail Customer"
  },
  "terms": {
    "id": "80000001-1234567890",
    "fullName": "Net 30"
  },
  "salesRepresentative": {
    "id": "80000001-1234567890",
    "fullName": "Jane Doe"
  },
  "balance": "1000.00",
  "totalBalance": "5000.00",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "salesTaxItem": {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  },
  "salesTaxCountry": "us",
  "resaleNumber": "123456789",
  "accountNumber": "1010",
  "creditLimit": "5000.00",
  "preferredPaymentMethod": {
    "id": "80000001-1234567890",
    "fullName": "Credit Card"
  },
  "creditCard": {
    "number": "xxxxxxxxxxxx1234",
    "expirationMonth": 12,
    "expirationYear": 2024,
    "name": "John Doe",
    "address": "1234 Main St, Anytown, USA, 12345",
    "postalCode": "12345"
  },
  "jobStatus": "in_progress",
  "jobStartDate": "2024-01-15",
  "jobProjectedEndDate": "2024-12-31",
  "jobEndDate": "2024-11-30",
  "jobDescription": "Kitchen renovation project for residential client.",
  "jobType": {
    "id": "80000001-1234567890",
    "fullName": "Installation"
  },
  "note": "Our favorite customer.",
  "additionalNotes": [
    {
      "id": 1,
      "date": "2024-01-01",
      "note": "This is a fun note."
    }
  ],
  "preferredDeliveryMethod": "email",
  "priceLevel": {
    "id": "80000001-1234567890",
    "fullName": "Gold Member Pricing"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "taxRegistrationNumber": "GB123456789",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}