A local-first personal finance app
Closing #696 - total rewrite of the Schedule tool. (#734)
Ruben Olsen Lærk04801d2b8174
diff --git a/docs/schedules.md b/docs/schedules.mdindex 2edde28f53..e78e32d6f6 100644--- a/docs/schedules.md+++ b/docs/schedules.md@@ -1,78 +1,195 @@# Schedules-## Creating a schedule+Schedules in Actual are a versatile tool designed to help you stay on top of your finances by supporting planning and automation.-Schedules can be used to enter anticipated transactions early. Some of the available options to tailor schedules to your needs are:+Schedules are a powerful planning tool that helps you stay ahead of your finances. Many users rely on them to anticipate upcoming expenses, avoid missed payments, and ensure money is available where it's needed. While they also automate recurring transactions to keep your budget accurate and save time, their real strength lies in helping you prepare for what's ahead.++You can set schedules to recur on specific dates or frequencies and tailor them to fit your unique budgeting needs. Whether you're creating them from scratch or existing transactions, schedules can also be linked to rules to categorize and annotate entries automatically.++By combining automation with proactive planning, schedules enable you to maintain control over your budget and avoid unexpected surprises.++++## The Schedules Overview Screen+++Most of the columns in the Schedules overview screen are self-explanatory.++However, if there is ~ (tilde) in front of the _Amount_ column, it indicates that the amount is an approximate value.+This is useful for transactions that may vary slightly each time, such as utility bills or subscriptions that change based on usage.++See [Creating a Schedule](#creating-a-schedule) for more information on how to set up approximate amounts.+++## What are Schedules?++Schedules can be used to enter anticipated transactions early. These transactions can be recurring or one-time.+Schedules allow you to set up a transaction that will be automatically entered into your account register on a specified date or at a specified frequency. This is particularly useful for bills, subscriptions, and other regular expenses that you want to track without having to enter them manually each time.++Schedules can also be used for income, such as paychecks or other regular payments. By scheduling these transactions, you can ensure that your budget accurately reflects your expected income and expenses.++Schedules can be set to recur on a specific day of the month, such as the 1st or the 15th, or they can be set to recur every week, every two weeks, or at other intervals. You can also choose to have the schedule automatically enter the transaction into your account register or to approve each entry manually.++Schedules can also be used to link transactions together, making it easy to track related expenses and income. For example, suppose you have a mortgage payment that is automatically deducted from your bank account each month. In that case, you can create a schedule for that payment and link it to the corresponding transaction in your budget.+Schedules can be created from scratch or existing transactions, and they can be customized to fit your specific+needs. You can also use rules to automatically categorize and add notes to scheduled transactions, making it easier+to keep track of your budget.+++## Adjusting the Upcoming Length of Schedules++You can control how far in advance scheduled transactions _appear_ in the Schedule and Account register views as _upcoming_. This setting determines the number of days before the scheduled date that a transaction will be displayed as upcoming in the account ledger, helping you plan and avoid surprises.++For example, in the image at the top of this page, the upcoming length is set to _End of the current month_.++By clicking on the **Change upcoming length** button, you can select how far in advance you want to see forthcoming transactions (e.g., 1 day, 1 week, 2 weeks, 1 month, End of the current month, or Custom length).++++If you change the upcoming length to _1 week_, only transactions scheduled within the next week will appear as forthcoming.+The _Monthly movie subscription_, _the Mortgage_, and the _Water melon subscription_ will now show as upcoming transactions.++++This flexibility allows you to customize your view — whether you want to see all upcoming transactions for the month or just those in the immediate future. Adjusting the upcoming length can help you focus on the most relevant transactions and keep your budget organized.++Changing the upcoming length only affects how schedules are displayed in your ledger; it does not impact how your budget data is stored or calculated. You can adjust this setting at any time to fit your preferences. If we change the upcoming length to _1 month_ the Account register will also reflect this change:++++## Creating a Schedule++Clicking on the **Add new schedule** button in the bottom right of the Schedules screen will add a new schedule.++Some of the available options to tailor schedules to your needs are:1. Set to be recurring or only entered once2. Set to be automatically entered into the account register or choose to manually approve entries3. Options for recurring entries for multiple specific days of the month.- 1. A single schedule can be created for a Cell phone plan that has multiple users and different payment cycles for each phone. If you have 3 cell phones that all get paid on different days of the month, each day can be defined in a single schedule for each phone.+ a. A single schedule can be created for a Cell phone plan that has multiple users and different payment cycles for each phone. If you have 3 cell phones that all get paid on different days of the month, each day can be defined in a single schedule for each phone.4. Options to determine frequency of payments, such as every month, every 2 months, every 2 years, etc.- a. "Last" day of month can be selected by selecting "Add specific days", and selecting "Last" from the day drop-down list.- b. Otherwise, if you select the 30th of every month, February will be skipped every year.- c. If you select 31st, approximately every other month will be skipped.+ a. "Last" day of month can be selected by selecting "Add specific days", and selecting "Last" from the day drop-down list.+ c. If you select 31st, approximately every other month will be skipped.-Once a schedule is started, Actual will search the transaction history for entries that match the schedule. You can then select the matches, and will have the option to link those transactions to the current schedule. You can click on the **Find missing transactions** button to have Actual look for matches.-+-!Example of schedule for a mortgage[](/img/schedules/schedules-6.png)+The example above shows a mortgage payment schedule which is to be executed on the 10th of July.+Since a mortgage payment is a recurring transaction, the **Repeats** checkbox should be enabled. By enabling _Repeats_ the **Date** field now let you enter a frequency for your transaction.+You can also enter more than one date by hitting the **+** button next to the date field.+This is useful for transactions that occur on multiple days of the month, such as a bi-weekly payments.-!Example of schedule for a mortgage[](/img/schedules/schedules-7.png)+-## How Actual finds schedules-In addition to the requirements you have specified when creating a schedule, a transaction must also meet the date requirements to be matched to a schedule. Transactions must be dated within 2 days before or after a schedule.+The **Move schedule** checkbox allows you to move the schedule either to before of after a weekend, if the selected date falls on a weekend.-For example: You have a schedule set up for your power bill for the 15th of every month. Today is the 10th of the month and you can see an upcoming scheduled transaction of your bill in Actual. The utility company decided to withdraw the funds on the 10th this month, so you post the transaction to Actual early and change the date of the transaction to match your bank statement. A problem just occurred because now the posted transaction is outside of the 2 day window to match scheduled transactions. You'll see your bill posted in the Actual account ledger but you'll also see an upcoming transaction for the power bill on the 15th even though you just entered it. This is the expected behavior when using schedules.-You can resolve this issue in one of two ways.+:::note+Schedules do not account for holidays.+:::-1. Skip the next schedule by selecting the upcoming scheduled transaction and choosing the "Skip Scheduled Date" from the menu options.-2. Accept that the date doesn't match and leave it as is so the schedule doesn't prompt a second transaction.+The **Amount** field allows you to enter the amount of the transaction.-## Schedule options that are not supported+-1. Schedules cannot be made that adjust based on the last non-weekend day (Monday-Friday) of a month.-2. Schedules do not take into account holidays.+Next to the amount field, you can select if the amount is the exact number, an approximate value, or a range between two amounts. This is useful if you want to track a range of expected amounts for a transaction, such as a utility bill that may vary slightly each month.-## How to use rules with Schedules+If you choose _is approximately_, the amount will be treated as an estimate, and Actual will match transactions that are plus/minus 7.5% of the amount entered. This means that if you enter $100, Actual will match transactions that are between $92.50 and $107.50.-Many times it's desired to add notes to the scheduled transactions or to assign categories automatically. This is done with the [Rules](/docs/budgeting/rules) tool.+Enable the **Automatically add transaction** checkbox if you want the schedule to automatically enter the transaction into your account register.+This means that the transaction will be automatically entered into the account register on all scheduled dates without requiring manual approval.-Create a schedule.+It may also be useful to link the schedule to transactions.-+-You can click on it and a new button has now appeared called **Edit as rule**.-+Once a schedule is started, Actual will search the transaction history for entries that match the schedule. You can then select the matches, and will have the option to link those transactions to the current schedule. You can click on the **Find matching transactions** button to have Actual look for matches.-Click on **Edit as Rule** to further customize the automatic entry.-+## Let Actual Find Scheduled Transactions-By clicking the **+** arrow on in the **Then apply these actions** area, you can define the category this schedule should be assigned against as well as any notes you might want to include.+Instead of manually entering each schedule, you can let Actual find and suggest schedules for you.-+Click the **Find schedules** button in the bottom left corner of the Schedules page to let Actual automatically search for transactions that appear to be recurring.-You can apply this newly made rule to any other of the linked transactions. Select all of the transactions from the rules dialog and press **Apply actions**.+-+Select the suggested schedules you want to add, and click the **Create schedule** button. Actual will then create schedules based on the selected transactions. You may need to adjust the dates and other settings for the schedules to fit your needs after they have been created.-Save the rule and any time this scheduled transaction gets entered into the register it can be automatically categorized with a helpful note.+If a schedule you expect does not appear, it may be because the payees on the transactions do not match. Ensure all transactions for a schedule use the same payee name.+++## Creating Schedules From Transactions++You can also create a schedule from an existing transaction. This is useful if you have a transaction that you want to turn into a schedule, such as a recurring bill or income.-### Creating Schedules From Transactions-To create a Schedule from an existing transaction:-1. Navigate to the Accounts page-2. Select the tick box in the left hand column for the transaction you wish to copy.-3. Once selected, go to the drop-down menu on the top right of the page-4. Click Link Schedule-5. In the Pop up that appears click "Create New"-6. All fields will populate from the transaction,-7. Adjust any additional fields and click Add.+Navigate to the Accounts page, find the transaction you wish to create a schedule from.-+1. Select the tick box in the left hand column for the transaction you wish to copy.+2. Once selected, go to the drop-down menu on the top right of the page.+3. Click on **Link schedule**.++++In the Pop up that appears click "Create New"+++++You are now presented with the same dialog as when creating a new schedule from scratch.+All fields will populate from the transaction,+Adjust any additional fields, and then click Add.++++++## Managing Schedules++Once you have created a schedule, you can edit it by clicking on the schedule line in the Schedules view. This will open the Schedule Details dialogue, where you can edit the schedule.++If you click on the ellipsis at the end of the schedule line, you will see various options to manage the schedule.+++++## How Actual Finds Schedules++In addition to the requirements you have specified when creating a schedule, a transaction must also meet the date requirements to be matched to a schedule. Transactions must be dated within 2 days before or after the scheduled date.++For example, you have a schedule set up for your power bill to be paid on the 15th of every month. Today is the 10th of the month, and you can see an upcoming scheduled transaction of your bill in Actual.+The utility company decided to withdraw the funds on the 10th of this month. Therefore, post the transaction to Actual early and update the transaction date to match your bank statement.++A problem has occurred because the posted transaction is now outside the 2-day window to match scheduled transactions.+You'll see your bill posted in the Actual account ledger, but you'll also see an upcoming transaction for the power bill on the 15th, even though you just entered it. This is the expected behaviour when using schedules.++You can resolve this issue in one of two ways.++1. Skip the next schedule by selecting the upcoming scheduled transaction and choosing the "Skip Scheduled Date" from the menu options.+2. Accept that the date doesn't match and leave it as is so the schedule doesn't prompt a second transaction.+++## How To Use Rules With Schedules++Many times it's desired to add notes to the scheduled transactions or to assign categories automatically. This is done with the [Rules](/docs/budgeting/rules) tool. The tool can be reached directly from the Schedules page by clicking on the **Edit as a rule** button in the edit dialog of a schedule.++When you edit a schedule, the **Edit as rule** button will appear in the dialog+++++Click on **Edit as Rule** to further customize the automatic entry.++We can see that the rule is already populated with the information from the schedule. The **If these conditions are met** area will have the date and frequency of the schedule, as well as the account it is linked to.+The only thing you would like to add is the category and notes for the transaction.++++Next you can select all the matching transactions that you want to apply this rule to. This is done by clicking on the checkbox next to the _Date_ header. Then click on the **Apply actions** button in the dialog.++++Save the rule and any time this scheduled transaction gets entered into the register it can be automatically categorized with a helpful note.-diff --git a/static/img/schedules/schedules-1.png b/static/img/schedules/schedules-1.pngdeleted file mode 100644index 1541317de7..0000000000Binary files a/static/img/schedules/schedules-1.png and /dev/null differdiff --git a/static/img/schedules/schedules-2.png b/static/img/schedules/schedules-2.pngdeleted file mode 100644index 1db5d9f74b..0000000000Binary files a/static/img/schedules/schedules-2.png and /dev/null differdiff --git a/static/img/schedules/schedules-3.png b/static/img/schedules/schedules-3.pngdeleted file mode 100644index 8333c6ce25..0000000000Binary files a/static/img/schedules/schedules-3.png and /dev/null differdiff --git a/static/img/schedules/schedules-4.png b/static/img/schedules/schedules-4.pngdeleted file mode 100644index 32b6beadcc..0000000000Binary files a/static/img/schedules/schedules-4.png and /dev/null differdiff --git a/static/img/schedules/schedules-5.png b/static/img/schedules/schedules-5.pngdeleted file mode 100644index fb6f9e282d..0000000000Binary files a/static/img/schedules/schedules-5.png and /dev/null differdiff --git a/static/img/schedules/schedules-6.png b/static/img/schedules/schedules-6.pngdeleted file mode 100644index 1cd388810a..0000000000Binary files a/static/img/schedules/schedules-6.png and /dev/null differdiff --git a/static/img/schedules/schedules-7.png b/static/img/schedules/schedules-7.pngdeleted file mode 100644index 691fe7c5e8..0000000000Binary files a/static/img/schedules/schedules-7.png and /dev/null differdiff --git a/static/img/schedules/schedules-8.png b/static/img/schedules/schedules-8.pngdeleted file mode 100644index 401e309474..0000000000Binary files a/static/img/schedules/schedules-8.png and /dev/null differdiff --git a/static/img/schedules/schedules-account-register.png b/static/img/schedules/schedules-account-register.pngnew file mode 100644index 0000000000..ffcd0fc8a6Binary files /dev/null and b/static/img/schedules/schedules-account-register.png differdiff --git a/static/img/schedules/schedules-add-repeat.png b/static/img/schedules/schedules-add-repeat.pngnew file mode 100644index 0000000000..c2b5463019Binary files /dev/null and b/static/img/schedules/schedules-add-repeat.png differdiff --git a/static/img/schedules/schedules-add-rule.png b/static/img/schedules/schedules-add-rule.pngnew file mode 100644index 0000000000..d49eb80f3fBinary files /dev/null and b/static/img/schedules/schedules-add-rule.png differdiff --git a/static/img/schedules/schedules-add-with-repeat-and-autoadd.png b/static/img/schedules/schedules-add-with-repeat-and-autoadd.pngnew file mode 100644index 0000000000..b127fbe4efBinary files /dev/null and b/static/img/schedules/schedules-add-with-repeat-and-autoadd.png differdiff --git a/static/img/schedules/schedules-add.png b/static/img/schedules/schedules-add.pngnew file mode 100644index 0000000000..0b9f53a12eBinary files /dev/null and b/static/img/schedules/schedules-add.png differdiff --git a/static/img/schedules/schedules-amount.png b/static/img/schedules/schedules-amount.pngnew file mode 100644index 0000000000..e7b88f4fc4Binary files /dev/null and b/static/img/schedules/schedules-amount.png differdiff --git a/static/img/schedules/schedules-edit-as-rule.png b/static/img/schedules/schedules-edit-as-rule.pngnew file mode 100644index 0000000000..27d05625f8Binary files /dev/null and b/static/img/schedules/schedules-edit-as-rule.png differdiff --git a/static/img/schedules/schedules-find-matches.png b/static/img/schedules/schedules-find-matches.pngnew file mode 100644index 0000000000..3568905fe6Binary files /dev/null and b/static/img/schedules/schedules-find-matches.png differdiff --git a/static/img/schedules/schedules-from-transaction-add-as-usual.png b/static/img/schedules/schedules-from-transaction-add-as-usual.pngnew file mode 100644index 0000000000..b0a903949cBinary files /dev/null and b/static/img/schedules/schedules-from-transaction-add-as-usual.png differdiff --git a/static/img/schedules/schedules-from-transactions-link-schedule.png b/static/img/schedules/schedules-from-transactions-link-schedule.pngnew file mode 100644index 0000000000..e9ed14b280Binary files /dev/null and b/static/img/schedules/schedules-from-transactions-link-schedule.png differdiff --git a/static/img/schedules/schedules-from-transactions.png b/static/img/schedules/schedules-from-transactions.pngnew file mode 100644index 0000000000..17b5855977Binary files /dev/null and b/static/img/schedules/schedules-from-transactions.png differdiff --git a/static/img/schedules/schedules-manage.png b/static/img/schedules/schedules-manage.pngnew file mode 100644index 0000000000..139d5fd79fBinary files /dev/null and b/static/img/schedules/schedules-manage.png differdiff --git a/static/img/schedules/schedules-overview.png b/static/img/schedules/schedules-overview.pngnew file mode 100644index 0000000000..691784a76bBinary files /dev/null and b/static/img/schedules/schedules-overview.png differdiff --git a/static/img/schedules/schedules-rule-apply-action.png b/static/img/schedules/schedules-rule-apply-action.pngnew file mode 100644index 0000000000..9fbcc55dedBinary files /dev/null and b/static/img/schedules/schedules-rule-apply-action.png differdiff --git a/static/img/schedules/schedules-upcoming-length-dialog.png b/static/img/schedules/schedules-upcoming-length-dialog.pngnew file mode 100644index 0000000000..7f4e09c3c4Binary files /dev/null and b/static/img/schedules/schedules-upcoming-length-dialog.png differdiff --git a/static/img/schedules/schedules-upcoming-new-list.png b/static/img/schedules/schedules-upcoming-new-list.pngnew file mode 100644index 0000000000..4d7e304deeBinary files /dev/null and b/static/img/schedules/schedules-upcoming-new-list.png differ