CData Python Connector for QuickBooks

Build 25.0.9454

Customers

Handles QuickBooks Customers, supporting creation, updates, deletion, and queries for managing customer data effectively.

Table Specific Information

To add a Customer, you must specify the Name field.

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

The following filters support server-side execution. Other filters are executed client-side.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Customers are Id, Name, Balance, IsActive, and TimeModified. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Balance may be used with the >=, <=, or = conditions but cannot be used to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example: 

SELECT * FROM Customers WHERE Name LIKE '%George%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Balance > 100.00 AND Balance < 200.00

Columns

Name Type ReadOnly References ColumnSize Description
ID [KEY] String True 255

The unique identifier for the customer.

Name String False 41

The name of the customer. This is required when adding a new customer.

FullName String True 159

The full name of the customer, including hierarchical parent relationships, formatted as Parent:Customer.

Salutation String False 15

The salutation for the customer, such as Mr., Mrs., Dr., etc.

FirstName String False 25

The customer's first name as per the address information.

MiddleInitial String False 5

The middle name or initial of the customer.

LastName String False 25

The customer's last name as per the address information.

AccountNumber String False 99

The account number associated with the customer.

Company String False 41

The name of the company the customer is associated with.

Balance Double True

The total balance owed by the customer, including balances of any subcustomers.

CustomerBalance Double True

The balance owed solely by this customer, excluding subcustomers.

Contact String False 41

The name of the primary contact person for the customer.

Type String False 1000

The predefined customer type in QuickBooks, such as Commercial or Residential.

TypeId String False

CustomerTypes.ID

255

The unique identifier for the customer type in QuickBooks.

Phone String False 21

The main phone number for the customer.

Fax String False 21

The fax number for the customer.

AlternateContact String False 41

The name of an alternate contact for the customer.

AlternatePhone String False 21

The alternate phone number for the customer.

Email String False 1023

The email address for the customer.

Cc String False 1023

An additional email address for sending copies of communications to the customer. Requires QBXML Version 12.0 or higher.

AdditionalContactInfo String False

Additional contact details for the customer.

ContactsAggregate String False 5000

An XML-formatted collection of additional contacts for the customer. Must include the contact's FirstName. Requires QBXML Version 12.0.

ClassName String False

The name of the class associated with the customer. Requires QBXML Version 12.0 or higher.

ClassId String False

The unique identifier for the class associated with the customer. Requires QBXML Version 12.0 or higher.

Notes String False 5000

The first note associated with the customer. For all notes, refer to NotesAggregate or the CustomerNotes table.

NotesAggregate String False 5000

An XML-formatted collection of additional notes for the customer, including NoteId and Note elements. Requires QBXML Version 12.0.

ParentName String False

The name of the parent job for this customer.

ParentId String False

Customers.ID

255

The unique identifier for the parent job associated with this customer.

Sublevel Integer False

The number of levels in the customer's hierarchy.

JobStatus String False 10

The current status of the customer's job, if applicable.

The allowed values are Awarded, Closed, InProgress, None, NotAwarded, Pending.

JobStartDate Date False

The starting date of the customer's job.

JobProjectedEndDate Date False

The projected end date of the customer's job.

JobEndDate Date False

The actual end date of the customer's job.

JobDescription String False 99

A description of the customer's job.

JobType String False 1000

The name of the job type.

JobTypeId String False

JobTypes.ID

255

The unique identifier for the job type.

CreditCardAddress String False 41

The billing address associated with the customer's credit card.

CreditCardExpMonth Integer False

The expiration month of the customer's credit card.

CreditCardExpYear Integer False

The expiration year of the customer's credit card.

CreditCardNameOnCard String False 41

The name appearing on the customer's credit card.

CreditCardNumber String False 25

The credit card number associated with the customer.

CreditCardPostalCode String False 41

The postal code linked to the customer's credit card address.

CreditLimit Double False

The credit limit for the customer. If zero, no credit limit applies.

BillingAddress String True

The complete billing address for the customer.

BillingLine1 String False 41

The first line of the billing address.

BillingLine2 String False 41

The second line of the billing address.

BillingLine3 String False 41

The third line of the billing address.

BillingLine4 String False 41

The fourth line of the billing address.

BillingLine5 String False 41

The fifth line of the billing address.

BillingCity String False 31

The city in the billing address.

BillingState String False 21

The state in the billing address.

BillingPostalCode String False 13

The postal code in the billing address.

BillingCountry String False 31

The country in the billing address.

BillingNote String False 41

A note associated with the billing address.

ShippingAddress String True

The complete shipping address for the customer.

ShippingLine1 String False 41

The first line of the shipping address.

ShippingLine2 String False 41

The second line of the shipping address.

ShippingLine3 String False 41

The third line of the shipping address.

ShippingLine4 String False 41

The fourth line of the shipping address.

ShippingLine5 String False 41

The fifth line of the shipping address.

ShippingCity String False 31

The city in the shipping address.

ShippingState String False 21

The state in the shipping address.

ShippingPostalCode String False 13

The postal code in the shipping address.

ShippingCountry String False 31

The country in the shipping address.

ShippingNote String False 41

A note associated with the shipping address.

ShippingAggregate String False 5000

An XML-formatted collection of shipping addresses for the customer. Requires QBXML Version 12.0.

ResaleNumber String False 16

The resale number associated with the customer, if applicable. Can only be set on inserts.

SalesRep String False

SalesReps.ID

5

The name of the sales representative assigned to the customer.

SalesRepId String False 255

The unique identifier for the sales representative assigned to the customer.

Terms String False 100

The payment terms for the customer, such as '2% 10 Net 60'. Can only be set on inserts.

TermsId String False 255

The unique identifier for the payment terms associated with the customer.

CurrencyName String False 64

The name of the currency used by this customer. Requires QBXML Version 8.0 or higher.

CurrencyId String False

Currency.ID

255

The unique identifier for the currency used by this customer. Requires QBXML Version 8.0 or higher.

TaxCode String False 3

A reference to the predefined sales tax code in QuickBooks. Can only be set on inserts.

TaxCodeId String False

SalesTaxCodes.ID

255

The unique identifier for the predefined sales tax code. Can only be set on inserts.

TaxItem String False 100

A sales tax item specifying a single tax collected at a specific rate and paid to an agency.

TaxItemId String False

SalesTaxItems.ID

255

The unique identifier for the sales tax item.

SalesTaxCountry String False 100

The country that collects applicable sales taxes. Available only in international editions of QuickBooks.

PriceLevel String False 100

The name of the price level associated with the customer.

PriceLevelId String False

PriceLevels.ID

255

The unique identifier for the price level associated with the customer.

PreferredDeliveryMethod String False 20

The preferred delivery method for customer communications, such as email, fax, or none. Requires QBXML Version 12.0.

PreferredPaymentMethodName String False 100

The preferred payment method for the customer.

PreferredPaymentMethodId String False

PaymentMethods.ID

255

The unique identifier for the preferred payment method.

IsActive Boolean False

Indicates whether the customer is currently active.

CustomFields String False

An XML-formatted collection of custom fields for the customer.

EditSequence String True 16

An identifier used to track the version of this customer object.

TimeModified Datetime True

The timestamp when the customer was last modified.

TimeCreated Datetime True

The timestamp when the customer was created.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IncludeJobs Boolean

Indicates whether job-related information should be included in the results.

The default value is TRUE.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454