← InícioFleetPay / API

Atualizar rascunho de MDF-e

Parâmetros, estrutura de dados e respostas do contrato versionado.

PUT/fiscal/mdfe/{mdfe_uuid}
updateMdfeBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Substitui os dados editáveis do rascunho. Documentos já enviados são imutáveis.

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

mdfe_uuidpath · stringObrigatório

UUID público do MDF-e.

Restrições
{
  "type": "string",
  "format": "uuid"
}

Corpo da Requisição

Obrigatório

application/json

cte_uuidsarrayObrigatório

UUIDs públicos de CT-e autorizados e disponíveis.

minItems1
vehicle_idintegerObrigatório
minimum1
trailersarray | nullOpcional
maxItems3
driver_user_idinteger | nullOpcional
minimum1
starts_atstring | null · dateOpcional
ends_atstring | null · dateOpcional
origin_city_codestring | nullOpcional
pattern"^\\d{7}$"
origin_citystring | nullOpcional
maxLength80
origin_statestringObrigatório
minLength2
maxLength2
destination_city_codestring | nullOpcional
pattern"^\\d{7}$"
destination_citystring | nullOpcional
maxLength80
destination_statestringObrigatório
minLength2
maxLength2
salvar_seguro_padraoboolean | nullOpcional
info_fiscostring | nullOpcional
maxLength2000
observacoesstring | nullOpcional
maxLength5000
seriestring | nullOpcional
maxLength3

Respostas

200 Resposta HTTP

MDF-e encontrado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

Recurso não encontrado no tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

422 Resposta HTTP

Payload inválido, pendência ou regra de negócio.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

429 Resposta HTTP

Limite por transportadora excedido.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

Retry-After

Segundos até uma nova tentativa.

500 Resposta HTTP

Falha interna sem detalhes de integrações operacionais.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação
{
  "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"
    }
  ]
}