Ordenar el pago de la cuota N de un MDF-e

Parámetros, estructura de datos y respuestas del contrato versionado.

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

pagarParcelasPorMdfeBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Equivalente de pagar en lote por manifiesto: aplica la orden de pago de la posición indicada a cada CT-e del MDF-e y devuelve un resultado por CT-e (ordenada, ja_ordenada, recusada, ignorado). Rigen las reglas de la orden individual: la cuota debe estar liberada (parcela_nao_liberada), la anterior debe tener una orden (parcela_anterior_sem_ordem) y el servicio debe existir (servico_inexistente). Una cuota en modo automático ya liberada devuelve ja_ordenada: no hay una orden manual que emitir.

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

`application/json`

PagarParcelasPorMdfe ↗

mdfestringObligatorio

maxLength64

posicaointegerObligatorio

minimum1

maximum3

Respuestas

200 Respuesta HTTP

MDF-e procesado; consulta resumo y documentos[].resultado.

`application/json`

RespostaParcelasPorMdfe ↗

dataobjectOpcional

ParcelaPorMdfeLinha ↗

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Respuesta HTTP

La credencial no tiene habilitado el permiso operacao.

`application/json`

Erro ↗

errorobjectOpcional

404 Respuesta HTTP

MDF-e no encontrado o perteneciente a otro transportista (mdfe_nao_encontrado).

`application/json`

Erro ↗

errorobjectOpcional

422 Respuesta HTTP

MDF-e sin CT-e vinculado (mdfe_sem_documentos), o payload inválido.

`application/json`

Erro ↗

errorobjectOpcional

Definición Completa de la Operación

{
  "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": []
}