Jump to Content
Home
Documentação
Referências das Apis
Changelog
Log In
Referências das Apis
Log In
Home
Documentação
Referências das Apis
Changelog
Configurações Comerciais
All
Pages
Start typing to search…
JUMP TO
Atendimento API
Atendimento
Cadastrar Atendimento
post
Alterar situação do atendimento
put
Lista os atendimentos
get
Adiciona uma mensagem no atendimento
post
Altera os dados do atendimento
put
Tarefas
Tarefas
Retorna as tarefas criadas do atendimento
get
Retorna uma tarefa criada
get
Encerra uma tarefa criada
post
Assistência Técnica API
Assistência
Realiza o cadastro de uma nova assistência técnica para o síndico
post
Criar nova assistência
post
Listar assistências
get
Consultar detalhes completos da assistência
get
Atualizar informações da assistência
put
Alterar situação do chamado
post
Visitas
Alterar situação de uma visita técnica
post
Agendar nova visita
post
Altera os dados da visita
put
Equipes
Listar equipes disponíveis
get
Listar profissionais da equipe
get
Itens
Adicionar item
post
Atualizar situação de um item específico
post
Modifica os dados do item
put
Remover item da assistência
del
Localidade
Listar localidades disponíveis
get
Área Comum
Listar áreas comuns configuradas
get
Itens de Manutenção
Listar tipos de itens de manutenção
get
Cadastra item de manutenção
post
Mensagens
Enviar mensagem
post
Patologias
Listar patologias cadastradas
get
Criar nova patologia
post
Retorna uma patologia
get
Atualizar patologia existente
put
Remover patologia
del
Upload
Upload de anexos
post
Cadastro gerais do ambiente do CV
Tipos de Associações
Retorna os tipos de associações disponíveis
get
Tipos de Arquivos
Retorna os tipos de arquivos disponíveis
get
Kit Decoração
Esta API é responsável por retornar os kits decoração cadastrados no CV
get
Correspondentes
Retorna os usuários correspondentes
get
Cadastra um usuário correspondente
post
Retorna as empresas correspondentes
get
Cadastra empresa correspondente
post
API de Clientes
Cliente
Cadastra cliente.
post
Retorna clientes.
get
Atualiza o Sinalizador Juridico de uma pessoa para ativo ou inativo.
put
Cadastra cliente.
post
Retorna clientes.
get
Atualiza o Sinalizador Juridico de uma pessoa para ativo ou inativo.
put
API de Comissões
Comissão
Recupera a lista de comissões
get
Cadastrar nova comissão
post
Altera a situação de uma comissão.
post
Comissão
Recupera a lista de comissões
get
Altera a situação de uma comissão.
post
Cadastrar nova comissão
post
APIS - Comunicações
Assuntos
Retorna os assuntos do atendimento
get
Retorna os Subassuntos do assunto
get
Retorna os assuntos de atendimento
get
Atendimentos
Realiza o cadastro de um novo atendimento
post
Finaliza um atendimento
post
Lista os atendimentos
get
Contratos
Solicitação de envio por e-mail dos contratos associados ao cliente
post
Empreendimentos
Retorna os dados dos empreendimentos ativos no sistema
get
Retorna as unidades disponíveis do empreendimento
get
Financeiro
Solicitação de envio por e-mail da segunda via dos boletos da unidade
post
Solicitação de envio por e-mail do extrato financeiro do cliente
post
Solicitação de envio por e-mail o imposto de renda
post
Leads
Realiza o cadastro de um novo lead
post
Altera o empreendimento vinculado ao lead
put
Pessoa
Retorna os dados da pessoa
get
Unidades
Retorna os dados da unidade
get
Agendamentos
Retorna os agendamentos ativos que o gestor está associado
get
Cadastrar um agendamento
post
Retorna os agendamentos ativos que uma pessoa está associada
get
Retorna os horários disponíveis para agendamento em uma determinada unidade
get
Cancelar um determinado agendamento, seja visita ou vistoria
put
Retorna os ids de todos os agendamentos ativos da base do cliente
get
Retorna as datas disponíveis para agendamento de determinado empreendimento
get
Retorna as unidades disponiveis para agendamentos
get
Retorna os horários disponíveis para agendamento em uma ou de todas as unidade da pessoa
get
API de Corretores
Corretor
Cadastra corretor.
post
Retorna um ou vários corretores.
get
Cadastra corretor PJ.
post
CVDW
Leads
Retorna os dados do corretor do lead
get
Retorna os dados dos leads
get
Retorna os dados das conversões dos leads
get
Retorna os dados dos leads ganhos
get
Retorna o histórico das situações dos leads
get
Retorna alguns dados dos leads
get
Retorna a listagem de interações dos leads.
get
Retorna os dados dos momentos dos leads
get
Retorna as informações de perda do leads
get
Retorna as tarefas dos leads
get
Retorna a listagem de interações de visitas de leads.
get
Retorna o tempo em que o lead passou em determinada situação.
get
Retorna as alterações na possibilidade de vendas dos leads.
get
Agendamentos
Retorna os dados das vistorias
get
Distratos
Retorna os distratos
get
Comissões
Atendimentos
Retorna os dados dos atendimentos
get
Retorna o tempo que o atendimento passou em cada situação.
get
Retorna as interações dos atendimentos
get
Retorna as respostas dos atendimentos
get
Retorna as tarefas dos atendimentos
get
Retorna os times de atendimentos
get
Retorna os integrantes dos times de atendimentos
get
Distratos
Reservas
Vendas
Retorna os dados das vendas
get
Assistências
Retorna os dados das assistências
get
Retorna o tempo que a assistência passou em cada situação.
get
Retorna os dados dos itens das assistências
get
Retorna o tempo que o item da assistência passou em cada situação.
get
Retorna o tempo que a visita da assistência passou em cada situação.
get
Simulações
Vendas
Assistências
Pre-cadastro
Retorna os dados dos pré-cadastros
get
Retorna o tempo do pré-cadastro em cada situação
get
Retorna o histórico de situações do pré-cadastro
get
Filas de Distribuição
Retorna a distribuição dos leads
get
Usuários Administrativos
Processos
Retorna os dados dos processos
get
Pre-cadastro
Imobiliarias
Retorna os dados das imobiliarias
get
Corretores
Retorna os dados dos corretores
get
Pesquisas
Repasses
Retorna os dados dos repasses
get
Retorna o tempo que o repasse ficou em uma determinada situação.
get
Retorna o histórico das situações do repasse
get
Campanhas de Ativação
Campos Adicionais
Pessoas
Retorna os dados das pessoas
get
Retorna os dados de contatos das pessoas
get
Retorna os dados profissionais e outras rendas das pessoas
get
Retorna os dados patrimoniais das pessoas
get
Retorna os dados bancários das pessoas
get
Retorna os bens da empresa das pessoas
get
Retorna os dados financeiros das pessoas
get
Retorna as tags associadas a pessoa
get
Correspondentes
Comissões
Retorna as comissões
get
Retorna os pagamentos das comissões
get
Retorna o tempo da comissão em cada situação do workflow
get
Reservas
Retorna as reservas
get
Retorna os dados de comissão na reserva
get
Retorna os dados da programação da comissão na reserva
get
Retorna os dados dos coordenadores da reserva
get
Retorna os dados históricos das situações das reservas
get
Retorna os dados do histórico da reserva
get
Retorna os dados das condições da reserva
get
Retorna os dados dos associados da reserva
get
Retorna os dados dos contratos da reserva
get
Retorna os dados do workflow de reservas
get
Retorna os dados dos campos adicionais de reservas
get
Retorna os dados das reservas do Sienge
get
Retorna as situações em que a reserva passou
get
Simulações
Retorna os dados das simulações
get
Unidades
Retorna situacao das unidades
get
Valores das unidades das tabelas dinâmicas (Valor unidades)
get
Retorna os dados das unidades
get
Usuários Administrativos
Retorna os dados dos usuários administrativos
get
Pesquisas
Retorna as pesquisas ativas
get
Retorna as perguntas das pesquisas
get
Retorna as respostas das pesquisas
get
Campanhas de Ativação
Retorna as campanhas de ativação
get
Campos Adicionais
Retorna os campos adicionais
get
Correspondentes
Retorna os usuários correspondentes
get
Retorna as empresas correspondentes
get
Empresas
Empresas
/empresas
get
API de Empreendimentos
Empreendimento
Cadastra empreendimento.
post
Retorna empreendimentos.
get
Retorna empreendimento.
get
Cadastra novo arquivo de cliente no empreendimento.
post
Retorna as pastas dos arquivos de cliente no empreendimento.
get
Etapa
Cadastra etapa.
post
Bloco
Cadastra bloco.
post
Unidade
Cadastra unidade.
post
Retorna unidade.
get
bloquear_unidade
Bloqueia ou disponibiliza unidade.
post
Tipologias das Unidades
Retornar tipologias das unidades
get
Adicionar tipologia das unidades
post
Atualiza tipologia das unidades
put
Deletar tipologia das unidades
del
Empreendimento Corretores
Retornar corretores associados a um empreendimento
get
Associar corretor a um empreendimento
post
Empreendimento Imobiliárias
Retornar imobiliárias associadas a um empreendimento
get
Associar imobiliária a um empreendimento
post
campos_obrigatorios
Retorna campos obrigatórios.
get
Motivos de Bloqueio Unidade
Retorna motivos de bloqueio de unidade.
get
referencia_externa
Atualiza referência externa.
put
Dados ERP
Retorna dados ERP Sienge do empreendimento.
get
Gestões de Distrato
Gestões de Distrato
Retorna todas as gestões de distrato cadastradas
get
Api de Gestões de Cessão
Gestões de Cessão
get gestão de cessão
get
Gestões de Contrato
Gestões de Contrato
Retorna todas as gestões de contrato cadastradas
get
API de Imobiliárias
Imobiliária
Cadastra imobiliária.
post
Retorna uma imobiliária cadastrada
get
Usuários Imobiliárias
Retorna usuários de imobiliárias
get
Adicionar ou alterar usuário de imobiliária
post
Indexadores
Indexadores
/indexador
get
Integrações
Webhook
Adicionar webhook
post
Retornar Webhooks
get
Deletar Webhook
del
Retornar Gatilhos
get
API de Leads
Leads
Retorna leads
get
Cadastra Leads
post
Atendentes das Filas de Distribuição de Leads por Tag
Retorna os Atendentes das Filas de Distribuição de Leads
get
Consultar Atendimento do Lead
Retorna os atendimentos dos Leads
get
Filas de Distribuição de Leads
Retorna as Filas de Distribuição de Leads
get
Motivos de Cancelamento de Lead
Retorna os Motivos de Cancelamento do Lead
get
Tarefas
Retorna as tarefas dos leads
get
Retorna uma tarefa por id
get
/cvio/lead_tarefas/cadastrar
post
/cvio/lead_tarefas/cadastrar
put
Conversões dos Leads
Retorna as Conversões do Lead
get
Interações
Retorna as interações dos leads
get
Atualiza as interações dos leads
put
Mapa Disponibilidade
Mapa Disponibilidade
/mapadisponibilidade/{idEmpreendimento}
get
Portal do Cliente API
Autenticação
Comunicados
Retorna os comunicados dos empreendimentos referente ao cliente logado
get
Configurações
Retorna as configurações do painel do cliente
get
Retorna o dominio dos múltiplos portais cadastrados
get
Retorna se o slug informado é válido
get
Campos Adicionais
Retorna os campos adicionais do cliente
get
Banners
Retorna os banners ativos do painel do cliente
get
Empreendimentos
Retona os dados dos empreendimentos associados ao cliente
get
Retona os dados dos empreendimentos ativos no sistemas
get
Retorna a galeria de fotos de um empreendimento
get
Retorna a galeria de fotos de uma unidade
get
Retorna os estágios do andamento da obra de um empreendimento
get
Retorna os estágios do andamento da obra de uma unidade
get
Retorna os comunicados do empreendimento buscado
get
Retorna os documentos do empreendimento do cliente
get
Retorna os documentos do síndico do empreendimento
get
Realiza o cadastro dos arquivos do síndico no empreendimento
post
Faz o upload dos arquivos do síndico do empreendimento
post
Contratos
Retornar os contratos das unidades do cliente
get
Endereço
Retornar os logradouros cadastrados no sistema
get
Retornar os estados cadastrados no sistema
get
Retornar as cidades de um estado cadastrados no sistema
get
Itens de Manutenção
Retorna os itens de manutenção das assistências técnicas
get
Financeiro
Retorna os boletos que o cliente possui
get
Retorna um link com o pdf gerado do boleto
get
Retorna as unidades que é possivel requisitar o relatório de imposto de renda
get
Solicitação o envio do relatório do imposto de renda no Sienge
put
Link para download do relatório do imposto de renda no Sienge
get
Retorna o extrato do cliente
get
Retorna um link com o pdf gerado do extrato
get
Retorna um link com o pdf do saldo devedor
get
Envia o extrato do cliente por e-mail
put
Retorna os parcelas disponiveis para antecipação de uma unidade
get
Retorna as parcelas antecipadas de uma unidade que foram confirmadas
get
Realiza a simulação de Antecipação de Parcelas
post
Realiza a solicitação de Antecipação de Parcelas
post
Retorna os reparcelamentos realizados de uma unidade
get
Realiza o reparcelamento de uma ou mais parcelas
post
Assistências Técnicas
Retorna as assistências técnicas do cliente
get
Retorna as situações possíveis para uma assistência tecnica
get
Retorna os dados de uma assistência técnica
get
Realiza o cadastro de uma nova assistência técnica
post
Faz o upload dos arquivos na mensagem da assistência
post
Faz o upload dos arquivos da assistência
post
Cadastra uma mensagem na assistência
post
Retorna as áreas comuns das assistências técnicas
get
Retorna as datas disponíveis para visita técnica de acordo com o item
get
Retorna os horários disponíveis para visita técnica para a data informada
get
Cadastra uma visita técnica
post
Localidade
Retorna as localidades das assistências técnicas
get
Autenticação
Realizar login
post
Realizar login como síndico
post
Realizar login
post
Envia o código de verificação para autenticação externa
post
Gera o token de autenticação externa
post
Agendamentos
Retorna os agendamentos ativos que o cliente está associado
get
Cadastrar um agendamento para o cliente
post
Retorna dados de um determinado agendamento com a unidade
get
Retorna as unidades do cliente disponíveis para agendamento
get
Cancelar um determinado agendamento, seja visita ou vistoria
put
Retorna os horários disponíveis para agendamento em uma determinada unidade em uma data
get
Retorna as datas disponíveis para agendamento de determinado empreendimento
get
Retorna as situações possíveis para um agendamento
get
Notificações
Cadastra um novo dispositivo
post
Remove um dispositivo
del
Retorna as últimas notificações de um cliente
get
Marca uma notificação como lida
put
Retorna as permissões de notificação de um cliente
get
Cria ou atualiza uma permissão de notificação de um cliente
post
Associações de Pessoas
Retornar as associações ao cliente
get
Adiciona uma associação do cliente
post
Adiciona uma associação de uma pessoa não cadastrada no sistema
post
Remove uma associação do cliente
del
Atualiza os dados de uma associação do cliente
put
Retornar os tipos de associações cadastrados no sistema
get
Atendimentos
Retorna os dados de um atendimento
get
Retorna os atendimentos ativos que o cliente está associado e é permitido a visualização
get
Realiza o cadastro de um atendimento
post
Faz o upload dos arquivos do atendimento
post
Responde um determinado atendimento
post
Avalia um atendimento
post
Retorna os assuntos do atendimento
get
Retorna os subassuntos de assunto do atendimento
get
Retorna as areas comum do atendimento
get
Retorna as situaçõea possíveis em um atendimento
get
Documentos
Retorna os documentos do síndico
get
Financeiro CV
Retorna os boletos que o cliente possui em determinada unidade
get
Retorna os extratos que o cliente possui em determinada unidade
get
Retorna o IR que o cliente possui em determinada unidade
get
Pesquisas
Retornar as pesquisas ativas para o usuário
get
Retorna as resposta do cliente de uma pesquisa
get
Portal de Benefícios
Retorna os marketplaces vinculados a um portal do cliente
get
Pessoa
Realizar cadastro de um novo cliente
post
Retorna os dados do cliente logado
get
Modifica o cliente de acordo com os dados passados
put
Modifica o endereço do usuário
put
Retorna o token do cliente
get
Retornar os dados de uma pessoa pelo seu documento
get
Ativa a conta de uma pessoa
put
Define a unidade padrão de um cliente
post
Realizar exclusão de dados
put
Perguntas frequentes
Retorna as perguntas frequentes do portal
get
Permissões dos Perfis
Retorna as permissões dos perfis do cliente de acordo com configuração do painel do cliente
get
Permissões dos Síndicos
Retorna as permissões do síndico de acordo com configuração do painel do cliente
get
Pré Cadastros
Retorna os pré cadastros do cliente pendentes de documento
get
Síndico
Retorna os dados do síndico logado
get
Modifica o síndico de acordo com os dados passados
put
Modifica o avatar do síndico
post
Reservas
Retorna as reservas do cliente pendentes de documento
get
Resetar Senha
Resetar senha recebendo pelo email
post
Resetar senha do síndico por email
post
Resetar senha recebendo por SMS
post
Resetar senha do síndico por SMS
post
Termo de Aceite
Retorna um termo a ser aceitado pelo cliente
get
Realiza o aceite do termo
post
Unidades
Retona os dados das unidades ativas associadas ao usuário
get
Retona os dados da unidade ativas filtrada pelo seu id
get
Retona os documentos da unidade
get
Retona os documentos da unidade
get
Portal do Corretor API
Simulações
Comissões
Tabela de Preço do Empreendimento
Configurações Comerciais
Notificações
API de Pré-cadastro
Pré-cadastro
Retorna o Pré-cadastro
get
Cadastra o Pré-cadastro
post
Edita o Pré-cadastro
put
Mensagens
Retorna a lista de mensagens de um pré-cadastro
get
Cadastra uma mensagem para um pré-cadastro
post
Documentos
Retorna os Documentos do Pré-cadastro
get
Cadastra Documentos no Pré-cadastro
post
Altera Documentos no Pré-cadastro
post
Profissões
Profissões
/profissoes
get
Cadastrar uma profissão no CV
post
Profissões
Notificações
Repasse
Notificações
API de Reservas
Reserva
Retorna as reservas de acordo com os filtros
get
Retorna a reserva de acordo com os filtros
get
Retorna as regras de comissão da reserva no Construtor de Vendas
get
Atualiza uma reserva no Construtor de Vendas
put
Cadastra uma reserva no Construtor de Vendas
post
Retorna as reservas de acordo com os filtros
get
Atualiza uma reserva no Construtor de Vendas
put
Cadastra uma reserva no Construtor de Vendas
post
Retorna a reserva de acordo com os filtros
get
Retorna as regras de comissão da reserva no Construtor de Vendas
get
Cancelamento
Altera situação da reserva para cancelada
post
Altera situação da reserva para cancelada
post
Distrato
Retorna distratos de reservas
get
Altera situação da reserva para distrato
post
Retorna distratos de reservas
get
Altera situação da reserva para distrato
post
Retorna as reservas com solicitações de distrato
get
Solicita o distrato da reserva
post
Cessão
Retorna as cessões de direitos
get
Realiza cessão de direitos de uma reserva
post
Retorna as cessões de direitos
get
Realiza cessão de direitos de uma reserva
post
Repasse
Retorna repasses
get
Altera situação de um repasse
post
Retorna repasses
get
Altera situação de um repasse
post
Cadastra uma nova mensagem
post
Retorna os números do Repasse
get
Alterar Situação
Altera situação da reserva
post
Boletos
Cadastra boleto para parcela de série do tipo Ato ou Sinal
post
Atualiza boleto para parcela de série do tipo Ato ou Sinal
put
Cadastra boleto para parcela de série do tipo Ato ou Sinal
post
Atualiza boleto para parcela de série do tipo Ato ou Sinal
put
Lotes
Retorna lote de pagamentos de comissão
get
Cadastra lote de pagamentos de comissão
post
Altera lote de pagamentos de comissão
put
Retorna lote de pagamentos de comissão
get
Cadastra lote de pagamentos de comissão
post
Altera lote de pagamentos de comissão
put
Campanhas
Retorna as campanhas cadastradas na reserva
get
Retorna as campanhas cadastradas na reserva
get
Mensagens
Cadastra uma nova mensagem
post
Retorna a(s) mensagem(s) de uma reserva
get
Correspondente
Altera o correspondente da reserva
put
Dados ERP
Retorna dados do ERP Sienge da reserva
get
Atualiza dados do ERP Sienge em uma reserva
put
Análises de Crédito
Retorna a(s) análise(s) de crédito de uma reserva
get
Kit Decoração
Retorna os kits de decoração da reserva
get
Associa um kit de decoração a uma reserva
post
Alterar Situação
Altera situação da reserva
post
Informar Venda
Atualiza situação da reserva para vendida
post
Atualiza situação da reserva para vendida
post
Contratos
Retornar contratos da reserva
get
Cadastrar contratos na reserva
post
Envia contratos da reserva para a assinatura eletrônica
post
Documentos
Retorna os documentos cadastrados na reserva
get
Cadastra documentos na reserva
post
Condição de Pagamentos da Reserva
Retorna as condições de pagamento de uma reserva
get
Retorna as condições de pagamento de uma reserva
get
Dados ERP
Retorna dados do ERP Sienge da reserva
get
Atualiza dados do ERP Sienge em uma reserva
put
Mensagens
Cadastra uma nova mensagem
post
Retorna a(s) mensagem(s) de uma reserva
get
Análises de Crédito
Retorna a(s) análise(s) de crédito de uma reserva
get
Kit Decoração
Retorna os kits de decoração da reserva
get
Associa um kit de decoração a uma reserva
post
Contratos
Retornar contratos da reserva
get
Cadastrar contratos na reserva
post
Envia contratos da reserva para a assinatura eletrônica
post
Retorna os contratos assinados por assinatura eletrônica da reserva
get
Documentos
Retorna os documentos cadastrados na reserva
get
Cadastra documentos na reserva
post
API de Séries de Tabelas de Preços
Tabelas de Preços
Retorna as tabelas de preço ou uma tabela de preço mais detalhada
get
Retorna as tabelas de preço ou uma tabela de preço mais detalhada
get
Recupera a lista de tabelas de preço
get
Recupera a lista de tabelas de preço
get
Recupera uma tabela de preço específica
get
Séries de Tabelas de Preços
Cadastro de Séries de Tabelas de Preços
post
Recupera a lista de tabelas de preço completa
get
Usuários Administrativos
Usuários Administrativos
/v1/configuracoes/usuariosadm
get
Usuários Administrativos por Perfís de Acesso
Autenticação
Envia o código de verificação para autenticação externa
post
Gera o token de autenticação externa
post
Esqueci Senha
Enviar código de recuperação de senha
post
Validar código de recuperação de senha
post
Senha Expirada
Workflow API
Workflow
/workflows/{funcionalidade}
get
/workflows/{funcionalidade}/{idSituacao}
get
/workflows/{funcionalidade}/subworkflows
get
Localidades API
Localidades
Retorna os estados
get
Retorna as cidades
get
Gestões de Time
Gestões de Time
Retorna uma gestão de time cadastrada
get
API do Financeiro
Boleto
Salva os boletos para o Portal do cliente
post
Retorna os boletos de uma reserva
get
Atualiza a situação do pagamento no cv
put
Extrato
Salva os boletos para serem exibidos no portal do cliente
post
IR
salva a renda para ser exibida no portal do cliente
post
Mensagens da comissão
Retorna as mensagens de uma comissão
get
Cadastra uma mensagem em uma comissão
post
Retorna a mensagem de uma comissão
get
Retorna os arquivos de uma mensagem da comissão
get
Retorna o arquivo de uma mensagem da comissão
get
Pagamentos da comissão
Retorna os pagamentos da comissão
get
Alterar pagamento da comissão
put
Libera os pagamentos da comissão
put
Bloqueia os pagamentos da comissão
put
Anexa um documento a um pagamento de comissão
post
Parcelas da reserva
Retorna todas as parcelas de pagamento da reserva
get
Cadatra boletos das parcelas quando for tipo ato ou sinal
put
Configurações Comerciais
Ask AI
