Ordenar o pagamento da 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/pagar-por-mdfe

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

Gêmea de pagar, em lote pelo manifesto: aplica a ordem de pagamento da posição a cada CT-e do MDF-e e devolve um resultado por CT-e (ordenada, ja_ordenada, recusada, ignorado). Valem as regras da ordem unitária — parcela precisa estar liberada (parcela_nao_liberada), a anterior precisa ter ordem (parcela_anterior_sem_ordem) e o serviço precisa existir (servico_inexistente). Parcela em modo automático já liberada responde ja_ordenada: não há ordem manual a dar.

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`

PagarParcelasPorMdfe ↗

mdfestringObrigatório

maxLength64

posicaointegerObrigatório

minimum1

maximum3

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": "Ordenar o pagamento da parcela N de todos os CT-e de um MDF-e",
  "operationId": "pagarParcelasPorMdfe",
  "description": "Gêmea de `pagar`, em lote pelo manifesto: aplica a ordem de pagamento da posição a cada\nCT-e do MDF-e e devolve um resultado por CT-e (`ordenada`, `ja_ordenada`, `recusada`,\n`ignorado`). Valem as regras da ordem unitária — parcela precisa estar liberada\n(`parcela_nao_liberada`), a anterior precisa ter ordem (`parcela_anterior_sem_ordem`) e o\nserviço precisa existir (`servico_inexistente`). Parcela em modo automático já liberada\nresponde `ja_ordenada`: não há ordem manual a dar.\n",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PagarParcelasPorMdfe"
        }
      }
    }
  },
  "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/pagar-por-mdfe",
  "parameters": []
}