Skip to content

Commit f44bec1

Browse files
authored
V3.2 changes (#33)
* catch up on releases * v3.2 changes * more changes * update changes * fix build error * update with changes
1 parent 6b20806 commit f44bec1

15 files changed

Lines changed: 226 additions & 15 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Auto-Categorization
2+
3+
You can train a machine learning model on your categorized transactions and use that model to predict categories for new transactions.
4+
5+
## Setting up
6+
7+
To set up auto-categorization, navigate to the `Settings` page and find the `Auto-Categorization` settings under the `Advanced Settings` section.
8+
9+
First, you will need to train the auto-categorizer. Click the `Train` button and select a date range to train on. If you would like to include all of your transactions in the training data, you can leave the date range blank.
10+
11+
Once you have trained the model, you can enable auto-categorization by clicking the toggle button. When auto-categorization is enabled, new transactions that are added to Budget Board via external sync or CSV import will automatically have a category predicted for them based on the model that was trained.
12+
13+
:::note
14+
A minimum confidence level can be specified for predictions. If the model's confidence in a prediction is below this threshold, the transaction will not be automatically categorized and will instead be left uncategorized for you to review and categorize manually. By default, this threshold is set to 70% confidence, but you can adjust it to be more or less strict based on your preferences.
15+
:::
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# External Providers
2+
3+
External providers are services that Budget Board can connect to in order to import financial data. This includes services like SimpleFIN and LunchFlow, which are financial data aggregation services that can connect to your bank accounts and other financial institutions to pull in transaction data.
4+
5+
The `External Accounts` page allows you to manage your connections to external providers, view the accounts that have been imported from those providers, and map those accounts to accounts in Budget Board. Once an external account is mapped to a Budget Board account, transaction and balance data will be imported from the external provider into that Budget Board account whenever a sync is performed.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# LunchFlow
2+
3+
Budget Board can sync with [LunchFlow](https://lunchflow.app/), a third‑party service that connects to your bank and imports transactions. LunchFlow is similar to SimpleFIN, but with support for more institutions, particularly institutions outside of the U.S.
4+
5+
## Getting Started
6+
7+
### Setting up LunchFlow
8+
9+
To use LunchFlow with Budget Board, set up a [LunchFlow](https://lunchflow.app/) account. This service securely connects to your bank and provides access tokens for third‑party applications like Budget Board.
10+
11+
1. Go to [LunchFlow](https://lunchflow.app/) and create an account.
12+
2. After logging in, connect your bank account by following the prompts in LunchFlow.
13+
3. Once your accounts are connected, go to the `Destinations` page in LunchFlow and click the `Add Destination` button.
14+
4. Select `Rest API` as the destination type.
15+
5. Copy the generated API key.
16+
17+
### Linking LunchFlow to Budget Board
18+
19+
Use the API key to link LunchFlow to Budget Board:
20+
21+
1. In Budget Board, open the `External Accounts` page.
22+
2. Under the `LunchFlow` section, paste the API key from LunchFlow into the input field.
23+
3. Click `Set API Key`. If successful, the section will display `Connected`.

docs/features/importing-data/simplefin-sync.mdx renamed to docs/features/importing-data/external-providers/simplefin.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SimpleFIN Sync
1+
# SimpleFIN
22

33
Budget Board can sync with [SimpleFIN](https://simplefin.com/), a third‑party service that connects to your bank and imports transactions.
44

@@ -17,10 +17,10 @@ To use SimpleFIN with Budget Board, set up a [SimpleFIN Bridge](https://beta-bri
1717

1818
Use the access token to link SimpleFIN to Budget Board:
1919

20-
1. In Budget Board, open the Settings page.
21-
2. Find the "Link SimpleFIN" section.
20+
1. In Budget Board, open the `External Accounts` page.
21+
2. Find the `SimpleFIN` section.
2222
3. Paste the access token from SimpleFIN Bridge into the input field.
23-
4. Click "Save Changes". If successful, the section will display "Linked".
23+
4. Click `Set Access Token`. If successful, the section will display `Linked`.
2424

2525
## Advanced Configuration
2626

docs/overview/index.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import BudgetBoardLogo from "@site/static/img/budgetBoardLogo.svg";
2222

2323
## Summary
2424

25-
BudgetBoard is an open-source personal finance application designed to help users track their monthly spending and work towards financial goals. It offers a user-friendly interface, robust budgeting tools, and seamless integration with various financial institutions via sync providers like SimpleFIN.
25+
BudgetBoard is an open-source personal finance application designed to help users track their monthly spending and work towards financial goals. It offers a user-friendly interface, robust budgeting tools, and seamless integration with various financial institutions via sync providers like SimpleFIN and LunchFlow.
2626

2727
### Key Features
2828

@@ -37,7 +37,8 @@ BudgetBoard is an open-source personal finance application designed to help user
3737
#### Data Import & Automation
3838

3939
- **Transaction CSV Import**: Import transactions in bulk using CSV files.
40-
- **Sync Providers**: Integrate with financial institutions through providers like SimpleFIN for automatic transaction and account balance syncing.
40+
- **Sync Providers**: Integrate with financial institutions through providers like SimpleFIN and LunchFlow for automatic transaction and account balance syncing.
41+
- **Auto-Categorization**: Train a machine learning model on your categorized transactions to automatically predict categories for new transactions.
4142
- **Automatic Rules**: Create rules to automatically update transactions based on criteria like description, amount, or date.
4243

4344
#### Analytics & Insights
@@ -48,6 +49,10 @@ BudgetBoard is an open-source personal finance application designed to help user
4849

4950
- **User Authentication**: Authenticate locally with two-factor authentication (2FA), or bring your own authentication provider with OIDC login.
5051

52+
#### Internationalization
53+
54+
- **Multiple Languages**: Available in multiple languages including English, German, and Simplified Chinese, with community-contributed translations.
55+
5156
### Screenshots
5257

5358
<img
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Release v3.1.1"
3+
---
4+
5+
Some of the localization changes broke some of the logic with the automatic rules component. Fixed the issue to check against the underlying value rather than the localization key.
6+
7+
## What's Changed
8+
9+
- Fix transaction category stuff by @teelur in https://github.com/teelur/budget-board/pull/663
10+
11+
**Full Changelog**: https://github.com/teelur/budget-board/compare/v3.1.0...v3.1.1
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: "Release v3.1.2"
3+
---
4+
5+
This patch fixes a bug where the balance doesn't update properly when an account has multiple balances for a given day.
6+
7+
## What's Changed
8+
9+
- Add translations by @teelur in https://github.com/teelur/budget-board/pull/664
10+
- Add CodeQL analysis workflow configuration by @teelur in https://github.com/teelur/budget-board/pull/668
11+
- Fixing balances so each account only has one balance per day (#666) by @awilner in https://github.com/teelur/budget-board/pull/667
12+
13+
## New Contributors
14+
15+
- @awilner made their first contribution in https://github.com/teelur/budget-board/pull/667
16+
17+
**Full Changelog**: https://github.com/teelur/budget-board/compare/v3.1.1...v3.1.2
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Release v3.1.3"
3+
---
4+
5+
Fixed an issue where importing a CSV with numeric account names causes a fatal error.
6+
7+
## What's Changed
8+
9+
- Translations update from Hosted Weblate by @weblate in https://github.com/teelur/budget-board/pull/669
10+
- Translations update from Hosted Weblate by @weblate in https://github.com/teelur/budget-board/pull/670
11+
- Translations update from Hosted Weblate by @weblate in https://github.com/teelur/budget-board/pull/676
12+
- remove unused keys by @teelur in https://github.com/teelur/budget-board/pull/679
13+
- Translations update from Hosted Weblate by @weblate in https://github.com/teelur/budget-board/pull/680
14+
- Fix numeric account names in transaction import by @teelur in https://github.com/teelur/budget-board/pull/683
15+
16+
## New Contributors
17+
18+
- @weblate made their first contribution in https://github.com/teelur/budget-board/pull/669
19+
20+
**Full Changelog**: https://github.com/teelur/budget-board/compare/v3.1.2...v3.1.3
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Release v3.1.4"
3+
---
4+
5+
This patch fixes a bug where custom transaction categories were not getting assigned during transaction import.
6+
7+
## What's Changed
8+
9+
- Fixing bug that ignored custom transactions on CSV import (#673) (#674) by @awilner in https://github.com/teelur/budget-board/pull/685
10+
11+
**Full Changelog**: https://github.com/teelur/budget-board/compare/v3.1.3...v3.1.4
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Release v3.1.5"
3+
---
4+
5+
Removed some unnecessary config options from the compose.env file to reduce the chance of deployment issues.
6+
7+
## What's Changed
8+
9+
- remove unused config options (#699) by @teelur in https://github.com/teelur/budget-board/pull/701
10+
11+
**Full Changelog**: https://github.com/teelur/budget-board/compare/v3.1.4...v3.1.5

0 commit comments

Comments
 (0)