CompuDime API docs

Reference / Schemas

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.

NameTypeDescription
kind requiredstringWhat 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 requirednumberThe 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.
aliasCodestringThe alias code the item was scanned by.
bogoPricenumberThe 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.
casePricenumberThe 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.
caseSalePricenumberThe 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.
casesbooleanSold by the case (a flag, not a count).
categorystringThe item's category.
departmentstringThe item's department.
descriptionstringThe item description on the receipt.
discountPercentnumberThe line's percentage discount.
discountedbooleanThe line got a discount.
extendedAmountnumberThe extension after the item's best price, before the ticket discount and deposits (unsigned, as stored).
foodStampbooleanFood-stamp eligible.
lineIdstringThe POS line id.
lineNumberintegerThe order the line was rung in.
lineTotalnumberThe line's sold total: signed, after the ticket discount, with deposit and up-charge, tax excluded.
longDescriptionstringThe item's long description, at stores that keep one on the line.
mixMatchstringThe mix-and-match group the line was priced in.
noDiscountbooleanThe item is excluded from the ticket discount.
overLimitQuantitynumberThe part of quantity above the item's sale limit, charged at the regular price.
packagePricenumberThe 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.
packageQuantitynumberHow many units the package price is for.
packageSalePricenumberThe 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.
packageSaleQuantitynumberHow many units the sale package price is for.
pricenumberThe 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.
priceLevelintegerHow 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.
productCodestringThe store product code.
salePricenumberThe 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.
scalebooleanAn item sold by weight.
soldUnitsnumberSigned units sold (negative on a return), cases times the pack; 0 on every ticket that is not an S ticket.
taxnumberThe line's share of the ticket tax.
taxable1booleanThe first tax applies to the line.
taxable2booleanThe second tax applies to the line.
unitsPerCasenumberUnits in a case of the item.
voidedbooleanPresent and true when the item line was voided on the register (its quantity is 0); a voided line stays on the ticket.
wicbooleanWIC eligible.

No other fields appear.