Leitura de contratos e dos movimentos de aluguel e repasse.
Sobre esta seçãoConsultar os contratos de locação e venda do convênio e os movimentos de cada competência, com o que o locatário paga e o que sai para os beneficiários. Serve para área do cliente, app do proprietário ou conciliação.
Escopo: leitura com
contratos:read. Só funciona no convênio que contratou o módulo Administrativo.
Regras que valem para toda a seção:
| Regra | O que significa |
|---|---|
| 👁️ Só leitura | Ativação, reajuste, rescisão e baixa são feitos pela imobiliária no sistema. |
| 🧩 Módulo contratado | Convênio sem o módulo Administrativo recebe 403 com MODULE_NOT_ENABLED, mesmo com a chave certa. |
| 🔒 Locador só pelo id | O locador sai como personId e percentage. Nome, documento e contato ficam em GET /people/{id}, com pessoas:read. O contrato não traz dado bancário. |
| 💰 Aluguel vigente | rentValue é o aluguel vigente do contrato, somando os imóveis dele. Não é o preço de anúncio do imóvel. |
| ➗ Total assinado | Em cada movimento, chargeTotal e payoutTotal somam as pernas pela direção: a taxa de administração reduz o repasse. |