← InicioFleetPay / API

Descargar archivo fuente de la NF-e (XML o PDF)

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/fiscal/nfe/{access_key}/arquivo
downloadNfeSourceBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Descarga el archivo fuente exacto (XML autorizado o DANFE en PDF) que generó la NF-e en esta empresa. El archivo se entrega en stream con encabezado Content-Disposition.

Autenticación

Permiso Requerido
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e y CIOT
Perfiles Aplicables
Gestor de Transporte · Agregado Empresarial · Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

access_keypath · stringObligatorio

Clave de acceso de la NF-e, con 44 dígitos.

Restricciones
{
  "type": "string",
  "pattern": "^\\d{44}$"
}

Respuestas

200 Respuesta HTTP

El archivo de la NF-e (XML o PDF).

application/xml

application/pdf

Headers

Content-Disposition
Content-Type
401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

404 Respuesta HTTP

NF-e no encontrada (nfe_nao_encontrada) o archivo fuente no disponible (arquivo_nfe_nao_encontrado).

application/json

503 Respuesta HTTP

Archivo temporalmente no disponible en el almacenamiento (arquivo_nfe_indisponivel).

application/json

Definición Completa de la Operación
{
  "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"
    }
  ]
}