Fiscal
Org-level NFS-e fiscal-document reads and short-lived artifact downloads.
Fiscal documents are legal artifacts, not usage-summary invoices. Reads require
fiscal:read, are organization-scoped, and stay reachable even when production credit is exhausted.List documents
GET/v1/fiscal/nfse
Query params
| Field | Type | Notes |
|---|---|---|
limitrequired | integer | Maximum number of items to return. Defaults to 20; maximum 100. range 1..100 |
starting_after | string | Opaque cursor from the previous response next_cursor. |
status | "pending" | "authorized" | "rejected" | "blocked" | "canceled" | "substituted" | Optional fiscal document status filter. |
source_kind | "consumption_period" | "subscription_term" | Optional taxable-event source filter. |
Response
| Field | Type | Notes |
|---|---|---|
objectrequired | "list" | |
datarequired | object[] | |
has_morerequired | boolean | |
next_cursorrequired | string | null |
Retrieve a document
GET/v1/fiscal/nfse/{'{id}'}
Response
| Field | Type | Notes |
|---|---|---|
idrequired | string | |
objectrequired | "fiscal_document" | |
organization_idrequired | string | |
statusrequired | "pending" | "authorized" | "rejected" | "blocked" | "canceled" | "substituted" | |
source_kindrequired | "consumption_period" | "subscription_term" | |
source_idrequired | string | |
serierequired | string | |
numerorequired | integer | range -9007199254740991..9007199254740991 |
chave_acessorequired | string | null | |
amount_brlrequired | string | |
competence_daterequired | string<ISO-8601> | null | |
receipt_daterequired | string<ISO-8601> | null | |
cancellation_deadline_atrequired | string<ISO-8601> | null | |
rejection_cstatrequired | string | null | |
rejection_reasonrequired | string | null | |
danfse_availablerequired | boolean | |
xml_availablerequired | boolean | |
created_atrequired | string<ISO-8601> | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ |
updated_atrequired | string<ISO-8601> | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ |
Download artifacts
Authorized documents expose 15-minute presigned URLs for the DANFSE PDF and authorized NFS-e XML. If an artifact is not ready, the API returns fiscal_document_not_ready.
GET/v1/fiscal/nfse/{'{id}'}/danfse
GET/v1/fiscal/nfse/{'{id}'}/xml
Response
| Field | Type | Notes |
|---|---|---|
objectrequired | "fiscal_document_download" | |
fiscal_document_idrequired | string | |
artifactrequired | "danfse" | "xml" | |
urlrequired | string | |
expires_atrequired | string<ISO-8601> | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ |