AlmondTill/G3N API

On this page

refundTender

mutation · in the family Refunds and payment corrections

What it does

Refund a specific payment on an order (the record-only lane for cash/external tenders).

REFUND part of a PLACED order's tendered deposit: a NEGATIVE tender row + for cash the cash_refund drawer lane + both OCC stamps in ONE transaction; cap = the net tendered (CONFLICT/OVER_TENDERED); reason REQUIRED. cancelOrder refuses CONFLICT/TENDERED while net tendered > 0 — refund-then-cancel. Requires the unrestricted capability.

Careful

Money out, recorded forever.

Who may call it

Capability area: Refunds and payment corrections — Refunds, corrective notes and voiding invoices.

Arguments

NameTypeRequiredNotes
inputRefundTenderInput RefundTenderInput!yesNo further notes.

Returns

Tender Tender! — 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).

Example request

mutation ExampleRefundTender($input: RefundTenderInput!) {
  refundTender(input: $input) {
    id
    type
    caption
    status
    parentId
    rootId
    tenderType
    appliedMinor
    currency
    collectedMinor
    changeMinor
    tipMinor
    roundingDeltaMinor
    paymentId
    instrumentId
    orgCustomerId
    returnId
    tillSessionId
    reason
    refs
    createdAt
    updatedAt
    revision
    revisionNum
  }
}

Variables:

{
  "input": {
    "orderId": "01900000-0000-7000-8000-f6d8263a0000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000",
    "tenderType": "cash",
    "amountMinor": 1,
    "tillSessionId": "01900000-0000-7000-8000-83d61fef0000",
    "reason": "Correcting a miscount."
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "refundTender": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "type": "<type>",
      "caption": "Blue jeans",
      "status": "<status>",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "tenderType": "cash",
      "appliedMinor": 1,
      "currency": "USD",
      "collectedMinor": 1,
      "changeMinor": 1,
      "tipMinor": 1,
      "roundingDeltaMinor": 1,
      "paymentId": "01900000-0000-7000-8000-a7c488a40000",
      "instrumentId": "01900000-0000-7000-8000-736f3dcd0000",
      "orgCustomerId": "01900000-0000-7000-8000-ba56ff800000",
      "returnId": "01900000-0000-7000-8000-4d4c03d20000",
      "tillSessionId": "01900000-0000-7000-8000-83d61fef0000",
      "reason": "Correcting a miscount.",
      "refs": [
        "<refs>"
      ],
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "revisionNum": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in