documentostringObligatorioClave de acceso de 44 dígitos, internal_id o UUID.
Parámetros, estructura de datos y respuestas del contrato versionado.
/carriers/parcelas-repasse/biparLas 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.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]No hay parámetros declarados para esta operación.
Obligatorio
Identificador del documento y datos opcionales de verificación.
application/jsondocumentostringObligatorioClave de acceso de 44 dígitos, internal_id o UUID.
data_eventostring | null · dateOpcional200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
422 Respuesta HTTPDocumento no elegible para escaneo.
{
"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": []
}