CompuDime API docs

Reference / Schemas

PosTicketTotals

The ticket's money columns in dollars, signed exactly as the POS stores them; nothing is clamped or derived. A figure whose column the store lacks, or that the POS left blank, is absent.

Type: object.

NameTypeDescription
changenumberChange given.
codChargenumberThe COD part of onAccount.
discountnumberThe ticket percentage discount amount only; item discounts are on the lines.
onAccountnumberCharged to the customer's account (COD included).
paidnumberEvery tender taken, over-tender included: the change is change, not subtracted here.
paidOnAccountnumberA payment toward the customer's account balance taken on the ticket.
paperBagFeenumberThe paper-bag fee, included in sale.
returnsnumberReturns on the ticket, a positive amount (return tax and deposits included).
salenumberThe receipt total: tax included, returns and the ticket discount taken off, deposits, the paper-bag fee and the up-charge included. Negative on a return-only ticket. It is filled in on voided and held tickets too, which is why only the sale types count.
taxnumberTax (both taxes), net of returns.
upChargenumberThe up-charge amount, included in sale.

No other fields appear.