Liberar a parcela N de todos os CT-e de um MDF-e

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

POST/carriers/parcelas-repasse/liberar-por-mdfe

liberarParcelasPorMdfeBase 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.

A liberação em lote pelo manifesto: informe o MDF-e (uuid, chave de acesso ou número) e a posição, e a FleetPay aplica liberar a cada CT-e vinculado à viagem — inclusive os contra-CT-e de um lote de subcontratação — devolvendo um resultado por CT-e. Uma recusa numa linha não impede as outras.

Três regras que valem a pena saber antes de chamar:

Só parcelas que já existem. A parcela nasce na bipagem; o MDF-e não é tratado como evento de coleta. CT-e do manifesto ainda sem parcela na posição responde recusada / parcela_inexistente na linha dele.
Só o condutor do MDF-e. Parcela de outro motorista é ignorado / motorista_divergente.
Mesmas regras da liberação unitária (evento_fora_de_ordem, parcela_cancelada...), e a mesma idempotência: parcela já liberada é ja_liberada, não erro.

O MDF-e pode estar em rascunho — ele é só o seletor dos CT-e. Manifesto de outra transportadora ou inexistente responde 404; manifesto sem CT-e, 422.

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`

LiberarParcelasPorMdfe ↗

mdfestringObrigatório

UUID do MDF-e, chave de acesso (44) ou número.

maxLength64

posicaointegerObrigatório

minimum1

maximum3

ocorrido_emstring · dateObrigatório

Data do evento; hoje ou passado.

Respostas

200 Resposta HTTP

O MDF-e foi processado; leia resumo e documentos[].resultado.

`application/json`

RespostaParcelasPorMdfe ↗

dataobjectOpcional

ParcelaPorMdfeLinha ↗

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Credencial sem o escopo operacao habilitado.

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

MDF-e não encontrado, ou de outra transportadora (mdfe_nao_encontrado).

`application/json`

Erro ↗

errorobjectOpcional

422 Resposta HTTP

MDF-e sem CT-e vinculado (mdfe_sem_documentos), ou payload inválido.

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "tags": [
    "Parcelas"
  ],
  "summary": "Liberar a parcela N de todos os CT-e de um MDF-e",
  "operationId": "liberarParcelasPorMdfe",
  "description": "A liberação em **lote pelo manifesto**: informe o MDF-e (uuid, chave de acesso ou número)\ne a posição, e a FleetPay aplica `liberar` a cada CT-e vinculado à viagem — inclusive os\ncontra-CT-e de um lote de subcontratação — devolvendo **um resultado por CT-e**. Uma recusa\nnuma linha não impede as outras.\n\nTrês regras que valem a pena saber antes de chamar:\n\n- **Só parcelas que já existem.** A parcela nasce na bipagem; o MDF-e não é tratado como\n  evento de coleta. CT-e do manifesto ainda sem parcela na posição responde\n  `recusada / parcela_inexistente` na linha dele.\n- **Só o condutor do MDF-e.** Parcela de outro motorista é `ignorado / motorista_divergente`.\n- **Mesmas regras da liberação unitária** (`evento_fora_de_ordem`, `parcela_cancelada`...),\n  e a mesma idempotência: parcela já liberada é `ja_liberada`, não erro.\n\nO MDF-e pode estar em rascunho — ele é só o seletor dos CT-e. Manifesto de outra\ntransportadora ou inexistente responde `404`; manifesto sem CT-e, `422`.\n",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LiberarParcelasPorMdfe"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "O MDF-e foi processado; leia `resumo` e `documentos[].resultado`.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaParcelasPorMdfe"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "description": "Credencial sem o escopo `operacao` habilitado.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "MDF-e não encontrado, ou de outra transportadora (`mdfe_nao_encontrado`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "MDF-e sem CT-e vinculado (`mdfe_sem_documentos`), ou payload inválido.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "method": "POST",
  "path": "/carriers/parcelas-repasse/liberar-por-mdfe",
  "parameters": []
}