documento_idinteger | nullOpcionalLiberar cuota en regla manual vía servicio
Parámetros, estructura de datos y respuestas del contrato versionado.
/servicos/liberar-parcelaLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Libera la cuota de escaneo (posición 1) o finalización (posición 2) cuando la relación comercial utiliza regla de liberación manual. Requiere el permiso operacao.
Autenticación
- Permiso Requerido
operacao— Operación- Módulo
- Transferencias y Comprobantes
- Perfiles Aplicables
- Gestor de Transporte · Agregado Empresarial · Transportista Flotista
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Parámetros
No hay parámetros declarados para esta operación.
Cuerpo de la Solicitud
Obligatorio
Identificación del documento, posición de la cuota y fecha del evento.
application/json
chave_acessostring | nullOpcionalposicaointegerObligatorioPosición de la cuota (1 o 2).
data_eventostring · dateObligatorioFecha del evento operativo (YYYY-MM-DD).
Respuestas
201 Respuesta HTTP
Cuota liberada o repetición idempotente (200).
application/json
data—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTP
Credencial ausente, inválida o de otro entorno.
403 Respuesta HTTP
Permiso del panel no habilitado o recurso fuera del alcance de la company.
422 Respuesta HTTP
Regla automática u orden de liberación inválida.
Definición Completa de la Operación
{
"tags": [
"Parcelas"
],
"operationId": "liberarParcelaServico",
"summary": "Liberar parcela em regra manual via serviço",
"description": "Libera parcela de bipagem (posição 1) ou conclusão (posição 2) quando a relação comercial utiliza regra de liberação manual. Exige escopo `operacao`.",
"requestBody": {
"required": true,
"description": "Identificação do documento, posição da parcela e data do evento.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"posicao",
"data_evento"
],
"properties": {
"documento_id": {
"type": [
"integer",
"null"
]
},
"chave_acesso": {
"type": [
"string",
"null"
]
},
"posicao": {
"type": "integer",
"description": "Posição da parcela (1 ou 2)."
},
"data_evento": {
"type": "string",
"format": "date",
"description": "Data do evento operacional (YYYY-MM-DD)."
}
}
}
}
}
},
"responses": {
"201": {
"description": "Parcela liberada ou replay idempotente (`200`).",
"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": "Regra automática ou ordem de liberação inválida."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "repasses-comprovantes",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"transportador_frotista"
],
"method": "POST",
"path": "/servicos/liberar-parcela",
"parameters": []
}