Pular para conteúdo

📊 Visão Geral Funcional - ecosif-compliance

📋 Sobre o Projeto

ecosif-compliance é um microserviço Python/Flask especializado em validação de conformidade contábil no sistema eCosif. Utiliza um sistema de regras configuráveis com DSL customizada para identificar possíveis inconsistências ou indícios de problemas contábeis.


🎯 Objetivo do Serviço

O serviço tem como objetivo fornecer validação automatizada de conformidade contábil, com:

  • Sistema de regras flexível - Regras configuráveis via DSL
  • Identificação de indícios - Classificação de problemas encontrados
  • Auditoria - Histórico de execuções
  • Integração - Integrado com dados contábeis do eCosif

🏢 Contexto no Sistema eCosif

O ecosif-compliance é parte do ecossistema eCosif, trabalhando em conjunto com:

  • ecosif-auth: Autenticação e autorização
  • ecosif-masterdata: Dados mestres (empresas, planos de contas)
  • ecosif-moviments: Lançamentos contábeis (dados validados)
  • ecosif-querys: Consultas (dados consultados para validação)
  • ecosif-reports: Relatórios (pode incluir resultados de compliance)

📦 Funcionalidades Principais

1. Gerenciamento de Regras

  • Cadastro de regras de validação
  • Edição de regras existentes
  • Listagem de regras
  • Scripts DSL para definição de lógica

2. Execução de Validações

  • Validação por empresa/filial
  • Validação por documento
  • Validação por período
  • Execução em lote

3. Tipos de Indício

  • Classificação de problemas encontrados
  • Múltiplos tipos de indício configuráveis
  • Severidade de problemas

4. Histórico de Execuções

  • Listagem de processos executados
  • Detalhamento de resultados
  • Filtros por data e empresa

📊 Estatísticas

  • 1 aplicação Flask
  • 11 endpoints REST documentados
  • 3 services principais
  • 9 DAOs para acesso a dados
  • 9 entidades SQLAlchemy
  • 1 DSL customizada com parser PLY

🔄 Fluxos Principais

Fluxo de Validação

1. Usuário solicita validação com parâmetros
   ↓
2. Serviço busca regras aplicáveis
   ↓
3. Para cada regra:
   - Compila script DSL
   - Executa sobre dados contábeis
   - Coleta resultados
   ↓
4. Persiste resultados no banco
   ↓
5. Retorna resultados ao usuário

🎓 Público-Alvo

Usuários Finais

  • Contadores e analistas contábeis
  • Auditores
  • Gestores financeiros
  • Compliance officers

Integradores

  • Desenvolvedores que precisam integrar validações
  • Sistemas externos que validam conformidade
  • Frontend Angular que exibe resultados

Última Atualização: 2025-12-01