- Guias de NFS-e
- Distribuição pela ADN
Guias de NFS-e
Distribuição pela ADN
Baixe as NFS-e em que a empresa aparece, pelo Ambiente de Dados Nacional.
O ADN (Ambiente de Dados Nacional) distribui os documentos fiscais em que a empresa aparece, por exemplo as NFS-e que ela recebeu como tomadora. Cada documento tem um número sequencial, o NSU.
A distribuição não emite nota. Ela baixa documentos de terceiros e não lista as NFS-e que você emitiu pela Treeunfe. Para essas, use Listar NFS-e.
A empresa precisa de um certificado A1 válido.
Sincronização (recomendado)
POST /nfse/distribute/sync é o caminho padrão. A Treeunfe retoma do último NSU baixado e consulta a ADN em lotes até ficar em dia ou atingir os limites:
{
"maxIterations": 10,
"maxDocuments": 100
}
| Campo | Descrição |
|---|---|
maxIterations | Máximo de consultas à ADN nesta chamada (1 a 50). |
maxDocuments | Máximo de documentos nesta chamada (1 a 500). |
cnpjConsulta | CNPJ do consulente (14 dígitos), se diferente do da empresa. |
Os XMLs ficam guardados na Treeunfe e o cursor de NSU é atualizado. Se ainda houver documentos, chame de novo.
Consulta pontual
POST /nfse/distribute faz uma única consulta a partir de um NSU:
| Campo | Descrição |
|---|---|
nsu | NSU inicial. Sem ele, a consulta continua do último NSU baixado. |
lote | true traz um lote de documentos; false (padrão) traz só um. |
cnpjConsulta | CNPJ do consulente (14 dígitos). |
Avisos por webhook
Com um webhook de produto NFSE, a Treeunfe avisa o seu sistema:
| Evento | Quando |
|---|---|
NFSE_DISTRIBUTION_BATCH | A cada lote com documentos novos. |
NFSE_DISTRIBUTION_SYNC_COMPLETED | Ao fim de uma sincronização. |
Documentos baixados
GET /nfse/distribute/documents lista o que já foi baixado, com paginação (page, pageSize) e filtro por faixa de NSU (fromNsu, toNsu).