On this page
cannedFiscalRegimes
query · in the family Reading your records
What it does
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.
The AT-maintained canned fiscal-regime roster: issueFiscalReceipt must name a listed key (the refusal NAMES the roster). Unpaginated bounded roster (not a construct list). Requires authentication.
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:cannedFiscalRegimes
Returns
FiscalRegime [FiscalRegime!]! — One canned fiscal regime: merchants pick a key, never author regimes. model = signature (sign + gap-free number + journal; EU-typical) | clearance (the authority authorizes BEFORE issuing; LATAM/Québec-typical). US carries no row — no national regime exists.
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
}
}
}
}
}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)