AlmondTill/G3N API

Tender

object type

ONE applied tender: FSM-LESS by ratified intent (SPEC_CATALOG / — status is always active; the lifecycle is its Payment / the money facts); sysId-LESS (the class); IMMUTABLE — reversal = a NEW refund tender row (negative appliedMinor), never an edit. Posted ONLY by applyTender, refundTender, and the refund writers (refundReturn/posReturn method=cash) — each in ONE transaction with the Order rollup stamp (+ the drawer entries for cash).

Fields

FieldTypeNotes
idID ID!No further notes.
typeString String!No further notes.
captionString String!The derived display caption — tenderType + currency + signed applied minor; never editable.
statusString String!FSM-less: always active.
parentIdID ID!The parent Order.
rootIdID ID!No further notes.
tenderTypeTenderType TenderType!The canned tender type (SPEC_REGISTRY row 92).
appliedMinorInt Int!SIGNED minor units APPLIED toward the order balance — positive = payment, negative = a refund tender.
currencyString String!The settlement currency — the order currency snapshot.
collectedMinorIntCASH, positive tenders: the PHYSICAL cash handed over (before change, tip included).
changeMinorIntCASH: the physical change handed back (the change_given drawer lane).
tipMinorIntThe tip captured at tender.
roundingDeltaMinorIntThe cash-rounding ledger note (settling cash tenders): roundedDue − exactDue — the sale total NEVER changes.
externalCardTenderExternalCardThe pinpad capture (external_card tenders only).
fxTenderFxThe foreign-cash capture (foreign_cash tenders only).
paymentIdIDThe Payment this card tender was spawned by (card tenders only; the payment read tells the processor story).
instrumentIdIDThe StoredValueInstrument this tender drew from or credited.
orgCustomerIdIDThe OrgCustomer house account this tender charged or credited.
returnIdIDThe Return this refund tender settles.
tillSessionIdIDThe drawer session a cash tender settled to/paid out of.
reasonStringThe caller's reason (required on refund tenders).
refsString [String!]Provenance document refs (bounded free strings).
createdAtString String!No further notes.
updatedAtString String!No further notes.
revisionID ID!No further notes.
revisionNumInt Int!No further notes.

Used by