AlmondTill/G3N API

On this page

forceCloseTillSession

mutation · in the family Till session

What it does

Force-close a till that cannot close normally (a crashed register, an abandoned shift).

Force-close a TillSession WITHOUT a proper count; requires the unrestricted capability + the record's CURRENT revision.

Careful

A supervisory act — it closes the accountability record without the normal count ritual and says so in the audit trail.

Who may call it

Capability area: Till and cash management — Manual drawer entries and force-closing a till.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

TillSession TillSession! — A TillSession — the cash-drawer session at a Register: opened by a User with a counted starting float, tracking float / expected / counted / over-short through the immutable CashEntry ledger (the Stock-Card discipline — nothing changes the drawer without a ledger entry). ONE live session per register (STRICT — the tillSession marker). Expected cash = the drawerTotals cache, stamped in the SAME transaction as every entry post. The shift IS this doc (openedBy + createdAt→closedAt); X/Z report ARTIFACTS are the reports family.

Example request

mutation ExampleForceCloseTillSession($id: ID!, $revision: ID!, $reason: String) {
  forceCloseTillSession(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    openedBy
    closedAt
    noSaleCount
    lastNoSaleAt
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

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

Example response

{
  "data": {
    "forceCloseTillSession": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TS-EXMP-0000-000F",
      "type": "TillSession",
      "caption": "Blue jeans",
      "status": "open",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "openedBy": "01900000-0000-7000-8000-553745ed0000",
      "closedAt": "2027-01-31T00:00:00.000Z",
      "noSaleCount": 1,
      "lastNoSaleAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer