NFC-e
Query NFC-e
Returns status, QR Code, receipt and XML links and the echo of the issuance.
GET
/openapi/v2/empresas/{empresaId}/nfce/{nfceId}Requires the
token, timestamp and sign signature headers, see Authentication.Queries by the id sent at issuance. Download links need no signature and are re-issued on every query; see File download. The receipt is rendered on the first download; if the rendering service is busy the link returns 503 and a retry is enough.
Path parameters
empresaId* | string | Issuing company identifier |
nfceId* | string | NFC-e identifier |
* Required field
200
Invoice found.
id | string | Request identifier |
tipo | string | Document type |
status | string | Status |
motivoStatus | string | Reason |
ambienteEmissao | string | Issuing environment |
dataCriacao | string | Creation time |
dataUltimaAlteracao | string | Last change |
| object | Order |
| object | Consumer |
transporte | object | Transport |
numero | string | Invoice number |
serie | string | Series |
dataEmissao | string | Issue time |
chaveAcesso | string | Access key |
dataAutorizacao | string | Authorization time |
| object | Authorization protocol |
qrCode | string | QR Code content |
urlConsulta | string | Lookup URL by access key |
linkDanfe | string | Receipt PDF link |
linkDownloadXml | string | XML link |
emitidaEmContingencia | bool | Issued in contingency |
alertas | array | Authorization warnings |
| array | Items |
valorTotal | number | Invoice total |
statusStatus
While a cancellation is in progress the invoice stays Autorizada.
| Values | Meaning |
|---|---|
| AguardandoAutorizacao | Accepted, waiting for SEFAZ |
| Autorizada | Authorized by SEFAZ |
| Negada | Rejected by SEFAZ, or failed during platform processing; reason in motivoStatus |
| Cancelada | Cancelled |
| ContingenciaPendente | Issued offline while SEFAZ was down; the platform transmits it once SEFAZ is back |
| Code | HTTP | |
|---|---|---|
| 10022006 | 404 | nfceId not found for this company. |
| 10003000 | 404 | empresaId not found. |
