Documentação do Síndico Online
O Síndico Online é uma plataforma SaaS completa para gestão condominial digital. Esta documentação apresenta todos os módulos disponíveis e a referência completa da API de integração para conectar sistemas contábeis externos.
Módulos da Plataforma
Conheça cada módulo que compõe a plataforma de gestão condominial.
Mural de Publicações
Canal de comunicação centralizado do condomínio. Permite criar posts com texto, imagens e arquivos, com suporte a comentários e notificações para todos os moradores.
Financeiro
Controle completo de receitas e despesas do condomínio. Registre lançamentos, categorize transações, anexe comprovantes e acompanhe o fluxo de caixa em tempo real.
Cobranças
Gestão de cobranças individuais por unidade. Crie ciclos de cobrança, acompanhe pagamentos, gere relatórios de inadimplência e configure regras de cobrança automática.
Unidades
Cadastro completo das unidades do condomínio com informações de moradores, dependentes, veículos, pets e histórico de movimentações (mudanças).
Documentos
Repositório digital de documentos do condomínio. Armazene atas, contratos, plantas, regulamentos e qualquer arquivo relevante com organização por categorias.
Chamados
Sistema de tickets para solicitações dos moradores. Abertura de chamados com categorização, prioridade, timeline de atualizações, comentários e acompanhamento de status.
Manutenções
Controle de manutenções preventivas e corretivas. Cadastre equipamentos e serviços, crie planos de manutenção com calendário, registre execuções e acompanhe custos.
Multas
Registro e gestão de infrações e multas aplicadas a unidades, com notificação automática aos moradores e acompanhamento de pagamento.
Votações
Criação de votações e enquetes digitais para decisões coletivas do condomínio, com controle de quórum e apuração automática de resultados.
Assembleias
Organização completa de assembleias: convocação com pauta, controle de presença e quórum, votações por item, registro de procurações, discussões e geração de ata.
Reservas
Sistema de reservas de áreas comuns. Cadastre espaços com regras (horários, capacidade, antecedência), gerencie solicitações e evite conflitos de agenda.
Eventos
Calendário de eventos do condomínio. Divulgue festas, reuniões e atividades com data, local, descrição e controle de confirmações de presença.
Portaria
Controle digital de acesso ao condomínio. Registro de entrada e saída de veículos, visitantes e prestadores de serviço com histórico completo.
Visitantes
Pré-autorização e controle de visitantes. Moradores cadastram visitantes antecipadamente, gerando QR Code de acesso com aprovação do porteiro.
Encomendas
Gestão de recebimento de encomendas e correspondências. Registro na portaria com notificação automática ao morador e controle de retirada.
Prestadores
Cadastro de prestadores de serviço com informações de contato, documentação, especialidade e histórico de acessos ao condomínio.
Contratos
Gestão de contratos com fornecedores e prestadores. Controle de vigência, alertas de vencimento, renovações e timeline de histórico.
Contabilidade
Módulo contábil com integrações via API.
Relatórios
Geração de relatórios personalizados com seções configuráveis (financeiro, inadimplência, manutenções, chamados). Visualize online ou exporte em PDF.
Auditoria
Log de auditoria com registro de todas as ações realizadas na plataforma. Filtragem por tipo de ação, usuário, data e recurso afetado.
API de Integração
A API pública permite que sistemas externos (contabilidade, ERPs, etc.) consultem dados financeiros do condomínio de forma segura e automatizada.
Autenticação
Todas as requisições à API devem incluir uma API Key no header X-API-Key. As chaves são gerenciadas no painel Contabilidade > Integrações API.
Header obrigatório
X-API-Key: sk_sua_chave_aqui
Base URL
https://sindicoonline.com/api/public/v1
Formato da chave
As chaves seguem o formato sk_ seguido de 32 caracteres alfanuméricos. Elas são exibidas apenas uma vez no momento da criação.
Escopos disponíveis
| Escopo | Descrição |
|---|---|
| transactions:read | Leitura de lançamentos financeiros |
| user-transactions:read | Leitura de cobranças por morador |
| payments:read | Leitura de pagamentos recebidos |
| delinquency:read | Leitura de dados de inadimplência |
Endpoints
Códigos de Erro
| Código HTTP | Descrição | Causa |
|---|---|---|
| 400 | Bad Request | Parâmetros inválidos na requisição |
| 401 | Unauthorized | API Key ausente, inválida ou expirada |
| 404 | Not Found | Recurso não encontrado (ex: transação inexistente) |
| 500 | Internal Server Error | Erro interno do servidor |
Formato de erro
{
"message": "API Key é obrigatória. Use o header X-API-Key."
}Exemplos de Uso
Listar lançamentos do mês
curl -H "X-API-Key: sk_sua_chave_aqui" \ "https://sindicoonline.com/api/public/v1/transactions?startDate=2026-03-01&endDate=2026-03-31"
Buscar cobranças pendentes de um morador
curl -H "X-API-Key: sk_sua_chave_aqui" \ "https://sindicoonline.com/api/public/v1/user-transactions?status=PENDING&userId=UUID_DO_USUARIO"
Consultar inadimplência total
curl -H "X-API-Key: sk_sua_chave_aqui" \ "https://sindicoonline.com/api/public/v1/delinquency"
Pagamentos recebidos com paginação
curl -H "X-API-Key: sk_sua_chave_aqui" \ "https://sindicoonline.com/api/public/v1/payments?page=2&limit=25"