Foram disponibilizadas novas APIs para consulta, cadastro e gestão de regras e pagamentos de comissão, ampliando as possibilidades de integração com sistemas externos.

⚠️ Importante:
O uso dessas APIs depende de liberação prévia pelo time do CV, pois não são APIs públicas.

• Consulta de regra de comissão, para verificar os dados de regra da comissão da reserva
  https://{dominiodocliente}.cvcrm.com.br/api/v1/comercial/reservas/{idReserva}/regras-comissao
•  Cadastro de Regra de Comissão
  https://{dominiodocliente}.cvcrm.com.br/api/v3/comercial/reservas/{idReserva}/comissoes
•  Deleção de regra de comissão
  /v3/comercial/reservas/{idReserva}/comissoes/{idRegra}
  Precisa passar um Id por vez
•  Pagamento de comissão
  Cadastro de pagamento de comissão, precisa consultar o idRegra de comissão
  POST
  /v3/financeiro/comissoes/{idComissao}/pagamentos
  Cadastra um pagamento para uma comissão
•  Atualização de pagamento de comissão
  PATCH
  /v3/financeiro/comissoes/{idComissao}/pagamentos/{idPagamento}
  Atualiza um pagamento de comissão
•  Deleção de pagamento de comissão
  DELETE
  /v3/financeiro/comissoes/{idComissao}/pagamentos
  Remove pagamentos de uma comissão

Foram realizadas melhorias nas APIs relacionadas à consulta de tipos de documentos utilizados no pagamento de comissões, além da ampliação de filtros em outras consultas existentes.

O objetivo é tornar as consultas mais confiáveis, previsíveis e fáceis de utilizar nas integrações e operações do dia a dia.

Consulta de tipos de documentos para pagamento de comissões

A consulta pode ser acessada em:

https://integracao.cvcrm.com.br/api/v3/configuracoes/tipos-arquivos-pagamentos-comissoes

Comportamento após a melhoria

• Apenas opções válidas e ativas passam a aparecer na listagem
• Consultas com informações preenchidas incorretamente podem retornar mensagens de inconsistência
• Situações inesperadas continuam sendo tratadas como erro interno

Essas mudanças aumentam a confiabilidade dos dados retornados pela API.

Novos filtros em consultas existentes

Também foram adicionados filtros por nome em algumas consultas já existentes, facilitando buscas quando não se possui o código ou documento do registro.

Consultas que passaram a contar com esse filtro:

• Consulta de corretores
• Consulta de usuários administrativos
• Consulta de imobiliárias
• Consulta de usuários de imobiliárias

Na prática, isso permite localizar registros com mais facilidade quando o cliente não tiver em mãos um código ou documento. 

Nova consulta de imobiliárias

Foi disponibilizada uma nova API para consulta de imobiliárias, com possibilidade de busca por nome.

Endereço:

https://integracao.cvcrm.com.br/api/v1/cadastros/imobiliarias

Comportamentos esperados

• A consulta retorna normalmente quando os dados informados estão corretos
• Consultas com parâmetros inválidos retornam mensagem de preenchimento incorreto
• Falhas inesperadas continuam sendo tratadas como erro interno

Foram disponibilizados dois novos endpoints para consulta de informações relacionadas às Visitas Técnicas vinculadas às assistências.

1. Listagem de Visitas Técnicas

API responsável por retornar a lista de visitas técnicas relacionadas a uma assistência específica.

Objetivo

Permitir a consulta estruturada de todas as visitas registradas, facilitando integrações, relatórios e acompanhamento externo.

2. Consulta de Detalhes da Visita Técnica

API destinada a retornar os detalhes completos de uma visita técnica específica.

Parâmetros obrigatórios

• idVisita – Identificador da visita técnica a ser consultada
• idAssistencia – Identificador da assistência vinculada à visita

Objetivo

Disponibilizar informações detalhadas da visita, possibilitando consultas individualizadas e maior controle sobre os dados registrados.

Benefícios da melhoria

• Maior flexibilidade para integrações
• Consulta estruturada e padronizada de dados
• Melhor rastreabilidade das visitas técnicas
• Apoio a relatórios e auditorias

A API de Comissões recebeu melhorias que ampliam as possibilidades de filtragem e enriquecem as informações retornadas no response.

Endpoint:

GET /api/v1/financeiro/comissoes

Por que isso é importante?

As melhorias permitem integrações mais completas com sistemas financeiros e de pagamento, facilitando:

• Identificação da pagadoria responsável
• Visualização da forma de pagamento realizada
• Vínculo com cobranças específicas por meio do codigo_pagadoria_int

Isso aumenta a rastreabilidade, melhora a conciliação financeira e traz mais precisão nas integrações.

O que foi implementado?

• Novo filtro por pagadoria

Foi incluído um novo parâmetro de filtro que permite consultar as comissões considerando a pagadoria vinculada.

Com isso, integrações podem segmentar os dados conforme a entidade responsável pelo pagamento das comissões.

• Forma de pagamento no array de pagamentos

No response da API, dentro do array de pagamentos dos beneficiários, passa a ser retornado o campo que identifica a forma de pagamento realizada.

Isso permite diferenciar pagamentos como:

• Boleto
• Transferência
• PIX
• Outros meios configurados

• Inclusão do código da pagadoria na programação

No array de programação da comissão, foi adicionado o campo: codigo_pagadoria_int

Esse campo identifica a cobrança associada ao agendamento de pagamento vinculado à pagadoria Avendre Pay, sendo equivalente ao ChargeID.

Essa informação facilita:

• Rastreamento da cobrança no gateway/pagadoria
• Integração com sistemas externos de faturamento
• Auditorias financeiras

Pré-requisitos

• Credenciais válidas de API
• Permissão de acesso aos dados financeiros de comissão

Foi criada uma nova API que retorna todos os contratos enviados para assinatura eletrônica, independentemente do status atual.

Diferente do endpoint já existente — que retorna apenas contratos assinados — este novo endpoint contempla o ciclo completo da assinatura eletrônica, incluindo contratos:

• Pendentes
• Assinados
• Cancelados

Endpoint:https://{dominiodocliente}.cvcrm.com.br/api/v3/comercial/reservas/{idReserva}/contratos/assinatura-eletronica 

O que essa melhoria permite?

essa melhoria amplia a visibilidade do ciclo completo de assinatura eletrônica, permitindo que integrações externas acompanhem o status de todos os contratos enviados, inclusive os que ainda estão aguardando assinatura ou que foram cancelados.

Com isso, é possível melhorar o controle operacional, auditorias e automações de fluxo baseadas no status real dos contratos.

O que o endpoint retorna?

• Contratos enviados para assinatura eletrônica
• Contratos assinados
• Contratos pendentes de assinatura
• Contratos cancelados

Além disso:

• Quando o contrato estiver com status Cancelado, será retornado um novo campo informando o motivo do cancelamento, dentro do array de contratos.

Exemplo de comportamento

• Se o contrato foi enviado e ainda não foi assinado → será retornado
• Se o contrato já foi assinado → será retornado
• Se o contrato foi cancelado → será retornado, incluindo o campo motivoCancelamento

No CVDW_API de Leads – Interações, adicionamos dois novos campos de retorno:

• whatsapp_respondido
• ultimo_retorno

Essa melhoria amplia a visibilidade sobre o histórico de comunicação do lead, trazendo mais precisão para análises e integrações.

Agora, na API PUT de Atendimentos, é possível informar diretamente o ID da situação desejada para realizar a alteração do atendimento.

Realizamos uma melhoria na tela de Integrações.

Agora, durante a criação do token, não é mais necessário informar a interface.
O processo ficou mais simples e rápido, reduzindo etapas e facilitando a configuração das integrações.

Criamos duas novas APIs para trabalhar com mensagens no Pré-cadastro, seguindo o mesmo padrão já existente nas APIs de mensagens da Reserva.

📌 APIs disponíveis:

• POST: permite cadastrar mensagens no pré-cadastro.
• GET: permite consultar as mensagens já cadastradas no pré-cadastro.

Disponibilizamos novas APIs para consulta de tabelas de preços, utilizando o formato de autenticação v3.

Essas interfaces permitem consultar:

• Uma tabela de preços específica de um empreendimento
• A lista completa de tabelas de preços de um empreendimento

Endpoints disponíveis

• Consulta específica:
  GET /api/v3/cadastros/empreendimentos/{idEmpreendimento}/tabelas-preco/{idTabela}
• Consulta múltipla:
  GET /api/v3/cadastros/empreendimentos/{idEmpreendimento}/tabelas-preco

Comportamento da API

As tabelas de preços são retornadas independentemente do status de aprovação ou de estarem ativas, garantindo acesso completo às informações cadastradas.