← InícioFleetPay / API

Registrar bipagem de documento para gerar parcela de repasse

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/carriers/parcelas-repasse/bipar
biparDocumentoParcelaRepasseBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Registra o evento de bipagem em documento único (CT-e ou contra-CT-e) vinculado ao transportador autenticado.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Repasses e Comprovantes
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

Identificador do documento e dados opcionais de conferência.

application/json

documentostringObrigatório

Chave de acesso de 44 dígitos, internal_id ou UUID.

data_eventostring | null · dateOpcional

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

422 Resposta HTTP

Documento inelegível para bipagem.

Definição Completa da Operação
{
  "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": []
}