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

Fixing #490 Improve bank sync instructions #603

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 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
6 changes: 3 additions & 3 deletions docs-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion docs/accounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 0 additions & 17 deletions docs/advanced/bank-sync.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
220 changes: 106 additions & 114 deletions docs/getting-started/envelope-budgeting.md

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions docs/getting-started/starting-fresh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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).


Expand All @@ -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
Expand All @@ -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

Expand All @@ -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.
Expand All @@ -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.


Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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).


Expand Down
2 changes: 1 addition & 1 deletion docs/tour/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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.
Expand Down
38 changes: 38 additions & 0 deletions docs/transactions/bank-sync/index.md
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems not quite right. The keys are stored in the server so it shouldn't matter that much if encryption is enabled or not.


- You will need to add a config file to your installation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't true. You don't need one for simplefin at least.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nor GoCardless



## 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 "Sync".

![Image showing where in the GUI you can sync your bank accounts](/static/img/connecting-your-bank/syncing-with-your-bank.png)
RubenOlsen marked this conversation as resolved.
Show resolved Hide resolved


## 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 historic data. This has caused some users a lot of headaches with subsequent reconciliation.
RubenOlsen marked this conversation as resolved.
Show resolved Hide resolved

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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably add how to do the link process via the account menu.

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.
Loading
Loading