access_keypath · stringObrigatórioChave de acesso da NF-e, com 44 dígitos.
Restrições
{
"type": "string",
"pattern": "^\\d{44}$"
}← InícioFleetPay / API
Consultar NF-e
Parâmetros, estrutura de dados e respostas do contrato versionado.
GET
/fiscal/nfe/{access_key}Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Autenticação
[
{
"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
Respostas
200 Resposta HTTP
NF-e encontrada.
Headers
X-Request-IdIdentificador de correlação da chamada.
401 Resposta HTTP
Chave de API FleetPay ausente ou inválida.
Headers
X-Request-IdIdentificador de correlação da chamada.
403 Resposta HTTP
Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.
Headers
X-Request-IdIdentificador de correlação da chamada.
404 Resposta HTTP
Recurso não encontrado no tenant autenticado.
Headers
X-Request-IdIdentificador de correlação da chamada.
429 Resposta HTTP
Limite por transportadora excedido.
Headers
X-Request-IdIdentificador de correlação da chamada.
Retry-AfterSegundos até uma nova tentativa.
500 Resposta HTTP
Falha interna sem detalhes de integrações operacionais.
Headers
X-Request-IdIdentificador de correlação da chamada.
Definição Completa da Operação
{
"tags": [
"NF-e"
],
"summary": "Consultar NF-e",
"operationId": "getNfe",
"responses": {
"200": {
"$ref": "#/components/responses/NfeOk"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "GET",
"path": "/fiscal/nfe/{access_key}",
"parameters": [
{
"$ref": "#/components/parameters/NfeAccessKey"
}
]
}