A local-first personal finance app
[WIP] GoCardless clarification on number of requests on the free tier + alt-text of images + fix a step number (#426)
Ruben Olsen Lærk7d0cc155b105
diff --git a/docs/advanced/bank-sync.md b/docs/advanced/bank-sync.mdindex f0247be034..4016424312 100644--- a/docs/advanced/bank-sync.md+++ b/docs/advanced/bank-sync.md@@ -5,7 +5,8 @@ Client Version 23.7.0 andServer Version 23.7.0 or higher are required for this feature.:::-We are excited to offer this 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.+We are excited to offer this 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.@@ -15,45 +16,53 @@ We are excited to offer this optional bank integration in Actual. Here are a cou- You will need to add a config file to your installation-### Supported Providers+## Supported Providers-GoCardless+* GoCardless-### GoCardless Setup+## GoCardless Setup-**Create SECRET and KEY for Actual**+### Create SECRET and KEY for Actual1. 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-++3. Click on the '+ create new' button at the bottom left.- Make sure you download your secrets file since the **key** will not be available to you again in the account dashboard- These secrets will be used in Actual to make the bank sync connection-++4. Enter a name for your secrets and click Create._This is only for you to easily identify them in the GoCardless User secrets overview_-++5. Download this file and keep it on your computer.-+++6. Back in Actual, click on “+ Add account” at the bottom of the sidebar.- +++7. Click “Set-up GoCardless for bank-sync.”- +8. You will be asked to enter your GoCardless secret ID and secret key. These values will be saved on the server, so you will only need to enter them once.- ++### Link Accounts with GoCardless@@ -61,43 +70,43 @@ GoCardless- **_For an existing account, click on that account, select the ... (kebab menu) in the top right, and choose Link Account_**- +- **_To create a new account with bank syncing click on the '+ Add account' link in the left menu at the bottom_**- +2. Select the Link your bank account button-+3. Select your country and bank from the list and click the Link bank in browser button-+4. Clicking Link bank in browser will redirect you to a new tab to grant access to your bank for GoCardless-+5. Select **I agree** to continue with setting up the connection-+6. If your connection was a success, you will be able to click on the continue button which allows GoCardless to connect-+7. A progress indicator will display while GoCardless connects to your bank to get a list of your accounts-+8. Once the connection has been made, there will be a list of your accounts that you can choose from-+-7. The final step is to select the account you want to sync and click Link account+9. The final step is to select the account you want to sync and click Link account-+### Frequently Asked Questions@@ -105,11 +114,18 @@ GoCardlessAt 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".-+-**The best way to start from scratch in Actual with Go Cardless?**+**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 Go Cardless as above-3. Sync the account with Go Cardless. You should find that only transactions subsequent to the opening account balance entry are imported, making reconciliation easy.+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.+++**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.+For more information, see the [Bank Account Data API Usage](https://bankaccountdata.zendesk.com/hc/en-gb/articles/11528933493916-Bank-Account-Data-API-Usage-how-is-your-usage-number-calculated)+topic in the GoCardless FAQ.+