customerId
Reference to a customer or job
displayName
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`.
title
Title of the person. This tag supports i18n, all locales. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, `Suffix`, or `FullyQualifiedName` attributes are required during create.
givenName
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 for object create.
middleName
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 for object create.
familyName
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 for object create.
suffix
Suffix of the name. For example, `Jr`. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.
currencyRefValue
A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.
active
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.
alternatePhoneFreeFormNumber
Specifies the alternate phone number in free form.
arAccountRefValue
ID of the accounts receivable account to be used for this customer. Each customer must have his own AR account. Applicable for France companies, only. Available when endpoint is evoked with the minorversion=3 query parameter. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType=Accounts Receivable. Use `Account.Id` from that object for `ARAccountRef.value`.
billAddrCity
City name for the billing address.
billAddrCountry
Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
billAddrCountrySubDivisionCode
Region within a country for the billing address. For example, state name for USA, province name for Canada.
billAddrLate
Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
billAddrLine1
First line of the billing address.
billAddrLine2
Second line of the billing address.
billAddrLine3
Third line of the billing address.
billAddrLine4
Fourth line of the billing address.
billAddrLine5
Fifth line of the billing address.
billAddrLong
Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
billAddrPostalCode
Postal code for the billing address. For example, zip code for USA and Canada.
billWithParent
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.
businessNumber
Also called, PAN (in India) is a code that acts as an identification for individuals, families and corporates, especially for those who pay taxes on their income.
companyName
The name of the company associated with the person or organization.
customerTypeRefValue
ID referencing the customer type assigned to a customer
defaultTaxCodeValue
ID of the 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` from that object for `DefaultTaxCodeRef.value`.
faxFreeFormNumber
Specifies the fax number in free form.
GSTIN
GSTIN is an identification number assigned to every GST registered business.
gstRegistrationType
For the filing of GSTR, transactions need to be classified depending on the type of customer to whom the sale is done. To facilitate this, we have introduced a new field as
job
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.
mobileFreeFormNumber
Specifies the mobile phone number in free form.
notes
Free form text describing the Customer.
paymentMethodRefValue
ID referencing a PaymentMethod object associated with this Customer object
preferredDeliveryMethod
Preferred delivery method. Values are `Print`, `Email`, or `None`.
primaryEmailAddr
Primary email address.
primaryPhoneFreeFormNumber
Specifies the primary phone number in free form.
primaryTaxIdentifier
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
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
Resale number or some additional info about the customer.
saleTermRefValue
ID of a SalesTerm object associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use `Term.Id` from that object for `SalesTermRef.value`.
secondaryTaxIdentifier
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`
shipAddrCity
City name for the shipping address.
shipAddrCountry
Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
shipAddrCountrySubDivisionCode
Region within a country for the shipping address. For example, state name for USA, province name for Canada.
shipAddrId
Unique identifier of the QuickBooks object for the shipping address, used for modifying the address. \nThe ShippingAddr object represents the 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:\n* `Line1` and `Line2` elements are populated with the customer name and company name.\n* Original `Line1` through `Line5` contents, `City`, `SubDivisionCode`, and `PostalCode` flow into `Line3` through `Line5` as a free format strings.
shipAddrLate
Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
shipAddrLine1
First line of the shipping address.
shipAddrLine2
Second line of the shipping address.
shipAddrLine3
Third line of the shipping address.
shipAddrLine4
Fourth line of the shipping address.
shipAddrLine5
Fifth line of the shipping address.
shipAddrLong
Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.
shipAddrPostalCode
Postal code for the shipping address. For example, zip code for USA and Canada.
taxable
If true, transactions for this customer are taxable. Default behavior with minor version 10 and above: true, if `DefaultTaxCodeRef` is defined or false if `TaxExemptionReasonId` is set.
taxExemptionReasonId
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:\n**Id\tReason**\n* 1\tFederal government\n* 2\tState government\n* 3\tLocal government\n* 4\tTribal government\n* 5\tCharitable organization\n* 6\tReligious organization\n* 7\tEducational organization\n* 8\tHospital\n* 9\tResale\n* 10\tDirect pay permit\n* 11\tMultiple points of use\n* 12\tDirect mail\n* 13\tAgricultural production\n* 14\tIndustrial production / manufacturing\n* 15\tForeign diplomat