hledger-budget 1.4.0

Wrapper script for 'hledger balance --budget' report.

hledger-budget

hledger-budget is a wrapper for for hledger balance --budget report which helps maintaining envelope-style budgeting while using goal-based capabilities for budgeting in hledger.

Introduction

With envelope-style budgeting one divides available spending money into "envelopes" which represent spending categories. For example, there may be a separate envelope for groceries, bills, entertainment and so on. With ledger and hledger accounts and subaccounts serve a role of envelopes.

There are 2 typical approaches for ledger and hledger for envelope-style budgeting:

• by using subaccounts for your main checking account (for example assets:bank:checking:groceries, assets:bank:checking:bills and so on;
• by using virtual accounts (and possibly automated transactions).

hledger-budget proposes a different approach: using goal-based budgeting from hledger. With hledger you use periodic transactions to set budgeting goals against "expenses" accounts and track these expenses. One thing which many hledger tutorials often omit, but which enables periodic transaction for fluid envelope-stype budgeting, is that "periodic" transactions don't have to be periodic at all. This gives flexibility necessary for effective envelope-style budgeting and simplicity of budgeting recurring expenses.

To efficiently use goal-based budgeting as envelope-style budgeting, bare hledger misses necessary tools, which hledger-budget provides:

• ability to verify how much of available money is not yet budgeted and if we're not over-budgeting;
• easy way to forecast whether there's still enough money to cover all budgeted expenses;
• how much money each expenses category has budgeted (hledger aggregates budgets of subaccounts in parent accounts).

Example

~ monthly from 2024-01
    (expenses:groceries)        200.00 EUR
    (expenses:bills)            300.00 EUR
    (expenses:car:fuel)         100.00 EUR

~ monthly from 2024-03-10
    (expenses:other)             50.00 EUR

~ 2024-03-05
    (expenses:car:repairs)      150.00 EUR
    (expenses:trips)            400.00 EUR

This is example budget, which you can keep in a separate file included in your journal file, or directly in journal file. It uses non-balancing virtual accounts which are only used for hledger's budget reports; alternatively you could also project your income and balance expenses against it).

This budget sets 2 automatic budgets:

1. for groceries, bills and car fuel which occurs on the first day of each month;
2. for "other" expenses which occurs on the 10th day of each month.

By default hledger-budget takes into account budgets from the beginning of current month to the current day. This means that hledger-budget won't account the budget for "other" before 10th day of current month. This is useful for example when you get your salary ~10th of each month. You may include or exclude such budget postings by changing the time period of hledger-budget reports with -b, -e and -p switches. Somewhat counterintuitively, reports with -p 'this month' will create reports for whole months, including the future.

Additionally, there's a one-time envelope-style budget for car repair and for a trip.

Current Budget

hledger-budget balance provides a similar table for a current budget as hledger --budget, but with deaggregated budgets for all accounts. It means that you'll only see money which you explicitly assigned to each "envelope".

hledger-budget makes no assumptions here and shows all accounts for which budget is defined. You may exclude your "spending" accounts from the report, because they affect the total spendings which report presents. For example, if you track transactions like this:

2024-02-01 Groceries
    expenses:groceries          10.00 EUR
    assets:bank:checking       -10.00 EUR

you may want to use hledger-budget balance -x assets:bank:checking.

Budget Verification

hledger-budget check compares your budgets for each month against the money available on one or more "spending" accounts. For example, to see the report for current month, you may use hledger-budget check assets:bank:checking.

The report automatically verifies the validity of your budget:

• whether there's enough of money for all remaining (budgeted) spendings;
• whether you're not over-budgeting.

Output Formats

hledger-budget prints pretty tables by default, but there are more formats which it can output. Format is controlled with -O switch and it accepts the following values: rich (default), csv, html, html-bare.