batch_idstringObligatorioUUID o ID del lote de contra-CT-e.
Parámetros, estructura de datos y respuestas del contrato versionado.
/carriers/parcelas-repasse/pagar-por-loteLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Dispara el pago de las cuotas ya liberadas de todos los contra-CT-e vinculados al lote de subcontratación (batch_id).
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]No hay parámetros declarados para esta operación.
Obligatorio
Identificador del lote y posición de la cuota.
application/jsonbatch_idstringObligatorioUUID o ID del lote de contra-CT-e.
posicaointegerObligatorioNúmero de cuota por pagar.
200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
422 Respuesta HTTPSaldo insuficiente o cuotas no liberadas.
{
"tags": [
"CT-e de subcontratação",
"Parcelas"
],
"operationId": "pagarParcelasPorLoteContraCte",
"summary": "Solicitar pagamento em lote por batch de contra-CT-e",
"description": "Dispara o pagamento das parcelas já liberadas de todos os contra-CT-e vinculados ao lote de subcontratação (`batch_id`).",
"requestBody": {
"required": true,
"description": "Identificador do lote e posição da parcela.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"batch_id",
"posicao"
],
"properties": {
"batch_id": {
"type": "string",
"description": "UUID ou ID do lote de contra-CT-e."
},
"posicao": {
"type": "integer",
"description": "Número da parcela a pagar."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
},
"422": {
"description": "Saldo insuficiente ou parcelas não liberadas."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "subcontratacao",
"x-fleetpay-profiles": [
"transportador_frotista"
],
"method": "POST",
"path": "/carriers/parcelas-repasse/pagar-por-lote",
"parameters": []
}