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 |
terminal | string | Identificação do caixa |
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 |
tipoTipo do documento
| Valores | Significado |
|---|---|
| NFC-e | Nota fiscal de consumidor eletrônica; sempre este valor |
ambienteEmissaoAmbiente de emissão
| Valores | Significado |
|---|---|
| Homologacao | Ambiente de teste da SEFAZ; a nota não tem validade |
| Producao | Ambiente oficial |
pedido.presencaConsumidorPresença do consumidor
| Valores | Significado |
|---|---|
| OperacaoPresencial | Venda presencial na loja; não envie transportadora |
| EntregaEmDomicilio | Venda não presencial com entrega; exige cliente com documento e endereço, e transporte.transportadora; o local de entrega fica no estado do emitente |
| OperacaoPresencialForaDoEstabelecimento | Venda presencial fora da loja, como feira ou ambulante; não envie transportadora |
pedido.pagamento.formas[].tipoTipo de pagamento
Ecoado da emissão.
| Valores | Significado |
|---|---|
| Dinheiro | Dinheiro; pode gerar troco |
| Cheque | Cheque |
| CartaoDeCredito | Cartão de crédito; muitos estados exigem credenciadoraCartao |
| CartaoDeDebito | Cartão de débito; muitos estados exigem credenciadoraCartao |
| CreditoLoja | Crédito na loja, venda a prazo |
| ValeAlimentacao | Vale-alimentação; aceita credenciadoraCartao |
| ValeRefeicao | Vale-refeição; aceita credenciadoraCartao |
| ValePresente | Vale-presente; aceita credenciadoraCartao |
| ValeCombustivel | Vale-combustível; aceita credenciadoraCartao |
| BoletoBancario | Boleto bancário; aceita credenciadoraCartao |
| DepositoBancario | Depósito bancário |
| PagamentoInstantaneoPix | Pix dinâmico; muitos estados exigem credenciadoraCartao |
| TransferenciaBancaria | Transferência bancária; aceita credenciadoraCartao |
| ProgramaDeFidelidade | Programa de fidelidade ou cashback |
| PagamentoInstantaneoPixEstatico | Pix estático: QR Code estático, chave Pix ou dados da conta |
| CreditoEmLoja | Saldo em loja de pagamento anterior ou devolução |
| PagamentoEletronicoNaoInformado | Pagamento eletrônico não informado; só quando falha de hardware impede integrar o pagamento e a emissão offline |
| PagamentoInstantaneoPixAutomatico | Pix automático, cobrança recorrente |
| TransferenciaTefBookTransfer | Transferência TEF entre contas do mesmo banco |
| PagamentoPosterior | Pagamento posterior; valor 0, a soma pode ficar abaixo do total e não há troco |
| Outros | Outros; exige descricao |
cliente.endereco.ufEstado do consumidor
Ecoado da emissão; sempre o estado do emitente.
| Valores | Significado |
|---|---|
| AC | Acre |
| AL | Alagoas |
| AP | Amapá |
| AM | Amazonas |
| BA | Bahia |
| CE | Ceará |
| DF | Distrito Federal |
| ES | Espírito Santo |
| GO | Goiás |
| MA | Maranhão |
| MT | Mato Grosso |
| MS | Mato Grosso do Sul |
| MG | Minas Gerais |
| PA | Pará |
| PB | Paraíba |
| PR | Paraná |
| PE | Pernambuco |
| PI | Piauí |
| RJ | Rio de Janeiro |
| RN | Rio Grande do Norte |
| RS | Rio Grande do Sul |
| RO | Rondônia |
| RR | Roraima |
| SC | Santa Catarina |
| SP | São Paulo |
| SE | Sergipe |
| TO | Tocantins |
transporte.frete.modalidadeModalidade do frete
| Valores | Significado |
|---|---|
| SemFrete | Sem frete |
| PorContaDoEmitente | Frete por conta do vendedor |
| PorContaDoDestinatario | Frete por conta do comprador |
| PorContaDeTerceiros | Frete por conta de terceiros |
| TransporteProprioPorContaDoRemetente | Transporte próprio do vendedor |
| TransporteProprioPorContaDoDestinatario | Transporte próprio do comprador |
itens[].cfopCFOP aceitos na NFC-e
Ecoado da emissão.
| Valores | Significado |
|---|---|
| 5101 | Venda de produção própria. ICMS sem ST: CST 00 / 20 / 40 / 41 / 90 ou CSOSN 102 / 103 / 300 / 400 / 900 |
| 5102 | Revenda de mercadoria de terceiros. Mesmos códigos sem ST do 5101 |
| 5103 | Venda de produção própria fora do estabelecimento. Mesmos códigos sem ST do 5101 |
| 5104 | Revenda de mercadoria de terceiros fora do estabelecimento. Mesmos códigos sem ST do 5101 |
| 5115 | Venda de mercadoria recebida em consignação mercantil. Mesmos códigos sem ST do 5101 |
| 5405 | Venda de mercadoria com ICMS já retido por ST. CST 60 ou CSOSN 500 |
| 5656 | Venda de combustível a consumidor final. Exige o bloco combustivel; CST 60 / 61 ou CSOSN 500 |
| 5667 | Venda de combustível a consumidor final fora do estabelecimento. Exige o bloco combustivel; CST 60 / 61 ou CSOSN 500 |
| 5910 | Brinde ou bonificação. Aceita os códigos com e sem ST |
| 5933 | Serviço tributado pelo ISSQN. Exige impostos.issqn em vez de icms e ncm = 00; a nota precisa de ao menos uma linha de mercadoria |
| Código | HTTP | |
|---|---|---|
| 10022006 | 404 | nfceId não encontrado nesta empresa. |
| 10003000 | 404 | empresaId não encontrado. |
