Vendors
Create, update, delete and query QuickBooks POS vendors.
Table Specific Information
Select
QuickBooks POS 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 Vendors WHERE CompanyName LIKE '%Cross%'
Insert
To create a new vendor record, the CompanyName field is required.
INSERT INTO Vendors (CompanyName, VendorCode, AccountNumber, FirstName, LastName) VALUES ('Cross Industries', 'JCI', '12345', 'Joshua', 'Cross')
Update
Any field that is not read-only can be updated.
UPDATE Vendors SET Street='123 Main St', City='Townville', State='AZ', PostalCode='85201' WHERE ListId='-1234567890123456789'
Columns
Name | Type | ReadOnly | Filter Type | Description |
ListID [KEY] | String | True | Single |
The unique identifier, generated by QuickBooks POS. |
CompanyName | String | False | Range |
The name of the business. |
VendorCode | String | False | Range |
The user-defined code for the vendor. |
AccountNumber | String | False | Range |
Your account number with the vendor. This number is displayed on purchase orders that are created for the vendor. |
Salutation | String | False | Range |
A salutation, such as Mr., Mrs., etc. |
FirstName | String | False | Range |
The first name of the vendor. |
LastName | String | False | Range |
The last name of the vendor. |
Street | String | False | Range |
Street address of the vendor. |
Street2 | String | False | Range |
The second line of the street address of the vendor. |
City | String | False | Range |
City name for the billing address of the vendor. |
State | String | False | Range |
State name for the billing address of the vendor. |
PostalCode | String | False | Range |
Postal code for the billing address of the vendor. |
Country | String | False | Range |
Country for the billing address of the vendor. |
Phone | String | False | Range |
The primary telephone number for the vendor. |
Phone2 | String | False | Range |
An alternate telephone or fax number for the vendor. |
Phone3 | String | False | Range |
An alternate telephone or fax number for the vendor. |
String | False | Range |
The email address for communicating with the vendor. | |
Notes | String | False | Range |
Notes on this vendor. |
IsInactive | Boolean | False | Single |
Indicates whether the vendor is currently active. |
StoreExchangeStatus | String | True | Single |
In multistore configurations, if the customer information has changed, this information is updated at the headquarters store. This response field indicates whether the customer information was successfully updated or not. Possible values are Modified, Sent, and Acknowledged. |
Terms | String | True |
Any payment terms that are defined for the vendor file are carried to the purchase order, although payment terms are not visible on a purchase order. | |
TermsDiscount | Decimal | False | Range |
The discount percentage. A discount is applied by the vendor if payment is received on or before the number of days specified in the TermsDiscountDays field for that vendor. Terms-related discounts for vendors are created or modified using the TermsDiscountDays and TermsDiscount fields in an insert or update. |
TermsDiscountDays | Double | False | Range |
The number of days after the invoice date when payment must be received in order to obtain the discount percentage. A discount is applied by the vendor if payment is received on or before the number of days specified in the TermsDiscountDays field for that vendor. Terms-related discounts for vendors are created or modified using the TermsDiscountDays and TermsDiscount fields in an insert or update. |
TermsNetDays | Double | False | Range |
Payment must be made within this number of days, counting from the invoice date. |
CustomFieldsOwnerID | String | False | Multi |
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). |
CustomFields | String | False |
Custom fields returned from QuickBooks POS and formatted into XML. | |
TimeCreated | Datetime | True | Range |
When the vendor was created. |
TimeModified | Datetime | True | Range |
When the vendor was last modified. |