v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Comissão da Reserva

Cadastra as comissões de uma 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)

Interface responsável por cadastrar as comissões de uma reserva no Construtor de Vendas.

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

Path parameters

idReservainteger required

Example:7367

Identificador da reserva.

Request body

comissaoTipo'C' | 'P' | 'E'

Tipo da comissão. Valores: C (Comissão), P (Prêmio), E (Premiação Extra).

tipoValor'V' | 'P' | 'VSC' | 'VSP' | 'PRT'

Tipo do valor da comissão. Valores: V (Valor), P (Porcentagem), VSC (Valor da série de comissão), VSP (Valor da série de prêmio), PRT (Premiação Regra Tabela de Preço).

comissaoPagamentoTipo'VGV' | 'PV'

Base de cálculo do pagamento. Valores: VGV (Valor Contrato), PV (Valor Presente).

comissaoJurosboolean

Calcula juros na comissão.

para'CP' | 'CC' | 'CR' | 'GC' | 'IC' | 'CO' | 'IR' | 'UA' | 'UI' required

Para quem é a comissão. Valores: CP (Coordenador do Produto), CC (Corretor Cadastro), CR (Corretor Reserva), GC (Gestor do Corretor), IC (Imobiliária Cadastro), CO (Imobiliária Coordenação), IR (Imobiliária Reserva), UA (Usuário Administrativo), UI (Usuário Imobiliária).

{"stackTrail":"components:schemas:cadastrarComissao:properties:quem","oasType":"schema","type":"unknown","description":"ID do beneficiário.","example":1,"nullable":true}

paraPagamento'DU' | 'DF'

Dados usados para pagamento. Valores: DU (Dados do usuário), DF (Dados de faturamento).

valornumber float required

Valor da comissão.

enviarPagadoriaboolean

Enviar para pagadoria.

formaPagamentostring

Forma de pagamento.

pagoPelaCondicaoReservaboolean

Comissão paga pela condição da reserva.

contratoboolean required

Comissão referente ao contrato.

enviarErpboolean

Enviar para ERP.

descricaostring

Descrição da comissão.

valorPorcentagemPremiacaostring

Valor ou porcentagem de premiação.

ordeminteger

Ordem da comissão.

proporcaonumber float

Proporção da comissão.

idindexadorSiengeComissaointeger

Identificador do indexador de comissão no Sienge.

Example request

{
  "comissaoTipo": "C",
  "tipoValor": "P",
  "comissaoPagamentoTipo": "VGV",
  "comissaoJuros": false,
  "para": "CR",
  "quem": null,
  "paraPagamento": "DU",
  "valor": 12.22,
  "enviarPagadoria": false,
  "formaPagamento": "BL",
  "pagoPelaCondicaoReserva": true,
  "contrato": true,
  "enviarErp": false,
  "descricao": "",
  "valorPorcentagemPremiacao": "",
  "ordem": 1,
  "proporcao": 35,
  "idindexadorSiengeComissao": 123
}

Response

Operação realizada com sucesso

statusstring string

codeinteger

Example response

{
  "status": "success",
  "code": 201,
  "data": {
    "id": 1
  }
}