access_keypath · stringObrigatórioChave de acesso da NF-e, com 44 dígitos.
Restrições
{
"type": "string",
"pattern": "^\\d{44}$"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/fiscal/nfe/{access_key}/arquivoDescriçõ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.
fiscal — Fiscal[
{
"oauth2": []
},
{
"chaveApi": []
}
]access_keypath · stringObrigatórioChave de acesso da NF-e, com 44 dígitos.
{
"type": "string",
"pattern": "^\\d{44}$"
}200 Resposta HTTPO arquivo da NF-e (XML ou PDF).
application/xmlapplication/pdfContent-DispositionContent-Type401 Resposta HTTPChave de API FleetPay ausente ou inválida.
X-Request-IdIdentificador de correlação da chamada.
403 Resposta HTTPEscopo fiscal desabilitado na chave, ou chave sem transportadora ativa.
X-Request-IdIdentificador de correlação da chamada.
404 Resposta HTTPNF-e não encontrada (nfe_nao_encontrada) ou arquivo de origem não disponível (arquivo_nfe_nao_encontrado).
503 Resposta HTTPArquivo temporariamente indisponível no storage (arquivo_nfe_indisponivel).
{
"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"
}
]
}