v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Unidade

Cadastra unidade.

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

Unidade é um imóvel do empreendimento. Quando essa interface for consumida uma nova unidade será cadastrada no Construtor de Vendas. A interface irá verificar se o dado inserido no campo idbloco_int existe ou não no CV, se já existir um bloco cadastrado com o mesmo idbloco_int essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los.

Obs: Para que essas informações sejam inseridas no CV, os identificadores da etapa e do empreendimento devem existir no sistema.

post/v1/cadastros/empreendimentos/unidades

Headers

emailstring required

Example:email@email.com

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

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de unidade.

Request body

idunidade_intstring required

Identificador da unidade no sistema legado (código interno).

idbloco_intstring required

Identificador do bloco da unidade no sistema legado (código interno).

idetapa_intstring required

Identificador da etapa da unidade no sistema legado (código interno).

idempreendimento_intstring required

Identificador do empreendimento da unidade no sistema legado (código interno).

idtipologia_intstring

Identificador da tipologia no sistema legado (código interno).

idtipo_intstring

Identificador da tipo no sistema legado (código interno).

matriculastring

Matrícula de Unidade.

cibstring

Cadastro Imobiliário Brasileiro (CIB) da unidade. Formato AAAAAAA-D (7 caracteres alfanuméricos, hífen e 1 dígito verificador).

nomestring required

Nome da unidade.

descricaostring

Descrição da unidade.

complementostring

Complemento da unidade.

vagas_garagemstring

Número de vagas da garagem.

situacaostring required

Situação da unidade (Disponivel ou Bloqueada).

removerstring

Identificador da unidade que deseja remover.

andarstring

Andar da unidade.

colunainteger

Coluna da unidade.

valornumber

Valor da unidade.

valor_avaliacaonumber

Valor de avaliação da unidade.

qtde_quartosinteger

Quantidade de quartos da unidade.

qtde_banheirosinteger

Quantidade de banheiros da unidade.

qtde_suitesinteger

Quantidade de suítes da unidade.

qtde_espacos_complementaresinteger

Quantidade de espaços complementares da unidade.

qtde_vagas_garageminteger

Quantidade de vagas de garagem da unidade.

jardimstring

Jardim da unidade.

dimensoesstring

Dimensões da unidade.

latitudestring

latitude da unidade.

longitudestring

latitude da unidade.

tipologiastring

tipologia da unidade. (Pode informar o id ou nome de uma tipologia existente)

posicaostring

Posição da unidade. (Pode informar o id ou nome de uma posição existente)

ref_ordenacaostring

Referência de ordenação da unidade.

faseinteger

Fase da unidade.

fator_apropriacaonumber

Fator de apropriação da unidade.

mapa_lotestring binary

Enviar imagem do mapa do lote (multipart/form-data ou passar uma imagem em base64)

fracao_idealstring

Fração ideal da unidade.

area_privativastring required

Área privativa da unidade em m².

area_garagemstring

Área de garagem da unidade em m².

area_comumstring

Área comum da unidade em m².

area_outra_privativastring

Outras áreas privativas em m².

area_totalstring

Área total da unidade em m² (deve ser equivalente à soma das áreas privativa, garagem, comum e outras áreas privativas).

area_privativa_totalstring

Área privativa total da unidade em m².

area_terrenostring

Área de terreno da unidade em m².

motivo_bloqueiostring

Motivo de bloqueio da unidade (caso seja bloqueada).

nome_tipostring

Tipo da unidade.

data_entregastring

Data de entrega da unidade (dd/mm/aaaa)

data_entrega_chavesstring

Data de entrega das chaves da unidade (dd/mm/aaaa)

agendar_a_partirstring

Data de agendamentos das vistorias da unidade (dd/mm/aaaa)

liberar_a_partirstring

Data de liberação da unidade (dd/mm/aaaa)

Example request

{
  "idunidade_int": "3652889",
  "idbloco_int": "12589",
  "idetapa_int": "5898",
  "idempreendimento_int": "12345678",
  "idtipologia_int": "1",
  "idtipo_int": "1",
  "matricula": "123",
  "cib": "1234ABC-5",
  "nome": "Unidade 01",
  "descricao": "Descrição da unidade",
  "complemento": "Complemento da unidade",
  "vagas_garagem": "10",
  "situacao": "Bloqueada",
  "remover": "0",
  "andar": "10",
  "coluna": 10,
  "valor": 150000,
  "valor_avaliacao": 150000,
  "qtde_quartos": 2,
  "qtde_banheiros": 2,
  "qtde_suites": 2,
  "qtde_espacos_complementares": 2,
  "qtde_vagas_garagem": 2,
  "jardim": "Informação jardim",
  "dimensoes": "Informação das dimensões",
  "latitude": "-10.9409535",
  "longitude": "-37.0343687",
  "tipologia": "2 banheiros",
  "posicao": "Sul",
  "fase": 3,
  "fator_apropriacao": 98.4567,
  "fracao_ideal": "152.12",
  "area_privativa": "620.59",
  "area_garagem": "119.41",
  "area_comum": "120.5",
  "area_outra_privativa": "50",
  "area_total": "910.5",
  "area_privativa_total": "650",
  "area_terreno": "150",
  "motivo_bloqueio": "Unidade bloqueada",
  "nome_tipo": "Lote",
  "data_entrega": "01/01/2023",
  "data_entrega_chaves": "01/01/2023",
  "agendar_a_partir": "01/01/2023",
  "liberar_a_partir": "01/01/2023",
  "campos_adicionais": {
    "adc_valor_adicional": "1.000,00"
  }
}

Response

Mensagem de sucesso ao cadastrar unidade.

idinteger

Id criado

sucessoboolean

Example response

{
  "id": 90,
  "sucesso": true
}