| Name | Type | ReadOnly | Filterable | Description |
|---|---|---|---|---|
| Id [KEY] | string | true | true | The Id of the customer. |
| SyncToken | string | false | false | The sync token. This must be specified when executing an update or delete. |
| MetaData_CreateTime | datetime | true | true | The time the record was created. |
| MetaData_LastUpdatedTime | datetime | true | true | The time the record was last updated. |
| Title | string | false | false | The title of the person. This field supports all i18n locales. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName. |
| GivenName | string | false | true | The given name or first name of the customer. At least one of the following elements is required: Title, GivenName, MiddleName, or FamilyName. |
| MiddleName | string | false | true | The middle name of the customer. The customer can have zero or more middle names. At least one of the elements is required: Title, GivenName, MiddleName, or FamilyName. |
| FamilyName | string | false | true | The family name or the last name of the customer. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName. |
| Suffix | string | false | true | The suffix of the name. |
| FullyQualifiedName | string | true | true | The fully qualified name of the customer. The fully qualified name consists of the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2. |
| CompanyName | string | false | true | The name of the company associated with the customer. |
| DisplayName | string | false | true | The name of the customer is to be displayed. This value must be unique. |
| PrintOnCheckName | string | false | true | The name of the customer is printed on a check. If this is not provided, it is populated from DisplayName. |
| Active | boolean | false | true | This field indicates whether the customer is currently enabled for use by QuickBooks. |
| IsProject | boolean | false | true | If true, it indicates this is a Project. |
| PrimaryPhone_FreeFormNumber | string | false | false | The primary phone number. |
| AlternatePhone_FreeFormNumber | string | false | false | The alternate phone number. |
| Mobile_FreeFormNumber | string | false | false | The mobile phone number. |
| Fax_FreeFormNumber | string | false | false | The fax number. |
| PrimaryEmailAddr_Address | string | false | false | The first line of the address. |
| WebAddr_URI | string | false | false | The website address. |
| DefaultTaxCodeRef | string | false | false | The tax code for the customer. |
| DefaultTaxCodeRef_Name | string | true | false | The name is associated with the tax code for the customer. |
| Taxable | boolean | false | false | This field indicates whether this customer is taxable. |
| CustomerTypeRef | string | false | false | The Id of the type of this customer. |
| BillAddr_Id | string | false | false | The Id of the entity for the billing address is mainly used for modifying the address. This value is assigned by the data service. |
| BillAddr_Line1 | string | false | false | The first line of the address. |
| BillAddr_Line2 | string | false | false | The second line of the address. |
| BillAddr_Line3 | string | false | false | The third line of the address. |
| BillAddr_Line4 | string | false | false | The fourth line of the address. |
| BillAddr_Line5 | string | false | false | The fifth line of the address. |
| BillAddr_City | string | false | false | The city name. |
| BillAddr_Country | string | false | false | The country name. |
| BillAddr_CountrySubDivisionCode | string | false | false | The country region. The state name for the USA or the province name for Canada. |
| BillAddr_PostalCode | string | false | false | The postal code. The zip code for the USA and Canada. |
| BillAddr_Lat | string | false | false | The latitude coordinate of the geocoded billing address. |
| BillAddr_Long | string | false | false | The longitude coordinate of the geocoded billing address. |
| ShipAddr_Id | string | false | false | The Id of the entity for the shipping address is mainly used for modifying the address. This field is assigned by the data service. |
| ShipAddr_Line1 | string | false | false | The first line of the address. |
| ShipAddr_Line2 | string | false | false | The second line of the address. |
| ShipAddr_Line3 | string | false | false | The third line of the address. |
| ShipAddr_Line4 | string | false | false | The fourth line of the address. |
| ShipAddr_Line5 | string | false | false | The fifth line of the address. |
| ShipAddr_City | string | false | false | City name. |
| ShipAddr_Country | string | false | false | Country name. |
| ShipAddr_CountrySubDivisionCode | string | false | false | Region within a country. For example, the state name for the USA or the province name for Canada. |
| ShipAddr_PostalCode | string | false | false | Postal code. For example, the zip code for the USA and Canada. |
| ShipAddr_Note | string | false | false | Note for the customer. |
| ShipAddr_Lat | string | false | false | The latitude coordinate of the geocoded shipping address. |
| ShipAddr_Long | string | false | false | The longitude coordinate of the geocoded shipping address. |
| Notes | string | false | false | Notes on the customer. |
| Job | boolean | false | true | This field indicates whether the customer is a job or subcustomer. If false or null, this is a top-level customer. |
| BillWithParent | boolean | false | false | This field sets whether the customer is to be billed together with its parent entity. This field is valid only if this entity is a job or subcustomer. |
| ParentRef | string | false | false | The immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list. This field is required for the creation operation if the customer is a subcustomer or a job. |
| ParentRef_Name | string | true | false | The name of the immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list. |
| Level | integer | false | false | This field shows the level of the hierarchy in which customer record is located. A value of 0 specifies the top level of the hierarchy. The hierarchy is implicit when the parent is specified in an insert command. |
| SalesTermRef | string | false | false | The Id of the sales term associated with the customer. |
| SalesTermRef_Name | string | true | false | The name of the sales term associated with the customer. |
| PaymentMethodRef | string | false | false | The Id of the payment method associated with the customer. |
| PaymentMethodRef_Name | string | true | false | The name of the payment method associated with the customer. |
| Balance | decimal | false | true | The open balance amount or the amount unpaid by the customer. For the creation operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance for that customer. |
| OpenBalanceDate | date | false | false | The date of the open balance. This field is used in the create operation. |
| BalanceWithJobs | decimal | true | false | The cumulative open balance amount for the customer and all its subcustomers. |
| PreferredDeliveryMethod | string | false | false | The preferred delivery method. |
| ResaleNum | string | false | false | The resale number or additional info about the customer. |
| CurrencyRef | string | false | false | The Id of the currency used in the transaction. |
| CurrencyRef_Name | string | true | false | The name of the currency used in the transaction. |
| TaxExemptionReasonId | integer | false | false | This field shows the level of the hierarchy in which the customer record is located. A value of 0 specifies the top level of the hierarchy. The hierarchy is implicit when the parent is specified in an insert command. The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled 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 |
