Retrieve a customer
Retrieves a customer by ID.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").
Path Parameters
The QuickBooks-assigned unique identifier of the customer to retrieve.
Response
The unique identifier assigned by QuickBooks to this customer. This ID is unique across all customers but not across different QuickBooks object types.
The type of object. This value is always "qbd_customer".
"qbd_customer"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.
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.
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.
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.
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.
Indicates whether this customer is active. Inactive objects are typically hidden from views and reports in QuickBooks.
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.
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.
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).
The name of the company associated with this customer. This name is used on invoices, checks, and other forms.
The formal salutation title that precedes the name of the contact person for this customer, such as "Mr.", "Ms.", or "Dr.".
The first name of the contact person for this customer.
The middle name of the contact person for this customer.
The last name of the contact person for this customer.
The job title of the contact person for this customer.
The customer's billing address.
The customer's shipping address.
A list of additional shipping addresses for this customer. Useful when the customer has multiple shipping locations.
The customer's primary telephone number.
The customer's alternate telephone number.
The customer's fax number.
The customer's email address.
An email address to carbon copy (CC) on communications with this customer.
The name of the primary contact person for this customer.
The name of a alternate contact person for this customer.
Additional custom contact fields for this customer, such as phone numbers or email addresses.
Additional alternate contacts for this customer.
The customer's type, used for categorizing customers into meaningful segments, such as industry or region.
The customer's payment terms, defining when payment is due and any applicable discounts.
The customer's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
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.
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.
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.
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.
The country for which sales tax is collected for this customer.
australia, canada, uk, us 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.
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.
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.
The customer's preferred payment method (e.g., cash, check, credit card).
The customer's credit card information, including card type, number, and expiration date, used for processing credit card payments.
The status of this customer's job, if this object is a job (i.e., sub-customer).
awarded, closed, in_progress, none, not_awarded, pending The date when work on this customer's job began, if applicable, in ISO 8601 format (YYYY-MM-DD).
The projected completion date for this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).
The actual completion date of this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).
A brief description of this customer's job, if this object is a job (i.e., sub-customer).
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).
Additional notes or comments about this customer.
Additional notes about this customer.
The preferred method for delivering invoices and other documents to this customer.
email, mail, none 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.
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.
The customer's tax registration number, for use in Canada or the UK.
The customer's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The custom fields for the customer object, added as user-defined data extensions, not included in the standard QuickBooks object.