v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Empreendimento

Cadastra empreendimento.

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

Empreendimento é um conjunto de unidades (imóveis) para venda ou aluguel. Esta integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo 'nome' existe ou não no Construtor de Vendas. Se já existir um empreendimento cadastrado com o mesmo nome, essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los.

Obs: Somente será aceito um cadastro por nome. O campo estado deve ter a sigla em letras MAIÚSCULAS (Exemplo: São Paulo = SP).

post/v1/cadastros/empreendimentos

Headers

emailstring required

Example:email@email.com

E-mail de autenticação para cadastro de empreendimento.

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de empreendimento.

Request body

idempreendimento_intstring required

Código interno do empreendimento.

nomestring required

Nome do empreendimento.

disponivelstring

Informa a disponibilidade do empreendimento (Ativou ou Finalizado).

matriculastring required

Matrícula do empreendimento.

referencia_externastring

Referência de externa.

regiaostring

Região do empreendimento.

cidadestring required

Cidade do empreendimento.

estadostring required

Estado do empreendimento.

bairrostring

Bairro do empreendimento.

endereco_empstring

Endereço do empreendimento.

numerostring

Número do empreendimento.

logradourostring

Logradouro do empreendimento. (id ou nome)

cepstring

CEP do empreendimento.

enderecostring

Endereço completo do empreendimento.

data_entregastring

Data de entrega do empreendimento. (AAAA/MM/DD)

periodo_venda_iniciostring

Início do das Vendas do empreendimento.

area_construidastring

Área construída do Empreendimento.

area_privativastring

Área privativa do Empreendimento.

idempresa_intstring required

Código interno da empresa.

nome_empresastring required

Nome da empresa.

razao_social_empresastring required

Razão Social da empresa.

cnpj_empresastring required

CNPJ da empresa.

endereco_empresastring

Endereço da empresa.

ativo_painelstring required

Disponibilidade de relacionamento do Empreendimento com as funcionalidades do sistema.

siglastring required

Sigla do empreendimento.

Example request

{
  "idempreendimento_int": "12345678",
  "nome": "Sol Nascente",
  "disponivel": "Ativo",
  "matricula": "emp",
  "regiao": "Nordeste",
  "cidade": "Aracaju",
  "estado": "SE",
  "bairro": "Centro",
  "endereco_emp": "R. Julio Garcez",
  "numero": "123",
  "logradouro": "Rua",
  "cep": "49140000",
  "endereco": "Rua teste, 321",
  "data_entrega": "2024-01-30",
  "periodo_venda_inicio": "2018-01-06 00:00:00",
  "area_construida": "1500,45",
  "area_privativa": "1500,00",
  "idempresa_int": "5325898",
  "nome_empresa": "Emp Token",
  "razao_social_empresa": "Realizaçoes.com Ltda",
  "cnpj_empresa": "32462336000162",
  "endereco_empresa": "Av. Beira mar",
  "ativo_painel": "S",
  "sigla": "Emp",
  "campos_adicionais": {
    "adc_valor_adicional": "1.000,00"
  }
}

Response

Empreendimento cadastrado com sucesso.

codigointeger

mensagemstring

Example response

{
  "codigo": 200,
  "mensagem": "Empreendimento cadastrado com sucesso."
}