CompuDime API docs

Reference / Schemas

PosTicketTender

One tender row of a register ticket. Only the tender type, the amount, the date, the register log and the row id are read. A ticket never says who rang it or who the customer is beyond the POS customer id: no cashier, no remark, no phone. A tender never carries a card number, its last four digits, an authorization or reference code, a check number, a gift-card number, an EBT or gift-card balance or a signature: the store agent never reads the columns that hold them.

Type: object.

NameTypeDescription
action requiredstringWhat the row records: payment, void (a voided payment, negative), credit (a refund on a return, negative), void_credit, activate (a gift card activated, negative), add_value (value added to a gift card, negative), void_add_value, auth_only (a card authorization only). One of: payment, void, credit, void_credit, activate, add_value, void_add_value, auth_only, other.
amount requirednumberThe amount, signed exactly as the POS stores it; a cash row holds the full amount tendered.
datestring (date)The payment date.
lineIdstringThe POS row id of the tender.
logNumberintegerThe register log at payment time.
tenderCodestringThe tender code (tenders.list code); 1 to 8 on legacy rows.
tenderNamestringThe tender's name in the store's tender list.

No other fields appear.