NFC-e
Consultar NFC-e
Devolve status, QR Code, links do cupom e do XML e o eco da emissão.
GET
/openapi/v2/empresas/{empresaId}/nfce/{nfceId}Requer os cabeçalhos de assinatura
token, timestamp e sign, veja Autenticação.Consulta pelo id enviado na emissão. Os links de download não exigem assinatura e são gerados de novo a cada consulta; veja Download de arquivos. O cupom é gerado no primeiro download; se o serviço de renderização estiver ocupado, o link devolve 503 e basta tentar de novo.
Parâmetros de caminho
empresaId* | string | Identificador da empresa emitente |
nfceId* | string | Identificador da NFC-e |
* Campo obrigatório
200
Nota encontrada.
id | string | Identificador da requisição |
tipo | string | Tipo de documento |
status | string | Status |
motivoStatus | string | Motivo |
ambienteEmissao | string | Ambiente de emissão |
dataCriacao | string | Data de criação |
dataUltimaAlteracao | string | Última alteração |
| object | Pedido |
| object | Consumidor |
transporte | object | Transporte |
numero | string | Número da nota |
serie | string | Série |
dataEmissao | string | Data de emissão |
chaveAcesso | string | Chave de acesso |
dataAutorizacao | string | Data de autorização |
| object | Protocolo de autorização |
qrCode | string | Conteúdo do QR Code |
urlConsulta | string | URL de consulta pela chave |
linkDanfe | string | Link do cupom em PDF |
linkDownloadXml | string | Link do XML |
emitidaEmContingencia | bool | Emitida em contingência |
alertas | array | Alertas da autorização |
| array | Itens |
valorTotal | number | Valor total da nota |
statusStatus
Durante um cancelamento em andamento a nota continua Autorizada.
| Valores | Significado |
|---|---|
| AguardandoAutorizacao | Aceita, aguardando a SEFAZ |
| Autorizada | Autorizada pela SEFAZ |
| Negada | Rejeitada pela SEFAZ, ou falhou no processamento da plataforma; motivo em motivoStatus |
| Cancelada | Cancelada |
| ContingenciaPendente | Emitida offline com a SEFAZ indisponível; a plataforma transmite quando ela voltar |
| Código | HTTP | |
|---|---|---|
| 10022006 | 404 | nfceId não encontrado nesta empresa. |
| 10003000 | 404 | empresaId não encontrado. |
