RomanNum3ral
/
whisper-money
mirror of https://github.com/whisper-money/whisper-money.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add core user guides

This commit is contained in:
Víctor Falcón 2026-05-25 15:42:44 +02:00
parent 38ca6a465a
commit cf0cb3c96a
18 changed files with 2017 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
config/documentation.php
View File

@ -1,7 +1,7 @@
<?php
return [
'default' => 'categories',
'default' => 'getting-started',
'fallback_locale' => 'en',
'locales' => [
@ -19,6 +19,48 @@ return [
],
'pages' => [
'getting-started' => [
'title' => [
'en' => 'Getting started',
'es' => 'Primeros pasos',
],
'description' => [
'en' => 'Learn the basic Whisper Money workflow.',
'es' => 'Aprende el flujo básico de Whisper Money.',
],
'file' => [
'en' => resource_path('docs/documentation/en/getting-started.md'),
'es' => resource_path('docs/documentation/es/getting-started.md'),
],
],
'accounts' => [
'title' => [
'en' => 'Accounts',
'es' => 'Cuentas',
],
'description' => [
'en' => 'Understand accounts, account types, and balance tracking.',
'es' => 'Entiende las cuentas, los tipos de cuenta y el seguimiento de saldos.',
],
'file' => [
'en' => resource_path('docs/documentation/en/accounts.md'),
'es' => resource_path('docs/documentation/es/accounts.md'),
],
],
'transactions' => [
'title' => [
'en' => 'Transactions',
'es' => 'Transacciones',
],
'description' => [
'en' => 'Learn how transactions, filters, categories, and labels work.',
'es' => 'Aprende cómo funcionan las transacciones, filtros, categorías y etiquetas.',
],
'file' => [
'en' => resource_path('docs/documentation/en/transactions.md'),
'es' => resource_path('docs/documentation/es/transactions.md'),
],
],
'categories' => [
'title' => [
'en' => 'Categories',
@ -33,5 +75,61 @@ return [
'es' => resource_path('docs/documentation/es/categories.md'),
],
],
'automation-rules' => [
'title' => [
'en' => 'Automation rules',
'es' => 'Reglas de automatización',
],
'description' => [
'en' => 'Use rules to categorize and label repeated transactions automatically.',
'es' => 'Usa reglas para categorizar y etiquetar transacciones repetidas automáticamente.',
],
'file' => [
'en' => resource_path('docs/documentation/en/automation-rules.md'),
'es' => resource_path('docs/documentation/es/automation-rules.md'),
],
],
'cashflow' => [
'title' => [
'en' => 'Cashflow',
'es' => 'Flujo de efectivo',
],
'description' => [
'en' => 'Understand income, expenses, net cashflow, and savings rate.',
'es' => 'Entiende ingresos, gastos, flujo neto y tasa de ahorro.',
],
'file' => [
'en' => resource_path('docs/documentation/en/cashflow.md'),
'es' => resource_path('docs/documentation/es/cashflow.md'),
],
],
'budgets' => [
'title' => [
'en' => 'Budgets',
'es' => 'Presupuestos',
],
'description' => [
'en' => 'Track planned spending by category or label.',
'es' => 'Controla el gasto planificado por categoría o etiqueta.',
],
'file' => [
'en' => resource_path('docs/documentation/en/budgets.md'),
'es' => resource_path('docs/documentation/es/budgets.md'),
],
],
'imports' => [
'title' => [
'en' => 'Imports',
'es' => 'Importaciones',
],
'description' => [
'en' => 'Import transactions and balances from bank files.',
'es' => 'Importa transacciones y saldos desde archivos bancarios.',
],
'file' => [
'en' => resource_path('docs/documentation/en/imports.md'),
'es' => resource_path('docs/documentation/es/imports.md'),
],
],
],
];

172
resources/docs/documentation/en/accounts.md Normal file
View File

@ -0,0 +1,172 @@
# Accounts
Accounts are the foundation of Whisper Money. They hold balances, transactions, and account history.
{{TOC}}
## Quick start
1. Create one account for each place where you keep or owe money.
2. Pick the account type that best matches the real account.
3. Add balances for accounts that are balance-only.
4. Import transactions for accounts that have day-to-day activity.
5. Review the Accounts page to see balances and net worth movement.
## Account map
```mermaid
flowchart TD
account[Account] --> balances[Balance history]
account --> transactions[Transactions]
balances --> networth[Net worth]
transactions --> cashflow[Cashflow]
```
## Account types
<div class="cards-wrapper">
<div class="card">
### Checking
Use this for everyday bank accounts.
Good for:
- Salary deposits
- Card payments
- Bill payments
- Daily spending
</div>
<div class="card">
### Savings
Use this for cash you keep aside.
Good for:
- Emergency funds
- Short-term goals
- Money you do not spend daily
</div>
<div class="card">
### Credit card
Use this for credit cards.
Credit card balances reduce net worth because they are money owed.
</div>
<div class="card">
### Investment
Use this for broker or investment accounts.
These are usually balance-only accounts. You track value over time instead of daily transactions.
</div>
<div class="card">
### Retirement
Use this for pension or retirement accounts.
Like investments, these usually focus on balance history and long-term growth.
</div>
<div class="card">
### Loan
Use this for money you owe.
Examples:
- Mortgage
- Personal loan
- Student loan
Loan balances reduce net worth.
</div>
<div class="card">
### Real estate
Use this for property value.
You can track market value and link a loan account when the property has a mortgage.
</div>
<div class="card">
### Others
Use this when none of the other types fit.
Keep the name clear so you remember what the account represents.
</div>
</div>
## Transactional and balance-only accounts
Some accounts are best tracked with transactions. Others are best tracked with balances.
Use transactions for:
- Checking accounts
- Credit cards
- Savings accounts with regular movements
Use balances for:
- Investment accounts
- Retirement accounts
- Real estate
- Loans
## Balances, market values, and owed amounts
Whisper Money uses different words depending on the account type.
- Normal accounts use **balance**.
- Loan accounts use **owed amount**.
- Real estate accounts use **market value**.
This keeps the language closer to what the number means.
## Connected and manual accounts
You can track accounts manually or connect supported providers.
Manual accounts are good when:
- Your bank is not supported.
- You want full control.
- You only need occasional updates.
Connected accounts are good when:
- You want automatic transaction updates.
- You want less manual work.
- Your bank connection is available and healthy.
## FAQ
### Why is my loan reducing net worth?
A loan is money owed. Whisper Money subtracts it from assets when calculating net worth.
### Why does real estate use market value?
The important number for property is its estimated value today. That value can change over time.
### Should I create one account or combine several?
Create separate accounts when the money is stored separately in real life. Reports are clearer that way.

134
resources/docs/documentation/en/automation-rules.md Normal file
View File

@ -0,0 +1,134 @@
# Automation rules
Automation rules save time by updating matching transactions for you. They can set a category, add labels, and add a note.
{{TOC}}
## Quick start
1. Open Automation rules from settings or from the transaction tools.
2. Create a rule with one or more conditions.
3. Choose at least one action: category or labels.
4. Save the rule.
5. Apply it to existing transactions if you want old matches updated too.
## How rules work
```mermaid
flowchart TD
transaction[Transaction] --> conditions[Rule conditions]
conditions -->|matches| actions[Rule actions]
actions --> category[Set category]
actions --> labels[Add labels]
actions --> note[Add note]
```
Rules are checked by priority. The first matching rule can apply its actions.
## Conditions
Conditions decide whether a rule matches a transaction.
<div class="cards-wrapper">
<div class="card">
### Description
Match text from the bank description.
Good for merchants, subscriptions, and repeated payments.
</div>
<div class="card">
### Amount
Match an exact amount or compare amounts.
Good for fixed subscriptions or recurring transfers.
</div>
<div class="card">
### Bank name
Match transactions from a specific bank.
Good when the same merchant appears differently by bank.
</div>
<div class="card">
### Account name
Match a specific account.
Good when one account needs special handling.
</div>
<div class="card">
### Category
Match whether a category is empty, present, or equal to a value.
Good for cleaning uncategorized transactions.
</div>
</div>
## Actions
Actions are what the rule changes.
A rule can:
- Set a category.
- Add one or more labels.
- Add a note.
At least one category or label action is required.
## Groups and priority
Use groups when a rule needs more than one condition.
Examples:
- Description contains "Netflix" **and** amount is less than 20.
- Description contains "Uber" **or** description contains "Cabify".
Priority controls which rule wins when multiple rules could match.
Put specific rules before broad rules.
## Applying rules to existing transactions
Rules run when new plain transactions are created. Older transactions may need a manual apply step.
Use apply or re-evaluate when:
- You create a new rule.
- You change a rule.
- You imported old transactions.
- You want to clean a backlog.
## Important limitations
Automation needs readable transaction data.
Rules do not match encrypted descriptions because the server cannot read them. This protects your private data.
## FAQ
### Why did a rule not run?
Check the description, amount, account, and priority. Also check whether the transaction is encrypted.
### Should I create broad or specific rules?
Start specific. Broad rules are useful, but they can match too much.
### Can a rule add multiple labels?
Yes. A rule can add more than one label.

112
resources/docs/documentation/en/budgets.md Normal file
View File

@ -0,0 +1,112 @@
# Budgets
Budgets help you plan spending and see how much room is left in a period.
{{TOC}}
## Quick start
1. Create a budget for an area you want to control.
2. Pick the category or label it should track.
3. Set the amount for the period.
4. Review progress during the month.
5. Adjust the budget when your real spending changes.
## Budget flow
```mermaid
flowchart TD
budget[Budget] --> target[Category or label]
transactions[Transactions] --> target
target --> progress[Progress]
progress --> decision[Spend, pause, or adjust]
```
## What a budget tracks
A budget can track spending that matches a category or label.
Use a category when the spending has one clear meaning.
Use a label when the spending cuts across categories.
Example:
- Category budget: Groceries.
- Label budget: Vacation, Project, Business trip.
## Good budget examples
<div class="cards-wrapper">
<div class="card">
### Groceries
Good for everyday spending that happens often.
Review weekly.
</div>
<div class="card">
### Restaurants
Good for optional spending that can grow quickly.
Review mid-month.
</div>
<div class="card">
### Travel
Good for spending across many categories.
A label-based budget can work well here.
</div>
<div class="card">
### Subscriptions
Good for repeated expenses.
Automation rules can help keep these categorized.
</div>
</div>
## Reading budget progress
Budget progress compares matched transactions with the budget amount.
If progress is high early in the period, slow down or increase the budget if the plan was too low.
If progress is low, the budget may be generous or the period may not be finished.
## Budget periods
Budgets are tracked by period. Most people think about budgets monthly.
When reviewing a budget, make sure you are looking at the right period.
## Common mistakes
- Budgeting before transactions are categorized.
- Creating too many budgets at once.
- Mixing one-time purchases with normal monthly spending.
- Forgetting that labels can be better for projects or trips.
## FAQ
### Do budgets change my transactions?
No. Budgets read transactions. They do not change them.
### Should every category have a budget?
No. Budget only what you want to actively control.
### Why does a budget look empty?
The matching transactions may be uncategorized, use a different label, or be in another period.

122
resources/docs/documentation/en/cashflow.md Normal file
View File

@ -0,0 +1,122 @@
# Cashflow
Cashflow shows how money moves in and out during a period. It helps you understand whether you earned more than you spent.
{{TOC}}
## Quick start
1. Choose the month you want to review.
2. Check income and expense totals.
3. Look at net cashflow.
4. Review the money flow diagram.
5. Open income or expense breakdowns when something looks unusual.
## Cashflow formula
```mermaid
flowchart LR
income[Income] --> net[Net cashflow]
expenses[Expenses] --> net
net --> savings[Savings rate]
```
The basic formula is:
```text
Net cashflow = Income - Expenses
```
## Main cards
<div class="cards-wrapper">
<div class="card">
### Net cashflow
Shows what is left after expenses.
Positive is usually good. Negative means expenses were higher than income.
</div>
<div class="card">
### Savings rate
Shows the percentage of income left after expenses.
A higher rate means more income was kept.
</div>
<div class="card">
### Trend chart
Shows income, expenses, and net cashflow over recent months.
Use it to spot patterns.
</div>
<div class="card">
### Money flow
Shows where money came from and where it went.
Use it to understand the biggest flows quickly.
</div>
</div>
## Period navigation
The Cashflow page works by month.
Use period controls to move between months. The URL keeps the selected month, so you can refresh or share the same view.
## Income and expense breakdowns
Breakdowns show which categories make up income or spending.
Use them to answer questions like:
- Which category caused spending to increase?
- Was this month unusual?
- Which income source changed?
- Are uncategorized transactions affecting the result?
## Transfers in cashflow
Transfers are special.
Most transfers between your own accounts should not count as income or spending. If a transfer should appear in cashflow, set its cashflow direction on the category.
Options:
- Do not show.
- Show as cash inflow.
- Show as cash outflow.
## When cashflow looks wrong
Check these first:
1. Are transactions categorized correctly?
2. Are transfers using the right cashflow direction?
3. Are dates in the expected month?
4. Are imported amounts positive and negative the right way around?
5. Are there uncategorized transactions?
## FAQ
### Why is savings rate negative?
Expenses were higher than income for the selected period.
### Why are transfers missing?
Transfer categories are usually hidden from cashflow. Change cashflow direction if you want them shown.
### Why does the current month look incomplete?
The month may not be finished yet. Income or bills may still be missing.

93
resources/docs/documentation/en/categories.md
View File

@ -1,60 +1,44 @@
# Categories
Categories help Whisper Money understand each transaction. Pick the right category, and your reports become easier to trust.
Categories explain what each transaction means. Pick the right category and your reports become easier to trust.
{{TOC}}
## Quick start
If you only read one section, read this one.
1. Decide whether the transaction is income, expense, or transfer.
2. Use transfer categories for money moving between your own accounts.
3. Review uncategorized transactions often.
4. Create automation rules for repeated merchants.
1. **Choose what the transaction is.** Is it spending, income, saving, investing, or a transfer?
2. **Use transfers for money moving between your own accounts.** This keeps reports from counting the same money twice.
3. **Review uncategorized transactions often.** Reports are only useful when transactions have the right category.
4. **Create automation rules for repeated transactions.** Let Whisper Money handle future matches for you.
> Not sure what to pick? Start with the category type. The name can be adjusted later.
> Not sure what to pick? Start with the type. You can rename the category later.
## Category map
Here is the basic idea:
```mermaid
flowchart TD
transaction[Transaction] --> category[Category]
category --> reports[Reports]
category --> budgets[Budgets]
category --> cashflow[Cashflow]
category --> budgets[Budgets]
category --> reports[Reports]
```
A few examples:
Examples:
- 🛒 **Groceries** → Expense → spending report and budgets.
- 💼 **Salary** → Income → income and cashflow reports.
- 🏦 **Checking to savings** → Transfer or Savings → cashflow stays accurate.
- 📈 **Broker deposit** → Investment → investing is separated from daily spending.
## What categories do
Every transaction can have one category.
Whisper Money uses that category to answer questions like:
- How much did I spend on food?
- How much income came in this month?
- Am I saving or investing regularly?
- Is this real spending, or did I move money between my own accounts?
- Groceries → Expense → spending reports and budgets.
- Salary → Income → income and cashflow reports.
- Checking to savings → Transfer → avoids double-counting.
## Category types
Each category has a type. The type tells Whisper Money how to treat the transaction.
Each category has one type.
<div class="cards-wrapper">
<div class="card">
### Expense
Money leaving your finances.
Use this for money leaving your finances.
Examples:
@ -69,7 +53,7 @@ Examples:
<div class="card">
### Income
Money coming into your finances.
Use this for money coming into your finances.
Examples:
@ -84,7 +68,7 @@ Examples:
<div class="card">
### Transfer
Money moving between accounts you own.
Use this when money moves between accounts you own.
Examples:
@ -93,40 +77,13 @@ Examples:
- Bank account to investment account
</div>
<div class="card">
### Savings
Money intentionally set aside.
Examples:
- Emergency fund
- House deposit
- Vacation fund
- Other money goals
</div>
<div class="card">
### Investment
Money going into assets or investment accounts.
Examples:
- Broker deposits
- Index funds
- Retirement contributions
- Crypto purchases
</div>
</div>
## Transfers and cashflow direction
Transfers can also have a cashflow direction.
Transfer categories can be shown or hidden in cashflow.
Choose the option that best matches how you want the transfer to appear:
Options:
- **Do not show**: hide the transfer from cashflow.
- **Show as cash inflow**: show the transfer as money coming in.
@ -136,7 +93,7 @@ For most account-to-account movement, **Do not show** is the safest choice.
## Uncategorized transactions
Imported transactions may start without a category.
Imported or synced transactions may start without a category.
Try this routine:
@ -145,19 +102,15 @@ Try this routine:
3. Leave confusing ones for later if needed.
4. Create automation rules for repeated merchants or descriptions.
This keeps reports clean without turning categorization into a big chore.
## Changing a category
Changing a transaction category updates every report that includes that transaction.
Changing a transaction category updates reports that include that transaction.
This can change:
This can affect:
- Spending totals
- Budget progress
- Income totals
- Savings totals
- Investment totals
- Cashflow
Changing the category itself, such as its name or type, affects all transactions using that category.
@ -176,10 +129,6 @@ Usually no. If you already track the card purchases, the payment is money moving
Start small. Too many categories make reports harder to read. Add more only when you need more detail.
### When should I create an automation rule?
Create one when the same merchant or description keeps getting the same category.
## Good category habits
- Keep names short and clear.

122
resources/docs/documentation/en/getting-started.md Normal file
View File

@ -0,0 +1,122 @@
# Getting started
Whisper Money helps you understand where your money is, where it went, and what changed over time.
{{TOC}}
## Quick start
Follow this order if you are setting things up for the first time.
1. Create your accounts.
2. Add or import transactions.
3. Review uncategorized transactions.
4. Create automation rules for repeated transactions.
5. Check Cashflow to see income, expenses, and net movement.
6. Add budgets when you want spending limits.
## How the pieces fit together
```mermaid
flowchart TD
accounts[Accounts] --> transactions[Transactions]
transactions --> categories[Categories]
transactions --> labels[Labels]
categories --> cashflow[Cashflow]
categories --> budgets[Budgets]
labels --> budgets
automation[Automation rules] --> transactions
```
## Main concepts
<div class="cards-wrapper">
<div class="card">
### Accounts
Accounts are where money lives.
Examples:
- Checking account
- Credit card
- Savings account
- Loan
- Real estate
</div>
<div class="card">
### Transactions
Transactions are money movements.
Examples:
- Salary payment
- Grocery purchase
- Card payment
- Bank transfer
</div>
<div class="card">
### Categories
Categories explain what a transaction means.
Examples:
- Groceries
- Salary
- Rent
- Transfer
</div>
<div class="card">
### Automation rules
Rules save time by applying categories and labels for you.
Example:
- If description contains "Netflix", set category to "Subscriptions".
</div>
</div>
## Recommended weekly routine
A simple routine is enough for most people.
1. Import or sync new transactions.
2. Categorize anything uncategorized.
3. Fix transfers between your own accounts.
4. Check Cashflow for the month.
5. Review budgets if you use them.
## What to do when reports look wrong
Start with the basics.
- Check that the right accounts exist.
- Look for uncategorized transactions.
- Make sure transfers are not counted as income or spending.
- Check that dates are correct.
- Check whether a transaction belongs to a different currency account.
## FAQ
### Do I need budgets to use Whisper Money?
No. You can start with accounts, transactions, and categories. Add budgets later if you want limits.
### Should I categorize every transaction?
Yes, if you want accurate reports. Automation rules make this much faster.
### What should I set up first?
Start with accounts. Then add transactions. Categories and reports depend on those two things.

110
resources/docs/documentation/en/imports.md Normal file
View File

@ -0,0 +1,110 @@
# Imports
Imports let you bring bank files into Whisper Money when automatic syncing is not available or when you want more control.
{{TOC}}
## Quick start
1. Choose the account.
2. Upload the bank file.
3. Map the columns.
4. Check the preview.
5. Import selected transactions.
6. Review categories and duplicates after import.
## Import flow
```mermaid
flowchart TD
account[Choose account] --> file[Upload file]
file --> mapping[Map columns]
mapping --> preview[Preview]
preview --> import[Import]
import --> review[Review transactions]
```
## Required columns
<div class="cards-wrapper">
<div class="card">
### Date
The transaction date.
Whisper Money can detect common date formats, but you can adjust it if needed.
</div>
<div class="card">
### Description
The text that explains the transaction.
You can combine description columns when the bank splits details across fields.
</div>
<div class="card">
### Amount
The transaction amount.
Make sure income and expenses use the correct sign.
</div>
<div class="card">
### Balance
Optional.
Use this when the file includes running account balances.
</div>
</div>
## Balance calculation
Some files do not include a balance column.
When available, Whisper Money can calculate balances from transactions using a reference balance.
This is useful when:
- Your bank exports transactions but not balances.
- You know the latest balance.
- You want historical balance charts.
## Preview before importing
Always review the preview.
Look for:
- Wrong dates.
- Amounts with the wrong sign.
- Duplicate transactions.
- Missing descriptions.
- Unexpected empty rows.
## Automation during import
Automation rules can help categorize imported transactions.
This works best when descriptions are consistent. If imported rows come from the same bank file format every time, rules become very useful.
## FAQ
### Which file should I use?
Use the cleanest export your bank provides. CSV and spreadsheet-style files are usually easiest.
### Why are amounts reversed?
Some banks export expenses as positive numbers. Check the preview before importing.
### Can I import the same file twice?
Whisper Money tries to help identify duplicates, but review the preview to avoid importing the same transaction twice.

151
resources/docs/documentation/en/transactions.md Normal file
View File

@ -0,0 +1,151 @@
# Transactions
Transactions are the individual money movements in your accounts. They power categories, cashflow, budgets, and automation rules.
{{TOC}}
## Quick start
1. Add transactions manually, import them from a file, or sync them from a connected account.
2. Check dates, descriptions, and amounts.
3. Add categories and labels.
4. Use filters to find groups of transactions.
5. Use bulk actions when many transactions need the same update.
## Transaction flow
```mermaid
flowchart TD
new[New transaction] --> review[Review]
review --> category[Category]
review --> labels[Labels]
category --> reports[Reports]
labels --> filters[Filters and budgets]
rules[Automation rules] --> category
rules --> labels
```
## What a transaction contains
<div class="cards-wrapper">
<div class="card">
### Date
The day the money moved.
Dates control which month the transaction appears in.
</div>
<div class="card">
### Description
The text from your bank or the text you entered manually.
Descriptions are useful for search and automation rules.
</div>
<div class="card">
### Amount
The money value.
Positive amounts usually mean money coming in. Negative amounts usually mean money going out.
</div>
<div class="card">
### Category
The meaning of the transaction.
Categories decide where the transaction appears in reports.
</div>
<div class="card">
### Labels
Extra tags you can use for filtering and budgets.
A transaction can have more than one label.
</div>
<div class="card">
### Notes
Private context for yourself.
Use notes when the bank description is not enough.
</div>
</div>
## Filtering and search
Use filters when the list is too large.
You can filter by:
- Date range
- Amount range
- Category
- Account
- Label
- Search text
A good search often starts with the merchant name or a word from the bank description.
## Bulk actions
Bulk actions help when many transactions need the same change.
Good uses:
- Assign one category to several transactions.
- Add the same label to a group.
- Update notes for matching transactions.
- Re-evaluate automation rules for selected transactions.
Before bulk editing, double-check the filtered list. Bulk actions can update many rows at once.
## Uncategorized transactions
Uncategorized transactions make reports less useful.
Try this approach:
1. Filter for uncategorized transactions.
2. Categorize obvious merchants first.
3. Create automation rules for repeated merchants.
4. Leave unclear items for later instead of guessing.
## Re-evaluating automation rules
If you create or change rules after transactions already exist, older transactions may not update automatically.
Use re-evaluation when you want rules to run again on existing transactions.
Use it after:
- Creating a new rule.
- Fixing a rule condition.
- Importing many transactions.
- Cleaning up old uncategorized items.
## FAQ
### Why does a transaction show in the wrong month?
Check the transaction date. Reports use that date.
### Can one transaction have multiple categories?
No. A transaction has one category. Use labels when you need extra tags.
### What is the difference between categories and labels?
Categories define the main meaning. Labels add flexible tags for filtering and budgets.

172
resources/docs/documentation/es/accounts.md Normal file
View File

@ -0,0 +1,172 @@
# Cuentas
Las cuentas son la base de Whisper Money. Guardan saldos, transacciones e historial.
{{TOC}}
## Inicio rápido
1. Crea una cuenta por cada lugar donde tienes o debes dinero.
2. Elige el tipo que mejor encaje con la cuenta real.
3. Añade saldos para cuentas que solo necesitan seguimiento de valor.
4. Importa transacciones para cuentas con actividad diaria.
5. Revisa la página de Cuentas para ver saldos y evolución del patrimonio neto.
## Mapa de cuentas
```mermaid
flowchart TD
account[Cuenta] --> balances[Historial de saldos]
account --> transactions[Transacciones]
balances --> networth[Patrimonio neto]
transactions --> cashflow[Flujo de efectivo]
```
## Tipos de cuenta
<div class="cards-wrapper">
<div class="card">
### Corriente
Usa este tipo para cuentas bancarias del día a día.
Útil para:
- Ingresos de salario
- Pagos con tarjeta
- Facturas
- Gasto diario
</div>
<div class="card">
### Ahorro
Usa este tipo para dinero que mantienes apartado.
Útil para:
- Fondo de emergencia
- Objetivos a corto plazo
- Dinero que no gastas a diario
</div>
<div class="card">
### Tarjeta de crédito
Usa este tipo para tarjetas de crédito.
Los saldos de tarjeta reducen el patrimonio neto porque son dinero que debes.
</div>
<div class="card">
### Inversión
Usa este tipo para cuentas de broker o inversión.
Normalmente son cuentas de solo saldo. Sigues su valor en el tiempo en vez de transacciones diarias.
</div>
<div class="card">
### Jubilación
Usa este tipo para pensiones o cuentas de jubilación.
Como las inversiones, suelen centrarse en historial de saldo y crecimiento a largo plazo.
</div>
<div class="card">
### Préstamo
Usa este tipo para dinero que debes.
Ejemplos:
- Hipoteca
- Préstamo personal
- Préstamo estudiantil
Los préstamos reducen el patrimonio neto.
</div>
<div class="card">
### Inmueble
Usa este tipo para el valor de una propiedad.
Puedes seguir el valor de mercado y enlazar un préstamo cuando la propiedad tiene hipoteca.
</div>
<div class="card">
### Otros
Usa este tipo cuando ningún otro encaje.
Mantén un nombre claro para recordar qué representa la cuenta.
</div>
</div>
## Cuentas transaccionales y cuentas de solo saldo
Algunas cuentas se siguen mejor con transacciones. Otras se siguen mejor con saldos.
Usa transacciones para:
- Cuentas corrientes
- Tarjetas de crédito
- Cuentas de ahorro con movimientos frecuentes
Usa saldos para:
- Cuentas de inversión
- Cuentas de jubilación
- Inmuebles
- Préstamos
## Saldos, valores de mercado e importes debidos
Whisper Money usa palabras distintas según el tipo de cuenta.
- Las cuentas normales usan **saldo**.
- Las cuentas de préstamo usan **importe debido**.
- Las cuentas de inmueble usan **valor de mercado**.
Así el lenguaje se acerca más a lo que significa el número.
## Cuentas conectadas y manuales
Puedes llevar cuentas manualmente o conectar proveedores compatibles.
Las cuentas manuales son útiles cuando:
- Tu banco no está soportado.
- Quieres control total.
- Solo necesitas actualizar de vez en cuando.
Las cuentas conectadas son útiles cuando:
- Quieres actualizaciones automáticas de transacciones.
- Quieres menos trabajo manual.
- La conexión bancaria está disponible y funciona bien.
## Preguntas frecuentes
### ¿Por qué mi préstamo reduce el patrimonio neto?
Un préstamo es dinero que debes. Whisper Money lo resta de tus activos al calcular el patrimonio neto.
### ¿Por qué los inmuebles usan valor de mercado?
El número importante de una propiedad es su valor estimado actual. Ese valor puede cambiar con el tiempo.
### ¿Debería crear una cuenta o combinar varias?
Crea cuentas separadas cuando el dinero esté separado en la vida real. Los informes serán más claros.

134
resources/docs/documentation/es/automation-rules.md Normal file
View File

@ -0,0 +1,134 @@
# Reglas de automatización
Las reglas de automatización ahorran tiempo actualizando transacciones coincidentes por ti. Pueden asignar una categoría, añadir etiquetas y añadir una nota.
{{TOC}}
## Inicio rápido
1. Abre Reglas de automatización desde ajustes o desde herramientas de transacciones.
2. Crea una regla con una o más condiciones.
3. Elige al menos una acción: categoría o etiquetas.
4. Guarda la regla.
5. Aplícala a transacciones existentes si quieres actualizar coincidencias antiguas.
## Cómo funcionan las reglas
```mermaid
flowchart TD
transaction[Transacción] --> conditions[Condiciones de la regla]
conditions -->|coincide| actions[Acciones]
actions --> category[Asignar categoría]
actions --> labels[Añadir etiquetas]
actions --> note[Añadir nota]
```
Las reglas se revisan por prioridad. La primera regla que coincide puede aplicar sus acciones.
## Condiciones
Las condiciones deciden si una regla coincide con una transacción.
<div class="cards-wrapper">
<div class="card">
### Descripción
Coincide con texto de la descripción bancaria.
Útil para comercios, suscripciones y pagos repetidos.
</div>
<div class="card">
### Importe
Coincide con un importe exacto o compara importes.
Útil para suscripciones fijas o transferencias recurrentes.
</div>
<div class="card">
### Nombre del banco
Coincide con transacciones de un banco específico.
Útil cuando el mismo comercio aparece distinto según el banco.
</div>
<div class="card">
### Nombre de la cuenta
Coincide con una cuenta específica.
Útil cuando una cuenta necesita tratamiento especial.
</div>
<div class="card">
### Categoría
Coincide si una categoría está vacía, existe o es igual a un valor.
Útil para limpiar transacciones sin categoría.
</div>
</div>
## Acciones
Las acciones son lo que cambia la regla.
Una regla puede:
- Asignar una categoría.
- Añadir una o más etiquetas.
- Añadir una nota.
Hace falta al menos una acción de categoría o etiqueta.
## Grupos y prioridad
Usa grupos cuando una regla necesita más de una condición.
Ejemplos:
- La descripción contiene "Netflix" **y** el importe es menor que 20.
- La descripción contiene "Uber" **o** la descripción contiene "Cabify".
La prioridad controla qué regla gana cuando varias podrían coincidir.
Pon reglas específicas antes que reglas amplias.
## Aplicar reglas a transacciones existentes
Las reglas se ejecutan cuando se crean nuevas transacciones legibles. Las antiguas pueden necesitar un paso manual.
Usa aplicar o reevaluar cuando:
- Creas una regla nueva.
- Cambias una regla.
- Importaste transacciones antiguas.
- Quieres limpiar una acumulación de transacciones.
## Limitaciones importantes
La automatización necesita datos de transacción legibles.
Las reglas no coinciden con descripciones cifradas porque el servidor no puede leerlas. Esto protege tus datos privados.
## Preguntas frecuentes
### ¿Por qué no se ejecutó una regla?
Revisa la descripción, el importe, la cuenta y la prioridad. Comprueba también si la transacción está cifrada.
### ¿Debería crear reglas amplias o específicas?
Empieza con reglas específicas. Las reglas amplias son útiles, pero pueden coincidir con demasiado.
### ¿Una regla puede añadir varias etiquetas?
Sí. Una regla puede añadir más de una etiqueta.

112
resources/docs/documentation/es/budgets.md Normal file
View File

@ -0,0 +1,112 @@
# Presupuestos
Los presupuestos te ayudan a planificar gastos y ver cuánto margen queda en un periodo.
{{TOC}}
## Inicio rápido
1. Crea un presupuesto para un área que quieres controlar.
2. Elige la categoría o etiqueta que debe seguir.
3. Define el importe del periodo.
4. Revisa el progreso durante el mes.
5. Ajusta el presupuesto cuando tu gasto real cambie.
## Flujo de un presupuesto
```mermaid
flowchart TD
budget[Presupuesto] --> target[Categoría o etiqueta]
transactions[Transacciones] --> target
target --> progress[Progreso]
progress --> decision[Gastar, pausar o ajustar]
```
## Qué sigue un presupuesto
Un presupuesto puede seguir gastos que coinciden con una categoría o etiqueta.
Usa una categoría cuando el gasto tiene un significado claro.
Usa una etiqueta cuando el gasto cruza varias categorías.
Ejemplo:
- Presupuesto por categoría: Supermercado.
- Presupuesto por etiqueta: Vacaciones, Proyecto, Viaje de trabajo.
## Buenos ejemplos de presupuesto
<div class="cards-wrapper">
<div class="card">
### Supermercado
Útil para gasto diario que ocurre a menudo.
Revisar semanalmente.
</div>
<div class="card">
### Restaurantes
Útil para gasto opcional que puede crecer rápido.
Revisar a mitad de mes.
</div>
<div class="card">
### Viajes
Útil para gastos que cruzan varias categorías.
Un presupuesto basado en etiqueta puede funcionar bien aquí.
</div>
<div class="card">
### Suscripciones
Útil para gastos repetidos.
Las reglas de automatización pueden ayudar a mantenerlos categorizados.
</div>
</div>
## Leer el progreso del presupuesto
El progreso compara transacciones coincidentes con el importe del presupuesto.
Si el progreso es alto al principio del periodo, reduce el gasto o sube el presupuesto si el plan era demasiado bajo.
Si el progreso es bajo, puede que el presupuesto sea generoso o que el periodo no haya terminado.
## Periodos de presupuesto
Los presupuestos se siguen por periodo. La mayoría de personas piensa en presupuestos mensuales.
Al revisar un presupuesto, asegúrate de mirar el periodo correcto.
## Errores comunes
- Presupuestar antes de categorizar transacciones.
- Crear demasiados presupuestos de golpe.
- Mezclar compras puntuales con gasto mensual normal.
- Olvidar que las etiquetas pueden ser mejores para proyectos o viajes.
## Preguntas frecuentes
### ¿Los presupuestos cambian mis transacciones?
No. Los presupuestos leen transacciones. No las cambian.
### ¿Cada categoría debería tener un presupuesto?
No. Presupuesta solo lo que quieras controlar activamente.
### ¿Por qué un presupuesto aparece vacío?
Las transacciones coincidentes pueden estar sin categoría, usar otra etiqueta o estar en otro periodo.

122
resources/docs/documentation/es/cashflow.md Normal file
View File

@ -0,0 +1,122 @@
# Flujo de efectivo
Flujo de efectivo muestra cómo entra y sale el dinero durante un periodo. Te ayuda a entender si ganaste más de lo que gastaste.
{{TOC}}
## Inicio rápido
1. Elige el mes que quieres revisar.
2. Comprueba totales de ingresos y gastos.
3. Mira el flujo neto.
4. Revisa el diagrama de movimiento de dinero.
5. Abre desgloses de ingresos o gastos si algo parece extraño.
## Fórmula de flujo de efectivo
```mermaid
flowchart LR
income[Ingresos] --> net[Flujo neto]
expenses[Gastos] --> net
net --> savings[Tasa de ahorro]
```
La fórmula básica es:
```text
Flujo neto = Ingresos - Gastos
```
## Tarjetas principales
<div class="cards-wrapper">
<div class="card">
### Flujo neto
Muestra lo que queda después de gastos.
Positivo suele ser bueno. Negativo significa que los gastos fueron mayores que los ingresos.
</div>
<div class="card">
### Tasa de ahorro
Muestra el porcentaje de ingresos que queda después de gastos.
Una tasa más alta significa que conservaste más ingresos.
</div>
<div class="card">
### Gráfico de tendencia
Muestra ingresos, gastos y flujo neto en los últimos meses.
Úsalo para detectar patrones.
</div>
<div class="card">
### Movimiento de dinero
Muestra de dónde vino el dinero y a dónde fue.
Úsalo para entender los flujos principales rápidamente.
</div>
</div>
## Navegación por periodo
La página de Flujo de efectivo funciona por mes.
Usa los controles de periodo para moverte entre meses. La URL mantiene el mes seleccionado, así puedes refrescar o compartir la misma vista.
## Desgloses de ingresos y gastos
Los desgloses muestran qué categorías componen ingresos o gastos.
Úsalos para responder preguntas como:
- ¿Qué categoría hizo subir el gasto?
- ¿Este mes fue inusual?
- ¿Qué fuente de ingresos cambió?
- ¿Las transacciones sin categoría afectan el resultado?
## Transferencias en flujo de efectivo
Las transferencias son especiales.
La mayoría de transferencias entre tus propias cuentas no deberían contar como ingreso ni gasto. Si una transferencia debe aparecer en flujo de efectivo, ajusta su dirección en la categoría.
Opciones:
- No mostrar.
- Mostrar como entrada de efectivo.
- Mostrar como salida de efectivo.
## Cuando el flujo de efectivo parece incorrecto
Revisa esto primero:
1. ¿Las transacciones están bien categorizadas?
2. ¿Las transferencias usan la dirección correcta?
3. ¿Las fechas están en el mes esperado?
4. ¿Los importes importados tienen el signo correcto?
5. ¿Hay transacciones sin categoría?
## Preguntas frecuentes
### ¿Por qué la tasa de ahorro es negativa?
Los gastos fueron mayores que los ingresos en el periodo seleccionado.
### ¿Por qué faltan transferencias?
Las categorías de transferencia suelen estar ocultas del flujo de efectivo. Cambia la dirección si quieres mostrarlas.
### ¿Por qué el mes actual parece incompleto?
Puede que el mes aún no haya terminado. Pueden faltar ingresos o facturas.

93
resources/docs/documentation/es/categories.md
View File

@ -1,60 +1,44 @@
# Categorías
Las categorías ayudan a Whisper Money a entender cada transacción. Elige bien la categoría y tus informes serán más fáciles de confiar.
Las categorías explican qué significa cada transacción. Elige bien la categoría y tus informes serán más fáciles de confiar.
{{TOC}}
## Inicio rápido
Si solo lees una sección, lee esta.
1. Decide si la transacción es ingreso, gasto o transferencia.
2. Usa categorías de transferencia para dinero que se mueve entre tus propias cuentas.
3. Revisa las transacciones sin categoría a menudo.
4. Crea reglas de automatización para comercios repetidos.
1. **Elige qué es la transacción.** ¿Es gasto, ingreso, ahorro, inversión o transferencia?
2. **Usa transferencias para dinero que se mueve entre tus propias cuentas.** Así evitas contar el mismo dinero dos veces.
3. **Revisa las transacciones sin categoría a menudo.** Los informes solo son útiles cuando las transacciones tienen la categoría correcta.
4. **Crea reglas de automatización para transacciones repetidas.** Deja que Whisper Money gestione futuras coincidencias.
> ¿No sabes qué elegir? Empieza por el tipo de categoría. El nombre se puede ajustar después.
> ¿No sabes qué elegir? Empieza por el tipo. Puedes cambiar el nombre de la categoría después.
## Mapa de categorías
La idea básica es esta:
```mermaid
flowchart TD
transaction[Transacción] --> category[Categoría]
category --> reports[Informes]
category --> budgets[Presupuestos]
category --> cashflow[Flujo de efectivo]
category --> budgets[Presupuestos]
category --> reports[Informes]
```
Algunos ejemplos:
Ejemplos:
- 🛒 **Supermercado** → Gasto → informe de gastos y presupuestos.
- 💼 **Salario** → Ingreso → informes de ingresos y flujo de efectivo.
- 🏦 **Cuenta corriente a ahorro** → Transferencia o Ahorro → el flujo de efectivo sigue siendo preciso.
- 📈 **Depósito en broker** → Inversión → la inversión queda separada del gasto diario.
## Qué hacen las categorías
Cada transacción puede tener una categoría.
Whisper Money usa esa categoría para responder preguntas como:
- ¿Cuánto gasté en comida?
- ¿Cuánto ingreso entró este mes?
- ¿Estoy ahorrando o invirtiendo con regularidad?
- ¿Esto es un gasto real o moví dinero entre mis propias cuentas?
- Supermercado → Gasto → informes de gasto y presupuestos.
- Salario → Ingreso → informes de ingresos y flujo de efectivo.
- Cuenta corriente a ahorro → Transferencia → evita contar dos veces.
## Tipos de categoría
Cada categoría tiene un tipo. El tipo le dice a Whisper Money cómo tratar la transacción.
Cada categoría tiene un tipo.
<div class="cards-wrapper">
<div class="card">
### Gasto
Dinero que sale de tus finanzas.
Usa este tipo para dinero que sale de tus finanzas.
Ejemplos:
@ -69,7 +53,7 @@ Ejemplos:
<div class="card">
### Ingreso
Dinero que entra en tus finanzas.
Usa este tipo para dinero que entra en tus finanzas.
Ejemplos:
@ -84,7 +68,7 @@ Ejemplos:
<div class="card">
### Transferencia
Dinero que se mueve entre cuentas tuyas.
Usa este tipo cuando el dinero se mueve entre cuentas que son tuyas.
Ejemplos:
@ -93,40 +77,13 @@ Ejemplos:
- Cuenta bancaria a inversión
</div>
<div class="card">
### Ahorro
Dinero que apartas intencionadamente.
Ejemplos:
- Fondo de emergencia
- Entrada para una casa
- Fondo de vacaciones
- Otros objetivos de dinero
</div>
<div class="card">
### Inversión
Dinero que va a activos o cuentas de inversión.
Ejemplos:
- Depósitos en broker
- Fondos indexados
- Aportaciones para jubilación
- Compras de cripto
</div>
</div>
## Transferencias y dirección de flujo de efectivo
Las transferencias también pueden tener una dirección de flujo de efectivo.
Las categorías de transferencia pueden mostrarse u ocultarse en flujo de efectivo.
Elige la opción que mejor encaje con cómo quieres que aparezca la transferencia:
Opciones:
- **No mostrar**: oculta la transferencia del flujo de efectivo.
- **Mostrar como entrada de efectivo**: muestra la transferencia como dinero que entra.
@ -136,7 +93,7 @@ Para la mayoría de movimientos entre tus propias cuentas, **No mostrar** es la
## Transacciones sin categoría
Las transacciones importadas pueden empezar sin categoría.
Las transacciones importadas o sincronizadas pueden empezar sin categoría.
Prueba esta rutina:
@ -145,19 +102,15 @@ Prueba esta rutina:
3. Deja las confusas para más tarde si hace falta.
4. Crea reglas de automatización para comercios o descripciones repetidas.
Así mantienes los informes limpios sin convertir la categorización en una tarea pesada.
## Cambiar una categoría
Cambiar la categoría de una transacción actualiza todos los informes que incluyen esa transacción.
Cambiar la categoría de una transacción actualiza los informes que incluyen esa transacción.
Esto puede cambiar:
Esto puede afectar:
- Totales de gasto
- Progreso de presupuestos
- Totales de ingresos
- Totales de ahorro
- Totales de inversión
- Flujo de efectivo
Cambiar la categoría en sí, como su nombre o tipo, afecta a todas las transacciones que usan esa categoría.
@ -176,10 +129,6 @@ Normalmente no. Si ya registras las compras de la tarjeta, el pago es dinero mov
Empieza con pocas. Demasiadas categorías hacen que los informes sean más difíciles de leer. Añade más solo cuando necesites más detalle.
### ¿Cuándo debería crear una regla de automatización?
Crea una cuando el mismo comercio o descripción siempre acaba con la misma categoría.
## Buenos hábitos con categorías
- Usa nombres cortos y claros.

122
resources/docs/documentation/es/getting-started.md Normal file
View File

@ -0,0 +1,122 @@
# Primeros pasos
Whisper Money te ayuda a entender dónde está tu dinero, dónde se fue y qué cambió con el tiempo.
{{TOC}}
## Inicio rápido
Sigue este orden si estás configurando todo por primera vez.
1. Crea tus cuentas.
2. Añade o importa transacciones.
3. Revisa las transacciones sin categoría.
4. Crea reglas de automatización para transacciones repetidas.
5. Revisa Flujo de efectivo para ver ingresos, gastos y movimiento neto.
6. Añade presupuestos cuando quieras límites de gasto.
## Cómo encajan las piezas
```mermaid
flowchart TD
accounts[Cuentas] --> transactions[Transacciones]
transactions --> categories[Categorías]
transactions --> labels[Etiquetas]
categories --> cashflow[Flujo de efectivo]
categories --> budgets[Presupuestos]
labels --> budgets
automation[Reglas de automatización] --> transactions
```
## Conceptos principales
<div class="cards-wrapper">
<div class="card">
### Cuentas
Las cuentas son donde vive el dinero.
Ejemplos:
- Cuenta corriente
- Tarjeta de crédito
- Cuenta de ahorro
- Préstamo
- Inmueble
</div>
<div class="card">
### Transacciones
Las transacciones son movimientos de dinero.
Ejemplos:
- Pago de salario
- Compra en supermercado
- Pago de tarjeta
- Transferencia bancaria
</div>
<div class="card">
### Categorías
Las categorías explican qué significa una transacción.
Ejemplos:
- Supermercado
- Salario
- Alquiler
- Transferencia
</div>
<div class="card">
### Reglas de automatización
Las reglas ahorran tiempo aplicando categorías y etiquetas por ti.
Ejemplo:
- Si la descripción contiene "Netflix", usar categoría "Suscripciones".
</div>
</div>
## Rutina semanal recomendada
Una rutina simple es suficiente para la mayoría de personas.
1. Importa o sincroniza nuevas transacciones.
2. Categoriza lo que esté sin categoría.
3. Corrige transferencias entre tus propias cuentas.
4. Revisa Flujo de efectivo del mes.
5. Revisa presupuestos si los usas.
## Qué hacer si los informes parecen incorrectos
Empieza por lo básico.
- Comprueba que existen las cuentas correctas.
- Busca transacciones sin categoría.
- Asegúrate de que las transferencias no cuentan como ingreso o gasto.
- Revisa que las fechas sean correctas.
- Comprueba si una transacción pertenece a una cuenta en otra moneda.
## Preguntas frecuentes
### ¿Necesito presupuestos para usar Whisper Money?
No. Puedes empezar con cuentas, transacciones y categorías. Añade presupuestos después si quieres límites.
### ¿Debería categorizar todas las transacciones?
Sí, si quieres informes precisos. Las reglas de automatización lo hacen mucho más rápido.
### ¿Qué debería configurar primero?
Empieza por las cuentas. Después añade transacciones. Las categorías y los informes dependen de esas dos cosas.

110
resources/docs/documentation/es/imports.md Normal file
View File

@ -0,0 +1,110 @@
# Importaciones
Las importaciones te permiten traer archivos bancarios a Whisper Money cuando la sincronización automática no está disponible o cuando quieres más control.
{{TOC}}
## Inicio rápido
1. Elige la cuenta.
2. Sube el archivo del banco.
3. Mapea las columnas.
4. Revisa la vista previa.
5. Importa las transacciones seleccionadas.
6. Revisa categorías y duplicados después de importar.
## Flujo de importación
```mermaid
flowchart TD
account[Elegir cuenta] --> file[Subir archivo]
file --> mapping[Mapear columnas]
mapping --> preview[Vista previa]
preview --> import[Importar]
import --> review[Revisar transacciones]
```
## Columnas necesarias
<div class="cards-wrapper">
<div class="card">
### Fecha
La fecha de la transacción.
Whisper Money puede detectar formatos comunes, pero puedes ajustarlo si hace falta.
</div>
<div class="card">
### Descripción
El texto que explica la transacción.
Puedes combinar columnas de descripción cuando el banco separa detalles en varios campos.
</div>
<div class="card">
### Importe
El importe de la transacción.
Asegúrate de que ingresos y gastos usan el signo correcto.
</div>
<div class="card">
### Saldo
Opcional.
Úsalo cuando el archivo incluye saldos de cuenta acumulados.
</div>
</div>
## Cálculo de saldos
Algunos archivos no incluyen una columna de saldo.
Cuando es posible, Whisper Money puede calcular saldos desde transacciones usando un saldo de referencia.
Esto es útil cuando:
- Tu banco exporta transacciones pero no saldos.
- Conoces el saldo más reciente.
- Quieres gráficos de saldo histórico.
## Vista previa antes de importar
Revisa siempre la vista previa.
Busca:
- Fechas incorrectas.
- Importes con el signo equivocado.
- Transacciones duplicadas.
- Descripciones vacías.
- Filas vacías inesperadas.
## Automatización durante la importación
Las reglas de automatización pueden ayudar a categorizar transacciones importadas.
Funciona mejor cuando las descripciones son consistentes. Si siempre importas el mismo formato de archivo bancario, las reglas son muy útiles.
## Preguntas frecuentes
### ¿Qué archivo debería usar?
Usa la exportación más limpia que ofrezca tu banco. CSV y archivos tipo hoja de cálculo suelen ser los más fáciles.
### ¿Por qué los importes están invertidos?
Algunos bancos exportan gastos como números positivos. Revisa la vista previa antes de importar.
### ¿Puedo importar el mismo archivo dos veces?
Whisper Money intenta ayudar a detectar duplicados, pero revisa la vista previa para evitar importar la misma transacción dos veces.

151
resources/docs/documentation/es/transactions.md Normal file
View File

@ -0,0 +1,151 @@
# Transacciones
Las transacciones son los movimientos individuales de dinero en tus cuentas. Alimentan categorías, flujo de efectivo, presupuestos y reglas de automatización.
{{TOC}}
## Inicio rápido
1. Añade transacciones manualmente, impórtalas desde un archivo o sincronízalas desde una cuenta conectada.
2. Revisa fechas, descripciones e importes.
3. Añade categorías y etiquetas.
4. Usa filtros para encontrar grupos de transacciones.
5. Usa acciones masivas cuando muchas transacciones necesitan el mismo cambio.
## Flujo de una transacción
```mermaid
flowchart TD
new[Nueva transacción] --> review[Revisión]
review --> category[Categoría]
review --> labels[Etiquetas]
category --> reports[Informes]
labels --> filters[Filtros y presupuestos]
rules[Reglas de automatización] --> category
rules --> labels
```
## Qué contiene una transacción
<div class="cards-wrapper">
<div class="card">
### Fecha
El día en que se movió el dinero.
La fecha controla en qué mes aparece la transacción.
</div>
<div class="card">
### Descripción
El texto de tu banco o el texto que escribiste manualmente.
Las descripciones son útiles para búsqueda y reglas de automatización.
</div>
<div class="card">
### Importe
El valor del movimiento.
Los importes positivos suelen ser dinero que entra. Los negativos suelen ser dinero que sale.
</div>
<div class="card">
### Categoría
El significado de la transacción.
Las categorías deciden dónde aparece la transacción en los informes.
</div>
<div class="card">
### Etiquetas
Tags extra para filtrar y presupuestar.
Una transacción puede tener más de una etiqueta.
</div>
<div class="card">
### Notas
Contexto privado para ti.
Usa notas cuando la descripción del banco no sea suficiente.
</div>
</div>
## Filtros y búsqueda
Usa filtros cuando la lista sea demasiado grande.
Puedes filtrar por:
- Rango de fechas
- Rango de importes
- Categoría
- Cuenta
- Etiqueta
- Texto de búsqueda
Una buena búsqueda suele empezar con el nombre del comercio o una palabra de la descripción bancaria.
## Acciones masivas
Las acciones masivas ayudan cuando muchas transacciones necesitan el mismo cambio.
Buenos usos:
- Asignar una categoría a varias transacciones.
- Añadir la misma etiqueta a un grupo.
- Actualizar notas para transacciones coincidentes.
- Reevaluar reglas de automatización en transacciones seleccionadas.
Antes de editar en masa, revisa bien la lista filtrada. Las acciones masivas pueden actualizar muchas filas a la vez.
## Transacciones sin categoría
Las transacciones sin categoría hacen que los informes sean menos útiles.
Prueba este enfoque:
1. Filtra transacciones sin categoría.
2. Categoriza primero los comercios obvios.
3. Crea reglas de automatización para comercios repetidos.
4. Deja los casos poco claros para más tarde en vez de adivinar.
## Reevaluar reglas de automatización
Si creas o cambias reglas después de que existan transacciones, las antiguas pueden no actualizarse automáticamente.
Usa la reevaluación cuando quieras que las reglas vuelvan a ejecutarse sobre transacciones existentes.
Úsala después de:
- Crear una regla nueva.
- Corregir una condición.
- Importar muchas transacciones.
- Limpiar transacciones antiguas sin categoría.
## Preguntas frecuentes
### ¿Por qué una transacción aparece en el mes equivocado?
Revisa la fecha de la transacción. Los informes usan esa fecha.
### ¿Una transacción puede tener varias categorías?
No. Una transacción tiene una categoría. Usa etiquetas cuando necesites tags extra.
### ¿Cuál es la diferencia entre categorías y etiquetas?
Las categorías definen el significado principal. Las etiquetas añaden tags flexibles para filtrar y presupuestar.

44
tests/Feature/DocumentationTest.php
View File

@ -9,16 +9,34 @@ it('shows the default documentation page', function () {
->assertInertia(
fn (AssertableInertia $page) => $page
->component('documentation/show')
->where('document.slug', 'categories')
->where('document.slug', 'getting-started')
->where('document.locale', 'en')
->where('document.title', 'Categories')
->where('document.description', 'Learn how categories work in Whisper Money.')
->where('document.title', 'Getting started')
->where('document.description', 'Learn the basic Whisper Money workflow.')
->where('navigation.0.active', true)
->where('languages.0.active', true)
->where('languages.1.url', '/documentation/categories?lang=es')
->where('languages.1.url', '/documentation/getting-started?lang=es')
);
});
it('shows every configured documentation page in every locale', function () {
$pages = array_keys(config('documentation.pages'));
$locales = array_keys(config('documentation.locales'));
foreach ($pages as $slug) {
foreach ($locales as $locale) {
$this->get(route('documentation.show', ['slug' => $slug, 'lang' => $locale]))
->assertOk()
->assertInertia(
fn (AssertableInertia $page) => $page
->component('documentation/show')
->where('document.slug', $slug)
->where('document.locale', $locale)
);
}
}
});
it('shows the English categories documentation page', function () {
$this->get(route('documentation.show', ['slug' => 'categories', 'lang' => 'en']))
->assertOk()
@ -28,7 +46,6 @@ it('shows the English categories documentation page', function () {
->where('document.slug', 'categories')
->where('document.locale', 'en')
->where('document.title', 'Categories')
->where('navigation.0.url', '/documentation/categories?lang=en')
);
});
@ -42,11 +59,10 @@ it('shows the Spanish categories documentation page', function () {
->where('document.locale', 'es')
->where('document.title', 'Categorías')
->where('document.description', 'Aprende cómo funcionan las categorías en Whisper Money.')
->where('navigation.0.title', 'Categorías')
->where('languages.0.url', '/documentation/categories?lang=en')
->where('languages.1.active', true)
->where('document.html', fn (string $html): bool => str_contains($html, 'Qué hacen las categorías')
&& str_contains($html, 'href="#que-hacen-las-categorias"')
->where('document.html', fn (string $html): bool => str_contains($html, 'Mapa de categorías')
&& str_contains($html, 'href="#mapa-de-categorias"')
&& str_contains($html, '<p>En esta página</p>'))
);
});
@ -58,16 +74,16 @@ it('replaces the table of contents placeholder with heading links', function ()
fn (AssertableInertia $page) => $page
->where('document.html', fn (string $html): bool => ! str_contains($html, '{{TOC}}')
&& str_contains($html, '<nav class="documentation-toc"')
&& str_contains($html, 'href="#what-categories-do"')
&& str_contains($html, 'href="#category-map"')
&& str_contains($html, 'href="#expense"')
&& str_contains($html, 'language-mermaid')
&& str_contains($html, 'flowchart TD')
&& str_contains($html, '<div class="cards-wrapper">')
&& str_contains($html, '<section class="card"><h3 id="expense">Expense</h3>')
&& ! str_contains($html, '<div class="card">')
&& str_contains($html, '<span class="toc-number">3</span> What categories do')
&& str_contains($html, '<span class="toc-number">4.1</span> Expense')
&& str_contains($html, '<h2 id="what-categories-do">')
&& str_contains($html, '<span class="toc-number">2</span> Category map')
&& str_contains($html, '<span class="toc-number">3.1</span> Expense')
&& str_contains($html, '<h2 id="category-map">')
&& str_contains($html, '<h3 id="expense">')
&& ! str_contains($html, 'href="#categories"'))
);
@ -80,9 +96,9 @@ it('uses configured heading levels for the table of contents', function () {
->assertOk()
->assertInertia(
fn (AssertableInertia $page) => $page
->where('document.html', fn (string $html): bool => str_contains($html, 'href="#what-categories-do"')
->where('document.html', fn (string $html): bool => str_contains($html, 'href="#category-map"')
&& ! str_contains($html, 'href="#expense"')
&& str_contains($html, '<h2 id="what-categories-do">')
&& str_contains($html, '<h2 id="category-map">')
&& ! str_contains($html, '<h3 id="expense">'))
);
});