← HomeFleetPay / API

Record document scan to generate payout installment

Parameters, data structure and responses from the versioned contract.

POST/carriers/parcelas-repasse/bipar
biparDocumentoParcelaRepasseSandbox Base: https://api.fleetpay.site/v1

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

Records the scan event on a single document (CT-e or counter-CT-e) linked to the authenticated carrier.

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 identifier and optional verification data.

application/json

documentostringRequired

44-digit access key, internal_id or UUID.

data_eventostring | null · dateOptional

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

Document ineligible for scanning.

Complete Operation Definition
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "biparDocumentoParcelaRepasse",
  "summary": "Registrar bipagem de documento para gerar parcela de repasse",
  "description": "Registra o evento de bipagem em documento único (CT-e ou contra-CT-e) vinculado ao transportador autenticado.",
  "requestBody": {
    "required": true,
    "description": "Identificador do documento e dados opcionais de conferência.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "documento"
          ],
          "properties": {
            "documento": {
              "type": "string",
              "description": "Chave de acesso de 44 dígitos, internal_id ou UUID."
            },
            "data_evento": {
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            }
          }
        }
      }
    }
  },
  "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": "Documento inelegível para bipagem."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/carriers/parcelas-repasse/bipar",
  "parameters": []
}