Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use consistent terms regarding on-budget and off-budget accounts #504

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/accounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

You can add as many accounts as you like. Adding all of your accounts (including things like mortgages) is a nice way to get an overview of all your finances.

## Off-budget accounts
## Off budget accounts

Actual makes a distinction between accounts being **for** budget or **off** budget. Off budget accounts don't affect the budget and are meant to track stuff like investments and mortgages. Transactions in off budget accounts can't be categorized; they simply track balances over time.
Actual makes a distinction between accounts being **on** budget or **off** budget. Off budget accounts don't affect the budget and are meant to track stuff like investments and mortgages. Transactions in off budget accounts can't be categorized; they simply track balances over time.

**For budget** accounts affect the budget, and transactions can be categorized. These are accounts where you want to track cash flow and use the budget, like checking accounts and credit cards.
**Off budget** accounts don't effect the budget and are meant to track stuff like investments and mortgages. Transactions in off budget accounts can't be categorized; they simply track balances over time.

Depending on your usage, savings accounts can either be on or off the budget. If you're not sure, we recommend keeping it on budget at the start.
**On budget** accounts affect the budget, and transactions can be categorized. These are accounts where you want to track cash flow and use the budget, like checking accounts and credit cards.

Depending on your usage, savings accounts can be on or off the budget. If you're not sure, we recommend keeping them on budget at the start.

## Adding a new account

Expand All @@ -21,7 +23,7 @@ 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))
- Give your account a name
- Is the account on or off budget
- Is the account on budget or off budget
- The current account balance

:::note
Expand All @@ -35,7 +37,7 @@ Off budget means that the balance is not reflected when you assign money to cate
Here you can see how that looks when the options are completed.

:::note
If you select the Off Budget checkbox then change the account type the Off Budget checkbox will reset and will need to be re-selected each time the account type is changed
If you select the Off budget checkbox then change the account type the Off budget checkbox will reset and will need to be re-selected each time the account type is changed
:::

![](/img/add-account/NewBudget.png)
Expand Down
4 changes: 2 additions & 2 deletions docs/accounts/reconciliation.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Of course, there's always the possibility you need to change a locked transactio

![](/img/reconcile/reconcile-10.png)

## Using the Reconciliation Tool for Off-Budget Asset Tracking
## Using the Reconciliation Tool for Off Budget Asset Tracking

Some people use off-budget accounts to track values of assets such as vehicles, real estate, retirement accounts, or other investment accounts or property. The reconciliation tool is useful to update these values as well. Let's say we have a house that was valued at 358,700 but with current changes in the market it is now valued at 385,000. We go to the ledger for the house, choose the reconciliation tool, and enter 385,000 as the new value into the tool.
Some people use off budget accounts to track values of assets such as vehicles, real estate, retirement accounts, or other investment accounts or property. The reconciliation tool is useful to update these values as well. Let's say we have a house that was valued at 358,700 but with current changes in the market it is now valued at 385,000. We go to the ledger for the house, choose the reconciliation tool, and enter 385,000 as the new value into the tool.

![](/img/reconcile/reconcile-5.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/api/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ The account type does not effect anything currently. It's simply extra informati

Avoid setting the `closed` property directly to close an account; instead use the `closeAccount` method. If the account still has money in it you will be required to specify another account to transfer the current balance to. This will help track your money correctly.

If you want to fully delete an account and remove it entirely from the system, use [`deleteAccount`](#deleteaccount). Note that if it's an on-budget account, any money coming from that account will disappear.
If you want to fully delete an account and remove it entirely from the system, use [`deleteAccount`](#deleteaccount). Note that if it's an on budget account, any money coming from that account will disappear.

#### Methods

Expand Down Expand Up @@ -299,9 +299,9 @@ Update fields of an account. `fields` can specify any field described in [`Accou

Close an account. `transferAccountId` and `transferCategoryId` are optional if the balance of the account is 0, otherwise see next paragraph.

If the account has a non-zero balance, you need to specify an account with `transferAccountId` to transfer the money into. If you are transferring from an on-budget account to an off-budget account, you can optionally specify a category with `transferCategoryId` to categorize the transfer transaction.
If the account has a non-zero balance, you need to specify an account with `transferAccountId` to transfer the money into. If you are transferring from an on budget account to an off budget account, you can optionally specify a category with `transferCategoryId` to categorize the transfer transaction.

Transferring money to an off-budget account needs a category because money is taken out of the budget, so it needs to come from somewhere.
Transferring money to an off budget account needs a category because money is taken out of the budget, so it needs to come from somewhere.

If you want to simply delete an account, see [`deleteAccount`](#deleteaccount).

Expand Down
4 changes: 2 additions & 2 deletions docs/budgeting/joint-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Situation: I am using Actual to keep track of my budget and finances, but I shar

### Basic setup steps

1. Create an **on-budget** account used to pay joint bills.
1. Create an **on budget** account used to pay joint bills.
2. Create a **category group** used to group your shared expense categories.
3. Create the **categories** you plan to budget using your joint account.
4. **Optional:** Create an **Income Category** called **Partner Contribution** or something similar. This will be explained further below.
Expand All @@ -127,7 +127,7 @@ Situation: I am using Actual to keep track of my budget and finances, but I shar

#### Your contribution

Each month you will add a transfer of your share to the joint account from one of your on-budget accounts. You don't need a category for your contribution since it is just a transfer from one of your accounts to another.
Each month you will add a transfer of your share to the joint account from one of your on budget accounts. You don't need a category for your contribution since it is just a transfer from one of your accounts to another.

![Screenshot of joint accounts in a personal Actual Budget file](/img/joint-accounts/jointaccount-2.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/budgeting/returns-and-reimbursements.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Now when I check my budget, I have 32 dollars available to spend on clothing for

## Reimbursements

Handling reimbursements can be confusing. There are several ways to handle them in your budget and you may use each way at different times depending on the circumstances. When it comes to reimbursements, it is assumed you will be covering some purchases that you would not normally make in your normal monthly budget. Having a special category in your budget that captures these purchases is not uncommon. There are two fundamental ways to manage reimbursements. The first is by carrying debt and the second is to pre-fund the category. Ideally, carrying debt is a last resort. But if the reimbursable expense is large compared to your current on-budget account balances, there may be no other reasonable way.
Handling reimbursements can be confusing. There are several ways to handle them in your budget and you may use each way at different times depending on the circumstances. When it comes to reimbursements, it is assumed you will be covering some purchases that you would not normally make in your normal monthly budget. Having a special category in your budget that captures these purchases is not uncommon. There are two fundamental ways to manage reimbursements. The first is by carrying debt and the second is to pre-fund the category. Ideally, carrying debt is a last resort. But if the reimbursable expense is large compared to your current on budget account balances, there may be no other reasonable way.

In this scenario, all of your reimbursable expenses would go to a credit card. Credit cards have negative balances in the account view until they are paid in full, because after all, they are a debt product. You will also want a category that is meant for these reimbursable expenses. Maybe a **Business** category or **Shared Expenses** category will fill that role. Whatever category name you choose, you need to make a decision. Will you be pre-funding this category and allowing it to draw down towards 0 until you're reimbursed or will you let the category be overdrawn and carry a negative balance and then refill the category when you are reimbursed.

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/starting-fresh.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ This includes all savings, checking, and investment accounts.
These accounts should match what shows up in your Bank or Credit Union.
For example, if you have a savings, checking, and credit card account with Bank of America, add each as a separate account in Actual.

### On or Off Budget
### On Budget or Off Budget

In Actual, you have the option of on budget accounts and off budget accounts.
On budget accounts are included towards the funds available in your budget, while off budget accounts are only for tracking.
Off budget accounts are included in the net worth report.
It is usually best to err towards putting accounts on budget versus off.
It is usually best to err towards putting accounts on budget versus off budget.
The most common off budget accounts would be investment type accounts such as a 401(k), IRA, HSA, brokerage account, loans, and asset tracking such as your home equity.

Savings accounts can be either on or off budget.
Savings accounts can be either on budget or off budget.
It is usually easier, and more flexible, to place them on budget.

#### Considerations for On Budget Savings
Expand Down
14 changes: 7 additions & 7 deletions docs/reports/custom-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Custom reports allow analyzing transaction data by using charts or a data table
## Left Menu

The **Type** menu can be used to change the display of transactions shown in the report:
1. Payment: outflows from For budget accounts
2. Deposit: inflows in For budget accounts
3. Net: sum of outflows and inflows across For budget accounts. Net results are the figures shown in Budget page under Spent and Received columns. This option is currently available in Data Table, Area Graph and partially available in Bar Graph and Donut Graph
1. Payment: outflows from on budget accounts
2. Deposit: inflows to on budget accounts
3. Net: sum of outflows and inflows across on budget accounts. Net results are the figures shown in Budget page under Spent and Received columns. This option is currently available in Data Table, Area Graph and partially available in Bar Graph and Donut Graph

This sum can be **Split** by Category, Group, Payee, Account or Month.
Note that Split by Account shows sum of transactions from For budget account, not periodic balance.
Note that Split by Account shows sum of transactions from on budget account, not periodic balance.
Monthly breakdowns are provided by changing Mode from Total to Time.

![Custom report left side with display and date filters](/img/reports/cr-left-menu.png)
Expand All @@ -31,9 +31,9 @@ Under Options, reports behavior can be changed

* `Show hidden categories` will enable Categories marked as hidden in the Budget page.
* `Show empty rows` will show items chosen in Split with 0 value.
* `Show Off budget` enables two categories:
* Transfers: include all transfers across For budget account. Transfers from For budget to Off budget are not counted.
* Off budget: include all transactions in Off budget accounts. Transfers from For budget to Off budget are not counted.
* `Show off budget` enables two categories:
* Transfers: include all transfers across on budget account. Transfers from on budget to off budget are not counted.
* Off budget: include all transactions in off budget accounts. Transfers from on budget to off budget are not counted.
* `Show uncategorized` will show transactions which have not been assigned a category.

Single Categories or entire Groups can be excluded from the Report by using the list on the bottom left side.
Expand Down
2 changes: 1 addition & 1 deletion docs/tour/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ All reports in this view are shown in their small, tiled, version. Clicking on a
from the total value of your cash and assets. This includes all investments. Essentially, your net worth is the amount
you would have if you sold all your assets and paid off all your debts.

**Cash flow** tracks your spending over time by focusing solely on budgeted accounts and displaying their balances.
**Cash flow** tracks your spending over time by focusing solely on budget accounts and displaying their balances.
It includes separate visualizations for income and expenses, providing a quick overview of how these factors affect
your available money over time. By considering your budgeted accounts as “cash on hand,” cash flow clearly shows how your available funds fluctuate.

Expand Down
2 changes: 1 addition & 1 deletion docs/tour/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ The sidebar in Actual holds all of the links to navigate around the application,

### Account List

The sidebar also holds all of your accounts both on and off budget, these will display in a list under the heading they belong E.G On Budget. You can find out how to add an account [here](../accounts/index.md#adding-a-new-account)
The sidebar also holds all of your accounts both On budget and Off budget, these will display in a list under the heading they belong e.g. On budget. You can find out how to add an account [here](../accounts/index.md#adding-a-new-account)

![](/img/using-actual/budget-sidebar-accounts.png)
2 changes: 1 addition & 1 deletion docs/tour/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ From the sidebar, you have easy access to all Actual's functionality.

* Access to your Budget, Reports and Schedules.
* Less used functions are found under _More_, like managing Payees and Rules; this is where you find the software settings.
* The sidebar also holds all of your accounts, both on and off-budget; these will display in a list under the heading to which they belong, e.g., On Budget.
* The sidebar also holds all of your accounts, both on budget and off budget; these will display in a list under the heading to which they belong e.g. On budget.

Most of these will we cover later in the tour.

Expand Down
Binary file modified static/img/add-account/AccountNameEdit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/add-account/AddAccount.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/add-account/CreateAccount1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/add-account/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/add-account/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading