From 2a872761f4196589c68c59ec0fdaabe08f9276ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ruben=20Olsen=20L=C3=A6rk?= Date: Mon, 6 Jan 2025 18:43:23 +0100 Subject: [PATCH] #490 Improve bank sync instructions - Moved relevant information from gocardless.md to bank-syn.md and rewrote this to be general. - Fixed header level from 3 to 2 in gocardless.md and simplefin.md. --- docs/advanced/bank-sync.md | 25 +++++++++++++++++++++++-- docs/advanced/bank-sync/gocardless.md | 20 +++----------------- docs/advanced/bank-sync/simplefin.md | 10 +++++----- 3 files changed, 31 insertions(+), 24 deletions(-) diff --git a/docs/advanced/bank-sync.md b/docs/advanced/bank-sync.md index 237467ec8..caef0559e 100644 --- a/docs/advanced/bank-sync.md +++ b/docs/advanced/bank-sync.md @@ -1,6 +1,8 @@ # 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. @@ -11,7 +13,26 @@ Here are a couple of considerations to know about before making the decision to - You will need to add a config file to your installation. + ## Supported Providers -* GoCardless (European Banks) -* SimpleFIN Bridge (North American Banks) +* [GoCardless (European Banks)](/docs/bank-sync/gocardless) +* [SimpleFIN Bridge (North American Banks)](/docs/bank-syc/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) + + +## 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. + +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/gocardless.md b/docs/advanced/bank-sync/gocardless.md index 499afba09..6af6307ee 100644 --- a/docs/advanced/bank-sync/gocardless.md +++ b/docs/advanced/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/advanced/bank-sync/simplefin.md b/docs/advanced/bank-sync/simplefin.md index 605dc8fdc..d9dc5e1e5 100644 --- a/docs/advanced/bank-sync/simplefin.md +++ b/docs/advanced/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: