Consulta NF-e

Nota fiscal eletrônica pela chave de acesso: situação (autorizada, cancelada), emitente, destinatário, produtos, totais e transporte.

consulta-nfeJSONPDFR$ 1,99

Resumo

Item	Valor
Identificador técnico	`consulta-nfe`
Dados exigidos	chave (chave de acesso, 44 dígitos) (no catálogo: `chave`)
O que devolve	JSON da NF-e (situação/eventos, emitente, destinatário, itens, totais, transporte) + PDF
Preço vigente	R$ 1,99. Com a sua chave, `GET /v1/servicos` traz o seu preço.
Prazo	Poucos minutos.
Bloco veiculo	Não
Observação	O retorno traz dados do destinatário da nota: use apenas para a finalidade da consulta e não redistribua.

Requisição

Pelo endpoint comum de consultas, POST /v1/consultas. Os valores do exemplo são fictícios.

cURLPOST /v1/consultas (consulta-nfe)

curl -X POST "https://api.zapcarconsulta.com.br/v1/consultas" \
  -H "Authorization: Bearer $ZAPCAR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-erp-984281-consulta-nfe" \
  -d '{"servico":"consulta-nfe","chave":"35240912345678000190550010000123451000123459"}'

Resposta

O POST devolve 201 com o id e status: "processando". O resultado sai em GET /v1/consultas/{id}, que passa por um destes estados:

status	O que vem
processando	Só o envelope. Consulte de novo em 3 a 5 s.
concluido	`dados` e `pdf_url`.
erro	Valor estornado. `erro_codigo` diz o motivo e `retryable` se vale criar uma consulta nova.

Campo dados

No formato da base consultada (camada de espelho): nomes e preenchimento acompanham a fonte. Para dado com forma garantida, use o bloco veiculo quando o serviço tiver.

JSONExemplo ilustrativo: campo dados (consulta-nfe)

{
  "dados_nfe": {
    "dados": { "modelo": "55", "serie": "1", "numero": "12345", "data_emissao": "10/09/2024 10:00:00-03:00", "valor_total_nfe": "98.500,00" },
    "situacao_atual": [ { "eventos_nfe": "Autorização de Uso", "protocolo": "135240000000001", "data_autorizacao": "10/09/2024 10:01:00" } ]
  },
  "dados_emitente": { "nome_razao_social": "CONCESSIONARIA EXEMPLO LTDA", "cnpj": "12.345.678/0001-90", "uf": "SP" },
  "dados_destinatario": { "nome_razao_social": "FULANO DE TAL", "cpf": "123.456.789-09", "uf": "SP" },
  "dados_produtos_servicos": [ { "numero": "1", "descricao": "VEICULO NOVO MODELO X", "valor": "98.500,00", "cod_ncm": "87032310" } ],
  "totais": { "icms": { "valor_total_nf": "98.500,00" } },
  "transporte": { "modalidade_frete": "9 - Sem Ocorrência de Transporte" }
}

Particularidades

chave: os 44 dígitos do DANFE, com ou sem espaços. O dígito verificador é conferido antes da cobrança: chave errada volta 400 CHAVE_NFE_INVALIDA sem debitar.
Para saber se a nota vale, leia dados.dados_nfe.situacao_atual[]: um evento de cancelamento invalida a nota mesmo com a autorização também na lista.

No sandbox

Confere o dígito verificador da chave como a produção. dados fictício no formato do serviço, sem bloco veiculo. Os cenários TST0404/TST0503 não se aplicam (não há placa).

Cobrança

Debitado no POST, antes do processamento, e estornado automaticamente se a consulta terminar em erro. Pedido recusado na validação (400, 402, 409, 422) não cobra. Ler o resultado e baixar o documento são gratuitos. Ver Cobrança e estorno.

Testar no sandbox: abrir no API Explorer. Base da API: https://api.zapcarconsulta.com.br.