batch_idstringObrigatórioUUID ou ID do lote de contra-CT-e.
Parâmetros, estrutura de dados e respostas do contrato versionado.
/carriers/parcelas-repasse/pagar-por-loteDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Dispara o pagamento das parcelas já liberadas de todos os contra-CT-e vinculados ao lote de subcontratação (batch_id).
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]Nenhum parâmetro declarado nesta operação.
Obrigatório
Identificador do lote e posição da parcela.
application/jsonbatch_idstringObrigatórioUUID ou ID do lote de contra-CT-e.
posicaointegerObrigatórioNúmero da parcela a pagar.
200 Resposta HTTPOperação processada com sucesso.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
422 Resposta HTTPSaldo insuficiente ou parcelas não 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": []
}