Arquivos: XML e DANFSe
Depois que a prefeitura autoriza, os arquivos ficam disponíveis por job_id.
GET /v1/nfse/{job_id}/file/{tipo}
tipo | Conteúdo |
|---|---|
xml | XML da NFS-e autorizada, como o provedor devolveu |
pdf | DANFSe |
xml_cancelamento | XML do cancelamento, quando houver |
log | log técnico do processamento |
As rotas genéricas por job também servem, e são as mesmas para qualquer documento:
GET /v1/jobs/{job_id}/arquivos # o que existe para este job
GET /v1/jobs/{job_id}/file/{tipo} # baixa o arquivo
GET /v1/jobs/{job_id}/download/{tipo} # devolve a URL assinada, sem baixar
GET /v1/jobs/{job_id}/arquivos lista o que existe, com tamanho e URL pronta. Um job de
cancelamento, por exemplo, tem xml_cancelamento e log, mas não tem xml.
O XML da NFS-e não tem um layout único
Na NF-e o XML segue um layout nacional e único. Na NFS-e, o que você recebe depende de quem autorizou:
- no Padrão Nacional, o XML segue o layout da NFS-e nacional;
- em municípios com sistema próprio, o XML é o do provedor daquele município.
Se a sua aplicação faz parsing do XML da NFS-e, ela precisa saber com qual provedor está lidando. Ver Provedores.
O pdf é o DANFSe, gerado por nós a partir do XML autorizado. Ele é uma representação — como o
DANFE para a NF-e — e não substitui o XML.
Guarde o XML
A obrigação de guarda recai sobre o XML autorizado. O DANFSe pode ser regerado a partir dele; o contrário não é verdade.
A retenção dos arquivos no Conota depende do plano. Sua operação deve armazenar os XMLs no próprio ambiente — não trate a API como arquivo definitivo.
Pacotes mensais
Para fechamento contábil, o Conota gera pacotes ZIP com os XMLs do mês anterior:
GET /v1/arquivos/zips # o que está disponível
GET /v1/arquivos/zip-mensal?tipo=nfse&competencia=2026-08 # baixa
Repare no tipo=nfse: cada tipo de documento tem o seu pacote. Os ZIPs são gerados no dia 1º de
cada mês e o download vem por URL assinada, com validade curta.