← HomeFleetPay / API

Release manual-rule installment via service

Parameters, data structure and responses from the versioned contract.

POST/servicos/liberar-parcela
liberarParcelaServicoSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Releases the scan installment (position 1) or completion installment (position 2) when the commercial relationship uses manual release rules. Requires operacao scope.

Authentication

Required Scope
operacao — Operations
Module
Disbursements & Receipts
Target Profiles
Transport Manager · Dedicated Fleet Contractor · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Request Body

Required

Document identification, installment position and event date.

application/json

documento_idinteger | nullOptional
chave_acessostring | nullOptional
posicaointegerRequired

Installment position (1 or 2).

data_eventostring · dateRequired

Operational event date (YYYY-MM-DD).

Responses

201 HTTP Response

Installment released or idempotent replay (200).

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

422 HTTP Response

Automatic rule or invalid release order.

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