← HomeFleetPay / API

Release installments in batch per counter-CT-e batch

Parameters, data structure and responses from the versioned contract.

POST/carriers/parcelas-repasse/liberar-por-lote
liberarParcelasPorLoteContraCteSandbox 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 an installment position for all authorized counter-CT-es belonging to a subcontracting batch (batch_id). Exclusive to fleet carriers under operacao scope.

Authentication

Required Scope
operacao — Operations
Module
Subcontracting
Target Profiles
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

Counter-CT-e batch identifier and installment position.

application/json

batch_idstringRequired

Counter-CT-e batch UUID or ID.

posicaointegerRequired

Installment number to release.

Responses

200 HTTP Response

Operation processed successfully.

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

Batch has no installments eligible for release.

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