mdfe_uuidpath · stringRequiredPublic MDF-e UUID.
Constraints
{
"type": "string",
"format": "uuid"
}← HomeFleetPay / API
Get an MDF-e document
Parameters, data structure and responses from the versioned contract.
GET
/fiscal/mdfe/{mdfe_uuid}Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Authentication
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.
Parameters
Responses
200 HTTP Response
MDF-e found.
Headers
X-Request-IdCall correlation identifier.
401 HTTP Response
FleetPay API key missing or invalid.
Headers
X-Request-IdCall correlation identifier.
403 HTTP Response
Fiscal scope disabled for the key, or no active carrier associated with the key.
Headers
X-Request-IdCall correlation identifier.
404 HTTP Response
Resource not found in the authenticated tenant.
Headers
X-Request-IdCall correlation identifier.
429 HTTP Response
Per-carrier limit exceeded.
Headers
X-Request-IdCall correlation identifier.
Retry-AfterSeconds until another attempt.
500 HTTP Response
Internal failure without operational integration details.
Headers
X-Request-IdCall correlation identifier.
Complete Operation Definition
{
"tags": [
"MDF-e"
],
"summary": "Consultar MDF-e",
"operationId": "getMdfe",
"responses": {
"200": {
"$ref": "#/components/responses/MdfeOk"
},
"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/mdfe/{mdfe_uuid}",
"parameters": [
{
"$ref": "#/components/parameters/MdfeUuid"
}
]
}