AlmondTill/G3N API

On this page

openTillSession

mutation · in the family Till sessions

What it does

Open a till — start a drawer shift with a counted opening float.

OPEN a till session at a Register: ONE transaction — the doc + the one-live-per-register marker (a LIVE holder refuses CONFLICT/IDENTITY_TAKEN naming the open session; a TERMINAL holder is taken over) + one float_in entry per positive-float currency + the drawerTotals cache birth. The Register must be ACTIVE (tenant-scoped); openedBy stamps from the principal. Requires the unrestricted capability.

What happens

The drawer’s expected totals start tracking from your float count.

Who may call it

Capability area: Till sessions — Opening, suspending, resuming and closing your own till session.

Arguments

NameTypeRequiredNotes
inputOpenTillSessionInput OpenTillSessionInput!yesNo 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 ExampleOpenTillSession($input: OpenTillSessionInput!) {
  openTillSession(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    openedBy
    closedAt
    noSaleCount
    lastNoSaleAt
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "registerId": "01900000-0000-7000-8000-c30413dd0000",
    "float": [
      {
        "currency": "USD",
        "amountMinor": 1
      }
    ]
  }
}

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

Example response

{
  "data": {
    "openTillSession": {
      "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

Used in