QuickBooks: Read a customer — response body — Customer

API reference · Contract 2026-10-20

SDK schema: Read a customer — response body — Customer

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
Active	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks. If there is an amount in Customer.Balance when setting this Customer object to inactive through the QuickBooks UI, a CreditMemo balancing transaction is created for the amount.
Active (anyOf 1)	boolean	Alternative
Active (anyOf 2)	string	Alternative	Known values: true, false
AlternatePhone	Model	Optional	Expand Create a vendor — request body — body Fax Alternate phone number.
Balance	JSON	Optional	Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer. Write-on-create. Decimal string
Balance (anyOf 1)	JSON	Alternative
Balance (anyOf 1) (anyOf 1)	number	Alternative
Balance (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Balance (anyOf 2)	string	Alternative
BalanceWithJobs	JSON	Optional	Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks. Decimal string
BalanceWithJobs (anyOf 1)	JSON	Alternative
BalanceWithJobs (anyOf 1) (anyOf 1)	number	Alternative
BalanceWithJobs (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
BalanceWithJobs (anyOf 2)	string	Alternative
BillAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default billing address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
BillWithParent	JSON	Optional	If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.
BillWithParent (anyOf 1)	boolean	Alternative
BillWithParent (anyOf 2)	string	Alternative	Known values: true, false
CompanyName	string	Optional	The name of the company associated with the person or organization.
CurrencyRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the currency in which all amounts associated with this customer are expressed. Once set, it cannot be changed. If specified currency is not currently in the company’s currency list, it is added. If not specified, currency for this customer is the home currency of the company, as defined by Preferences.CurrencyPrefs.HomeCurrency . Read only: true
CustomerTypeRef	Model	Optional	Expand Read a customer — response body — Customer Customer Type Ref Reference to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.
DefaultTaxCodeRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a default tax code associated with this Customer object. Reference is valid if Customer.Taxable is set to true; otherwise, it is ignored. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) the default tax code is set by the system and can not be overridden. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for DefaultTaxCodeRef.value and DefaultTaxCodeRef.name , respectively.
DisplayName	string	Optional	The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title , GivenName , MiddleName , FamilyName , and Suffix . Conditionally required
FamilyName	string	Optional	Family name or the last name of the person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
Fax	Model	Optional	Expand Create a vendor — request body — body Fax Fax number.
FullyQualifiedName	string	Optional	Fully qualified name of the object. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Customer:Job:Sub-job . System generated. Limited to 5 levels. Read only: true
GivenName	string	Optional	Given name or first name of a person. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
Id	string	Optional	Unique identifier for this object. Read only: true
IsProject	JSON	Optional	If true, indicates this is a Project. Read only: true
IsProject (anyOf 1)	boolean	Alternative
IsProject (anyOf 2)	string	Alternative	Known values: true, false
Job	JSON	Optional	If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.
Job (anyOf 1)	boolean	Alternative
Job (anyOf 2)	string	Alternative	Known values: true, false
Level	JSON	Optional	Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent. Constraints: up to 5 levels Read only: true
Level (anyOf 1)	JSON	Alternative
Level (anyOf 1) (anyOf 1)	integer	Alternative
Level (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Level (anyOf 2)	string	Alternative
MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
MiddleName	string	Optional	Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
Mobile	Model	Optional	Expand Create a vendor — request body — body Fax Mobile phone number.
Notes	string	Optional	Free form text describing the Customer.
OpenBalanceDate	string	Optional	Date of the Open Balance for the create operation. Write-on-create.
ParentRef	Model	Optional	Expand Read an item — response body — Item Class Ref A reference to a Customer object that is the immediate parent of the Sub-Customer/Job in the hierarchical Customer:Job list. Required for the create operation if this object is a sub-customer or Job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for ParentRef.value and ParentRef.name , respectively.
PaymentMethodRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a PaymentMethod associated with this Customer object. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
PreferredDeliveryMethod	string	Optional	Preferred delivery method. Values are Print, Email, or None.
PrimaryEmailAddr	Model	Optional	Expand Full update companyinfo — request body — body Email Primary email address.
PrimaryPhone	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
PrimaryTaxIdentifier	string	Optional	Also called Tax Reg. No in ( UK ) , ( CA ) , ( IN ) , ( AU ) represents the tax ID of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
PrintOnCheckName	string	Optional	Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. Constraints: Cannot be removed with sparse update.
ResaleNum	string	Optional	Resale number or some additional info about the customer.
SalesTermRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a SalesTerm associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
SecondaryTaxIdentifier	string	Optional	Also called UTR No. in ( UK ) , CST Reg No. ( IN ) also represents the tax registration number of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of 123-45-6789 is returned as XXXXXX56789 .
ShipAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Default shipping address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
Source	string	Optional	The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce
Suffix	string	Optional	Suffix of the name. For example, Jr . The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
SyncToken	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
TaxExemptionReasonId	string	Optional	The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) for the company. Set TaxExemptionReasonId: to one of the following: Id Reason 1 Federal government 2 State government 3 Local government 4 Tribal government 5 Charitable organization 6 Religious organization 7 Educational organization 8 Hospital 9 Resale 10 Direct pay permit 11 Multiple points of use 12 Direct mail 13 Agricultural production 14 Industrial production / manufacturing 15 Foreign diplomat
Taxable	JSON	Optional	If true, transactions for this customer are taxable. Default behavior: true, if DefaultTaxCodeRef is defined or false if TaxExemptionReasonId is set.
Taxable (anyOf 1)	boolean	Alternative
Taxable (anyOf 2)	string	Alternative	Known values: true, false
Title	string	Optional	Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title , GivenName , MiddleName , FamilyName , or Suffix attributes is required. Conditionally required
WebAddr	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.

Referenced models: Read a customer — response body — Customer Customer Type Ref, Full update companyinfo — request body — body Email, Read a bill — response body — Bill Meta Data, Create a vendor — request body — body Bill Addr, Read an item — response body — Item Class Ref, Create a vendor — request body — body Fax, Create a vendor — request body — body Web Addr