diff --git a/docs-sidebar.js b/docs-sidebar.js index 8daafe83f..a1a1f730a 100644 --- a/docs-sidebar.js +++ b/docs-sidebar.js @@ -175,11 +175,11 @@ const sidebars = { label: 'Connecting Your Bank', link: { type: 'doc', - id: 'advanced/bank-sync', + id: 'transactions/bank-sync/index', }, items: [ - 'advanced/bank-sync/gocardless', - 'advanced/bank-sync/simplefin', + 'transactions/bank-sync/gocardless', + 'transactions/bank-sync/simplefin', ], }, 'advanced/scripts/modify-transfers', diff --git a/docs/accounts/index.md b/docs/accounts/index.md index cc4a7d449..7b0d9bafc 100644 --- a/docs/accounts/index.md +++ b/docs/accounts/index.md @@ -21,7 +21,7 @@ You can add an account to your budget at any time, however when you first instal You can also add an account using the `+ Add account` button in the sidebar. Two successive screens will appear with boxes asking you to fill in a few options -- Create a Local Account or Link to GoCardless (See [Connecting Your Bank](https://actualbudget.org/docs/advanced/bank-sync)) +- Create a Local Account or Link to GoCardless (See [Connecting Your Bank](https://actualbudget.org/docs/transactions/bank-sync)) - Give your account a name - Is the account on budget or off budget - The current account balance diff --git a/docs/advanced/bank-sync.md b/docs/advanced/bank-sync.md deleted file mode 100644 index 237467ec8..000000000 --- a/docs/advanced/bank-sync.md +++ /dev/null @@ -1,17 +0,0 @@ -# Connecting Your Bank - -We are excited to offer optional bank integration in Actual. -Here are a couple of considerations to know about before making the decision to use bank sync in your installation of Actual Budget. - -- This integration relies on you providing your own API credentials that you will need to get by signing up with the service provider and Generate Keys and Secrets that will be used in Actual. - -- The integration only works if you are using actual-server. - -- The Secrets and Keys are stored in your Actual installed version so it is highly recommended to turn on End to End encryption and create a strong passphrase to encrypt your files. - -- You will need to add a config file to your installation. - -## Supported Providers - -* GoCardless (European Banks) -* SimpleFIN Bridge (North American Banks) diff --git a/docs/faq.md b/docs/faq.md index 868456d92..55e732254 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -6,7 +6,7 @@ - **Q.** _Can I sync my bank to Actual automatically?_ - **A.** Yes, certain banks are now supported, you can find the documentation [here](./advanced/bank-sync.md). If you are setting up Actual for the first time, + **A.** Yes, certain banks are now supported, you can find the documentation [here](/docs/transactions/bank-sync/index.md). If you are setting up Actual for the first time, it is much easier to not pull in historical data. First, set up your account(s) with a correct opening balance on a recent date, then set up bank sync. Only transactions after the opening balance date will be synced, making reconciliation easy. diff --git a/docs/getting-started/envelope-budgeting.md b/docs/getting-started/envelope-budgeting.md index e2cfc99be..7b1275ede 100644 --- a/docs/getting-started/envelope-budgeting.md +++ b/docs/getting-started/envelope-budgeting.md @@ -14,7 +14,7 @@ but also addresses some of its limitations. One key difference is that traditional envelope budgeting often overlooks fixed expenses like rent, mortgage, utility bills, and other regular payments. These fixed costs are crucial and must be accounted for to have a complete picture of your finances. Actual Budget ensures that every fixed or variable expense is -considered. This comprehensive approach makes Actual Budget much more effective than the traditional cash-stuffing method. +considered. This comprehensive approach makes AB much more effective than the traditional cash-stuffing method. A significant advantage of using Actual Budget is increased awareness of expenses. Knowing where every penny of your money is spent is a decisive step towards financial control and stability. @@ -65,17 +65,41 @@ are going, make changes. If you're happy, great! Keep budgeting to keep track of A more detailed breakdown of how budgeting in Actual works is provided in the [budgeting page](/docs/budgeting/). -### Credit Cards -If you currently are carrying credit card debt in an on budget account you will need to capture that debt in a category. -A guide on how to handle that can be found in [the credit card guide](/docs/budgeting/credit-cards/). - -### The Month Ahead Method +### The Month Ahead Strategy It can be hard to know where to budget your funds when you get paid in the middle of the month, or get multiple paychecks per month. One way to handle this is called the *month ahead* method. This consists of holding everything you make this month and only budgeting it next month. The goal is to not need any of this month's income for this month's bills, but pay all of this month's bills with last month's income. Actual makes this easy by allowing you to hold your available funds for the next month by clicking the To Budget amount at the top of the budgeting screen -and selecting the "Hold for next month" option. You can read more about this on the budgeting page +and selecting the *Hold for next month* option. You can read more about this on [the budgeting page](/docs/budgeting/). + +For example, if you make $ 3,000 this month, instead of spending it on this month's bills, you save it and use it to +cover next month's expenses. Most people cannot achieve this in one month, so the way forward is to build up a +buffer. Instead of aiming to save the full $ 3,000 in one go, begin by setting aside a smaller amount each month. +For example, if you can set aside $ 200 each month, gradually build your buffer over several months. As you save +more, you’ll start to pay some of next month’s bills with this reserve. + +You can also read about this strategy in [one of our blog posts](/blog/2023-12-15-automate-your-budget-with-goal-templates). + + +### Pay-Yourself-First Strategy +The Pay-Yourself-First strategy focuses on saving a portion of your income before spending on anything else. +By making savings the top priority, this approach helps individuals build financial stability and prepare for unexpected +events. Automating savings, such as setting up automatic transfers, ensures consistency and reduces the temptation +to overspend. The strategy also encourages a balanced approach, addressing both immediate needs and long-term +financial security. Actual has functionality for [Schedules](/docs/schedules) +and [Budget Goal Templates](/docs/experimental/goal-templates#goal-directive) that can help you with this strategy. + +For example, if you earn $ 3,000 a month, you might decide to save 20%, or $ 600, as soon as you receive your paycheck. +You set up an automatic transfer to move this amount into a savings account, ensuring it is set aside before you +pay any bills or make purchases. The remaining $ 2,400 is then available to cover your living expenses, such as rent, +utilities, groceries, and entertainment. This method guarantees that your savings goal is consistently met without +having to rely on what’s left at the end of the month. + + +### Credit Cards +If you currently are carrying credit card debt in an on budget account you will need to capture that debt in a category. +A guide on how to handle that can be found in [the credit card guide](/docs/budgeting/credit-cards/). ### Shared accounts We have a guide on what to do when it comes to [strategies for handling joint accounts](/docs/budgeting/joint-accounts). @@ -84,12 +108,10 @@ We have a guide on what to do when it comes to [strategies for handling joint ac You can read more about these in the [returns and reimbursements guides](/docs/budgeting/returns-and-reimbursements). - - ## How to set up and use an envelope system with Actual Budget Learning to budget using Actual Budget is straightforward, even -if you're new to budgeting. Here's a checklist for getting started: +if you're new to budgeting. Here's a checklist for getting started: ### 1. Establish budget categories @@ -120,19 +142,19 @@ This average provides a realistic estimate of your spending and income patterns, you to set initial budget values that reflect your financial habits. -For example, if you have € 1 200 to allocate for the month, your budget might look like this: +For example, if you have $ 1,200 to allocate for the month, your budget might look like this: | Categories | Allocated (budgeted) funds | Explanation | -|-----------------|-----------------|---------------------------------------------------------------------| -| Groceries | € 300 | This covers your monthly food and household supplies. | -| Gas | € 100 | Allocated for fuel and transportation costs. | -| Dining Out | € 150 | Money set aside for eating out at restaurants or cafes. | -| Clothing | € 100 | Funds for purchasing new clothes or accessories. | -| Entertainment | € 150 | Budget for movies, hobbies, or other leisure activities. | -| Gifts | € 50 | Savings for birthdays, holidays, or special occasions. | -| Personal Care | € 150 | Allocated for health and beauty products or services like haircuts. | -| Savings | € 200 | Money set aside for future needs or emergencies. | -| **TOTAL** | **€ 1 200** | | +|-----------------|----------------------------|---------------------------------------------------------------------| +| Groceries | $ 300 | This covers your monthly food and household supplies. | +| Gas | $ 100 | Allocated for fuel and transportation costs. | +| Dining Out | $ 150 | Money set aside for eating out at restaurants or cafes. | +| Clothing | $ 100 | Funds for purchasing new clothes or accessories. | +| Entertainment | $ 150 | Budget for movies, hobbies, or other leisure activities. | +| Gifts | $ 50 | Savings for birthdays, holidays, or special occasions. | +| Personal Care | $ 150 | Allocated for health and beauty products or services like haircuts. | +| Savings | $ 200 | Money set aside for future needs or emergencies. | +| **TOTAL** | **$ 1,200** | | @@ -191,8 +213,8 @@ necessary adjustments. **How to Adjust Your Budget** 1. **Review your spending**: First, identify where you overspent. Look at your budget categories to see where adjustments are needed. -2. **Reallocate funds**: Move money from categories with surplus funds to cover the overspending. For example, if you budgeted € 100 - for *Eating Out* but spent € 140, find another category with extra funds, like *Clothing* or *Entertainment,* and shift some +2. **Reallocate funds**: Move money from categories with surplus funds to cover the overspending. For example, if you budgeted $ 100 + for *Eating Out* but spent $ 140, find another category with extra funds, like *Clothing* or *Entertainment,* and shift some of that money to cover the difference. 3. **Stay calm and flexible**: Remember, the goal of budgeting is to manage your finances effectively, not to be perfect. Flexibility is key. Adjusting your budget is a normal part of the process. @@ -211,7 +233,7 @@ you understand that budgets are not rigid constraints but flexible tools that ca -### 5. Prepare for the unexpected +### 4. Prepare for the unexpected There’s no such thing as a "normal" month when it comes to expenses. Your costs fluctuate throughout the year, often unpredictably. Envelope budgeting helps you prepare for these irregular expenses by adding funds to @@ -243,8 +265,8 @@ month to cover these rather than having to put up the larger amount when the bil as a fixed expense to ensure you consistently save for these future costs. -**Example:** Let’s say your annual insurance costs are € 2 400. Instead of scrambling to find this amount when the bill -arrives, you can set aside € 200 each month. By the time the bill is due, you’ll have the total amount saved and ready, +**Example:** Let’s say your annual insurance costs are $ 2,400. Instead of scrambling to find this amount when the bill +arrives, you can set aside $ 200 each month. By the time the bill is due, you’ll have the total amount saved and ready, avoiding the need to dip into savings or incur debt. @@ -262,7 +284,7 @@ having (to remember) to manually enter each transaction whenever you make a purc Most financial institutions will let you export your transactions as CSV files, which can be [imported into Actual Budget](/docs/transactions/importing). Using cards will save you time and reduce the risk of errors. -**Automatic import**: Actual Budget can [sync directly with your bank accounts](/docs/advanced/bank-sync). +**Automatic import**: Actual Budget can [sync directly with your bank accounts](/docs/transactions/bank-sync). Every time you use your debit or credit card, the transaction details are automatically imported into your budget categories. You no longer need to keep physical receipts or manually log each expense. @@ -272,25 +294,25 @@ Read more about [managing credit cards](/docs/budgeting/credit-cards) with Actua ## A detailed example of how to do Zero-Sum budgeting -Let's say your total monthly income of January is € 1 200. You get your money on the 1st. Using Zero-Based Budgeting, +Let's say your total monthly income in January is $ 1,200. You get your money on the 1st. Using Zero-Based Budgeting, you will allocate every unit of this income to different categories, ensuring that nothing is left unassigned. This is known as the *Total Allocation*. -Here's an example of how you could split the € 1 200: +Here's an example of how you could split the $ 1,200: -| Categories | Income | Explanation | -|-----------------|-----------------|---------------------------------------------------------------------| -| Groceries | € 300 | This covers your monthly food and household supplies. | -| Gas | € 100 | Allocated for fuel and transportation costs. | -| Dining Out | € 150 | Money set aside for eating out at restaurants or cafes. | -| Clothing | € 100 | Funds for purchasing new clothes or accessories. | -| Entertainment | € 150 | Budget for movies, hobbies, or other leisure activities. | -| Gifts | € 50 | Savings for birthdays, holidays, or special occasions. | -| Personal Care | € 150 | Allocated for health and beauty products or services like haircuts. | -| Savings | € 200 | Money set aside for future needs or emergencies. | -| **TOTAL** | **€ 1 200** | | +| Categories | Income | Explanation | +|-----------------|-------------|---------------------------------------------------------------------| +| Groceries | $ 300 | This covers your monthly food and household supplies. | +| Gas | $ 100 | Allocated for fuel and transportation costs. | +| Dining Out | $ 150 | Money set aside for eating out at restaurants or cafes. | +| Clothing | $ 100 | Funds for purchasing new clothes or accessories. | +| Entertainment | $ 150 | Budget for movies, hobbies, or other leisure activities. | +| Gifts | $ 50 | Savings for birthdays, holidays, or special occasions. | +| Personal Care | $ 150 | Allocated for health and beauty products or services like haircuts. | +| Savings | $ 200 | Money set aside for future needs or emergencies. | +| **TOTAL** | **$ 1,200** | | -We now see that all € 1 200 are assigned to specific categories, ensuring that every unit of your income has a purpose. +We now see that all $ 1,200 are assigned to specific categories, ensuring that every unit of your income has a purpose. ### Week 1 budget tracking @@ -299,13 +321,13 @@ Let's track the expenses in Week 1 and calculate the available amounts for Week | Categories | Budget Week 1 | Spending Week 1 | Available for Week 2 | |-----------------|------------------------|--------------------------|-----------------------------| -| Groceries | € 300 | € 123 | € 177 | -| Gas | € 100 | € 40 | € 60 | -| Dining Out | € 150 | € 10 | € 140 | -| Clothing | € 100 | € 34 | € 66 | -| Entertainment | € 150 | € 30 | € 120 | -| Gifts | € 50 | € 45 | € 5 | -| Personal Care | € 150 | € 75 | € 75 | +| Groceries | $ 300 | $ 123 | $ 177 | +| Gas | $ 100 | $ 40 | $ 60 | +| Dining Out | $ 150 | $ 10 | $ 140 | +| Clothing | $ 100 | $ 34 | $ 66 | +| Entertainment | $ 150 | $ 30 | $ 120 | +| Gifts | $ 50 | $ 45 | $ 5 | +| Personal Care | $ 150 | $ 75 | $ 75 | In this table, the "Available in Week 2" column shows the remaining budget after subtracting the Week 1 spending from the initial budget. This helps you see how much you have left to spend in each category for @@ -314,19 +336,19 @@ the next week. ### Week 2 budget tracking In week 2 you, are invited to a housewarming party, and you want to bring a gift. In the *Available in Week 2* we -saw that you only had € 5 to spend. This does not go a long way - but you found a gift costing only € 10. +saw that you only had $ 5 to spend. This does not go a long way - but you found a gift costing only $ 10. Let's track the expenses in Week 2 and calculate the available amounts for Week 3. | Categories | Available Week 2 | Spending Week 2 | Available in Week 3 | |-----------------|---------------------------|--------------------------|-----------------------------| -| Groceries | € 177 | € 98 | € 79 | -| Gas | € 60 | € 34 | € 26 | -| Dining Out | € 140 | € 30 | € 110 | -| Clothing | € 66 | € 34 | € 32 | -| Entertainment | € 120 | € 30 | € 90 | -| Gifts | € 5 | € 10 | € -5 | -| Personal Care | € 75 | € 40 | € 35 | +| Groceries | $ 177 | $ 98 | $ 79 | +| Gas | $ 60 | $ 34 | $ 26 | +| Dining Out | $ 140 | $ 30 | $ 110 | +| Clothing | $ 66 | $ 34 | $ 32 | +| Entertainment | $ 120 | $ 30 | $ 90 | +| Gifts | $ 5 | $ 10 | $ -5 | +| Personal Care | $ 75 | $ 40 | $ 35 | Now you are in deficit in the *Gift* category. @@ -341,10 +363,10 @@ here is the new available budget in Week 3: | Categories | Available Week 2 | Spending Week 2 | Available in Week 3 | |-----------------|---------------------------|--------------------------|-----------------------------| -| Dining Out | € 135 | € 30 | € 105 | -| Gifts | € 5 | € 10 | € 0 | +| Dining Out | $ 135 | $ 30 | $ 105 | +| Gifts | $ 5 | $ 10 | $ 0 | -This updated table reflects the reallocation of € 5 from the *Dining Out* category to cover the deficit in the *Gifts* +This updated table reflects the reallocation of $ 5 from the *Dining Out* category to cover the deficit in the *Gifts* category, ensuring that all budgets remain positive in Week 3. ### Week 3 budget tracking @@ -353,17 +375,17 @@ Let's track the expenses in Week 3 and calculate the available amounts for Week | Categories | Available Week 3 | Spending Week 3 | Available in Week 4 | |-----------------|---------------------------|--------------------------|-----------------------------| -| Groceries | € 79 | € 63 | € 16 | -| Gas | € 26 | € 12 | € 14 | -| Dining Out | € 105 | € 20 | € 85 | -| Clothing | € 32 | € 0 | € 32 | -| Entertainment | € 90 | € 35 | € 55 | -| Gifts | € 0 | € 0 | € 0 | -| Personal Care | € 35 | € 38 | € -3 | +| Groceries | $ 79 | $ 63 | $ 16 | +| Gas | $ 26 | $ 12 | $ 14 | +| Dining Out | $ 105 | $ 20 | $ 85 | +| Clothing | $ 32 | $ 0 | $ 32 | +| Entertainment | $ 90 | $ 35 | $ 55 | +| Gifts | $ 0 | $ 0 | $ 0 | +| Personal Care | $ 35 | $ 38 | $ -3 | Note that Personal Care is in deficit, so you must reallocate funds from another category to cover this deficit. -Luckily, this week, we won € 37 at the lottery. We will allocate all of these € 37 wisely. The most important thing is to take +Luckily, this week, we won $ 37 at the lottery. We will allocate all of these $ 37 wisely. The most important thing is to take care of the deficit. We now exercise both the *Flexibility* and the *Total Allocation* principles. What do we do with the rest of the money we won? We can add them to the Savings category. We see that we are @@ -373,14 +395,14 @@ We decide to split the rest of the money between Groceries and Savings. | Categories | Available Week 3 | Spending Week 3 | Adjustments | Available in Week 4 | |-----------------|---------------------------|--------------------------|-------------|-----------------------------| -| Groceries | € 79 | € 63 | € +24 | € 40 | -| Gas | € 26 | € 12 | | € 14 | -| Dining Out | € 105 | € 20 | | € 85 | -| Clothing | € 32 | € 0 | | € 32 | -| Entertainment | € 90 | € 35 | | € 55 | -| Gifts | € 0 | € 0 | | € 0 | -| Personal Care | € 35 | € 38 | € +3 | € 0 | -| Savings | € 200 | € 0 | € +10 | € 210 | +| Groceries | $ 79 | $ 63 | $ +24 | $ 40 | +| Gas | $ 26 | $ 12 | | $ 14 | +| Dining Out | $ 105 | $ 20 | | $ 85 | +| Clothing | $ 32 | $ 0 | | $ 32 | +| Entertainment | $ 90 | $ 35 | | $ 55 | +| Gifts | $ 0 | $ 0 | | $ 0 | +| Personal Care | $ 35 | $ 38 | $ +3 | $ 0 | +| Savings | $ 200 | $ 0 | $ +10 | $ 210 | In this revised table, the deficit in Personal Care has been addressed, and the remaining lottery money has been allocated to Groceries and Savings to better prepare for the coming week. @@ -391,13 +413,13 @@ Let's track the expenses in Week 4 and calculate the available amounts for next | Categories | Available Week 4 | Spending Week 4 | Available in Week 5 (February) | |-----------------|---------------------------|--------------------------|-----------------------------| -| Groceries | € 40 | € 38 | € 2 | -| Gas | € 14 | € 0 | € 14 | -| Dining Out | € 85 | € 45 | € 40 | -| Clothing | € 32 | € 16 | € 16 | -| Entertainment | € 55 | € 17 | € 38 | -| Gifts | € 0 | € 0 | € 0 | -| Personal Care | € 0 | € 0 | € 0 | +| Groceries | $ 40 | $ 38 | $ 2 | +| Gas | $ 14 | $ 0 | $ 14 | +| Dining Out | $ 85 | $ 45 | $ 40 | +| Clothing | $ 32 | $ 16 | $ 16 | +| Entertainment | $ 55 | $ 17 | $ 38 | +| Gifts | $ 0 | $ 0 | $ 0 | +| Personal Care | $ 0 | $ 0 | $ 0 | ### Preparing for February: Learnings About Our Spending Habits in January @@ -406,40 +428,10 @@ Let's track the expenses in Week 4 and calculate the available amounts for next Therefore, we need to increase next month's budget for Groceries. - We used more money than was allocated for gifts, so we should increase the budget for this category next month. - We spent much less on Dining Out than we allocated, so we can reduce this budget for February. -- We will also increase the Gas budget by € 10 because if we had to fill gas in week 4, we would have faced a +- We will also increase the Gas budget by $ 10 because if we had to fill gas in week 4, we would have faced a deficit and need to cover it from other categories. The rest we put into our Savings category | Categories | Available after week 4 | February Budget | To be allocated | -|-----------------|------------------------|-----------------|-----------------| -| Groceries | € 2 | € 350 | € 348 | -| Gas | € 14 | € 110 | € 96 | -| Dining Out | € 40 | € 150 | € 110 | -| Clothing | € 16 | € 100 | € 84 | -| Entertainment | € 38 | € 150 | € 112 | -| Gifts | € 0 | € 75 | € 75 | -| Personal Care | €  0 | € 150 | € 150 | - -The sum of to be allocated is € 975. The monthly income for February is € 1200. -€ 1200 - € 975 = € 225 is added to the Savings category. This is € 25 more than last month. -A job well done of not overspending more than necessary! - - -This revised budget considers the adjustments based on our spending habits in January, -ensuring a more accurate and adequate budget for February - -| Categories | Available at the start of February | -|-----------------|------------------------| -| Groceries | € 350 | -| Gas | € 110 | -| Dining Out | € 150 | -| Clothing | € 100 | -| Entertainment | € 150 | -| Gifts | € 75 | -| Personal Care | € 150 | - - - - -[^1]: Another name for this type of budgeting is Zero-Based Budgeting. +|-----------------|---------------------- diff --git a/docs/getting-started/starting-fresh.md b/docs/getting-started/starting-fresh.md index 783ccfba2..555632619 100644 --- a/docs/getting-started/starting-fresh.md +++ b/docs/getting-started/starting-fresh.md @@ -35,7 +35,7 @@ In some situations it may make sense to put a credit card account off budget. This is generally not recommended unless you are not using that card for any spending and are exclusively paying it off. ### How to Setup Accounts -The process of adding an account is detailed in [the adding a new account page](../accounts/index.md#adding-a-new-account). +The process of adding an account is detailed in [the adding a new account page](/docs/accounts/index.md#adding-a-new-account). It is recommended to not pull in transactions from more than a month or two prior to your start date. The reason for this is that those old transactions will need to be budgeted or your budget will be out of wack. @@ -46,15 +46,15 @@ Set that amount as the balance when creating the account. If your starting date is before the current date, edit the date on the starting balance transaction to the preferred date. Once your account has the proper starting balance, add all the transactions between your start date and today. -You can enter transactions [manually](../transactions/importing.md#manually-add-transactions), via [file import](../transactions/importing.md#import-financial-files), or via bank syncing to pull in transactions. -For bank syncing, Actual has built-in support for [GoCardless](../advanced/bank-sync.md) which works for most EU/UK banks, and SimpleFIN for US/Canadian banks. -For other bank syncing options see the [community projects page](../community-repos.md). +You can enter transactions [manually](/docs/transactions/importing.md#manually-add-transactions), via [file import](/docs/transactions/importing.md#import-financial-files), or via bank syncing to pull in transactions. +For bank syncing, Actual has built-in support for [GoCardless](/docs/transactions/bank-sync/gocardless.md) which works for most EU/UK banks, and [SimpleFIN](/docs/transactions/bank-sync/simplefin.md) for US/Canadian banks. +For other bank syncing options see the [community projects page](/docs/community-repos.md). An optional step after you have created your accounts and added your transactions is to reconcile the account. Reconciling your accounts is something you should get in the habit of doing regularly. This confirms that your accounts are accurate compared to what your bank says happened in your account. If you manually add transactions this is especially important. -The process of reconciling your account can be found on [the reconciliation page](../accounts/reconciliation.md) +The process of reconciling your account can be found on [the reconciliation page](/docs/accounts/reconciliation.md) ## 2. Handling cash @@ -103,12 +103,12 @@ This not only provides more visibility and control over your spending but also e to make informed financial decisions. When using the [envelope method](/docs/getting-started/envelope-budgeting), one will move available funds between categories when needed. However, there are some categories that you should be very wary about moving funds away -from. By grouping, you'll get an extra visual indication that moving funds from the Electricity  +from. By grouping, you'll get an extra visual indication that moving funds from the Electricity category, for instance, may not be the wisest choice. Another reason is to have a more convenient way of reporting your spending habits. -1. **Crucial or really important**. As the name suggests, these expenses are +1. **Crucial or really important**. As the name suggests, these expenses are difficult or impossible to reduce or remove from your daily life. Most of these are reoccurring bills, either monthly, quarterly or yearly. Many of the categories in this group have fixed amounts, or the amount does not fluctuate too much over the course of a year. Example of spending categories @@ -119,26 +119,26 @@ Stopping paying insurance is dumb. It is near impossible to live without electri 2. **Debt**. Create a separate category group if you have more than one kind of debt. Typical categories in this group are Mortgage, Car Payments, Student Loans, Short Term Credit. Should you put your credit card debts in this category? -The answer is *it depends*. For some input on this, please read our article on  +The answer is *it depends*. For some input on this, please read our article on [Carrying Debt](/docs/budgeting/credit-cards/carrying-debt). -3. **Daily expenses**. Group your everyday expenses for a more organized and convenient way -of tracking. This makes it easy to report on expenditures that fluctuate from month to month. -Examples of spending categories in this group are Groceries, Household Items, Fuel, Eating Out, Clothing, +3. **Daily expenses**. Group your everyday expenses for a more organized and convenient way +of tracking. This makes it easy to report on expenditures that fluctuate from month to month. +Examples of spending categories in this group are Groceries, Household Items, Fuel, Eating Out, Clothing, Personal Care, Gifts, Entertainment, Streaming services, News (paper) subscriptions, and Charities. 4. **For a rainy day**. Certain expenses you know will happen in the future, but you don't know when. -You should have at least one category named *Emergency Fund*. Other examples may be Car Maintenance, +You should have at least one category named *Emergency Fund*. Other examples may be Car Maintenance, Replacing Stove, and Replacing Washing Machine. -5. **Savings goals**. This is where you keep your savings goals categorized *on budget*. What we -mean by on budget is that if you need to reallocate money, you may settle for a cheaper Vacation or -postpone the Car Replacement or the Bathroom Renovation for a few months. If you are saving for a -long view, like your retirement, we suggest you create an *off budget* account for those kind of -savings. Money allocated in off budget accounts takes more effort to reallocate as you need to -move the actual funds from your savings account or sell your stocks or global +5. **Savings goals**. This is where you keep your savings goals categorized *on budget*. What we +mean by on budget is that if you need to reallocate money, you may settle for a cheaper Vacation or +postpone the Car Replacement or the Bathroom Renovation for a few months. If you are saving for a +long view, like your retirement, we suggest you create an *off budget* account for those kind of +savings. Money allocated in off budget accounts takes more effort to reallocate as you need to +move the actual funds from your savings account or sell your stocks or global index funds (a few examples of long term saving methods). @@ -150,14 +150,14 @@ Of course, your own experiences and approach to saving for a rainy day or longer ### How to Setup Categories -The process for adding and working with categories is found in [the category guide](../budgeting/categories.md#add-a-category). +The process for adding and working with categories is found in [the category guide](/docs/budgeting/categories.md#add-a-category). When making categories remember that it is easier to merge categories later than it is to manually move transactions to a new category. ## 4. Assigning Available Funds The big question everybody struggles with when using the envelope budgeting method for the first -time is *how much money to assign to each category*. Fear not; this part of our Starting Fresh +time is *how much money to assign to each category*. Fear not; this part of our Starting Fresh guide will help you with this. The best way of bootstrapping your budget is to rely on how you have spent your money and what @@ -173,15 +173,15 @@ For bills, your bank or credit card statements are good sources to establish you ### Use a spreadsheet to find your initial budget numbers -You enter all your expenses in a spreadsheet, summarize them per month, and then calculate the average. -Now, you know what you need to budget per -month. Having the budgeted numbers somewhat higher than the calculated average might be a good idea. +You enter all your expenses in a spreadsheet, summarize them per month, and then calculate the average. +Now, you know what you need to budget per +month. Having the budgeted numbers somewhat higher than the calculated average might be a good idea. This way, you add small buffers in each category as prices rise; the same goes for your rent and mortgage. Adding some extra, albeit small, paddings along the way means you are better suited when this happens. The only certainty we have in this day and age is that price increases will occur. -![](/img/getting-started/spreadsheet.png) +![Image of a spreadsheet](/img/getting-started/spreadsheet.png) We can now see the budget numbers to be used for the month of August in the Average column @@ -190,7 +190,7 @@ We can now see the budget numbers to be used for the month of August in the Aver It's important to note that this method only works correctly if you use a debit or credit card for all your purchases. -As a result, your actual *start date* for your budget is in the past. We will reiterate our warning on +As a result, your actual *start date* for your budget is in the past. We will reiterate our warning on [how to set up accounts](#how-to-setup-accounts): going too far back might make your budget completely out of wack. It's crucial to avoid this, as you can easily spend more time trying to find out what's wrong with your budget and spent numbers because "nothing adds up" anymore. @@ -204,7 +204,7 @@ If you have a lot of cash withdrawals during a month, you will be better off usi 1. You start the budget by entering or importing your transactions. -2. In the Budget view, you enter the same amount in the *Budgeted* columns as found in the *Spent* columns +2. In the Budget view, you enter the same amount in the *Budgeted* columns as found in the *Spent* columns for all the months you have entered or imported your data. @@ -232,7 +232,7 @@ You can start using Actual without actually assigning your available funds befor budgeting. -1. Record every transaction you make daily. If you do it weekly, the chances are that you will have +1. Record every transaction you make daily. If you do it weekly, the chances are that you will have forgotten some cash transactions. One way to avoid forgetting transactions is, of course, to keep all receipts. @@ -241,12 +241,12 @@ budgeting. over a month. If you repeatedly make cash withdrawals and do not know what you are spending your money on, then no expense and budget tracking tools in the world will be able to help you. -3. At the end of each week, set the *Budgeted* column in the Budget view to the same value - as what you see in the *Spent* column. If done correctly, the sum under *To Budget* should +3. At the end of each week, set the *Budgeted* column in the Budget view to the same value + as what you see in the *Spent* column. If done correctly, the sum under *To Budget* should correctly tell you how much money you have left. -4. Set aside time to analyze your spending and income at the end of the month. Based on this, - you can add values to the upcoming months' Budgeted column. +4. Set aside time to analyze your spending and income at the end of the month. Based on this, + you can add values to the upcoming months' Budgeted column. Remember, this process is challenging, and it's okay if you don't get everything right @@ -286,9 +286,9 @@ This topic is so important on how to actually use Actual, that we have devoted a ## The next step in your budgeting journey -A good next step is to read through the "Using Actual" section of the documentation. This section has detailed explanations on the -features of Actual and how to use them. Some of the most useful features are [Rules](/docs/budgeting/rules/index.md), -[Schedules](/docs/schedules.md), [Reconciliation](/docs/accounts/reconciliation.md), +A good next step is to read through the "Using Actual" section of the documentation. This section has detailed explanations on the +features of Actual and how to use them. Some of the most useful features are [Rules](/docs/budgeting/rules/index.md), +[Schedules](/docs/schedules.md), [Reconciliation](/docs/accounts/reconciliation.md), and [Reports](/docs/reports/index.md). diff --git a/docs/tour/accounts.md b/docs/tour/accounts.md index 7723c2423..333c75c5c 100644 --- a/docs/tour/accounts.md +++ b/docs/tour/accounts.md @@ -22,7 +22,7 @@ It is possible to split a transaction into more than one category. By clicking o you will be able to show or hide split transactions. The three horizontal dots, shown in the blue box, will allow you to perform various manipulations on the account. These range from -reconciling and exporting your account to closing and linking your account for [automatic bank transactions](/docs/advanced/bank-sync). +reconciling and exporting your account to closing and linking your account for [automatic bank transactions](/docs/transactions/bank-sync). This is also where you can show the account's running balance (as seen in the first screenshot on this page). You can also hide/show both reconciled transactions as well as the cleared checkbox column to the far right of the transaction's row. diff --git a/docs/advanced/bank-sync/gocardless.md b/docs/transactions/bank-sync/gocardless.md similarity index 84% rename from docs/advanced/bank-sync/gocardless.md rename to docs/transactions/bank-sync/gocardless.md index 499afba09..6af6307ee 100644 --- a/docs/advanced/bank-sync/gocardless.md +++ b/docs/transactions/bank-sync/gocardless.md @@ -5,7 +5,7 @@ Client Version 23.7.0 and Server Version 23.7.0 or higher are required for this feature. ::: -### Create SECRET and KEY for Actual +## Create SECRET and KEY for Actual 1. Create an account with GoCardless - https://bankaccountdata.gocardless.com/overview/. 2. Log into your account dashboard at the same URL and select **Developers->User secrets** from the left side menu. @@ -47,7 +47,7 @@ Server Version 23.7.0 or higher are required for this feature. ![Set-up GoCardless dialoag](/static/img/connecting-your-bank/connecting-your-bank-gocardless-06.png) -### Link Accounts with GoCardless +## Link Accounts with GoCardless 1. Add the link to your accounts in actual (Existing or New). @@ -91,21 +91,7 @@ Server Version 23.7.0 or higher are required for this feature. ![Dialog for linking accounts you want to sync](/static/img/connecting-your-bank/connecting-your-bank-10.png) -### Frequently Asked Questions - -**Does Actual sync automatically with your Bank?** - -At this moment, it is not yet possible for Actual to automatically sync with your bank. You need to do this manually by going to "All Accounts" and pressing "Sync". - -![Image showing where in the GUI you can sync your bank accounts](/static/img/connecting-your-bank/syncing-with-your-bank.png) - -**The best way to start from scratch in Actual with GoCardless?** - -If you are setting up Actual for the first time, it is much easier not to try to pull in historic data. This has caused some users a lot of headaches with subsequent reconciliation. The following process may be more helpful: -1. Set up your account in Actual specifying a correct opening account balance at a recent date. -2. Link the account to GoCardless as above -3. Sync the account with GoCardless. You should find that only transactions subsequent to the opening account balance entry are imported, making reconciliation easy. - +## Frequently Asked Questions **How many times can I sync with GoCardless?** In the free tier, you can sync 50 times per month. If you sync to two different banks (with three accounts in each bank), that is counted as two connections. diff --git a/docs/transactions/bank-sync/index.md b/docs/transactions/bank-sync/index.md new file mode 100644 index 000000000..c08f299ba --- /dev/null +++ b/docs/transactions/bank-sync/index.md @@ -0,0 +1,38 @@ +# Connecting Your Bank + +We are excited to offer optional bank integration in Actual. + +## Considerations +Here are a couple of considerations to know about before making the decision to use bank sync in your installation of Actual Budget. + +- This integration relies on you providing your own API credentials that you will need to get by signing up with the service provider and Generate Keys and Secrets that will be used in Actual. + +- The integration only works if you are using actual-server. + +- The Secrets and Keys are stored in your Actual installed version so it is highly recommended to turn on End to End encryption and create a strong passphrase to encrypt your files. + +- You will need to add a config file to your installation. + + +## Supported Providers + +* [GoCardless (European Banks)](/docs/transactions/bank-sync/gocardless) +* [SimpleFIN Bridge (North American Banks)](/docs/transactions/bank-sync/simplefin) + + +## Does Actual Sync Automatically With Your Bank? + +At this moment, it is not yet possible for Actual to automatically sync with your bank. You need to do this manually by going to _All Accounts_ and pressing _Bank Sync_. + +![Image showing where in the GUI you can sync your bank accounts](/static/img/connecting-your-bank/syncing-with-your-bank.png) + + +## A Small Tips on Starting From Scratch With Bank Sync in Actual + +If you are setting up Actual for the first time, it is much easier not to try to pull in historical data. This has caused some users a lot of headaches with subsequent reconciliation. + +The following process may be more helpful: + +1. Set up your account in Actual specifying a correct opening account balance at a recent date. +2. Link the account one of the supported providers (GoCardLess or SimpleFIN). +3. Sync the account with the chosen provider. You should find that only transactions subsequent to the opening account balance entry are imported, making reconciliation easy. diff --git a/docs/advanced/bank-sync/simplefin.md b/docs/transactions/bank-sync/simplefin.md similarity index 96% rename from docs/advanced/bank-sync/simplefin.md rename to docs/transactions/bank-sync/simplefin.md index 605dc8fdc..d9dc5e1e5 100644 --- a/docs/advanced/bank-sync/simplefin.md +++ b/docs/transactions/bank-sync/simplefin.md @@ -5,7 +5,7 @@ Client Version 24.10.0 and Server Version 24.10.0 or higher are required for this feature. ::: -### Generate Setup Token for Actual +## Generate Setup Token for Actual 1. Create an account with SimpleFIN Bridge - https://beta-bridge.simplefin.org/ , by clicking "Get Started" and entering your email address. @@ -45,7 +45,7 @@ Server Version 24.10.0 or higher are required for this feature. ![](/static/img/connecting-your-bank/connecting-your-bank-simplefin-06.png) -### Link Accounts with SimpleFIN +## Link Accounts with SimpleFIN 1. Add the link to your accounts in actual (Existing or New). @@ -74,7 +74,7 @@ Server Version 24.10.0 or higher are required for this feature. 5. When you've mapped all your accounts that you wish to, click the "Link Account" button. -### Retrieve Transactions +## Retrieve Transactions Actual does not automatically perform syncs. You will need to manually request a sync to pull new transactions from SimpleFIN. @@ -83,13 +83,13 @@ If you wish to only sync one account, view the desired account and click the syn ![](/static/img/connecting-your-bank/connecting-your-bank-simplefin-10.png) -### SimpleFIN Considerations +## SimpleFIN Considerations 1. Currently, the sync pulls at most 90 days of data from each linked account. The amount of data SimpleFIN can get from each account may vary, so not all accounts may have 90 days of historical transactions that can be imported. 2. SimpleFIN's data updates one time / day, roughly every 24 hours, for each linked account. The time of day that each bank updates in SimpleFIN may vary, even from day to day (based on the bank and upstream provider, MX). -### Resetting the Setup Token +## Resetting the Setup Token To reset your SimpleFIN setup token: diff --git a/src/pages/index.js b/src/pages/index.js index af898c16f..71cc125b6 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -176,7 +176,7 @@ export default function Hello() { Actual has built in support for bank syncing using goCardless (EU/UK) and SimpleFIN (US/Canada). diff --git a/static/img/connecting-your-bank/syncing-with-your-bank.png b/static/img/connecting-your-bank/syncing-with-your-bank.png index a650039c6..abfb5b2ed 100644 Binary files a/static/img/connecting-your-bank/syncing-with-your-bank.png and b/static/img/connecting-your-bank/syncing-with-your-bank.png differ