Glossário

📖
Para que serve
Vocabulário do domínio imobiliário usado na API. Se você integra de fora do setor, comece por aqui.

Termo	O que é
Convênio	A imobiliária (cliente do sistema). Cada chave de API pertence a um convênio, e todo dado (imóveis, pessoas, catálogos) é dele. Cadastros como características e tipos de imóvel variam de um convênio para outro.
Mídia	A origem de um lead (portal, site, campanha). Na API, a mídia vem da chave usada, não do corpo da requisição.
Atendimento	O registro de relacionamento com um lead/cliente dentro do CRM. Um lead recebido entra na fila de atendimento e é distribuído a um corretor.
Lead	Um interessado capturado (de um portal, site, etc.) e entregue ao CRM via `POST /leads`.
Captação	Atendimento de um proprietário que quer vender ou alugar. Entra pelo mesmo `POST /leads`, com `fluxo: "captacao"` e o imóvel ofertado.
Visita	Ida do cliente a um imóvel (ou empréstimo de chaves), marcada num atendimento. Tem situação (`scheduled`, `completed`, `cancelled`...) e, depois, o parecer (gostou ou não, com motivo).
Proposta	Oferta do cliente por um imóvel, criada a partir de uma visita com parecer. Aceitar e recusar acontecem no sistema.
Negócio	O fechamento (venda ou locação) registrado no atendimento.
Atividade	Compromisso da agenda: ligação, retorno, lembrete. Pode estar ligada a atendimento, imóvel, pessoa ou condomínio.
Contrato	Contrato de locação ou venda da administração, com os movimentos (o que o locatário paga e o que sai para os beneficiários). Só no convênio com o módulo Administrativo.
Lista de apoio	Cadastro auxiliar do convênio (motivos, tipos de atividade, mídias, equipes...), lido em `GET /schema/support` e citado por nome.
Etiqueta	Marcador colorido aplicado a imóvel, pessoa ou atendimento.
Módulo	Parte do produto que o convênio contrata (Administrativo, Captação...). Rota de módulo não contratado responde `403 MODULE_NOT_ENABLED`.
Característica	Um atributo do imóvel (quartos, suítes, piscina...). É cadastro do convênio: cada um define as suas, com tipo de dado próprio. Fonte da verdade: `GET /schema/properties`.
Tipo de imóvel	A categoria do imóvel (Apartamento, Casa, Terreno...). Também é cadastro do convênio. Cada tipo tem seu próprio conjunto de características.
Moderação (`em_moderacao`)	Situação inicial de todo imóvel criado por API. Ele não entra em feed de portal até alguém do convênio liberar, dentro do produto.
Situação (status)	O estado do imóvel (`alugado`, `vendido`, `em_reforma`, `em_moderacao`, `desativado`, `em_desocupacao`, `vago_disponivel`). O `PATCH` de situação aceita um subconjunto; `vago_disponivel` só é atingido dentro do produto.
Lançamento / Tipologia	Um lançamento é um empreendimento novo com várias unidades. Cada unidade é uma tipologia. Nas buscas, a API traz o imóvel avulso e uma tipologia representante por lançamento, nunca todas: publicar todas seria conteúdo duplicado para os portais.
Escopo	O que uma chave de API pode fazer, por área e direção (`leads:write`, `imoveis:read`, `visitas:write`...). A lista completa está em Autenticação. Chave sem o escopo da rota recebe `403 SCOPE_DENIED`.
Por nome, não por id	Tipo, bairro, cidade, unidade, característica, motivo e tipo de atividade são referenciados pelo nome cadastrado no convênio, não por identificadores internos. Nome inexistente ou ambíguo devolve `422`.