Actual Budget

Delete a payee. Destructive and irreversible: the first call only previews, and deleting requires confirm: true plus confirm_name set to the payee's exact name.

Delete a transaction rule by its ID. Destructive and irreversible: the first call only previews the rule, and deleting requires confirm: true.

Delete a transaction by its ID. Destructive and irreversible: the first call only previews what would be lost, and deleting requires confirm: true.

Get the budget for a specific month showing all category groups, their categories with budgeted amounts, actual spending, and remaining balance. Also shows the to-be-budgeted amount.

Executive summary of the budget showing totals by category group, total income, total expenses, savings rate, and to-be-budgeted for a given month.

List all category groups with their categories and IDs. Useful for seeing the full budget structure.

Get the balance and spending history for a specific category across a window of months, ending in the month you name or this month.

List all payees in the budget. Useful for seeing available payees and their IDs.

List transaction rules with their conditions and actions. Returns the first 100 rules; pass offset for the next page, flagged_only for just the ones with a warning, or field to see only the rules that mention one field.

List the budget's schedules: what is due next, how much, from which account, and whether the last one posted. Read-only; creating and changing schedules is not here.

List transactions with optional filters. Returns date, payee, category, amount, notes, account, cleared status, and — for a part of a split — the note on the split it belongs to.

Hold some of a month's unassigned money so it carries into the next month, instead of assigning it now. Adds to whatever is already held; pass 0 to release it all. To give money to a category, or to take it back, use transfer_between_categories; this one assigns nothing, it only keeps what is left over from being assigned this month.

List all budget accounts with their current balances, type (on-budget/off-budget), and status.

Monthly financial summary showing income, expenses, savings, and savings rate across multiple months. Great for seeing trends in your overall financial health.

Change the category of an existing transaction.

Compare an account against the balance a bank reports, and list what might explain the difference. Reads only; books nothing.

Book an adjustment transaction to bring a multi-currency account to the balance the bank reports, clearing accumulated FX-rate residual. It compares against every transaction up to today, and the reply says how much of that figure is not marked cleared and what the adjustment would have been against the cleared rows alone, since a statement generally shows only what has posted. The date must be today or earlier. If a transaction with the same account, date and amount already exists this books nothing and reports it instead; run it again to recompute, or pass allow_duplicate if the match is unr…

Repair the budget's sync state when operations fail with an out-of-sync error. Rebuilds sync bookkeeping without modifying budget data. Use this when other tools report that the budget is out of sync.

Sync bank transactions from linked accounts (GoCardless/SimpleFIN). Syncs a specific account or all linked accounts if none specified.

Turn a category's carryover on or off from a month onwards, so overspending rolls into that category next month instead of coming off the money to assign. Actual writes the flag into every month from the one given to the last the budget has, not only that one.

Break down spending by category for a date range. Shows each category's total spending and percentage of total.

Project end-of-month spending for each category based on the current daily spending rate. Warns about categories likely to exceed budget.

Move budgeted money between categories, or between a category and the money that is not budgeted yet, for a month. Creates no transaction.

Rename an account. Transactions, balance and budget status are untouched.

Set the budgeted amount for a category in a specific month, or add to it with mode: "delta".

Rename or hide/unhide a budget category.

Rename or hide/unhide a category group.

Rename a payee.

Update fields of an existing transaction. Only the fields you provide will be changed.