Download em Massa

Esta funcionalidade é responsável por disponibilizar um link para realização do download dos XMLs emitidos em um período e funciona de modo assíncrono, ou seja, é necessário agendar o download e posteriormente consultar o agendamento para obter o status do processamento e link para download dos arquivos. 

Importante

Não serão permitidos períodos de agendamento superiores a um mês.

Agendamento de Download

• API: /hubservices/Download/Send
• Método: POST
• Header: 
  • Authorization: Token de autorização
  • Content-Type: application/json

Dados dos parâmetros de envio:

Tag	Descrição	Obrig.
cnpj	CNPJ do emissor	Sim
dataInicial	Data de início do período de emissão	Sim
dataFinal	Data final do período de emissão	Sim
nfNumeroIni	Numeração inicial dos documentos	Não
nfNumeroFim	Numeração final dos documentos	Não
nfSerie	Série dos documentos	Não
statusNota	Status final dos documentos NF-e/NFC-e: 2 - Autorizado; 4 - Cancelado; 5 - Inutilizado; 6 – Denegado CF-e SAT: 17 - Autorizado SAT; 18 - Autorizado Sefaz-SAT; 19 - Cancelado SAT; 20 - Cancelado Sefaz-SATF-e/NFC-e	Não
tipoProduto	Tipo do Documento que será realizado download. Opções: 1= NF-e; 2 = NFC-e/CF-e SAT	Não

---

Campo tipoProduto

Caso não seja informado o tipoProduto a Solução Fiscal irá disponibilizar todos os tipos de documento disponíveis para o emissor solicitante.

Exemplo Payload de Envio

{
 "cnpj": "54517628001593",
 "dataInicial": "2023-06-01",
 "dataFinal": "2023-06-30,
 "nfNumeroIni": 1,
 "nfNumeroFim": 2,
 "nfSerie": "1",
 "statusNota": 0,
 "tipoProduto": 1
 }

Exemplo Payload de Retorno

{
 "idDownload": "b1b13517d1d54458a1b6d3bae0dbff60"
}

---

Possíveis retornos HTTP

• 200 - Sucesso
• 400 – BadRequest
  • Caso tenha algum problema nas informações enviadas, causando falha na Solução Fiscal 
• 401 - Unauthorized
• 404 – NotFound
• 429 - TooManyRequests
• 500 - InternalServerError
• 503 - Service Unavailable

---

Consulta Agendamento de Download

• API: /hubservices/Download/Search?
• Método: GET
• Parâmetros 
  • Cnpj: CNPJ emissor dos documentos 
  • idDownload: Identificador retornado no momento do agendamento
• Header: 
  • Authorization: Token de autorização
  • Content-Type: application/json

Exemplo Payload de Envio

{
/hubservices/Download/Search?cnpj=50354031000119&idDownload=04cdc58409044d3bb5440309f07ca36b
}

Exemplo Payload de Retorno

[
 {
   "cnpjs": "50354031000119",
   "nfSerie": null,
   "nfNumeroIni": 0,
   "nfNumeroFim": 0,
   "dataInclusao": "2025-03-14T16:33:35.833",
   "dataAlteracao": "2025-03-14T16:33:37.173",
   "dataConclusao": "2025-03-14T16:33:37.173",
   "tipoProduto": 2,
   "total": 0,
   "url": null,
   "idDownloadGuid": "04cdc584-0904-4d3b-b544-0309f07ca36b",
   "dataInicial": "2023-06-01T00:00:00",
   "dataFinal": "2023-06-30T00:00:00",
   "email": null,
   "statusDownload": 3,
   "idDownload": "04cdc58409044d3bb5440309f07ca36b"
  }
]

---

Abaixo segue o detalhamento dos possíveis retornos no parâmetro **statusDownload**

• 1 – Pendente. Aguardar para próxima consulta
• 2 – Processando. Aguardar para próxima consulta
• 3 – Finalizado, mas sem documentos para disponibilizar
• 7 – Finalizado, mas com falha na disponibilização
• 10 – Finalizado com sucesso

---

Possíveis retornos HTTP

• 200 - Sucesso
• 400 – BadRequest
  • Caso tenha algum problema nas informações enviadas, causando falha na Solução Fiscal 
• 401 - Unauthorized
• 404 – NotFound
• 429 - TooManyRequests
• 500 - InternalServerError
• 503 - Service Unavailable