Download e Recuperação de Documentos

Informações Gerais

Esta API permite o download em massa de documentos fiscais emitidos em um determinado período, de forma assíncrona.

O processo é composto por duas etapas:

• Agendamento de Download

• Consulta de Download

O serviço é indicado para processos de auditoria, guarda externa, conciliação fiscal e necessidade de recuperação em massa de XMLs.

Ambientes

• Integração Direta: 
  • HML: https://api-hml.fiscalpartners.com.br
  • PRD: https://api.fiscalpartners.com.br
• Autenticação: V2

Ver: Autenticações

---

Download XML em Massa

Agendamento de Download

• Endpoint /downloadschedule/send?api-version=2
• Método: POST
• Header:
  • AuthorizationToken: Token de autorização
  • Content-Type: application/json

Dados dos parâmetros de envio:

Campo	Descrição	Conteúdo / Observação	Obrigatório
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
Email	E-mail para recepção do link de download. Obs:	Caso informado mais de um e-mail, separar por ponto e vírgula (;)	Não
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. Caso não seja informado o tipoProduto serão disponibilizados todos os tipos de documento disponíveis para o emissor solicitante.	1= NF-e; 2 = NFC-e/CF-e SAT 5 = NF-e Entrada	Não
tipoDataDownload	Informar fixo 2	Sim

Exemplo de payload de Envio

{
    "cnpj":"11111111001593",
    "dataInicial":"2023-08-01T00:00:00-00:00",
    "dataFinal": "2023-08-10T23:59:59-00:00",
    "email": "tiago.1@linx.com.br",
    "nfNumeroIni":0,
    "nfNumeroFim":0,
    "nfSerie":"",
    "statusNota":0,
    "tipoDataDownload":2,
    "tipoProduto":2
}

Exemplo de Payload de Retorno

{
 "idDownload": "b1b13517d1d54458a1b6d3bae0dbff60"
}

---

Consulta de Download

• Endpoint : /downloadschedule/search
• Método: GET
• Header:
  • AuthorizationToken: Token de autorização
  • Content-Type: application/json
• Parâmetros :
  • Cnpj: CNPJ emissor dos documentos 
  • idDownload: Identificador retornado no momento do agendamento

Exemplo de Payload de Retorno

{
 "cnpjs": "11111111000119",
 "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": 752,
 "url": "https://downloadxmlhml......",
 "idDownloadGuid": "04cdc584-0904-4d3b-b544-0309f07ca36b",
 "dataInicial": "2023-06-01T00:00:00",
 "dataFinal": "2023-06-30T00:00:00",
 "email": "email@email.com.br",
 "statusDownload": 10,
 "idDownload": "04cdc58409044d3bb5440309f07ca36b"
}

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 - OK
• 400 - BadRequest
• 401- Unauthorized
• 404 - NotFound
• 500 - InternalServerError
• 503 – Service Unavailable