Create, update, delete, and query QuickBooks POS customers.
Table Specific Information
The Customers table allows you to select, insert, update, and delete Customers within QuickBooks POS.
QuickBooks Point of Sale allows many of the columns to be used in the WHERE clause of a SELECT query. These columns can create either Single or Range filters, as defined in the table schema.
|Single Filters||Single filters make direct comparisons by using the = comparison.|
|Range Filters||Range filters can search only ranges that have an inclusive lower bound, specified by the >= operator, and an exclusive upper bound, specified by the < operator.
To apply a single bound to a string column that has the Range filter type, the = or LIKE operators are available.
To apply a single bound to a numeric or datetime column that has the Range filter type, the >, >=, <, <=, or = operators are available.
SELECT * FROM Customers WHERE FirstName LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014' AND AccountBalance > 100.00
To create a new Customer record, the LastName field is required.
Shipping addresses are specified via an XML aggregate within the ShipAddressesAggregate column. The columns that may be used in these aggregates are defined in the CustomerShipAddresses table as # columns. Note that ShipAddressAddressName is required when adding a shipping address.
The following example demonstrates how to insert a new Customer with two shipping addresses:
INSERT INTO Customers (FirstName, LastName, ShipAddressesAggregate) VALUES ('Kristy', 'Abercrombie', '<CustomerShipAddresses> <Row><ShipAddressAddressName>Home</ShipAddressAddressName><ShipAddressStreet>123 Main Street</ShipAddressStreet><ShipAddressCity>Chapel Hill</ShipAddressCity><ShipAddressState>NC</ShipAddressState><ShipAddressPostalCode>12345</ShipAddressPostalCode></Row> <Row><ShipAddressAddressName>Office</ShipAddressAddressName><ShipAddressStreet>456 Downtown Drive</ShipAddressStreet><ShipAddressCity>Raleigh</ShipAddressCity><ShipAddressState>NC</ShipAddressState><ShipAddressPostalCode>98765</ShipAddressPostalCode></Row> </CustomerShipAddresses>')
Any field that is not read-only can be updated.
When updating a Customer record, shipping addresses can be added or modified via the ShipAddressesAggregate column (just as in an insert). In such cases, the ShipAddressAddressName column is required to identify the shipping address being added or updated.
In the case of updating a shipping address, pre-existing values will remain unchanged unless explicitly specified within the ShipAddressesAggregate. Therefore, to
remove a value, the column value in the aggregate must be set to "" (empty string).
UPDATE Customers SET ShipAddressesAggregate='<CustomerShipAddresses> <Row><ShipAddressAddressName>Office</ShipAddressAddressName><ShipAddressCompany>MyCompany</ShipAddressCompany></Row> </CustomerShipAddresses>' WHERE ListId='-1234567890123456789'
The unique identifier, generated by QuickBooks POS.
The user-specified Id for the customer.
The full name of the customer.
A salutation, such as Mr., Mrs., etc.
The first name of the customer as stated in the address info.
The last name of the customer as stated in the address info.
The name of the company of the customer.
The primary telephone number for the customer.
An alternate telephone or fax number for the customer.
An alternate telephone or fax number for the customer.
The email address of the customer.
Whether or not the customer can be notified via email.
A customer type within QuickBooks POS.
Notes on this customer.
Street address of the billing address of the customer.
The second line of the street address in the billing address of the customer.
City name for the billing address of the customer.
State name for the billing address of the customer.
Postal code for the billing address of the customer.
Country for the billing address of the customer.
Whether or not the billing address can be used as a shipping address.
The default shipping address of the customer.
An aggregate of the shipping address data, which can be used for adding a customer and their shipping address locations.
Indicates whether checks are being accepted from this customer. The default is True.
Indicates whether the customer is using a charge account.
In multistore configurations, if the customer information has changed, this information is updated at the headquarters store. This response field indicates whether customer information was successfully updated or not. Possible values are Modified, Sent, and Acknowledged.
The sales tax category.
The suggested customer discount percentage for all items listed on a sales receipt. Note that you cannot assign both a discount percentage and a price level to a customer.
The customer discount type. Possible values are None, PriceLevel, and Percentage.
The suggested price level discount given to the customer. Note that you cannot assign both a discount percentage and a price level to a customer.
The time of the last purchase made by this customer.
The amount past due for a transaction.
Whether or not the customer is using QuickBooks POS with QuickBooks.
The balance of the account owned by this customer, including subcustomers. Available only when QuickBooks POS is being used with QuickBooks and only if UseWithQB is True.
The limit of the account owned by this customer, including subcustomers. Available only when QuickBooks POS is being used with QuickBooks and only if UseWithQB is True.
Indicates whether the customer is a rewards member.
An aggregate of the reward data for the customer.
Identifies the owner of the CustomFields to be returned in the response. The default value of '0' is sent which refers to a public custom field that is exposed in the QuickBooks POS UI. All other values are GUID's that are created by the owner and are private custom fields (not exposed via the QuickBooks POS UI).
Custom fields returned from QuickBooks POS and formatted into XML.
When the customer was created.
When the customer was last modified.