COconductor-is

Retrieve a customer

Changed on

Retrieves a customer by ID.

IMPORTANT: If you need to fetch multiple specific customers by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/customers/{id}

Request

Path parameters

idstring required

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

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

Response

Returns the specified 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"
    }
  ]
}

Changes

  • f5e8ad815f89Revision changes
    • info

      removed the australia enum value from the / response property for the response status

    • info

      removed the canada enum value from the / response property for the response status

    • info

      removed the uk enum value from the / response property for the response status

    • info

      removed the united_arab_emirates enum value from the / response property for the response status

    • info

      removed the us enum value from the / response property for the response status

  • 2b44baac3231Revision changes
    • warning

      added the new united_arab_emirates enum value to the / response property for the response status