v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Comissão da Reserva

Retorna as regras de comissão da reserva no Construtor de Vendas

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Esta API deve ser utilizada para retornas as regras de comissão uma reserva no Construtor de Vendas.

get/v3/comercial/reservas/{idReserva}/comissoes

Path parameters

idReservainteger required

Example:7367

Identificador da reserva.

Query parameters

paginainteger

Example:1

Página que deseja visualizar os registros.

registros_por_paginainteger

Example:30

Quantidade de registros por página, máximo 500 registros.

sortstring

Example:idusuario

Informa o campo a ser ordenado.

order'ASC' | 'DESC'

Informa a ordem da classificação.

search[operador|campo]string

Example:14

Informa o termo para busca.

Operadores suportados:
- equal → igual
- notEqual → diferente
- greaterThan → maior que
- greaterThanOrEqual → maior ou igual a
- lessThan → menor que
- lessThanOrEqual → menor ou igual a
- in → dentro de lista de valores (passar valores separados por vírgula)
- notIn → fora de lista de valores (passar valores separados por vírgula)
- like → contém o valor informado

Response

Listagem retornada com sucesso.

statusstring required

codeinteger required

Example response

{
  "status": "success",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 2,
    "totalRegistros": 2,
    "totalPaginas": 1
  },
  "data": [
    {
      "id": 1,
      "comissaoTipo": "C",
      "tipoValor": "P",
      "comissaoPagamentoTipo": "VGV",
      "para": "CR",
      "quem": 23253,
      "paraPagamento": "DU",
      "ordem": 1,
      "valor": 3985.52,
      "porcentagem": 1.2,
      "formaPagamento": "BL",
      "pagoPelaCondicaoReserva": true,
      "contrato": true,
      "idindexadorSiengeComissao": 763,
      "enviarErp": true,
      "dataCad": "2025-01-15 10:30:00",
      "tipo": "C",
      "idreserva": 123,
      "idimobiliaria": 45,
      "idcorretor": 23,
      "codigointerno": "COD-001",
      "data": "2025-06-15",
      "idusuarioNivel": 2,
      "idusuarioCategoria": 3,
      "idcorretorNivel": 1,
      "idcorretorCategoria": 2,
      "fiftyIdreferencia": 7,
      "idSubRegraComissao": 5,
      "idlancamento": 100,
      "idreservaComissaoLancamento": 15,
      "valorPorcentagemPremiacao": 0.5,
      "dataModificacao": "2025-01-20 14:00:00",
      "idregraComissao": 8
    }
  ]
}