Click or drag to resize
Customer Properties

The Customer type exposes the following members.

Properties
  NameDescription
Public propertyAcctNum
Product: QBW Description: Name or number of the account associated with this customer.[br /]Max. length: 99 characters.
Public propertyActive
Product: ALL Description: If true, this entity is currently enabled for use by QuickBooks. The default value is true. Filterable: QBW
(Inherited from NameBase.)
Public propertyActiveSpecified (Inherited from NameBase.)
Public propertyAltContactName
Product: QBW Description: Name of the Alternate Customer contact.
Public propertyAlternatePhone
Product: ALL Description: Alternate phone number.
(Inherited from NameBase.)
Public propertyAnyIntuitObject
Public propertyARAccountRef
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.
Public propertyAttachableRef
Specifies entity name of the attachment from where the attachment was requested
(Inherited from IntuitEntity.)
Public propertyBalance
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
Public propertyBalanceSpecified
Public propertyBalanceWithJobs
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
Public propertyBalanceWithJobsSpecified
Public propertyBillAddr
Product: ALL Description: Default billing address.
Public propertyBillWithParent
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.
Public propertyBillWithParentSpecified
Public propertyCCDetail
Product: ALL Description: Credit-card information to request a credit card payment from a merchant account service.
Public propertyCompanyName
Product: ALL Description: The name of the company associated with the person or organization.
(Inherited from NameBase.)
Public propertyContactName
Product: QBW Description: Name of the Customer contact.
Public propertyCreditLimit
Product: QBW Description: Specifies the maximum amount of an unpaid customer balance.
Public propertyCreditLimitSpecified
Public propertyCurrencyRef
Product: ALL Description: Reference to the currency code for all the business transactions created for or received from the customer.
Public propertyCustomerEx
Product: ALL Description: Internal use only: extension place holder for Customer.
Public propertyCustomerTypeRef
Product: ALL Description: Reference to a CustomerType associated with the Customer.
Public propertyCustomField
Product: QBW Description: Custom field (or data extension). Filterable: QBW
(Inherited from IntuitEntity.)
Public propertyDefaultTaxCodeRef
Product: ALL Description: Reference to the tax code associated with the Customer or Vendor by default for sales or purchase taxes.
(Inherited from NameBase.)
Public propertyDisplayName
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.)
Public propertydomain
Product: ALL Description: Domain in which the entity belongs.
(Inherited from IntuitEntity.)
Public propertyFamilyName
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.)
Public propertyFax
Product: ALL Description: Fax number.
(Inherited from NameBase.)
Public propertyFullyQualifiedName
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.)
Public propertyGivenName
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.)
Public propertyHeaderFull
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyHeaderLite
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyId
Product: ALL Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation. Required: ALL Filterable: ALL
(Inherited from IntuitEntity.)
Public propertyIntuitId
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.)
Public propertyItemElementName
Public propertyJob
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.
Public propertyJobInfo
Product: ALL Description: Information about the job. Relevant only if the Customer represents the actual task or project, not just a person or organization.
Public propertyJobSpecified
Public propertyLevel
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.
Public propertyLevelSpecified
Public propertyMetaData
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.)
Public propertyMiddleName
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.)
Public propertyMobile
Product: ALL Description: Mobile phone number.
(Inherited from NameBase.)
Public propertyNameAndId
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyNotes
Product: ALL Description: Free form text describing the Customer.[br /]Max. length: 1024 characters.
Public propertyOpenBalanceDate
Product: ALL Description: Date of the Open Balance for the create operation.
Public propertyOpenBalanceDateSpecified
Public propertyOrganization
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.)
Public propertyOrganizationSpecified (Inherited from NameBase.)
Public propertyOtherAddr
Product: QBW only. Description: An address other than default billing or shipping.
Public propertyOtherContactInfo
Product: QBW Description: List of ContactInfo entities of any contact info type. The ContactInfo Type values are defined in the ContactTypeEnum.
(Inherited from NameBase.)
Public propertyOverDueBalance
Product: QBW Description: Over-due balance amount. Cannot be written to QuickBooks.
Public propertyOverDueBalanceSpecified
Public propertyOverview
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.)
Public propertyParentRef
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.
Public propertyPaymentMethodRef
Product: ALL Description: Reference to a PaymentMethod associated with the Customer.
Public propertyPreferredDeliveryMethod
Product: ALL Description: Preferred delivery method. Vales are Print, Email, or None.
Public propertyPriceLevelRef
Product: QBW Description: Reference to a PriceLevel associated with the Customer.
Public propertyPrimaryEmailAddr
Product: ALL Description: Primary email address.
(Inherited from NameBase.)
Public propertyPrimaryPhone
Product: ALL Description: Primary phone number.
(Inherited from NameBase.)
Public propertyPrimaryTaxIdentifier
Product: QBO Description: Specifies primary Tax ID of the Person or Organization.
Public propertyPrintOnCheckName
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.)
Public propertyResaleNum
Product: ALL Description: Resale number or some additional info about the customer.
Public propertyRootCustomerRef
Product: QBO Description: The top level Customer in the hierarchy to which this Job or sub customer belongs.
Public propertySalesRepRef
Product: QBW Description: Reference to a SalesRep associated with the Customer.
Public propertySalesTermRef
Product: ALL Description: Reference to a SalesTerm associated with the Customer.
Public propertySecondaryTaxIdentifier
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.
Public propertyShipAddr
Product: ALL Description: Default shipping address.
Public propertysparse
Product: ALL Description: True if the entity representation has a partial set of elements. Output only field.
(Inherited from IntuitEntity.)
Public propertysparseSpecified (Inherited from IntuitEntity.)
Public propertystatus
Product: ALL Description: System status of the entity. Output only field.[br /] Filterable: ALL
(Inherited from IntuitEntity.)
Public propertystatusSpecified (Inherited from IntuitEntity.)
Public propertySuffix
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.)
Public propertySyncToken
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.)
Public propertyTaxable
Product: QBO only Description: True if the customer is taxable.
Public propertyTaxableSpecified
Public propertyTaxExemptionReasonId
Public propertyTDSEnabled
Product: QBO Description: True, if TDS (Tax Deducted at Source) is enabled for this customer.
Public propertyTDSEnabledSpecified
Public propertyTitle
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.)
Public propertyTotalExpense
Product: QBW Description: The total expense amount for the Customer. Cannot be written to QuickBooks.
Public propertyTotalExpenseSpecified
Public propertyTotalRevenue
Product: QBW Description: The total revenue amount from the Customer. Cannot be written to QuickBooks.
Public propertyTotalRevenueSpecified
Public propertyUserId
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.)
Public propertyWebAddr
Product: ALL Description: Website address (URI).
(Inherited from NameBase.)
Top
See Also