documentostringObrigatórioChave de acesso de 44 dígitos, internal_id ou UUID.
Parâmetros, estrutura de dados e respostas do contrato versionado.
/carriers/parcelas-repasse/biparDescriçõ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.
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]Nenhum parâmetro declarado nesta operação.
Obrigatório
Identificador do documento e dados opcionais de conferência.
application/jsondocumentostringObrigatórioChave de acesso de 44 dígitos, internal_id ou UUID.
data_eventostring | null · dateOpcional200 Resposta HTTPOperação processada com sucesso.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
422 Resposta HTTPDocumento inelegível para bipagem.
{
"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": []
}