Skip to content

A local-first personal finance app

auto hold (#699)

youngcw59e51412d696
diff --git a/docs/budgeting/index.md b/docs/budgeting/index.md
index af178d93b8..78cd38c41c 100644
--- a/docs/budgeting/index.md
+++ b/docs/budgeting/index.md
@@ -45,7 +45,7 @@ Most likely, a common workflow will be to "hold" income you make this month for
1. Click the **To Budget** amount.
2. Select **Hold for next month** in the menu.
-![](/img/how-it-works/buffer-1.png)
+![hold funds](/img/how-it-works/buffer-1.png)
3. Press <Key k="enter" /> to hold all available money, or enter a custom amount to hold.
@@ -60,6 +60,9 @@ It is possible to hold money multiple months ahead. If you do this, those dollar
:::note
If you enter a new month and have a negative "To Be Budgeted" amount and you're sure it should be positive, try resetting next month's buffer to bring money that may be held back to the current month.
:::
+:::note
+If you hold funds regularly, you can [automatically hold funds from specific income categories](./#automatic-holding-of-funds).
+:::
### Overspending
@@ -100,3 +103,23 @@ Sometimes you want to keep a negative balance in a category across months. The m
1. Click an amount in the **Balance** column for a category.
2. Select **Rollover overspending**
3. For all future months, a negative balance will stay in the category
+
+### Automatic Holding of Funds
+
+Sometimes, you want to be consistently holding funds for future months.
+For example, if you use the "Month Ahead" strategy and reserve all income from the current month for the next month, keeping the held funds up to date and accurate can be a lot of work.
+You can automate holding funds from specific income categories for future months by clicking the income total and enabling the auto hold for that category.
+
+![Auto hold funds menu](/img/how-it-works/auto-hold.png)
+
+When the *auto hold* function has been enabled for an income category, this will be indicated by an arrow.
+The income category will be set for automatic holding starting from the current month and the following 12 months.
+If wanted, the *auto hold* functionality can be turned off by clicking the income balance and choosing "Disable auto hold".
+
+![Auto hold indicator](/img/how-it-works/auto-hold-carryover.png)
+
+If you need to modify the *held funds* later in the month, you can disable the auto hold for the current month by clicking the budget value and choosing "Disable current auto hold."
+You may then set the held funds like normal and the *auto hold* will still be set in the future.
+
+![Auto hold disable current month](/img/how-it-works/auto-hold-disable.png)
+
diff --git a/static/img/how-it-works/auto-hold-carryover.png b/static/img/how-it-works/auto-hold-carryover.png
new file mode 100644
index 0000000000..88cfaddc47
Binary files /dev/null and b/static/img/how-it-works/auto-hold-carryover.png differ
diff --git a/static/img/how-it-works/auto-hold-disable.png b/static/img/how-it-works/auto-hold-disable.png
new file mode 100644
index 0000000000..c09d199931
Binary files /dev/null and b/static/img/how-it-works/auto-hold-disable.png differ
diff --git a/static/img/how-it-works/auto-hold.png b/static/img/how-it-works/auto-hold.png
new file mode 100644
index 0000000000..4eed669579
Binary files /dev/null and b/static/img/how-it-works/auto-hold.png differ