batch_idstringObrigatórioUUID ou ID do lote de contra-CT-e.
Parâmetros, estrutura de dados e respostas do contrato versionado.
/carriers/parcelas-repasse/liberar-por-loteDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Libera uma posição de parcela para todos os contra-CT-e autorizados pertencentes a um lote de subcontratação (batch_id). Uso exclusivo de transportador frotista sob escopo operacao.
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]Nenhum parâmetro declarado nesta operação.
Obrigatório
Identificador do lote de contra-CT-e e posição da parcela.
application/jsonbatch_idstringObrigatórioUUID ou ID do lote de contra-CT-e.
posicaointegerObrigatórioNúmero da parcela a liberar.
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 HTTPLote sem parcelas elegíveis para liberação.
{
"tags": [
"CT-e de subcontratação",
"Parcelas"
],
"operationId": "liberarParcelasPorLoteContraCte",
"summary": "Liberar parcelas em lote por batch de contra-CT-e",
"description": "Libera uma posição de parcela para todos os contra-CT-e autorizados pertencentes a um lote de subcontratação (`batch_id`). Uso exclusivo de transportador frotista sob escopo `operacao`.",
"requestBody": {
"required": true,
"description": "Identificador do lote de contra-CT-e 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 liberar."
}
}
}
}
}
},
"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": "Lote sem parcelas elegíveis para liberação."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "subcontratacao",
"x-fleetpay-profiles": [
"transportador_frotista"
],
"method": "POST",
"path": "/carriers/parcelas-repasse/liberar-por-lote",
"parameters": []
}