O que esta API cobre — e o que não cobre
A API GaxDfe baixa os documentos que trafegam pela SEFAZ. O parâmetro modelo aceita:
modelo |
Documento |
|---|---|
| 55 | NF-e — Nota Fiscal Eletrônica |
| 57 | CT-e — Conhecimento de Transporte Eletrônico |
| 59 | CF-e/SAT — Cupom Fiscal Eletrônico |
| 65 | NFC-e — Nota Fiscal de Consumidor Eletrônica |
| 67 | CT-e OS — CT-e Outros Serviços |
⛔ A API GaxDfe não baixa NFS-e. A nota de serviço é municipal, não trafega na Distribuição de DF-e da SEFAZ e não está nesta API. Atenção especialmente ao modelo=59: ele é CF-e/SAT, não NFS-e.
✅ Para obter as NFS-e em arquivo, use a tela de Documentos → Exportação do GaxWeb, que gera XML e PDF por período.
Endpoint:
https://app.nssoft.com.br/webservice/gaxdfe/monitor/zip/
Parâmetros:
- modelo — 55, 57, 59, 65 ou 67 (ex:
modelo=55) — ver a tabela acima - empresa — CPF/CNPJ da empresa, somente números (ex:
empresa=12345678000123) - emissao — data de emissão no formato YYYY-mm-dd (Ano-mês-dia) (ex:
emissao=2022-12-30) - eventos — true ou false. Exporta os eventos do documento (somente zip). (ex:
eventos=true) - pdf — true ou false. Exporta o PDF do documento (somente zip). (ex:
pdf=true)
periodo (a partir de):
48h→ últimas 48 horas7d→ últimos 7 dias15d→ últimos 15 dias0m→ mês atual1m→ mês anterior2m→ últimos 2 meses3m→ últimos 3 meses4m→ últimos 4 meses5m→ últimos 5 meses6m→ últimos 6 meses1y→ ano atual2y→ últimos 2 anos3y→ últimos 3 anos4y→ últimos 4 anos5y→ últimos 5 anos
(ex: periodo=48h)
Exemplos
É necessário enviar o header appkey: {APPKEY} na requisição. ⚠️ A APPKEY vai sempre no header, nunca dentro da URL.
Chave única (ex.: 35250192791243002157550020004685301267323702):
curl https://app.nssoft.com.br/webservice/gaxdfe/nfe/{CHAVE}/zip -H "appkey: {APPKEY}"
Lote NFe mod 55, últimos 2 meses da empresa (sem eventos):
curl "https://app.nssoft.com.br/webservice/gaxdfe/monitor/zip?modelo=55&periodo=2m&empresa=12345678000123" -H "appkey: {APPKEY}"
Lote NFe mod 55, últimos 2 meses da empresa (com eventos):
curl "https://app.nssoft.com.br/webservice/gaxdfe/monitor/zip?modelo=55&periodo=2m&empresa=12345678000123&eventos=true" -H "appkey: {APPKEY}"
Retorno:
Em caso de sucesso retorna HTTP 200 e o arquivo anexo. Neste caso, continue enviando requisições até que não encontre mais documentos, quando retornará HTTP 204 (não há mais arquivos a baixar para esta requisição). Como cada requisição retorna no máximo 1000 arquivos por solicitação, repita as requisições até obter HTTP 204.
Erros:
- Erros de permissão retornam HTTP 403 (Forbidden).
- Demais erros retornam HTTP 400 e a mensagem de erro.
Importante:
A APPKEY está disponível em um terminal criado no menu Aplicações → GaxDFe. Os arquivos baixados são automaticamente registrados na lista de download e não serão baixados novamente em uma nova requisição — portanto, atenção ao baixar para não remover ou perder o arquivo. Caso precise baixar novamente, faça contato com o suporte pelo chat e solicite o desbloqueio dos arquivos já baixados.
Em caso de dúvida, fale com o suporte pelo chat.