← HomeFleetPay / API

Update an MDF-e draft

Parameters, data structure and responses from the versioned contract.

PUT/fiscal/mdfe/{mdfe_uuid}
updateMdfeSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Replaces editable draft data. Documents already submitted are immutable.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

mdfe_uuidpath · stringRequired

Public MDF-e UUID.

Constraints
{
  "type": "string",
  "format": "uuid"
}

Request Body

Required

application/json

cte_uuidsarrayRequired

Public UUIDs of authorized and available CT-e documents.

minItems1
vehicle_idintegerRequired
minimum1
trailersarray | nullOptional
maxItems3
driver_user_idinteger | nullOptional
minimum1
starts_atstring | null · dateOptional
ends_atstring | null · dateOptional
origin_city_codestring | nullOptional
pattern"^\\d{7}$"
origin_citystring | nullOptional
maxLength80
origin_statestringRequired
minLength2
maxLength2
destination_city_codestring | nullOptional
pattern"^\\d{7}$"
destination_citystring | nullOptional
maxLength80
destination_statestringRequired
minLength2
maxLength2
salvar_seguro_padraoboolean | nullOptional
info_fiscostring | nullOptional
maxLength2000
observacoesstring | nullOptional
maxLength5000
seriestring | nullOptional
maxLength3

Responses

200 HTTP Response

MDF-e found.

application/json

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

application/json

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

application/json

Headers

X-Request-Id

Call correlation identifier.

404 HTTP Response

Resource not found in the authenticated tenant.

application/json

Headers

X-Request-Id

Call correlation identifier.

422 HTTP Response

Invalid payload, outstanding requirement or business rule.

application/json

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

application/json

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

application/json

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition
{
  "tags": [
    "MDF-e"
  ],
  "summary": "Atualizar rascunho de MDF-e",
  "description": "Substitui os dados editáveis do rascunho. Documentos já enviados são imutáveis.",
  "operationId": "updateMdfe",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MdfeDraftInput"
        }
      }
    }
  },
  "responses": {
    "200": {
      "$ref": "#/components/responses/MdfeOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "PUT",
  "path": "/fiscal/mdfe/{mdfe_uuid}",
  "parameters": [
    {
      "$ref": "#/components/parameters/MdfeUuid"
    }
  ]
}