v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Imobiliária

Cadastra imobiliária.

🔒 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)

Interface responsável por inserir novas imobiliárias dentro do Construtor de Vendas, quando o serviço for requisitado irá verificar se o dado inserido no campo idimobiliaria_int ou CNPJ existe ou não no Construtor de Vendas, se já existir uma imobiliária cadastrada com o mesmo idimobiliaria_int (código interno da imobiliária) ou com mesmo CNPJ a API irá atualizar os dados solicitados na requisição, senão irá cadastrá-los.

Obs: Para que essas informações sejam inseridas no Construtor de Vendas, o campo estado deve ser a sigla em letras maiúsculas e os campos de CNPJ devem ser válidos. O campo remover só deve ser informado caso a imobiliária precise ser excluída do CV, para esse processo acontecer o campo deve conter a informação do código interno da imobiliária.

post/v1/cadastros/imobiliarias

Headers

emailstring required
Example:email@email.com

E-mail de autenticação para cadastro de imobiliária.

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de imobiliária.

Request body

referenciastring

Código identificador da imobiliaria

referencia_datastring

Data de referência

ativostring

Informa se está ativo ou não

ativo_painelstring required

Informa se está ativo no painel ou não

idimobiliariainteger

Código identificador da imobiliaria

data_cadstring

Data de Cadastro da imobiliária

idestadointeger

Identificação do estado da imobiliária

idcidadeinteger

Identificação da cidade da imobiliária

nomestring required

Nome da imobiliária

razao_socialstring required

Razao Social da Imobiliára

cnpjstring

CNPJ da imobiliária

cnpj_faturamentostring

CNPJ da faturmanto da imobiliária

idlogradourointeger

Logradouro da imobiliária

enderecostring

Endereço da imobiliária.

complementostring

Complemento do endereço da imobiliária

numerostring

Número de endereço da imobiliária

bairrostring

Bairro da imobiliária

cepstring

CEP da imobiliária

telefonestring

Telefone da imobiliária

celularstring

Celular da imobiliária

emailstring

E-mail da imobiliária.

crecistring required

CRECI da imobiliária

avatar_nomestring

Nome do arquivo avatar da imobiliária

avatar_servidorstring

Nome do arquivo avatar da imobiliária no servidor

avatar_tipostring

Tipo de arquivo do avatar da imobiliária

avatar_tamanhointeger

Tamanho do arquivo do avatar da imobiliária

validade_crecistring required

Data de validade do CRECI da imobiliária

gerente_nomestring

Nome do gerente da imobiliária

gerente_cpfstring

CPF do gerente da imobiliária

gerente_telefonestring

Telefone do gerente da imobiliária

gerente_celularstring

Celular do gerente da imobiliária

gerente_emailstring

E-mail do gerente da imobiliária

siglastring required

Sigla da imobiliária

codigointernostring

Código interno da imobiliária

observacoesstring

Observações da imobiliária

micro_empresastring required

Informa se imobiliária é uma microempresa Sim (S) ou Não (N)

inscricao_estadualstring

Inscrição estadual da imobiliária

inscricao_municipalstring

Inscrição municipal da imobiliária

tipo_contastring

Tipo de conta da imobiliária: Conta Corrente (C) ou Poupança (P)

idbancointeger

Identificador do banco da imobiliária no CV

nome_agenciastring

Nome da agência do banco da imobiliária

numero_agenciastring

Número da agência da imobiliária

digito_agenciastring

Dígito verificador da agência da imobiliária

numero_contastring

Número da conta de banco da imobiliária

digito_contastring

Dígito verificador da conta de banco da imobiliária

nome_favorecidostring

Nome do favorecido da conta de banco da imobiliária

cnpj_favorecidostring

CNPJ do favorecido da conta de banco da imobiliária

alterar_login_corretorstring required

Informa se a imobiliária pode interferir no login do corretor: Sim (S) ou Não (N)

escala_plantaostring required

Informa se a imobiliária pode administrar a escala de plantão: Sim (S) ou Não (N)

idimobiliaria_novstring

Campo idimobiliaria_nov da imobiliária

bloqueado_recebimento_pagamento_comissaostring

Informa se a imobiliária está bloqueada (S) ou não (N) para receber pagamento de comissão

autocadastro_corretorstring

Informa se exibe (S) ou não (N) a imobiliária no Cadastre-se do Painel Corretor.

diretor_nomestring

Nome do diretor da imobiliária

diretor_cpfstring

CPF do diretor da imobiliária

diretor_telefonestring

Telefone do diretor da imobiliária

diretor_celularstring

Celular do diretor da imobiliária

diretor_emailstring

E-mail do diretor da imobiliária

data_modificacaostring

Data de modificação da imobiliária

bancostring

Nome do banco.

idimobiliaria_intstring

Identificador da imobiliária no sistema legado.

logradourostring

Logradouro do endereço da imobiliária.

cidadestring

Cidade em que a imobiliária se localiza.

estadostring

Estado em que a imobiliária se localiza.

removerstring

Informar apenas se quiser remover a imobiliária informada do CV.

Example request

{
  "referencia": "193 ou 193_30",
  "referencia_data": "2023-01-15 15:26:15",
  "ativo": "S",
  "ativo_painel": "S",
  "idimobiliaria": 1,
  "data_cad": "2021-03-10 11:17:50",
  "idestado": 1,
  "idcidade": 1,
  "nome": "Imobiliaria teste",
  "razao_social": "Razao Social",
  "cnpj": "12.345.678/0001-55",
  "cnpj_faturamento": "12.345.678/0001-55",
  "idlogradouro": 1,
  "endereco": "Rua Esmeralda",
  "complemento": "apartamento",
  "numero": "32 A",
  "bairro": "bairro teste",
  "cep": "49500-235",
  "telefone": "7999858588",
  "celular": "7999858588",
  "email": "imobiliaria@email.com",
  "creci": "123456",
  "avatar_nome": "LOGO.jpg",
  "avatar_servidor": "20240918163700_66eb2bdc25823.jpg",
  "avatar_tipo": "image/jpeg",
  "avatar_tamanho": 3647,
  "validade_creci": "2021-03-10",
  "gerente_nome": "Nome gerente",
  "gerente_cpf": "123.456.789-10",
  "gerente_telefone": "799945-8585",
  "gerente_celular": "799945-8585",
  "gerente_email": "gerente@cvcrm.com.br",
  "sigla": "TS",
  "codigointerno": "123456",
  "observacoes": "observações sobre a imobiliária",
  "micro_empresa": "N",
  "inscricao_estadual": "456.669.456.444",
  "inscricao_municipal": "123654",
  "tipo_conta": "C",
  "idbanco": 1,
  "nome_agencia": "Agência Exemplo",
  "numero_agencia": "1234",
  "digito_agencia": "0",
  "numero_conta": "123456",
  "digito_conta": "1",
  "nome_favorecido": "José dos Santos Silva",
  "cnpj_favorecido": "87728824000160",
  "alterar_login_corretor": "S",
  "escala_plantao": "S",
  "idimobiliaria_nov": "123456789",
  "autocadastro_corretor": "S",
  "diretor_nome": "Pedro Paulo Pedroso",
  "diretor_cpf": "24290203515",
  "diretor_telefone": "+557933561247",
  "diretor_celular": "+5579998654478",
  "diretor_email": "diretordaimobiliaria@mail.com",
  "data_modificacao": "2024-09-18 17:51:51",
  "banco": "Banco XYZ",
  "idimobiliaria_int": "5458954",
  "logradouro": "Rua",
  "cidade": "Itaquaquecetuba",
  "estado": "SP",
  "remover": "0"
}

Response

Operação realizada com sucesso.

codigostring
mensagemstring

Example response

{
  "codigo": "200",
  "mensagem": "Operação realizada com sucesso."
}