AlmondTill/G3N API

Issue a fiscal receipt where the law requires one

Where a market’s fiscal scheme applies, issue the certified receipt for a completed order or an issued invoice — signed or authority-cleared, gap-free numbered, one per document forever.

Compliance · a play in 2 steps.

The steps

  1. See the fiscal schemes we support, per market. — cannedFiscalRegimes
  2. Issue the receipt — one per document per scheme, forever. — issueFiscalReceipt

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

cannedFiscalRegimes

cannedFiscalRegimes — query · The fiscal regimes we support, per market — each key names a country scheme (sign-and-journal, or authority-cleared before issuing); receipts only accept listed keys. Markets with no scheme (like the US) simply never issue one.

Example request

query ExampleCannedFiscalRegimes {
  cannedFiscalRegimes {
    key
    caption
    model
    countryCode
  }
}

Example response

{
  "data": {
    "cannedFiscalRegimes": [
      {
        "key": "<key>",
        "caption": "Blue jeans",
        "model": "<model>",
        "countryCode": "CA"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

issueFiscalReceipt

issueFiscalReceipt — mutation · Issue the fiscal receipt for a completed order or an issued invoice under a market’s fiscal scheme — the certified provider signs or clears it and the gap-free number is assigned.

Example request

mutation ExampleIssueFiscalReceipt($input: IssueFiscalReceiptInput!) {
  issueFiscalReceipt(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    parentKind
    regime
    logicalFacilityId
    seriesKey
    seq
    signature
    authorizationCode
    qrPayload
    partnerRef
  }
}

Variables:

{
  "input": {
    "parentKind": "<parent kind>",
    "parentId": "01900000-0000-7000-8000-065235280000",
    "regime": "<regime>"
  }
}

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

Example response

{
  "data": {
    "issueFiscalReceipt": {
      "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>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}