PosTicketLine
One line row of a register ticket, as stored. extendedAmount, lineTotal and tax are the register's own figures; lineTotal and tax are computed when a sale finishes and are 0 on every ticket that is not an S ticket.
Type: object.
| Name | Type | Description |
|---|---|---|
kind required | string | What the line is, from the key the cashier pressed: sale (an item sold), minus (a negative item line), return (a return), discount (a DISCOUNT % or DISCOUNT ON marker row with no quantity), other (legacy payment, change and paid-out rows). One of: sale, minus, return, discount, other. |
quantity required | number | The quantity rung: cases on a case line, pounds on a scale line (the register's count plus its over-limit count). Positive on a return line; see soldUnits for the sign. |
aliasCode | string | The alias code the item was scanned by. |
bogoPrice | number | The buy-one-get-one unit price. Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
casePrice | number | The case price. Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
caseSalePrice | number | The sale case price. Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
cases | boolean | Sold by the case (a flag, not a count). |
category | string | The item's category. |
department | string | The item's department. |
description | string | The item description on the receipt. |
discountPercent | number | The line's percentage discount. |
discounted | boolean | The line got a discount. |
extendedAmount | number | The extension after the item's best price, before the ticket discount and deposits (unsigned, as stored). |
foodStamp | boolean | Food-stamp eligible. |
lineId | string | The POS line id. |
lineNumber | integer | The order the line was rung in. |
lineTotal | number | The line's sold total: signed, after the ticket discount, with deposit and up-charge, tax excluded. |
longDescription | string | The item's long description, at stores that keep one on the line. |
mixMatch | string | The mix-and-match group the line was priced in. |
noDiscount | boolean | The item is excluded from the ticket discount. |
overLimitQuantity | number | The part of quantity above the item's sale limit, charged at the regular price. |
packagePrice | number | The package price (packageQuantity for packagePrice). Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
packageQuantity | number | How many units the package price is for. |
packageSalePrice | number | The sale package price (packageSaleQuantity for packageSalePrice). Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
packageSaleQuantity | number | How many units the sale package price is for. |
price | number | The item's regular unit price. Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
priceLevel | integer | How the register priced the line: 1 regular, 2 sale, 3, 4, 13 and 16 package and sale-package prices, 5 to 11 case prices, 12 a percent discount, 14 mix and match, 15 buy one get one. |
productCode | string | The store product code. |
salePrice | number | The unit price after a sale or an item discount (equal to price when there was none). Dollars (the POS stores it in cents and the API divides by 100, as TisWin3 shows it). Absent on a discount marker or other row. |
scale | boolean | An item sold by weight. |
soldUnits | number | Signed units sold (negative on a return), cases times the pack; 0 on every ticket that is not an S ticket. |
tax | number | The line's share of the ticket tax. |
taxable1 | boolean | The first tax applies to the line. |
taxable2 | boolean | The second tax applies to the line. |
unitsPerCase | number | Units in a case of the item. |
voided | boolean | Present and true when the item line was voided on the register (its quantity is 0); a voided line stays on the ticket. |
wic | boolean | WIC eligible. |
No other fields appear.