Customer Properties |
The Customer type exposes the following members.
Name | Description | |
---|---|---|
![]() | AcctNum |
Product: QBW
Description: Name or number of the account associated with this customer.[br /]Max. length: 99 characters.
|
![]() | Active |
Product: ALL
Description: If true, this entity is currently enabled for use by QuickBooks. The default value is true.
Filterable: QBW
(Inherited from NameBase.) |
![]() | ActiveSpecified | (Inherited from NameBase.) |
![]() | AltContactName |
Product: QBW
Description: Name of the Alternate Customer contact.
|
![]() | AlternatePhone |
Product: ALL
Description: Alternate phone number.
(Inherited from NameBase.) |
![]() | AnyIntuitObject | |
![]() | ARAccountRef |
Product: QBO
Description: The A/R account ID for the customer. This is applicable only in FR where each customer needs to have his own AR account.
|
![]() | AttachableRef |
Specifies entity name of the attachment from where the attachment was requested
(Inherited from IntuitEntity.) |
![]() | Balance |
Product: ALL
Description: 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.
Filterable: QBW
Sortable: QBW
|
![]() | BalanceSpecified | |
![]() | BalanceWithJobs |
Product: QBW
Description: Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks.
Product: QBO
Description: Cumulative open balance amount for the Customer (or Job) and all its sub-jobs.
Filterable: ALL
Non-default: ALL
|
![]() | BalanceWithJobsSpecified | |
![]() | BillAddr |
Product: ALL
Description: Default billing address.
|
![]() | BillWithParent |
Product: ALL
Description: If true, this Customer is billed with its parent. If false, or null the customer is not to be billed with its parent. This property is valid only if this entity is a Job or sub Customer.
|
![]() | BillWithParentSpecified | |
![]() | CCDetail |
Product: ALL
Description: Credit-card information to request a credit card payment from a merchant account service.
|
![]() | CompanyName |
Product: ALL
Description: The name of the company associated with the person or organization.
(Inherited from NameBase.) |
![]() | ContactName |
Product: QBW
Description: Name of the Customer contact.
|
![]() | CreditLimit |
Product: QBW
Description: Specifies the maximum amount of an unpaid customer balance.
|
![]() | CreditLimitSpecified | |
![]() | CurrencyRef |
Product: ALL
Description: Reference to the currency code for all the business transactions created for or received from the customer.
|
![]() | CustomerEx |
Product: ALL
Description: Internal use only: extension place holder for Customer.
|
![]() | CustomerTypeRef |
Product: ALL
Description: Reference to a CustomerType associated with the Customer.
|
![]() | CustomField |
Product: QBW
Description: Custom field (or data extension).
Filterable: QBW
(Inherited from IntuitEntity.) |
![]() | DefaultTaxCodeRef |
Product: ALL
Description: Reference to the tax code associated with the Customer or Vendor by default for sales or purchase taxes.
(Inherited from NameBase.) |
![]() | DisplayName |
Product: QBO
Description: The name of the person or organization as displayed. If not provided, this is populated from FullName.
Product: QBW
Description: The name of the person or organization as displayed.
Required: ALL
Filterable: QBW
(Inherited from NameBase.) |
![]() | domain |
Product: ALL
Description: Domain in which the entity belongs.
(Inherited from IntuitEntity.) |
![]() | FamilyName |
Product: QBW
Description: Family name or the last name of the person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
Product: QBO
Description: Family name or the last name of the person.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Filterable: ALL
Sortable: ALL
(Inherited from NameBase.) |
![]() | Fax |
Product: ALL
Description: Fax number.
(Inherited from NameBase.) |
![]() | FullyQualifiedName |
Product: ALL
Description: Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Customer:Job:Sub-job. Limited to 5 levels.[br /]Max. length: 41 characters (single name) or 209 characters (fully qualified name).
(Inherited from NameBase.) |
![]() | GivenName |
Product: QBW
Description: Given name or first name of a person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
Product: QBO
Description: Given name or first name of a person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Filterable: ALL
Sortable: ALL
(Inherited from NameBase.) |
![]() | HeaderFull |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | HeaderLite |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | Id |
Product: ALL
Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation.
Required: ALL
Filterable: ALL
(Inherited from IntuitEntity.) |
![]() | IntuitId |
Product: QBO
Description: IntuitId represents the realm id, authid or an entity id. An entity is a new type of IAM identity that represents a person or a business which has no Intuit authentication context
(Inherited from NameBase.) |
![]() | ItemElementName | |
![]() | Job |
Product: ALL
Description: 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.
|
![]() | JobInfo |
Product: ALL
Description: Information about the job. Relevant only if the Customer represents the actual task or project, not just a person or organization.
|
![]() | JobSpecified | |
![]() | Level |
Product: ALL
Description: Specifies the level of the hirearchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent.
|
![]() | LevelSpecified | |
![]() | MetaData |
Product: ALL
Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
(Inherited from IntuitEntity.) |
![]() | MiddleName |
Product: QBW
Description: Middle name of the person. The person can have zero or more middle names.[br /]Max. length: 5 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
Product: QBO
Description: Middle name of the person. The person can have zero or more middle names.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
Filterable: ALL
Sortable: ALL
(Inherited from NameBase.) |
![]() | Mobile |
Product: ALL
Description: Mobile phone number.
(Inherited from NameBase.) |
![]() | NameAndId |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | Notes |
Product: ALL
Description: Free form text describing the Customer.[br /]Max. length: 1024 characters.
|
![]() | OpenBalanceDate |
Product: ALL
Description: Date of the Open Balance for the create operation.
|
![]() | OpenBalanceDateSpecified | |
![]() | Organization |
Product: QBW
Description: True if the entity represents an organization; otherwise the entity represents a person. Default is NULL or False, representing a person.
(Inherited from NameBase.) |
![]() | OrganizationSpecified | (Inherited from NameBase.) |
![]() | OtherAddr |
Product: QBW only.
Description: An address other than default billing or shipping.
|
![]() | OtherContactInfo |
Product: QBW
Description: List of ContactInfo entities of any contact info type. The ContactInfo Type values are defined in the ContactTypeEnum.
(Inherited from NameBase.) |
![]() | OverDueBalance |
Product: QBW
Description: Over-due balance amount. Cannot be written to QuickBooks.
|
![]() | OverDueBalanceSpecified | |
![]() | Overview |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | ParentRef |
Product: ALL
Description: The immediate parent of the Sub-Customer/Job in the hierarchical "Customer:Job" list.[br /]Required for the create operation if the Customer is a sub-customer or Job.
|
![]() | PaymentMethodRef |
Product: ALL
Description: Reference to a PaymentMethod associated with the Customer.
|
![]() | PreferredDeliveryMethod |
Product: ALL
Description: Preferred delivery method. Vales are Print, Email, or None.
|
![]() | PriceLevelRef |
Product: QBW
Description: Reference to a PriceLevel associated with the Customer.
|
![]() | PrimaryEmailAddr |
Product: ALL
Description: Primary email address.
(Inherited from NameBase.) |
![]() | PrimaryPhone |
Product: ALL
Description: Primary phone number.
(Inherited from NameBase.) |
![]() | PrimaryTaxIdentifier |
Product: QBO
Description: Specifies primary Tax ID of the Person or Organization.
|
![]() | PrintOnCheckName |
Product: ALL
Description: Name of the person or organization as printed on a check. If not provided, this is populated from FullName.
(Inherited from NameBase.) |
![]() | ResaleNum |
Product: ALL
Description: Resale number or some additional info about the customer.
|
![]() | RootCustomerRef |
Product: QBO
Description: The top level Customer in the hierarchy to which this Job or sub customer belongs.
|
![]() | SalesRepRef |
Product: QBW
Description: Reference to a SalesRep associated with the Customer.
|
![]() | SalesTermRef |
Product: ALL
Description: Reference to a SalesTerm associated with the Customer.
|
![]() | SecondaryTaxIdentifier |
Product: QBO
Description: Specifies secondary Tax ID of the Person or Organization. Applicable for IN companies for CST Registration No. and in future can be extended to other regions.
|
![]() | ShipAddr |
Product: ALL
Description: Default shipping address.
|
![]() | sparse |
Product: ALL
Description: True if the entity representation has a partial set of elements. Output only field.
(Inherited from IntuitEntity.) |
![]() | sparseSpecified | (Inherited from IntuitEntity.) |
![]() | status |
Product: ALL
Description: System status of the entity. Output only field.[br /]
Filterable: ALL
(Inherited from IntuitEntity.) |
![]() | statusSpecified | (Inherited from IntuitEntity.) |
![]() | Suffix |
Product: QBO
Description: Suffix appended to the name of a person. For example, Senior, Junior, etc. QBO only field.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
(Inherited from NameBase.) |
![]() | SyncToken |
Product: ALL
Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation.
Required: ALL
(Inherited from IntuitEntity.) |
![]() | Taxable |
Product: QBO only
Description: True if the customer is taxable.
|
![]() | TaxableSpecified | |
![]() | TaxExemptionReasonId | |
![]() | TDSEnabled |
Product: QBO
Description: True, if TDS (Tax Deducted at Source) is enabled for this customer.
|
![]() | TDSEnabledSpecified | |
![]() | Title |
Product: ALL
Description: QBW: Title of the person. The person can have zero or more titles.
Description: QBO: Title of the person. The person can have zero or more titles.
InputType: ReadWrite
ValidRange: QBW: Min=0, Max=15
ValidationRules: QBW: At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName.
ValidationRules: QBO: At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
I18n: ALL
(Inherited from NameBase.) |
![]() | TotalExpense |
Product: QBW
Description: The total expense amount for the Customer. Cannot be written to QuickBooks.
|
![]() | TotalExpenseSpecified | |
![]() | TotalRevenue |
Product: QBW
Description: The total revenue amount from the Customer. Cannot be written to QuickBooks.
|
![]() | TotalRevenueSpecified | |
![]() | UserId |
Product: QBW
Description: The ID of the Intuit user associated with this name. Note: this is NOT the Intuit AuthID of the user.
(Inherited from NameBase.) |
![]() | WebAddr |
Product: ALL
Description: Website address (URI).
(Inherited from NameBase.) |