Documentation Index
Fetch the complete documentation index at: https://docs.patrimonion.com.br/llms.txt
Use this file to discover all available pages before exploring further.
O que é o Patrimonion?
O Patrimonion é uma plataforma SaaS multi-tenant para gestão imobiliária. Esta documentação cobre a API REST do backend — os endpoints disponíveis, os formatos de request/response e as regras de negócio que regem cada operação. A API segue convenções REST padrão: recursos são identificados por URLs, ações por verbos HTTP e erros por status codes semânticos.Base URL
Autenticação
A API usa Session Cookie via Firebase Admin SDK. O login é feito viaPOST /auth/login — o backend seta o cookie imob_session automaticamente. Todas as requisições seguintes enviam o cookie via credentials: "include", sem precisar de nenhum header manual.
Veja a seção Autenticação para o fluxo completo, incluindo registro, recuperação de senha e verificação de e-mail.
Stack
| Camada | Tecnologia |
|---|---|
| Runtime | Node.js + Express |
| Banco | Firestore (NoSQL) |
| Autenticação | Firebase Auth |
| Storage | MinIO (S3-compatible) |
| Logs | Pino (via logger) |
Módulos disponíveis
Imóveis
Cadastro, listagem e gestão de imóveis com suporte a fotos e vídeos.
Locatários
Cadastro completo de locatários com histórico de contratos.
Contratos
Ciclo de vida completo de contratos, incluindo rescisão.
Financeiro
Parcelas, pagamentos parciais, controle de inadimplência.
Recibos
Geração automática de recibos digitais por pagamento.
Inspeções
Vistorias de entrada, saída e rotina com snapshot de inventário.
Inventário
Controle de itens do imóvel com soft delete e histórico.
Upload
Upload de mídias para MinIO com URLs pressinadas e seguras.