Documentação › Emissão de NFS-e
Emissão em lote
Até 5.000 notas numa chamada, por JSON ou planilha, com resultado e reprocessamento por linha.
Até 5.000 notas numa chamada, por JSON ou pela planilha do painel, com
resultado por linha. Mesmo motor da emissão avulsa e da planilha. Mande
sempre referencia em cada item: é o que torna seguro reenviar o lote.
POST /v1/lotes --202--> validando
|
ao_validar = emitir_validas ao_validar = aguardar
| |
| aguardando_emissao
| |
| POST /v1/lotes/{id}/emissao
v v
processando (as notas transmitindo)
|
v
concluido --> webhook LOTE_EMISSAO_CONCLUIDO
| Etapa | Rota | O que acontece |
|---|---|---|
| Criar | POST /v1/lotes |
Sempre 202. Prontidão com bloqueio é 412, e nada é criado. |
| Acompanhar | GET /v1/lotes/{id} |
status: validando, aguardando_emissao, processando, concluido ou erro, e as contagens. |
| Resultado por linha | GET /v1/lotes/{id}/itens |
Cada linha com o status da nota, ou com_erro_validacao, aguardando_emissao, ja_existente. |
Emitir (com aguardar) |
POST /v1/lotes/{id}/emissao |
"todas" ou uma lista de linhas. Uma vez só. |
| Corrigir e emitir de novo | POST /v1/lotes/{id}/reprocessamento |
Só linhas com erro, rejeitada ou falha_transmissao com dps_enviada: "nao". |
| Relatório | GET /v1/lotes/{id}/relatorio |
A planilha com o resultado de cada linha. |
Limites: 5.000 itens com a chave de produção, 100 com a de teste. JSON
até 30 MB, planilha até 20 MB. Um POST /v1/lotes conta como uma chamada no
limite de requisições. Itens de lote entram na fila atrás das notas avulsas.
Não confunda validar com emitir. A validação roda sempre, logo depois de
criar o lote. Com emitir_validas (padrão), as linhas válidas são emitidas em
seguida. Com aguardar, nada é emitido até você chamar
POST /v1/lotes/{id}/emissao.
Mande referencia em todo item: é o que torna seguro mandar o lote de novo.
Veja Idempotência.
Rotas desta seção, com teste na página
- GET/v1/lotes · Lista os lotes
- POST/v1/lotes · Cria um lote de emissão
- GET/v1/lotes/{id} · Consulta um lote
- GET/v1/lotes/{id}/itens · Resultado por linha
- GET/v1/lotes/{id}/relatorio · Relatório em planilha
- POST/v1/lotes/{id}/emissao · Manda emitir um lote que aguardava
- POST/v1/lotes/{id}/reprocessamento · Corrige linhas e emite de novo