webmoney/docs/MANUAL_USUARIO.md
marco 54cccdd095 refactor: migração para desenvolvimento direto no servidor
- Removido README.md padrão do Laravel (backend)
- Removidos scripts de deploy (não mais necessários)
- Atualizado copilot-instructions.md para novo fluxo
- Adicionada documentação de auditoria do servidor
- Sincronizado código de produção com repositório

Novo workflow:
- Trabalhamos diretamente em /root/webmoney (symlink para /var/www/webmoney)
- Mudanças PHP são instantâneas
- Mudanças React requerem 'npm run build'
- Commit após validação funcional
2025-12-19 11:45:32 +01:00

801 lines
21 KiB
Markdown
Executable File

# 📖 WebMoney - Manual do Usuário
## Sistema de Gestão Financeira Pessoal e Empresarial
**Versão:** 1.0
**Data:** Dezembro 2025
---
## 📋 Índice
1. [Visão Geral](#1-visão-geral)
2. [Primeiros Passos](#2-primeiros-passos)
3. [Dashboard](#3-dashboard)
4. [Contas Financeiras](#4-contas-financeiras)
5. [Transações](#5-transações)
6. [Categorias](#6-categorias)
7. [Centros de Custo](#7-centros-de-custo)
8. [Importação de Extratos](#8-importação-de-extratos)
9. [Passivos e Financiamentos](#9-passivos-e-financiamentos)
10. [Transações Recorrentes](#10-transações-recorrentes)
11. [Detecção de Transferências](#11-detecção-de-transferências)
12. [Detecção de Reembolsos](#12-detecção-de-reembolsos)
13. [Configurações](#13-configurações)
---
## 1. Visão Geral
### O que é o WebMoney?
O **WebMoney** é um sistema completo de gestão financeira que permite:
- ✅ Controlar múltiplas contas bancárias e cartões
- ✅ Categorizar receitas e despesas automaticamente
- ✅ Importar extratos bancários (CSV, XLSX, OFX, PDF)
- ✅ Gerenciar financiamentos e passivos
- ✅ Acompanhar transações recorrentes
- ✅ Detectar transferências e reembolsos automaticamente
- ✅ Visualizar fluxo de caixa e análises financeiras
- ✅ Multi-idioma (Português, Espanhol, Inglês)
- ✅ Multi-moeda (BRL, EUR, USD, etc.)
### Características Principais
| Recurso | Descrição |
|---------|-----------|
| **Multi-Conta** | Gerencie contas correntes, poupança, cartões de crédito, investimentos |
| **Categorização Automática** | Sistema de palavras-chave para categorização inteligente |
| **Importação Flexível** | Suporte a CSV, XLSX, XLS, OFX e até PDF |
| **Passivos** | Controle financiamentos com parcelas e conciliação |
| **Recorrências** | Automatize contas fixas mensais |
| **Detecção Inteligente** | Identifica transferências entre contas automaticamente |
---
## 2. Primeiros Passos
### 2.1 Cadastro e Login
1. Acesse o sistema através do navegador
2. Clique em **"Criar Conta"** se for seu primeiro acesso
3. Preencha:
- Nome completo
- E-mail
- Senha (mínimo 8 caracteres)
4. Clique em **"Registrar"**
5. Faça login com seu e-mail e senha
### 2.2 Configuração Inicial Recomendada
Após o primeiro login, recomendamos seguir esta ordem:
1. **Criar Contas** - Cadastre suas contas bancárias
2. **Criar Categorias** - Configure categorias de receitas e despesas
3. **Criar Centros de Custo** - Organize por projetos ou departamentos (opcional)
4. **Importar Extratos** - Importe seu histórico bancário
5. **Categorizar Transações** - Use a categorização em lote
### 2.3 Navegação Principal
O menu lateral oferece acesso rápido a:
| Ícone | Seção | Função |
|-------|-------|--------|
| 📊 | Dashboard | Visão geral financeira |
| 💳 | Contas | Gerenciar contas bancárias |
| 💰 | Transações | Lista de movimentações |
| 🏷️ | Categorias | Organização por tipo |
| 🏢 | Centros de Custo | Organização por projeto |
| 📥 | Importar | Importar extratos |
| 📋 | Passivos | Financiamentos e dívidas |
| 🔄 | Recorrentes | Contas fixas |
| ↔️ | Transferências | Detecção automática |
| 🔁 | Reembolsos | Detecção de estornos |
---
## 3. Dashboard
O Dashboard é a tela inicial que apresenta uma visão consolidada das suas finanças.
### 3.1 Cards de Resumo
No topo da tela você encontra:
- **Saldo Total** - Soma dos saldos de todas as contas ativas
- **Receitas do Mês** - Total de créditos no mês atual
- **Despesas do Mês** - Total de débitos no mês atual
- **Balanço do Mês** - Diferença entre receitas e despesas
### 3.2 Gráfico de Fluxo de Caixa
Mostra a evolução de receitas x despesas ao longo dos meses.
**Configurações disponíveis:**
- Período: 3, 6, 12 ou 24 meses
- Filtro por conta específica
### 3.3 Análise de Variações de Pagamento
Identifica contas que apresentaram variação significativa em relação ao valor esperado (recorrente).
**Exemplo:** Se sua conta de luz costuma ser R$ 200 e veio R$ 350, o sistema alerta a variação de +75%.
### 3.4 Calendário Financeiro
Visualize transações planejadas e realizadas em formato de calendário.
- **Azul**: Transações pendentes
- **Verde**: Transações concluídas
- **Vermelho**: Transações vencidas
### 3.5 Transações Próximas e Vencidas
Widgets que mostram:
- **Próximas**: Transações com vencimento nos próximos 7 dias
- **Vencidas**: Transações pendentes com data passada
---
## 4. Contas Financeiras
### 4.1 Tipos de Conta Suportados
| Tipo | Ícone | Descrição |
|------|-------|-----------|
| Conta Corrente | 🏦 | Conta bancária principal |
| Conta Poupança | 💰 | Conta de economia |
| Cartão de Crédito | 💳 | Cartão com limite |
| Carteira Digital | 📱 | PayPal, PicPay, etc. |
| Investimentos | 📈 | Aplicações financeiras |
| Dinheiro | 💵 | Dinheiro em espécie |
| Outros | 📋 | Demais tipos |
### 4.2 Criar Nova Conta
1. Acesse **Contas** no menu lateral
2. Clique em **"+ Nova Conta"**
3. Preencha os campos:
- **Nome**: Nome identificador (ex: "Nubank", "Itaú Corrente")
- **Tipo**: Selecione o tipo de conta
- **Banco**: Nome da instituição (opcional)
- **Número da Conta**: Para referência (opcional)
- **Saldo Inicial**: Saldo atual da conta
- **Limite de Crédito**: Para cartões de crédito
- **Moeda**: BRL, EUR, USD, etc.
- **Cor**: Cor para identificação visual
- **Ícone**: Ícone personalizado
- **Incluir no Total**: Se deve somar no saldo geral
- **Ativo**: Se a conta está ativa
4. Clique em **"Salvar"**
### 4.3 Ajustar Saldo
Se o saldo calculado não corresponde ao saldo real:
1. Clique no botão **"⚙️"** da conta
2. Selecione **"Ajustar Saldo"**
3. Informe o **saldo real atual**
4. O sistema criará uma transação de ajuste
### 4.4 Recalcular Saldos
O sistema recalcula automaticamente os saldos, mas você pode forçar o recálculo:
1. Clique em **"Recalcular Todos os Saldos"** no topo da página
---
## 5. Transações
### 5.1 Visualização por Semana
As transações são agrupadas por semana para facilitar a análise.
**Cada semana mostra:**
- Data inicial e final
- Total de receitas (créditos)
- Total de despesas (débitos)
- Saldo da semana
### 5.2 Filtros Disponíveis
| Filtro | Descrição |
|--------|-----------|
| Conta | Filtrar por conta específica |
| Categoria | Filtrar por categoria |
| Centro de Custo | Filtrar por centro de custo |
| Tipo | Débito, Crédito ou Todos |
| Status | Pendente, Concluído, Cancelado |
| Busca | Pesquisar por descrição |
| Período | Data inicial e final |
### 5.3 Criar Nova Transação
1. Clique no botão **"+ Nova Transação"**
2. Preencha:
- **Conta**: Selecione a conta
- **Tipo**: Débito (saída) ou Crédito (entrada)
- **Descrição**: Descrição da transação
- **Categoria**: Categoria da transação
- **Centro de Custo**: Centro de custo (opcional)
- **Valor Planejado**: Valor esperado
- **Data Planejada**: Data prevista
- **Status**: Pendente ou Concluído
3. Clique em **"Salvar"**
### 5.4 Editar Transação
1. Clique no ícone **"✏️"** na linha da transação
2. Modifique os campos desejados
3. Clique em **"Salvar"**
### 5.5 Completar Transação (Marcar como Pago)
Para transações pendentes:
1. Clique no ícone **"✓"** (check) na transação
2. No modal de completar:
- **Valor Real**: Confirme ou altere o valor pago
- **Data Efetiva**: Data do pagamento
3. Clique em **"Completar"**
### 5.6 Completar Rapidamente (Quick Complete)
Para completar com os valores planejados:
- Clique no ícone de **raio** ⚡ na transação
- A transação será marcada como concluída com a data e valor planejados
### 5.7 Cancelar Transação
1. Clique no menu **"⋮"** da transação
2. Selecione **"Cancelar"**
3. Confirme a operação
### 5.8 Reverter Transação
Para voltar uma transação concluída ao status pendente:
1. Clique no menu **"⋮"** da transação
2. Selecione **"Reverter"**
### 5.9 Duplicar Transação
1. Clique no menu **"⋮"** da transação
2. Selecione **"Duplicar"**
3. Uma cópia será criada para edição
### 5.10 Dividir Transação (Split)
Divida uma transação em múltiplas categorias:
1. Clique no menu **"⋮"** da transação
2. Selecione **"Dividir"**
3. No modal:
- Adicione as divisões com categoria e valor
- O total das divisões deve ser igual ao valor original
4. Clique em **"Dividir"**
### 5.11 Criar Transferência
Para registrar transferência entre contas:
1. Clique em **"+ Transferência"**
2. Preencha:
- **Conta de Origem**: De onde sai o dinheiro
- **Conta de Destino**: Para onde vai
- **Valor**: Valor transferido
- **Data**: Data da transferência
- **Descrição**: Descrição (opcional)
3. Clique em **"Transferir"**
> **Nota:** O sistema cria duas transações vinculadas: um débito na origem e um crédito no destino.
### 5.12 Categorização em Lote
Para categorizar múltiplas transações de uma vez:
1. Use o filtro de **busca** para encontrar transações similares
- Exemplo: Busque "UBER" para ver todas as corridas
2. Clique em **"Categorizar em Lote"**
3. No modal:
- Selecione a **Categoria** a aplicar
- Selecione o **Centro de Custo** (opcional)
- Marque **"Adicionar como palavra-chave"** para categorização automática futura
4. Clique em **"Aplicar"**
### 5.13 Converter em Transferência
Se você tem duas transações que são uma transferência:
1. Na transação de débito, clique no menu **"⋮"**
2. Selecione **"Converter em Transferência"**
3. O sistema buscará transações de crédito compatíveis
4. Selecione o par correspondente
5. Confirme a vinculação
### 5.14 Conciliar com Passivo
Para vincular uma transação a uma parcela de financiamento:
1. Clique no menu **"⋮"** da transação
2. Selecione **"Conciliar com Passivo"**
3. Selecione a parcela correspondente
4. Confirme
---
## 6. Categorias
### 6.1 Estrutura Hierárquica
As categorias suportam **subcategorias** para organização detalhada:
```
📁 Alimentação
├── 🍔 Restaurantes
├── 🛒 Supermercado
└── ☕ Cafeterias
📁 Transporte
├── 🚗 Combustível
├── 🚌 Transporte Público
└── 🚕 Táxi/Uber
```
### 6.2 Tipos de Categoria
| Tipo | Cor | Uso |
|------|-----|-----|
| Despesa | Vermelho | Gastos e saídas |
| Receita | Verde | Entradas e ganhos |
| Ambos | Azul | Pode ser usado em ambos |
### 6.3 Criar Categoria
1. Acesse **Categorias** no menu
2. Clique em **"+ Nova Categoria"**
3. Preencha:
- **Nome**: Nome da categoria
- **Tipo**: Despesa, Receita ou Ambos
- **Categoria Pai**: Para criar subcategoria (opcional)
- **Cor**: Cor de identificação
- **Ícone**: Ícone visual
- **Palavras-chave**: Para categorização automática
4. Clique em **"Salvar"**
### 6.4 Criar Subcategoria
1. Na linha da categoria pai, clique em **"+"**
2. Preencha os dados da subcategoria
3. Salve
### 6.5 Sistema de Palavras-Chave
As palavras-chave permitem **categorização automática** de transações importadas.
**Como funciona:**
- Ao importar um extrato com "UBER TRIP", se a categoria "Transporte" tem a palavra-chave "UBER", a transação será categorizada automaticamente.
**Adicionar palavra-chave:**
1. Edite a categoria
2. No campo "Nova palavra-chave", digite a palavra
3. Pressione Enter ou clique em **"+"**
4. Salve a categoria
### 6.6 Categorização Automática em Lote
Para aplicar palavras-chave existentes a transações não categorizadas:
1. Na página de Categorias, clique em **"Categorizar em Lote"**
2. Visualize o preview das transações que serão categorizadas
3. Clique em **"Executar"**
### 6.7 Reordenar Categorias
As categorias podem ser reordenadas por drag-and-drop para personalizar a lista.
---
## 7. Centros de Custo
### 7.1 O que são Centros de Custo?
Centros de custo permitem **organizar transações por projeto, departamento ou cliente**, independente da categoria.
**Exemplos de uso:**
- Projetos: "Website Cliente X", "Reforma Casa"
- Departamentos: "Marketing", "TI", "RH"
- Clientes: "Empresa ABC", "Cliente João"
### 7.2 Criar Centro de Custo
1. Acesse **Centros de Custo** no menu
2. Clique em **"+ Novo Centro de Custo"**
3. Preencha:
- **Nome**: Nome identificador
- **Código**: Código interno (opcional)
- **Descrição**: Detalhes adicionais
- **Cor**: Cor de identificação
- **Ícone**: Ícone visual
- **Palavras-chave**: Para associação automática
4. Salve
### 7.3 Palavras-Chave em Centros de Custo
Similar às categorias, você pode usar palavras-chave para associar transações automaticamente a centros de custo.
---
## 8. Importação de Extratos
### 8.1 Formatos Suportados
| Formato | Extensão | Descrição |
|---------|----------|-----------|
| CSV | .csv | Arquivo separado por vírgula |
| Excel | .xlsx, .xls | Planilha Microsoft Excel |
| OFX | .ofx | Open Financial Exchange |
| PDF | .pdf | Extrato em PDF (com OCR) |
### 8.2 Processo de Importação
O processo é dividido em **4 etapas**:
#### Etapa 1: Upload do Arquivo
1. Acesse **Importar** no menu
2. Arraste o arquivo ou clique para selecionar
3. Aguarde o processamento
#### Etapa 2: Configuração
Configure como o arquivo deve ser lido:
- **Linha do Cabeçalho**: Qual linha contém os nomes das colunas
- **Linha de Início dos Dados**: Onde começam os dados
- **Formato de Data**: dd/mm/yyyy, mm/dd/yyyy, etc.
- **Separador Decimal**: Vírgula (,) ou ponto (.)
- **Separador de Milhar**: Ponto (.) ou vírgula (,)
#### Etapa 3: Mapeamento de Colunas
Associe as colunas do arquivo aos campos do sistema:
| Campo | Descrição | Obrigatório |
|-------|-----------|-------------|
| Data | Data da transação | ✅ Sim |
| Descrição | Descrição/histórico | ✅ Sim |
| Valor | Valor (pode ser com sinal) | ✅ Sim |
| Valor de Entrada | Valor de crédito separado | Não |
| Valor de Saída | Valor de débito separado | Não |
| Referência | Número do documento | Não |
#### Etapa 4: Opções e Importação
- **Conta de Destino**: Selecione a conta para importar
- **Categoria Padrão**: Categoria para transações não categorizadas
- **Centro de Custo**: Centro de custo padrão (opcional)
- **Salvar Mapeamento**: Para reutilizar em importações futuras
- **Nome do Mapeamento**: Nome para identificar o preset
Clique em **"Importar"**.
### 8.3 Resultado da Importação
Após a importação, você verá:
-**Importadas**: Transações novas criadas
- ⚠️ **Duplicadas**: Transações ignoradas por já existirem
-**Erros**: Linhas com problemas
### 8.4 Mapeamentos Salvos
Você pode salvar configurações de importação para reutilizar:
1. Na lista de mapeamentos, selecione um existente
2. O sistema preenche automaticamente as configurações
3. Modifique se necessário e importe
### 8.5 Presets de Banco
O sistema inclui presets para bancos comuns:
- Nubank
- Itaú
- Bradesco
- Banco do Brasil
- Santander
- Caixa Econômica
---
## 9. Passivos e Financiamentos
### 9.1 O que são Passivos?
Passivos são compromissos financeiros com parcelas, como:
- Financiamento de veículo
- Financiamento imobiliário
- Empréstimos pessoais
- Consórcios
### 9.2 Importar Passivo de PDF
1. Acesse **Passivos** no menu
2. Clique em **"+ Importar Contrato"**
3. Selecione o arquivo PDF do contrato/simulação
4. Preencha:
- **Nome**: Nome do financiamento
- **Credor**: Nome da instituição
- **Número do Contrato**: Para referência
- **Moeda**: Moeda do contrato
- **Descrição**: Notas adicionais
5. Clique em **"Importar"**
> O sistema usa OCR para extrair as parcelas automaticamente do PDF.
### 9.3 Visualizar Detalhes do Passivo
Ao clicar em um passivo, você vê:
- **Resumo**: Valor total, pago, pendente
- **Progresso**: Barra visual do pagamento
- **Lista de Parcelas**: Todas as parcelas com status
### 9.4 Status das Parcelas
| Status | Cor | Descrição |
|--------|-----|-----------|
| Pendente | Amarelo | Aguardando pagamento |
| Pago | Verde | Parcela quitada |
| Vencida | Vermelho | Parcela não paga e vencida |
| Parcial | Laranja | Parcialmente paga |
### 9.5 Conciliar Parcela com Transação
Para vincular um pagamento a uma parcela:
1. Na lista de parcelas, clique em **"Conciliar"**
2. O sistema busca transações compatíveis (mesmo valor/período)
3. Selecione a transação correspondente
4. Confirme
### 9.6 Marcar Parcela como Paga
Se você pagou mas não tem a transação registrada:
1. Na parcela, clique em **"Marcar como Pago"**
2. Uma transação será criada automaticamente
### 9.7 Análise de Preços
O sistema analisa as parcelas e identifica:
- Valor principal
- Juros
- Seguros
- Taxas
---
## 10. Transações Recorrentes
### 10.1 O que são Recorrências?
Recorrências automatizam o lançamento de transações que se repetem, como:
- Aluguel mensal
- Salário
- Netflix/Spotify
- Conta de luz/água
### 10.2 Criar Recorrência
#### Método 1: Do Zero
1. Acesse **Recorrentes** no menu
2. Clique em **"+ Nova Recorrência"**
3. Preencha:
- **Descrição**: Nome da transação
- **Conta**: Conta associada
- **Categoria**: Categoria da transação
- **Tipo**: Débito ou Crédito
- **Valor**: Valor da transação
- **Frequência**: Mensal, Semanal, etc.
- **Data de Início**: Quando começa
- **Data de Término**: Quando termina (opcional)
4. Salve
#### Método 2: A partir de Transação
1. Na página de Transações, clique no menu **"⋮"**
2. Selecione **"Criar Recorrência"**
3. Configure a frequência e datas
4. Salve
### 10.3 Frequências Disponíveis
| Frequência | Descrição |
|------------|-----------|
| Diária | Todo dia |
| Semanal | Toda semana |
| Quinzenal | A cada 15 dias |
| Mensal | Todo mês |
| Bimestral | A cada 2 meses |
| Trimestral | A cada 3 meses |
| Semestral | A cada 6 meses |
| Anual | Uma vez por ano |
### 10.4 Gerenciar Instâncias
Cada recorrência gera **instâncias** - as transações individuais.
**Ações em instâncias:**
- **Pagar**: Marcar como pago (cria transação)
- **Conciliar**: Vincular a transação existente
- **Pular**: Ignorar esta instância
- **Cancelar**: Cancelar esta instância
- **Editar**: Modificar valor ou data desta instância
### 10.5 Pausar/Retomar Recorrência
Para pausar temporariamente:
1. No template, clique em **"Pausar"**
2. Nenhuma nova instância será gerada
3. Para retomar, clique em **"Retomar"**
### 10.6 Conciliar com Transação Existente
Se você já tem a transação registrada:
1. Na instância pendente, clique em **"Conciliar"**
2. O sistema sugere transações compatíveis
3. Selecione a correspondente
4. Confirme
---
## 11. Detecção de Transferências
### 11.1 Como Funciona
O sistema analisa suas transações e identifica automaticamente **pares de transferência**: um débito em uma conta e um crédito correspondente em outra.
**Critérios de detecção:**
- Mesmo valor (ou similar)
- Datas próximas (tolerância configurável)
- Contas diferentes
### 11.2 Níveis de Confiança
| Nível | Cor | Significado |
|-------|-----|-------------|
| Alta | Verde | Valores e datas muito próximos |
| Média | Amarelo | Valores iguais, datas diferentes |
| Baixa | Cinza | Valores similares |
### 11.3 Ações Disponíveis
Para cada par detectado:
- **Confirmar**: Vincula as transações como transferência
- **Ignorar**: Marca para não sugerir novamente
- **Excluir Ambas**: Remove as duas transações
### 11.4 Confirmação em Lote
1. Marque os pares desejados com o checkbox
2. Clique em **"Confirmar Selecionados"**
3. Confirme a operação
### 11.5 Configurar Tolerância
Ajuste a tolerância de dias para detecção:
- Use o seletor no topo da página
- Valores maiores encontram mais pares
- Valores menores são mais precisos
---
## 12. Detecção de Reembolsos
### 12.1 O que são Reembolsos?
Reembolsos são transações onde você foi estornado por uma compra:
- Devolução de produto
- Cancelamento de assinatura
- Estorno de cobrança indevida
### 12.2 Como Funciona
O sistema detecta pares onde:
- Existe um débito (compra)
- Existe um crédito (reembolso) na mesma conta
- Valores iguais ou similares
- Datas próximas
### 12.3 Confirmar Reembolso
1. Na lista de reembolsos detectados
2. Clique em **"Confirmar"**
3. As transações são vinculadas
4. O sistema marca o status como reembolsado
### 12.4 Desfazer Reembolso
Se confirmou por engano:
1. Na transação vinculada
2. Use a opção **"Desfazer Reembolso"**
---
## 13. Configurações
### 13.1 Idioma
O sistema suporta três idiomas:
- 🇧🇷 Português (Brasil)
- 🇪🇸 Español
- 🇺🇸 English
Para alterar:
1. Clique no seletor de idioma no topo
2. Selecione o idioma desejado
### 13.2 Moeda Padrão
Cada conta pode ter sua própria moeda:
- BRL - Real Brasileiro
- EUR - Euro
- USD - Dólar Americano
- GBP - Libra Esterlina
### 13.3 Formato de Data
O sistema ajusta automaticamente o formato de data conforme o idioma:
- PT-BR: dd/mm/aaaa
- ES: dd/mm/aaaa
- EN: mm/dd/yyyy
### 13.4 Perfil do Usuário
Acesse seu perfil para:
- Alterar nome
- Alterar e-mail
- Alterar senha
- Ver tipo de conta (Admin/Usuário)
---
## 📞 Suporte
Para dúvidas ou problemas:
- Email: suporte@webmoney.com
- Documentação: Este manual
---
## 📝 Notas de Versão
### Versão 1.0 (Dezembro 2025)
- Lançamento inicial
- Multi-conta e multi-moeda
- Importação de extratos
- Categorização automática
- Passivos e recorrências
- Detecção de transferências e reembolsos
- Multi-idioma (PT-BR, ES, EN)
---
*WebMoney - Sua gestão financeira simplificada*