On this page
fiscalReceipt
query · in the family Reading your records
What it does
Look up one fiscal receipt — the legal tax artifact of a sale: its sequential fiscal number, signature or authorization code, and the QR the printed receipt shows.
ONE fiscal receipt by id, within your org group. Requires authentication (template class).
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:fiscalReceipt
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
FiscalReceipt — A FiscalReceipt: the gap-free sequential fiscal number + the regime's signature (model A) or clearance authorization code (model B) + the QR payload the printed receipt renders. IMMUTABLE once issued — no edit, no transitions, no doom (the ⚑none artifact class; status is the one literal 'issued' forever). Certified partners produce the artifact fields — the caller never supplies them.
Example request
query ExampleFiscalReceipt($id: ID!) {
fiscalReceipt(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
parentKind
regime
logicalFacilityId
seriesKey
seq
signature
authorizationCode
qrPayload
partnerRef
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"fiscalReceipt": {
"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": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)