cte_uuidsarrayObrigatórioUUIDs públicos de CT-e autorizados e disponíveis.
minItems1← InícioFleetPay / API
Criar rascunho de MDF-e
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/fiscal/mdfeDescriçõ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
Nenhum parâmetro declarado nesta operação.
Corpo da Requisição
Obrigatório
application/json
vehicle_idintegerObrigatóriominimum1trailersarray | nullOpcionalmaxItems3driver_user_idinteger | nullOpcionalminimum1starts_atstring | null · dateOpcionalends_atstring | null · dateOpcionalorigin_city_codestring | nullOpcionalpattern"^\\d{7}$"origin_citystring | nullOpcionalmaxLength80origin_statestringObrigatóriominLength2maxLength2destination_city_codestring | nullOpcionalpattern"^\\d{7}$"destination_citystring | nullOpcionalmaxLength80destination_statestringObrigatóriominLength2maxLength2seguroobjectOpcionalsalvar_seguro_padraoboolean | nullOpcionalinfo_fiscostring | nullOpcionalmaxLength2000observacoesstring | nullOpcionalmaxLength5000resp_tecobjectOpcionalseriestring | nullOpcionalmaxLength3Respostas
201 Resposta HTTP
Rascunho criado.
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.
422 Resposta HTTP
Payload inválido, pendência ou regra de negócio.
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": [
"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": []
}