Pular para o conteúdo principal

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
Zero Código

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óduloDescriçãoPrincipais Entidades
Estrutura OrganizacionalBase do sistema multi-tenantAccount, Store, User, Profile, Professional
CRMGestão de relacionamento com clientesCustomer, Pet, Address, BenefitClub
PDVPonto de venda e vendasSale, CartItem, Payment, Cashier
Beauty CenterCentro de estética/banho e tosaBeautyAppointment, BeautyService, BeautyPackage
ClinicalMódulo clínico veterinárioConsultation, MedicalRecord, Prescription
FinancialGestão financeiraFinancialAccount, FinancialTransaction
StockGestão de estoqueSaleProduct, StockMovement, Deposit
DeliveryGestão de entregasDelivery, DeliveryArea

Módulos de Suporte​

MóduloDescrição
ReportsRelatórios e dashboards
TaxGestão fiscal (NF-e, NFC-e)
RHRecursos humanos e comissões
IntegraçõesWhatsApp, 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​

  1. Inicie pela Estrutura Organizacional - Entenda os conceitos base de Account, Store e User
  2. Siga para o módulo de interesse - Cada módulo é documentado de forma independente
  3. Use o Glossário - Para termos técnicos e siglas específicas do domínio
  4. 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​

TipoDescrição
TextoString de caracteres
NúmeroInteiro
DecimalNúmero com casas decimais
MonetárioValor em reais (2 casas decimais)
DataData sem hora
Data/HoraData com hora
BooleanoVerdadeiro/Falso
SeleçãoLista de opções predefinidas
Múltipla EscolhaVárias opções podem ser selecionadas
ReferênciaRelacionamento 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