v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Unidades

Retorna os dados das unidades

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

Esta Api retorna os dados das unidades

get/unidades

Query parameters

paginainteger

Página que deseja visualizar os registros

registros_por_paginainteger

Quantidade de registro por página, máximo 500 registros

a_partir_referenciainteger

Retornará os registros a partir deste id, lembrando que está ordenado por referencia_data.

a_partir_data_referenciastring

Retornará os registros com data referência a partir da data informada

ate_data_referenciastring

Retornará os registros com data referência até a data informada

Headers

emailstring required

E-mail de autenticação do usuário administrativo

tokenstring required

Token criado no usuário administrativo do e-mail

Response

Unidade

paginainteger

Página atual do retorno dos registros

registrosinteger

Quantidade de registro da página, máximo 500 registros

total_de_registrosinteger

Total de registros encontrados

total_de_paginasinteger

Total de páginas encontradas

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 1054,
  "total_de_paginas": 36,
  "dados": [
    {
      "referencia": 1186,
      "referencia_data": "2023-01-15 15:26:15",
      "idempreendimento": 1186,
      "idempreendimento_int": "ABC-123",
      "nome_empreendimento": "Empreendimento X",
      "idtipo_empreendimento": 1,
      "tipo_empreendimento": "Horizontal",
      "idetapa": 1186,
      "idetapa_int": "1186",
      "etapa": "1ª ETAPA",
      "idbloco": 1186,
      "idbloco_int": "1186",
      "bloco": "BLOCO 01",
      "nome": "001",
      "area_privativa": 122,
      "idunidade": "12345",
      "idunidade_int": "123",
      "cib": "1234ABC-5",
      "vagas_garagem": "1",
      "andar": "7",
      "area_comum": "33.39",
      "coluna": 10,
      "posicao": "Leste",
      "tipologia": "3 suites com terraço gourmet",
      "tipo": "Apartamento",
      "idtipo_int": "123",
      "empresa_terceirizacao": "Nome da empresa de terceirização",
      "valor": "9999.99",
      "valor_avaliacao": "497242.40",
      "data_bloqueio": "01/10/2024",
      "data_entrega": "01/01/2023",
      "data_entrega_chaves": "01/01/2023",
      "agendar_a_partir": "01/01/2023",
      "liberar_a_partir": "01/01/2023",
      "plantas": [
        {
          "idplanta": 1,
          "nome": "planta 1"
        },
        {
          "idplanta": 2,
          "nome": "planta 2"
        }
      ],
      "campos_adicionais": [
        {
          "nome_referencia": "adc_valor_adicional",
          "valor": "1.000,00"
        }
      ],
      "situacao_reservada": 123,
      "situacao_reservada_vencimento": "2016-05-24 05:05:05",
      "situacao_reservada_idsituacao": 1,
      "situacao_reservada_nomesituacao": "Reservada",
      "situacao_cor_bg": "990000",
      "situacao_cor_nome": "ffffff",
      "situacao_nome": "João da Silva",
      "situacao_reservada_inicio": "N",
      "situacao_vendida": 1332,
      "situacao_vendida_idsituacao": 3,
      "situacao_idmotivo": 1,
      "situacao_bloqueados_internos": "N",
      "situacao_bloqueada": "N",
      "situacao_bloqueada_idmotivo": 1,
      "situacao_bloqueada_motivo": "Solicitação da Diretoria",
      "situacao_tipo_id": 1,
      "situacao_tipo_nome": "Garagem",
      "situacao_para_venda": 1,
      "situacao_mapa_disponibilidade": 1,
      "situacao_possui_reserva_solicitacao_distrato": "N"
    }
  ]
}