[Experimental] Report budget docs (#121)

I'm not a user of this feature, but I thought I could get the ball
rolling on adding some documentation. I'm not 100% sure this is how this
budget type is used, so there are likely wrong assumptions. I'm hopeful
someone will either correct me or take the reigns. There have been
several users looking for the features of this budget type, so I think
it deserves a little time to explain how it's intended to be used.
This commit is contained in:
shall0pass
2023-03-13 20:40:47 -05:00
committed by GitHub
parent 4985cbff96
commit b5ae4c5938
9 changed files with 74 additions and 1 deletions

View File

@@ -0,0 +1,72 @@
---
title: 'Report Budget'
---
:::warning
This is an **experimental feature**. That means were still working on finishing it. There may be bugs, missing functionality or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in the Discord.
:::
## Enabling the Report Budget
The **Report Budget** feature can be switched on from the Experimental features section within the Settings page. Navigate back to the **Budget** screen and a new button labeled **Rollover Budget** will be visible at the top of the screen. Select the button and use the option to **Switch to a Report Budget**.
![](/img/report-budget-7.png)
## Creating a budget
There are several important differences between the **Report Budget** and the default **Rollover Budget** type.
- Category balances do not rollover from month to month
- "To Be Budgeted" has been replaced with a "Saved" metric
- Income is forecasted rather than using what is available
![](/img/report-budget-1.png)
If you are creating a budget for the first time, here's how it works:
1. Assign the amount of income you expect to receive in the current month.
2. Assign the amount of money you need for each of your categories.
Once completing these two tasks for the month, you will see the budgeted totals in the monthly header in gray. The expected savings you will incur for the month will show up in the **Projected Savings** field for the current or future month. When you receive new income or spend from your categories, enter those transactions in the account registers. Your budget is not static, so there will be times when you do not have enough budgeted for your spending. When one of your categories is overdrawn, increase the budgeted amount for that category so it is 0 or greater.
## The monthly summary explained
As you can see in the following example, your total budgeted items show in the right hand side of the summary for both your **Income** and **Expenses** and your actual expenses and income are totaled in the left hand side of the summary. The **Projected Savings** field is calculated from your budgeted income minus budgeted expenses, so expect the **Projected Savings** to decrease when covering overspending.
![](/img/report-budget-2.png)
There are useful pie charts next to **Income** and **Expenses** to track your progress visually.
![](/img/report-budget-5.png)
- An incomplete green pie means your total expenses or income are less than your total amount budgeted for expenses or income, respectively.
![](/img/report-budget-4.png)
- A complete green pie chart means your spending and budget are exactly the same.
![](/img/report-budget-6.png)
- A pie chart that has turned red means you have overspent your total budget.
When a new month begins, your **Projected Savings** changes to **Saved** or **Overspent**, depending on your final transactions. The final savings amount calculated for this field is your actual income minus your actual expenses. If you hover your mouse over the **Saved** or **Overspent** text, you can view the breakdown of projected and actual savings for the month.
![](/img/report-budget-3.png)
## How money rolls over
Money does not automatically carry over from month to month in the **Report Budget**. If you have overspending in any category, you may wish to carry this balance forward into the next month. This can be done by clicking on the **Balance** of the category and select **Rollover Overspending**.
:::note
If you utilize the **Rollover Overspending** feature on a category that is not over spent, the entire spent amount will be forwarded to the next month and the **Saved** amount will increase for the current month.
:::
## Working with the Budget
Some of the features of the **Rollover Budget** are available in the **Report Budget**.
:::note
Not all features of the **Rollover Budget** have been implemented in the **Report Budget**. If you find critical functionality missing that you need, please submit a request on [GitHub](/Contact).
:::
- [Create new budgets for the next month](/Budgeting/howitworks#creating-a-budget)
- [Rollover negative category balances](/Budgeting/howitworks#rollover-negative-category-balances)

View File

@@ -270,7 +270,8 @@ const sidebars = {
collapsed: true,
items: [
'Advanced/Experimental-Features/goal-templates',
unavailable('Report Budget'),
'Advanced/Experimental-Features/report-budget',
//unavailable('Report Budget'),
unavailable('Account syncing'),
],
},

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 593 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 627 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 612 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB