v1
latestOpenAPI 3.0.02026-07-264636241.7 MBRecupera a lista de comissões
🔒 Autenticação necessária
Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)
Esta rota permite consultar e recuperar uma lista paginada de comissões registradas no sistema CVCRM.
A comissão representa um valor percentual ou fixo pago a um profissional (corretor e/ou equipe de vendas) com base no valor do contrato ou em outra base definida pela incorporadora, conforme suas regras configuradas no sistema.
Para garantir a eficiência da consulta e evitar retornos excessivamente amplos, a requisição deve ser filtrada obrigatoriamente por pelo menos um dos seguintes parâmetros (além dos headers de autenticação):
ID da comissão
ID da reserva
Documento do pagador
Data de cadastro (a_partir_de)
O endpoint utiliza paginação para controle do volume de registros retornados, permitindo melhor desempenho e previsibilidade nas integrações.
Query parameters
Id da comissão
Código interno da comissão
Id da reserva
Código interno da reserva
Documento do pagador (CNPJ ou CPF)
Documento do beneficiário (CNPJ ou CPF)
True or False
True or false. Padrão é false.
Retorna as comissões cadastradas a partir da data informada.
Retorna as comissões cadastradas até a data informada.
Retorna as comissões cadastradas com a pagadoria informada.
Headers
Email de autenticação no CV
Token de autenticação no CV
Response
Operação realizada com sucesso.
Example response
{
"total": 1,
"limit": 30,
"offset": 0,
"totalConteudo": 1,
"comissoes": [
{
"idcomissao_cv": 123,
"idcomissao_int": "CI4587",
"data_cad": "2022-08-16 16:59:34",
"idsituacao": 1,
"idreserva_cv": 321,
"idreserva_int": "RI7854",
"numero_venda": "12345",
"idempreendimento_cv": 3,
"idempreendimento_int": "EI54634",
"empreendimento": "Empreendimento",
"idetapa_cv": 4,
"idetapa_int": "ETI98076",
"etapa": "Etapa",
"idbloco_cv": 6,
"idbloco_int": "BI5498",
"bloco": "Bloco",
"idunidade_cv": 16181,
"idunidade_int": "UI1341",
"unidade": "Unidade",
"idpessoa_cv": 269,
"idpessoa_int": "PI726",
"valor_comissao": 17.5,
"valor_comissao_tipo_comissao": 9.81,
"valor_comissao_tipo_premio": 10.2,
"idcorretor_cv": 1,
"idcorretor_int": "CI4587",
"idimobiliaria_cv": 1,
"idimobiliaria_int": "IMI4587",
"corretor_nome": "João Silva",
"imobiliaria_nome": "Imobiliária Teste",
"pagador": {
"idpessoa_cv": 269,
"idpessoa_int": "PI726",
"nome": "Pagador",
"documento": "12345678901",
"tipo_documento": "cpf",
"email": "pagador@cvcrm.com.br",
"data_nascimento": "2000-01-01",
"logradouro": "Avenida",
"endereco": "Nome da Avenida",
"numero": "123",
"bairro": "Bairro",
"cep": "49030210",
"estado": "Estado",
"cidade": "Cidade",
"telefone": "(79) 99999-9999",
"estado_civil": 1
},
"beneficiarios": [
{
"nome": "Beneficiário",
"documento": "12345678901",
"documento_faturamento": "12345678901",
"email": "beneficiario@cvcrm.com.br",
"data_nascimento": "2000-01-01",
"comissao_tipo": "C",
"valor": 17.5,
"para": "Imobiliária (Reserva)",
"idbeneficiario_cv": 16,
"idbeneficiario_int": "CI4587",
"programacao": [
{
"idpagamento": 8851,
"idsituacao": 3,
"valor": 9.81,
"vencimento": "2022-03-26",
"data_medicao": "2022-03-26",
"observacoes": "lorem ipsum",
"cancelado": false,
"excluido": false
}
]
}
],
"documentos_pagamento": [
{
"idarquivo_cv": 16,
"idpagamento_cv": 2897,
"data_cad": "2022-08-17 15:22:02",
"tipo": "Nota Fiscal",
"nome": "nome_arquivo.pdf",
"arquivo_tipo": "application/pdf",
"arquivo_base64": "string contendo base64 do arquivo"
}
],
"lotes_pagamento": [
{
"idpagamento": 8858,
"idpagamento_legado": 8858,
"idcomissao": 2815,
"data_cad": "2022-08-16 16:59:35",
"ativo": "S",
"valor": 0.56,
"data_pagamento": "2022-04-18",
"nota_fiscal": null,
"idreserva_comissao": 16241,
"data_medicao": "2022-04-18",
"obs_medicao": "lorem ipsum",
"situacao": "P",
"codigointerno": "LPI1234",
"forma_pagamento": "TB",
"idprogramacaoreserva": 112236,
"cancelamento": "N",
"idsituacao": 4,
"bloqueado": "N",
"motivo_bloqueio": "lorem ipsum",
"idlote": 4
}
],
"mensagens": [
{
"idmensagem_cv": 53,
"nome": "Nome Usuário (Gestor)",
"mensagem": "teste de mensagem",
"data": "2022-08-17 15:22:02",
"arquivos": [
{
"idarquivo_cv": 13,
"data_cad": "2022-08-17 15:22:02",
"nome": "nome_arquivo.pdf",
"arquivo_tipo": "application/pdf",
"arquivo_base64": "string contendo base64 do arquivo"
}
]
}
],
"pagamentos": [
{
"idpagamento": 53,
"data_pagamento": "2023-10-08",
"nota_fiscal": "010101",
"situacao": "Pago",
"idsituacao": 1,
"forma_pagamento": "Boleto",
"valor": 1000,
"data_medicao": "2023-10-08",
"obs_medicao": "obs",
"enviar_pagadoria": "S"
}
]
}
]
}