Skip to content

A local-first personal finance app

Documenting percentage adjustments feature for actual PR #4257 (#631)

Matt Farrell1434ed871119
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
index 3ebea61ce6..a07a554485 100644
--- a/.github/actions/spelling/expect.txt
+++ b/.github/actions/spelling/expect.txt
@@ -30,8 +30,8 @@ Depositos
DIREKT
Dockerfiles
Dominguez
-DUSSELDORF
DUSSDEDDXXX
+DUSSELDORF
ENTERCARD
Entra
fidd
@@ -39,9 +39,9 @@ Fineco
Fintro
FORTUNEO
FTNOFRP
+Geral
gernes
gocardless
-Geral
Grafana
HABAL
HELADEF
@@ -63,6 +63,7 @@ Paribas
passwordless
Postgre
prefs
+proactively
revolut
RIED
RSchedule
diff --git a/docs/experimental/goal-templates.md b/docs/experimental/goal-templates.md
index e967d1a255..a3d855d0a7 100644
--- a/docs/experimental/goal-templates.md
+++ b/docs/experimental/goal-templates.md
@@ -364,6 +364,22 @@ Below is an example of using the "Full" flag assuming a once per year schedule f
|#template schedule full Simplefin | $ 0 | Budget in all months except May |
|#template schedule full Simplefin | $ 15 | Budget in May |
+#### Percentage Increase / Decrease
+
+Yearly expenses (e.g. insurance, property rates, etc.) increase year on year. Often the amount is unknown until close to the due date. This creates a budget crunch - if your $1,000 insurance jumps 20% ($1,200), you need to make up that extra $200 in just a month or two.
+
+This feature adds percentage adjustments to templates, letting you gradually save the expected increase throughout the year. By proactively budgeting a percentage change for these yearly increases, you avoid last-minute scrambling when renewal notices arrive with higher amounts.
+
+|Syntax|Description|
+|---|---|
+| #template schedule {SCHEDULE NAME} [{increase/decrease} {number}%] | Fund the upcoming scheduled transaction over time, increasing or decreasing the amount by the given percentage
+
+As an example, assuming the amount Scheduled for 'Insurance' the prior year was $1000, the below would apply.
+
+| Category | Template line | Amount applied |
+|---|---|:---:|
+| Insurance | #template schedule Insurance [increase 20%] | $1200 |
+
#### Available Variations
Below is a table of the variations of the Schedule template.
<!-- prettier-ignore -->
@@ -371,6 +387,7 @@ Below is a table of the variations of the Schedule template.
|---|---|---|
|#template schedule {SCHEDULE NAME}|Fund upcoming scheduled transactions over time|Monthly schedules, or larger non-monthly scheduled transactions|
|#template schedule full {SCHEDULE NAME}|Fund upcoming scheduled transaction only on needed month| Small schedules that are non-monthly|
+|#template schedule {SCHEDULE NAME} [{increase/decrease} {number}%]|Fund upcoming scheduled transaction over time, increasing or decreasing the amount by the given percentage|Yearly renewals where the amount changes|
### Average Type
The Average template allows you to budget the average amount spend over a number of months.
@@ -435,7 +452,6 @@ All of the examples below use the case of 100 leftover when the remainder pass i
| Vacation Fund | #template remainder | 16.66 |
| Investment Fund | #template remainder 2 | 33.34 |
-
### Goal Directive
This option is unique enough to warrant its own directive, `#goal`, instead of the standard `#template` option.