← InícioFleetPay / API

Baixar arquivo de origem da NF-e (XML ou PDF)

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/fiscal/nfe/{access_key}/arquivo
downloadNfeSourceBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Faz o download do arquivo de origem exato (XML autorizado ou DANFE em PDF) que gerou a NF-e nesta empresa. O arquivo é devolvido em stream com cabeçalho Content-Disposition.

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e e CIOT
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

access_keypath · stringObrigatório

Chave de acesso da NF-e, com 44 dígitos.

Restrições
{
  "type": "string",
  "pattern": "^\\d{44}$"
}

Respostas

200 Resposta HTTP

O arquivo da NF-e (XML ou PDF).

application/xml

application/pdf

Headers

Content-Disposition
Content-Type
401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

NF-e não encontrada (nfe_nao_encontrada) ou arquivo de origem não disponível (arquivo_nfe_nao_encontrado).

application/json

503 Resposta HTTP

Arquivo temporariamente indisponível no storage (arquivo_nfe_indisponivel).

application/json

Definição Completa da Operação
{
  "tags": [
    "NF-e"
  ],
  "summary": "Baixar arquivo de origem da NF-e (XML ou PDF)",
  "description": "Faz o download do arquivo de origem exato (XML autorizado ou DANFE em PDF) que gerou a\nNF-e nesta empresa. O arquivo é devolvido em stream com cabeçalho `Content-Disposition`.\n",
  "operationId": "downloadNfeSource",
  "responses": {
    "200": {
      "description": "O arquivo da NF-e (XML ou PDF).",
      "headers": {
        "Content-Disposition": {
          "schema": {
            "type": "string"
          }
        },
        "Content-Type": {
          "schema": {
            "type": "string"
          }
        }
      },
      "content": {
        "application/xml": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        },
        "application/pdf": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "description": "NF-e não encontrada (`nfe_nao_encontrada`) ou arquivo de origem não disponível (`arquivo_nfe_nao_encontrado`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorEnvelope"
          }
        }
      }
    },
    "503": {
      "description": "Arquivo temporariamente indisponível no storage (`arquivo_nfe_indisponivel`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorEnvelope"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "fiscal",
  "x-fleetpay-module": "fiscal-ciot",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/fiscal/nfe/{access_key}/arquivo",
  "parameters": [
    {
      "$ref": "#/components/parameters/NfeAccessKey"
    }
  ]
}