cte_uuidsarrayRequiredPublic UUIDs of authorized and available CT-e documents.
minItems1← HomeFleetPay / API
Create an MDF-e draft
Parameters, data structure and responses from the versioned contract.
POST
/fiscal/mdfeTechnical 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
No parameters declared for this operation.
Request Body
Required
application/json
vehicle_idintegerRequiredminimum1trailersarray | nullOptionalmaxItems3driver_user_idinteger | nullOptionalminimum1starts_atstring | null · dateOptionalends_atstring | null · dateOptionalorigin_city_codestring | nullOptionalpattern"^\\d{7}$"origin_citystring | nullOptionalmaxLength80origin_statestringRequiredminLength2maxLength2destination_city_codestring | nullOptionalpattern"^\\d{7}$"destination_citystring | nullOptionalmaxLength80destination_statestringRequiredminLength2maxLength2seguroobjectOptionalsalvar_seguro_padraoboolean | nullOptionalinfo_fiscostring | nullOptionalmaxLength2000observacoesstring | nullOptionalmaxLength5000resp_tecobjectOptionalseriestring | nullOptionalmaxLength3Responses
201 HTTP Response
Draft created.
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.
422 HTTP Response
Invalid payload, outstanding requirement or business rule.
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": "Criar rascunho de MDF-e",
"operationId": "createMdfe",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MdfeDraftInput"
}
}
}
},
"responses": {
"201": {
"description": "Rascunho criado.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/RequestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MdfeEnvelope"
}
}
},
"links": {
"ConsultarMdfe": {
"operationId": "getMdfe",
"parameters": {
"mdfe_uuid": "$response.body#/data/id"
}
},
"EmitirMdfe": {
"operationId": "issueMdfe",
"parameters": {
"mdfe_uuid": "$response.body#/data/id"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"422": {
"$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "POST",
"path": "/fiscal/mdfe",
"parameters": []
}