AlmondTill/G3N API

On this page

fiscalReceipts

query · in the family Reading your records

What it does

List your fiscal receipts, newest first — the gap-free compliance journal; receipts are permanent and never edited or removed.

One page of YOUR org group's fiscal receipts. Requires authentication (template class). STRUCTURED FILTER + SORT: filter = AND across clauses, OR within a clause's values; sort = one declared field, asc/desc. The declared FiscalReceipt roster: caption (text) · status (enum) · parentKind (enum) · regime (enum) · logicalFacilityId (ref) · seriesKey (text) · createdAt (date) · updatedAt (date). An illegal filter/sort refuses VALIDATION/INVALID NAMING the exact problem (an unknown field teaches the roster). A filtered/sorted read evaluates the WHOLE family server-side, returns the EXACT matchCount, and its nextToken binds to THE ONE filter+sort that minted it — replaying it under a different filter/sort refuses. Absent both, the unfiltered lane is unchanged (matchCount null). ⚠ status carries the ONE artifact literal issued — every live row matches (grammar parity, never narrowing).

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
filterFilterInputnoWhich records to answer — clauses over the family’s filterable fields (the FilterInput type and the paging guide carry the grammar).
sortSortInputnoThe order to answer in — one declared field and a direction (the SortInput type carries the grammar).
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.

Returns

FiscalReceiptPage FiscalReceiptPage! — One page of the org group's fiscal receipts (newest-first; walk until nextToken is null).

This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.

Example request

query ExampleFiscalReceipts($limit: Int) {
  fiscalReceipts(limit: $limit) {
    items {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      parentKind
      regime
      logicalFacilityId
      seriesKey
      seq
      signature
      authorizationCode
      qrPayload
      partnerRef
    }
    nextToken
    matchCount
  }
}

Variables:

{
  "limit": 1
}

Example response

{
  "data": {
    "fiscalReceipts": {
      "items": [
        {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "sysId": "FR-EXMP-0000-000F",
          "type": "FiscalReceipt",
          "caption": "Blue jeans",
          "status": "<status>",
          "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",
          "parentKind": "<parent kind>",
          "regime": "<regime>",
          "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
          "seriesKey": "<series key>",
          "seq": 1,
          "signature": "<signature>",
          "authorizationCode": "BJ-001",
          "qrPayload": "<qr payload>",
          "partnerRef": "<partner ref>"
        }
      ],
      "nextToken": "<the cursor from the previous page>",
      "matchCount": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer