NF3Docs
Chaves da API
PLATAFORMA DE INTEGRAÇÕES

Fluxo de emissão

Rascunho, revisão, transmissão e resultado.

Da preparação ao documento autorizado

1. Prepare um rascunho

Faça POST em /homologation/nfe ou /homologation/nfse, conforme o documento. Em produção, use o prefixo /production. Envie JSON e uma Idempotency-Key UUID exclusiva para a operação.

A resposta 201 significa que o rascunho foi preparado, não que a nota foi autorizada. A preparação pode consultar certificado e parâmetros fiscais. A NFS-e pode consultar CNC e parâmetros municipais, sem transmitir a DPS nessa etapa.

2. Consulte e revise

Faça GET no documento preparado. Confira empresa, destinatário ou tomador, serviço ou produtos, valores, tributação e numeração. Guarde o reviewed_hash da revisão atual.

3. Confirme a transmissão

Use POST .../{id}/transmissions, com outra Idempotency-Key, confirmed: true e o reviewed_hash conferido. A resposta 202 registra a solicitação em fila e retorna seu request_id.

4. Acompanhe o resultado

Consulte .../requests/{request_id} e o documento. Os estados da operação são queued, running, completed, failed e unknown. Uma operação concluída também pode conter rejeição: confira o resultado fiscal e o status da nota.

5. Reconcilie uma resposta incerta

Se houver tentativa sending ou unknown, consulte a tentativa persistida e use sua operação de reconciliação. A reconciliação consulta o autorizador; não repete a transmissão.

Os campos de série e número da API seguem seu contrato explícito; não presuma a numeração do formulário web. Os builders validam os tratamentos fiscais suportados e as configurações da empresa.

Buscar na documentação

Use ↑ ↓ para navegar e Enter para abrir.