← InicioFleetPay / API

Registrar escaneo de documento para generar cuota de transferencia

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/carriers/parcelas-repasse/bipar
biparDocumentoParcelaRepasseBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Registra el evento de escaneo en un documento único (CT-e o contra-CT-e) vinculado al transportista autenticado.

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": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

Identificador del documento y datos opcionales de verificación.

application/json

documentostringObligatorio

Clave de acceso de 44 dígitos, internal_id o UUID.

data_eventostring | null · dateOpcional

Respuestas

200 Respuesta HTTP

Operación procesada con éxito.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"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

Documento no elegible para escaneo.

Definición Completa de la Operación
{
  "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": []
}