Quickbooks Sandbox | quickbooks | app | This component uses the Quickbooks Sandbox app. |
Customer Reference | customerId | string | Select a value from the drop down menu. |
Display Name | displayName | string | 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 | string | 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.
|
Given Name | givenName | string | 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.
|
Middle Name | middleName | string | 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.
|
Family Name | familyName | string | 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 | string | 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.
|
Currency Code | currencyRefValue | string | Select a value from the drop down menu. |
Active | active | boolean | 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.
|
Alternate Phone Free Form Number | alternatePhoneFreeFormNumber | string | Specifies the alternate phone number in free form.
|
AR Account Ref Value | arAccountRefValue | string | Select a value from the drop down menu. |
Bill Addr City | billAddrCity | string | City name for the billing address.
|
Bill Addr Country | billAddrCountry | string | Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
|
Bill Addr Country Sub Division Code | billAddrCountrySubDivisionCode | string | Region within a country for the billing address. For example, state name for USA, province name for Canada.
|
Bill Addr Late | billAddrLate | string | Latitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
|
Bill Addr Line 1 | billAddrLine1 | string | First line of the billing address.
|
Bill Addr Line 2 | billAddrLine2 | string | Second line of the billing address.
|
Bill Addr Line 3 | billAddrLine3 | string | Third line of the billing address.
|
Bill Addr Line 4 | billAddrLine4 | string | Fourth line of the billing address.
|
Bill Addr Line 5 | billAddrLine5 | string | Fifth line of the billing address.
|
Bill Addr Long | billAddrLong | string | Longitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
|
Bill Addr Postal Code | billAddrPostalCode | string | Postal code for the billing address. For example, zip code for USA and Canada.
|
Bill With Parent | billWithParent | boolean | 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.
|
Business Number | businessNumber | string | 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.
|
Company Name | companyName | string | The name of the company associated with the person or organization.
|
Customer Type | customerTypeRefValue | string | Select a value from the drop down menu. |
Default Tax Code Value | defaultTaxCodeValue | string | 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 .
|
Fax Free Form Number | faxFreeFormNumber | string | Specifies the fax number in free form.
|
G S T I N | GSTIN | string | GSTIN is an identification number assigned to every GST registered business.
|
Gst Registration Type | gstRegistrationType | string | Select a value from the drop down menu:GST_REG_REG GST_REG_COMP GST_UNREG CONSUMER OVERSEAS SEZ DEEMED |
Job | job | boolean | 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.
|
Mobile Free Form Number | mobileFreeFormNumber | string | Specifies the mobile phone number in free form.
|
Notes | notes | string | Free form text describing the Customer.
|
Payment Method | paymentMethodRefValue | string | Select a value from the drop down menu. |
Preferred Delivery Method | preferredDeliveryMethod | string | Select a value from the drop down menu:Print Email None |
Primary Email Addr | primaryEmailAddr | string | |
Primary Phone Free Form Number | primaryPhoneFreeFormNumber | string | Specifies the primary phone number in free form.
|
Primary Tax Identifier | primaryTaxIdentifier | string | 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 .
|
Print On Check Name | printOnCheckName | string | 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.
|
Resale Num | resaleNum | string | Resale number or some additional info about the customer.
|
Term IDs | saleTermRefValue | string | Select a value from the drop down menu. |
Secondary Tax Identifier | secondaryTaxIdentifier | string | 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
|
Ship Addr City | shipAddrCity | string | City name for the shipping address.
|
Ship Addr Country | shipAddrCountry | string | Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.
|
Ship Addr Country Sub Division Code | shipAddrCountrySubDivisionCode | string | Region within a country for the shipping address. For example, state name for USA, province name for Canada.
|
Ship Addr Id | shipAddrId | string | Unique identifier of the QuickBooks object for the shipping address, used for modifying the address. The 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:
Line1 and Line2 elements are populated with the customer name and company name.
- Original
Line1 through Line5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
|
Ship Addr Late | shipAddrLate | string | Latitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
|
Ship Addr Line 1 | shipAddrLine1 | string | First line of the shipping address.
|
Ship Addr Line 2 | shipAddrLine2 | string | Second line of the shipping address.
|
Ship Addr Line 3 | shipAddrLine3 | string | Third line of the shipping address.
|
Ship Addr Line 4 | shipAddrLine4 | string | Fourth line of the shipping address.
|
Ship Addr Line 5 | shipAddrLine5 | string | Fifth line of the shipping address.
|
Ship Addr Long | shipAddrLong | string | Longitude coordinate of Geocode (Geospacial Entity Object Code). INVALID is returned for invalid addresses.
|
Ship Addr Postal Code | shipAddrPostalCode | string | Postal code for the shipping address. For example, zip code for USA and Canada.
|
Taxable | taxable | boolean | 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.
|
Tax Exemption Reason Id | taxExemptionReasonId | string | Select a value from the drop down menu:1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
Web Addr | webAddr | string | |