PriceDiscountItems
Create, update, delete, and query QuickBooks POS Price Discount Items.
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 PriceDiscountItems WHERE Associate LIKE '%George%' AND TimeModified >= '1/1/2014' AND TimeModified < '2/1/2014'
Insert
Insert can be used to create a new PriceDiscount record or to add an item to an existing PriceDiscount record.
To create a new PriceDiscount record, the PriceDiscountName and PriceDiscountReason fields are required.
INSERT INTO PriceDiscountItems (PriceDiscountName, PriceDiscountReason, PriceDiscountXValue, ItemListId, ItemUnitOfMeasure) VALUES ('New Discount', 'Sale', '10', '-1000000000000000001', 'lbs')
To add an item to an existing record, the TxnId column of the PriceDiscount record that the item is to be added to and the ItemListId are required.
INSERT INTO PriceDiscountItems (TxnId, ItemListId, ItemUnitOfMeasure) VALUES ('-1234567890123456789', '-1000000000000000001', 'lbs')
Update
Any field that is not read-only can be updated.
Note: Update operations will count as two operations against the QuickBooks POS API. One is required to retrieve the existing record, and another to update the record with new data.
To perform an update, TxnId and ItemTxnLineId are required fields.
UPDATE PriceDiscountItems SET ItemUnitOfMeasure='lbs' WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='1'
Delete
Delete is used to remove an item from the specified record (it will not delete the entire record itself).
Note: Deletion of an item requires that all the wanted items that currently exist in the record be sent in the request, thus deleting those that are not specified. Therefore Delete operations will count as two operations against the QuickBooks POS API. One is required to retrieve the existing record to obtain all the existing ItemTxnLineIds and another to delete the specified item.
To perform a delete, TxnId and ItemTxnLineId are required fields.
DELETE FROM PriceDiscountItems WHERE TxnId='-1234567890123456789' AND ItemTxnLineId='3'
Columns
Name | Type | ReadOnly | Filter Type | Description |
TxnID [KEY] | String | True | Single |
The unique identifier, generated by QuickBooks POS. |
PriceDiscountName | String | False | Range |
The name of the price discount. |
PriceDiscountReason | String | False | Range |
The status of the price discount. |
PriceDiscountType | String | False | Single |
The type of price discount. |
Associate | String | False | Range |
The employee making the adjustment. |
LastAssociate | String | True | Range |
The employee who made the last adjustment transaction. |
ItemsCount | String | True | Range |
The number of line items in the insert that added the transaction. |
StartDate | Datetime | False | Range |
The starting date of the discount. |
StopDate | Datetime | False | Range |
The ending date of the discount. |
IsInactive | Boolean | False | Single |
Determines whether the discount is active. |
PriceDiscountPriceLevels | String | False |
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. | |
PriceDiscountXValue | Decimal | False | Range |
The discount price over the X value. |
PriceDiscountYValue | Decimal | False | Range |
The discount price over the Y yalue. |
IsApplicableOverXValue | Boolean | False | Single |
Determines whether the discount is applicable over the X value. |
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 changes to the customer information were successfully updated or not. Possible values are Modified, Sent, and Acknowledged. |
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 transaction was created. |
TimeModified | Datetime | True | Range |
When the transaction was last modified. |
ItemTxnLineID# [KEY] | String | True |
Identification number of the transaction line. (TxnLineId is supported as of version 2.0 of the SDK. With QBXML 1.0 and 1.1, TxnLineId is always returned as zero.) If you need to add a new transaction line in an update, you can do so by setting the TxnLineId to -1. | |
ItemListID# | String | False |
The unique identifier for the item, generated by QuickBooks POS. | |
ItemUnitOfMeasure# | String | False |
If the company is using only a single unit of measure, this specifies the unit of measure for the item. If the company is using multiple units of measure, this specifies the base unit of measure for the item. |