AlmondTill/G3N API

ApplyTenderInput

input type

Apply-input for applyTender: collectedMinor = the cash physically handed over (BEFORE change, tip included) or the externally-authorized amount. cash REQUIRES the open till session and REFUSES the capture block; external_card the exact mirror; foreign_cash names the tendered currency (collectedCurrency — collectedMinor is in ITS minor units), REQUIRES the till, is converted at OUR stored BUY rate (settle + change in the org default currency; no covering rate = CONFLICT/NO_EFFECTIVE_RATE, retryable), and carries no tip (a named deferral). Dormant types refuse VALIDATION/UNSUPPORTED naming their arrival.

Fields

FieldTypeRequiredNotes
orderIdID ID!yesNo further notes.
expectedRevisionID ID!yesThe Order revision the caller read.
tenderTypeTenderType TenderType!yesNo further notes.
collectedMinorInt Int!yesThe POSITIVE physical/authorized amount in minor units.
collectedCurrencyStringnoThe TENDERED currency — REQUIRED iff foreign_cash, REFUSED otherwise.
tipMinorIntnoThe tip portion of collectedMinor. REFUSED on foreign_cash.
tillSessionIdIDnoThe OPEN drawer session — REQUIRED for cash/foreign_cash, REFUSED otherwise.
externalCardTenderExternalCardInputnoThe pinpad capture — REQUIRED for external_card, REFUSED otherwise.
cardTenderCardInputnoThe tokenized method presentation — REQUIRED for card, REFUSED otherwise.
instrumentTenderInstrumentInputnoThe instrument presentation — REQUIRED for gift_card/gift_certificate/store_credit, REFUSED otherwise. The redeem lane: active-only · type⟺tender · same-currency · ≤ the remaining due (NO change — the no-cash-out strict default) · ≤ the balance (CONFLICT/INSUFFICIENT_BALANCE — exhaust exactly + split-tender the remainder); NO tip; NO tillSessionId (no drawer money).
reasonStringnoOptional — why this tender (at most 256 characters). When the tender charges a house account (on_account) the reason is recorded on that ledger too — at most 256 characters there.
captionStringnoOptional caption override.
refsString [String!]noProvenance document refs (bounded free strings).

Used by