📖 Casos de Uso - ecosif-moviments¶
📋 Visão Geral¶
Este documento descreve os principais casos de uso do serviço ecosif-moviments.
📦 Caso de Uso 1: Criar Lançamento Contábil Manual¶
Descrição¶
Contador cria um lançamento contábil manualmente via API.
Atores¶
- Contador: Usuário que cria lançamentos
- Sistema: Valida e processa lançamentos
Pré-condições¶
- Usuário autenticado
- Lote e documento existem
- Período está aberto
- Conta contábil existe e está ativa
Fluxo Principal¶
- Contador cria débito via
POST /entry - Sistema valida dados
- Contador cria crédito correspondente via
POST /entry - Sistema valida partidas dobradas
- Sistema persiste lançamentos
- Sistema retorna confirmação
Fluxo Alternativo: Partidas Não Conferem¶
- Sistema detecta desbalanceamento
- Sistema retorna erro 400
- Contador ajusta valores
📥 Caso de Uso 2: Importar Arquivo CSV¶
Descrição¶
Importar múltiplos lançamentos de um arquivo CSV.
Atores¶
- Analista: Importa arquivos
- Sistema: Processa importação
Pré-condições¶
- Arquivo CSV válido
- Lote existe
- Estrutura do arquivo correta
Fluxo Principal¶
- Analista faz upload via
POST /batch/{id}/import - Sistema faz parse do CSV
- Sistema valida cada linha
- Sistema cria lançamentos válidos
- Sistema retorna relatório com estatísticas
- Sistema faz upload do arquivo para S3
🔄 Caso de Uso 3: Consolidar Período Contábil¶
Descrição¶
Consolidar saldos de um período contábil.
Atores¶
- Contador: Dispara consolidação
- Sistema: Processa consolidação
Pré-condições¶
- Períodos anteriores consolidados
- Período tem lançamentos
- Usuário tem permissão
Fluxo Principal¶
- Contador solicita consolidação via
POST /runconsolidation - Sistema valida pré-requisitos
- Sistema inicia processamento assíncrono
- Sistema calcula saldos de todas as contas
- Sistema atualiza saldos no banco
- Sistema marca período como consolidado
- Sistema notifica conclusão
💰 Caso de Uso 4: Calcular Cotas de Fundo¶
Descrição¶
Calcular valor de cotas tributárias de um fundo.
Atores¶
- Analista: Solicita cálculo
- Sistema: Calcula e persiste cotas
Pré-condições¶
- Mês consolidado
- Contas PL configuradas
- Calendário com dia livre
Fluxo Principal¶
- Analista consulta preview via
GET /taxquotacalculation/{company}/{branch}?confirmed=false - Sistema valida pré-requisitos
- Sistema calcula patrimônio líquido
- Sistema calcula valor da cota
- Sistema retorna preview
- Analista confirma via
GET /taxquotacalculation/{company}/{branch}?confirmed=true - Sistema salva valor da cota
📅 Caso de Uso 5: Abrir Novo Mês Contábil¶
Descrição¶
Abrir um novo período contábil para lançamentos.
Atores¶
- Administrador: Abre novos períodos
- Sistema: Cria calendário e atualiza opções
Pré-condições¶
- Empresa/filial existem
- Período anterior existe
Fluxo Principal¶
- Administrador solicita abertura via
POST /monthOpening/{company}/{branch} - Sistema atualiza currentYearMonth nas opções
- Sistema verifica se calendário existe
- Sistema cria calendário com indicadores de dias
- Sistema retorna informações do período
🗑️ Caso de Uso 6: Executar Purging de Dados¶
Descrição¶
Arquivar dados antigos para histórico.
Atores¶
- Administrador: Executa purging
- Sistema: Processa arquivamento
Pré-condições¶
- Períodos consolidados
- Dados antigos identificados
Fluxo Principal¶
- Administrador solicita purging via
POST /purging - Sistema valida períodos consolidados
- Sistema move dados para tabelas de histórico
- Sistema remove dados das tabelas principais
- Sistema faz upload de dump para S3
- Sistema retorna resultado
Última Atualização: 2025-11-27