Onepet2 - Documentação de Negócio
Bem-vindo à documentação de regras de negócio do sistema Onepet2, um SaaS multi-tenant completo para gestão de petshops.
Objetivo desta Documentação
Esta documentação foi criada para servir como referência de regras de negócio para um time de desenvolvimento que precisa construir uma nova versão do sistema. Aqui você encontrará:
- Estrutura de dados de cada entidade (campos, tipos, validações)
- Regras de negócio (cálculos, automações, restrições)
- Fluxos de processo (status, transições, ciclos de vida)
- Relacionamentos entre entidades
- Permissões e controle de acesso
Esta documentação foca exclusivamente em regras de negócio. Não contém código, implementação técnica ou detalhes de arquitetura. O objetivo é que qualquer desenvolvedor, independente da linguagem ou framework escolhido, consiga entender e replicar o comportamento do sistema.
Visão Geral do Sistema
O Onepet2 é uma plataforma completa para gestão de petshops que abrange:
Arquitetura Multi-Tenant
O sistema opera em modelo multi-tenant, onde:
- Cada Account (conta) representa um petshop/empresa
- Cada Account pode ter múltiplas Stores (filiais/unidades)
- Dados são completamente isolados entre Accounts
- Usuários pertencem a uma Account e podem ter acesso a uma ou mais Stores
Módulos do Sistema
Módulos Principais
| Módulo | Descrição | Principais Entidades |
|---|---|---|
| Estrutura Organizacional | Base do sistema multi-tenant | Account, Store, User, Profile, Professional |
| CRM | Gestão de relacionamento com clientes | Customer, Pet, Address, BenefitClub |
| PDV | Ponto de venda e vendas | Sale, CartItem, Payment, Cashier |
| Beauty Center | Centro de estética/banho e tosa | BeautyAppointment, BeautyService, BeautyPackage |
| Clinical | Módulo clínico veterinário | Consultation, MedicalRecord, Prescription |
| Financial | Gestão financeira | FinancialAccount, FinancialTransaction |
| Stock | Gestão de estoque | SaleProduct, StockMovement, Deposit |
| Delivery | Gestão de entregas | Delivery, DeliveryArea |
Módulos de Suporte
| Módulo | Descrição |
|---|---|
| Reports | Relatórios e dashboards |
| Tax | Gestão fiscal (NF-e, NFC-e) |
| RH | Recursos humanos e comissões |
| Integrações | WhatsApp, Vetsmart, Gateways de pagamento |
Fluxo Principal de Negócio
O fluxo típico de operação de um petshop no sistema:
Como Usar esta Documentação
- Inicie pela Estrutura Organizacional - Entenda os conceitos base de Account, Store e User
- Siga para o módulo de interesse - Cada módulo é documentado de forma independente
- Use o Glossário - Para termos técnicos e siglas específicas do domínio
- Observe os diagramas - Fluxos de status e relacionamentos estão em diagramas Mermaid
Convenções da Documentação
Estrutura de cada Entidade
Cada entidade é documentada seguindo este padrão:
- Descrição - Propósito da entidade
- Dados - Campos, tipos e validações
- Relacionamentos - Vínculos com outras entidades
- Regras de Negócio - Validações e comportamentos
- Fluxo de Status - Ciclo de vida (quando aplicável)
- Automações - Ações automáticas
- Permissões - Controle de acesso
Tipos de Campos
| Tipo | Descrição |
|---|---|
| Texto | String de caracteres |
| Número | Inteiro |
| Decimal | Número com casas decimais |
| Monetário | Valor em reais (2 casas decimais) |
| Data | Data sem hora |
| Data/Hora | Data com hora |
| Booleano | Verdadeiro/Falso |
| Seleção | Lista de opções predefinidas |
| Múltipla Escolha | Várias opções podem ser selecionadas |
| Referência | Relacionamento com outra entidade |
Status e Transições
Entidades com ciclo de vida têm seus status documentados com:
- Status possíveis
- Transições permitidas
- Condições para transição
- Efeitos colaterais de cada transição