Tool reference

The pools (budgets) you belong to, with your role and permissions in each. Pass a pool's id as poolId to the other tools when you belong to more than one.

Bank accounts, cards, loans and other accounts, with current balances. businessId says which business an account belongs to (null for personal).

Add an account. openingBalance is a decimal string in the account currency, e.g. "1250.00". For an account that is already closed (an old loan, say), pass openedOn and closedOn.

Rename an account, change its type or notes, set its bank account number (used to match transfers that mention it), move it into a business (businessId, or null for personal), or archive it. Set closedOn (YYYY-MM-DD) when an account was closed: it is archived and drops out of net worth after that month. openedOn limits net worth history the same way at the start.

Say who holds an account and when (people from list_people). Replaces the account's periods; from/to are inclusive YYYY-MM-DD, null for open-ended, and periods can't overlap. Transactions in a period become that person's unless a rule or a hand-set split says otherwise. Pass an empty list to clear.

Businesses in the pool. Their accounts are kept out of personal reports, budgets and forecasts unless you ask for them with a report's scope.

Add a business (a company, partnership or sole trader). Then move its accounts in with update_account.

Rename a business, change its notes, or archive it.

Transactions newest first, filtered by account, dates, text, category or person. Amounts are negative for money out; people shows who each one belongs to. Returns a page; pass nextCursor back to get more.

One transaction in full.

Record a transaction by hand, e.g. a cash purchase. amount is a decimal string, negative for money out ("-42.50").

Change a transaction's category, payee or notes (or, for transactions added by hand, its date, amount and description). Set applyToSimilar to also recategorise other uncategorised transactions from the same merchant and remember the choice.

Uncategorised transactions grouped by merchant, most transactions first, with each group's total, date range and transaction ids. Use it to categorise a backlog: pick a category per merchant, then categorise_transactions with its ids (or create_rule for merchants that will keep turning up). Transfers are left out.

Set (or clear, with categoryId null) the category of several transactions at once.

Stop treating a transaction as one side of a transfer between your own accounts.

Run rules, remembered merchants and transfer detection over uncategorised transactions, the same as the Categorise button. Rules with people also split transactions not split by hand.

Spending, income and transfer categories, with subcategories under their parents.

Add a category, or a subcategory by giving a parentId.

Rename, move, reorder or archive a category, or set whether its spending counts as essential or lifestyle (spendGroup; null follows the default).

Categorisation rules, in the order they are tried (lowest priority number first).

Which existing transactions a rule would match, without saving it. Amount conditions compare the absolute value; add {"field":"direction","op":"equals","value":"out"} (or "in") to match only money out (or in).

Add a rule that categorises matching transactions, links them to a loan (loanId: money out is a repayment, money in a redraw), splits them between people (people), or any mix. It applies to new imports; call apply_rule to run it over existing transactions. Amounts match regardless of sign; a direction condition (value "in" or "out") limits it to money in or out. Lines of {personId, kind, value}: kind "amount" takes a fixed amount off the top (value "1000.00"), kind "percent" a percentage of what's left after the amounts (value "50"). A person can have one of each. Anything left over is shared (nobody's in particular).

Change a rule's conditions, category, loan, people, priority, or switch it off.

Run a rule over existing transactions: recategorise the ones it matches, link them to its loan and split them between its people, if it has them.

The people in the pool (with or without a login), for splitting income and spending between them. Super members are people too.

Add someone to the pool, like a partner or a kid. userId links a pool member with a login.

Rename someone, link their login, set their date of birth, keep their age off charts (showAge false), or archive them.

Say whose transactions these are. Lines of {personId, kind, value}: kind "amount" takes a fixed amount off the top (value "1000.00"), kind "percent" a percentage of what's left after the amounts (value "50"). A person can have one of each. Anything left over is shared (nobody's in particular). Pass lines [] to make them nobody's, or null to hand them back to the rules. Splits set here stick: rules leave them alone.

Dated events the pool marks on its charts, earliest first. One with an endDate is a span; it counts if any of it falls in the range. kind is "life" (a new job, a baby, moving house), "financial" (bought the car, paid off a loan), "world" (a lockdown, rate rises) or "other". Ones kept off charts and reports are left out unless includeHidden.

Mark an event on the pool's charts. kind is "life" (a new job, a baby, moving house), "financial" (bought the car, paid off a loan), "world" (a lockdown, rate rises) or "other". Give endDate for something that lasted a while. personId (from list_people) says whose it is. showInReports false keeps it off charts and reports.

Change a milestone, or keep it off charts and reports with showInReports false.

Towns, suburbs and cities by name (from the built-in place list), for setting where transactions happened or for a rule. Places in the pool’s own country come first.

Say where transactions happened: {placeId} from find_places, "none" for nowhere in particular (like a subscription), or "auto" to have it worked out from the bank’s description again. Places set here stick: rules and automation leave them alone.

Where money was spent (or, with direction "in", came from) between two dates: totals by town and by country, with coordinates, plus how much has no location. Amounts are positive.

Budgets for a month: each category with its budget, spending, rollover and what is left, plus month totals. Spending is positive.

Set a category's monthly budget from fromMonth onwards (earlier months keep their old amount). amount is a positive decimal string. rollover carries unspent money into the next month.

Savings goals with progress, status and the monthly amount needed to reach each by its date. Pass personId for one person’s goals.

One savings goal with its contributions.

Add a savings goal, shared or for one person (personId, from list_people). Link an accountId to track that account’s growth, set netWorth to aim for a net worth (includeSuper to count super), or record contributions by hand with add_goal_contribution.

Change a goal's name, whose it is, target, date or notes (or whether a net worth goal counts super), or archive it.

Record money put towards a goal (negative to take some back out).

Recurring bills and income (pay, rent, subscriptions) with their schedule and next due date.

Due dates of bills and income between two dates, and whether each was paid, skipped, late or is still expected. Defaults to recent and upcoming weeks.

Recurring payments found in the transactions that aren't tracked as bills or income yet.

Track a recurring bill or income. amount is positive either way; kind says which direction. matchText is text that the matching transactions contain, so payments are ticked off automatically.

Change a bill or income: amount, schedule, account, category, or switch it off with active false.

Mark one due date of a bill or income as paid (optionally linking the transaction), skipped, or back to expected.

Projected balances day by day from bills, income, loan repayments and (optionally) typical day-to-day spending, with warnings where an account would go below zero. exclude takes bill or loan ids to try a what-if without them.

Income, spending and savings rate between two dates, by month and by category, plus the top merchants and income by person. Spending amounts are positive. Transfers between your own accounts are left out, except money moving across the scope (e.g. drawings from a business count as personal income).

Monthly spending per category between two dates. Defaults to the top 5 categories.

Total of account balances at the end of each month, overall and per account. months "all" reaches back to the first transaction. With personId (someone with a date of birth, from list_people), byAge also gives net worth at each of their birthdays and the change over each year of age.

Income and spending across several of your pools at once (e.g. your household and your business), by month, category and pool. Money moved between the pools, like owner's drawings, is left out. Pools in another currency are skipped.

Net worth across several of your pools at once, month by month, overall and per pool.

Where each financial year’s income went: essential spending, lifestyle spending (uncategorised included), paying off debt (transfers into loan accounts and spending filed as loan repayments) and what was saved. Whether a category is essential is set per category (update_category spendGroup).

Total spending on each day between two dates (days with none are left out). Amounts are positive.

An account’s lowest, highest and closing end-of-day balance each week, and the buffer to stay above: set by hand, or worked out as the lesser of a typical week’s spending and the level the balance stayed above three weeks in four.

Six measures for the last 12 months and the 12 before: emergency fund (months of essential spending covered by cash), savings rate, essentials as a share of income, debt to income, budgets kept and bills on time. Each has a target, set in the app or worked out to be a third of the way from last year to the usual rule of thumb, and a 0-1 score against it.

Loans with balance, rate, repayment, offset and payoff date: home, car and personal loans, and money lent to others (direction 'lent' = owed to you). A loan shared with another pool shows sharedWith.

One loan in full: terms, offsets, phases (interest-only, fixed periods) and current figures.

Interest rate history, including suggested changes inferred from statements awaiting confirmation.

Transactions linked to a loan and their role (repayment, interest, fee, redraw…).

Month by month: balance owed, offset, interest actually charged and the interest expected.

Payoff projection as things are, under a what-if scenario (extra repayments for a stretch, lump sums, offset changes, a rate change or a rate path over time), and with no offset. Shows payoff dates, total interest and each date the repayment changes (repaymentSteps) so scenarios can be compared.

Guess a loan's terms from a loan account's transaction history, to fill in create_loan.

Set up a loan on a loan account. Amounts are decimal strings and rates are percentages like "5.84". Use loan_draft first to get sensible values. For money lent to someone, set direction 'lent' and ledgerMode 'modelled': give the account a positive opening balance (what's owed to you); repayments are money coming in.

Change a loan's name, terms, fees, funding account or notes. On a shared loan the name is this pool's own.

Replace the accounts that offset this loan (and how much of each balance counts).

Add a period such as interest-only, with an optional repayment override.

Change a loan phase's dates, type or repayment override.

Record an interest rate change from a date, e.g. "6.09" from 2026-11-01.

Correct a rate, or confirm or dismiss a suggested rate change.

Look through the statements again for interest rate changes, and suggest any found.

Work out each of the loan account's transactions' role (repayment, interest, fee…) again.

Link a transaction to a loan with a role, e.g. a repayment made from another account for a loan whose statements aren't imported.

Remove a manually linked transaction from a loan.

Record that a loan was paid out (discharged) on a date. payoutAmount is everything it took, fees included; payoutFees is the discharge and break costs within it. The loan and its account close: no projections after that date. For a loan whose statements are not imported (modelled), the estimated balance is tied to the payout figure, and a rate that fits it is suggested if none is confirmed. To record moving to a new loan, use refinance_loans instead.

Undo a payout recorded with close_loan.

Record old loans being paid out by new ones on a settlement date (e.g. a split NAB loan refinanced to one Macquarie loan). Set up every loan first (create_loan; an old loan without statements can be ledgerMode 'modelled'). The old loans close with their payout figures; offsets, the funding account and the repayment bill move to the first new loan unless it has its own. The payouts and the new loans' drawdowns are filed as Transfers.

One refinance: what each old loan was paid out at, what the new loans drew, and the difference.

Undo a refinance: the old loans reopen and what moved to the new loan moves back.

Put the other side of this loan into another pool: the lender sees it as owed to them, the borrower as a debt. It's one loan; either side can change it and link their own payments. With toPoolId (another pool you belong to) it's shared straight away. Without it, you get a link for someone else's pool; it lasts 7 days and a new one replaces the last. Only modelled loans without offsets can be shared.

Accept a share link (from share_loan) into this pool. A new loan account is created here that mirrors the loan, so payments in this pool can be linked to it.

Stop sharing a loan, from either side. The other pool's copy of the loan account goes, and its payments come unlinked.

Every loan linked to this one by refinances as one history: owed and interest each month, rates per loan, each refinance, and what refinancing has saved compared with staying put.

Savings accounts and term deposits with interest tracking: balance, base/bonus/intro rate, bonus cap, projected interest over the next 12 months, maturity, and this period’s bonus-condition status.

One savings account or term deposit in full: terms, rate history (including suggestions), bonus conditions and the current tracker.

Whether each bonus condition is met, on track, at risk or missed this period (or another period with savingsId + period "YYYY-MM" / "YYYY-Qn"), from what has happened so far plus scheduled bills and income. At-risk conditions come with what to do: transfer an amount by a date, hold off a withdrawal, or make more card purchases. topUps combine deposit shortfalls into one transfer per account. Without savingsId, covers every tracked account.

Period by period: whether the bonus conditions held, interest actually credited against what the base and base+bonus rates would pay, the effective rate, and bonus interest lost in missed periods.

Compounding growth projection: the expected path (scheduled deposits, this period’s bonus as tracked, later bonuses met), a what-if scenario, and the scenario with every bonus met vs on the base rate alone, so the value of keeping the conditions is clear. Term deposits project to maturity.

Guess a savings account’s rate and interest day from its interest credits, to fill in create_savings.

The account’s transactions with how each is tagged (interest, bonus interest, excluded from conditions…).

Set up interest tracking on a savings, term deposit or other account that holds money. Rates are percentages like "5.50" with a component of "base", "bonus" (only paid when the conditions hold; maxBalance caps it) or "intro" (replaces both until endDate). For a term deposit set kind "term_deposit", interestFrequency "at_maturity" (or how it's paid), startDate, maturityDate and maturityInstruction. When reading a product's terms, turn its bonus requirements into conditions: Each condition is one object, and the bonus is paid only in periods where every enabled condition holds. Money is a decimal string in the account's currency. "accountId" is optional and defaults to the savings account itself; set it to watch a linked account instead (e.g. card purchases on the everyday account, or deposits into a linked transaction account). - {"type":"min_deposits","amount":"1000","minEach":null,"source":"any"}: deposit at least this much each period. source: "any" (own transfers count), "external" (only money from outside the pool, e.g. salary), "exclude_same_institution" (transfers from the same bank don't count). minEach: each deposit must be at least this. - {"type":"balance_growth","minIncrease":"0.01","excludeInterest":true}: end the period higher than it started ("0.01" = any growth). excludeInterest: interest paid doesn't count towards it (most banks). - {"type":"max_withdrawals","count":0,"maxTotal":null}: at most this many withdrawals (0 = none), optionally capped in total. - {"type":"min_card_purchases","count":5,"descriptionPattern":null,"accountId":"<everyday account>"}: at least this many settled card purchases (spending that isn't a transfer), optionally only rows matching a regex. - {"type":"min_balance","amount":"5000","basis":"period_end"}: keep at least this much, checked "daily" or at "period_end". Rules that aren't about the period's activity (age limits, one account per person, needing a linked account at all) aren't conditions; put them in the account's notes. A bonus that only applies up to a balance is a rate cap, not a condition: use add_savings_rate with component "bonus" and maxBalance.

Change how interest is paid, the transfer clearing time, term deposit details or notes.

Replace a savings account's bonus conditions with this list (send them all; an empty list removes them). Each condition is one object, and the bonus is paid only in periods where every enabled condition holds. Money is a decimal string in the account's currency. "accountId" is optional and defaults to the savings account itself; set it to watch a linked account instead (e.g. card purchases on the everyday account, or deposits into a linked transaction account). - {"type":"min_deposits","amount":"1000","minEach":null,"source":"any"}: deposit at least this much each period. source: "any" (own transfers count), "external" (only money from outside the pool, e.g. salary), "exclude_same_institution" (transfers from the same bank don't count). minEach: each deposit must be at least this. - {"type":"balance_growth","minIncrease":"0.01","excludeInterest":true}: end the period higher than it started ("0.01" = any growth). excludeInterest: interest paid doesn't count towards it (most banks). - {"type":"max_withdrawals","count":0,"maxTotal":null}: at most this many withdrawals (0 = none), optionally capped in total. - {"type":"min_card_purchases","count":5,"descriptionPattern":null,"accountId":"<everyday account>"}: at least this many settled card purchases (spending that isn't a transfer), optionally only rows matching a regex. - {"type":"min_balance","amount":"5000","basis":"period_end"}: keep at least this much, checked "daily" or at "period_end". Rules that aren't about the period's activity (age limits, one account per person, needing a linked account at all) aren't conditions; put them in the account's notes. A bonus that only applies up to a balance is a rate cap, not a condition: use add_savings_rate with component "bonus" and maxBalance.

Record a rate from a date: component "base", "bonus" or "intro" (with endDate). minBalance/maxBalance make it apply to that slice of the balance only (tiers, bonus caps).

Correct a rate, or confirm or dismiss a rate suggested from the interest credits.

Work out the rate from the interest credits again and suggest any change found.

Tag a transaction in the savings account: "interest" or "bonus_interest" (counted as interest, so it can be left out of balance growth), "excluded" (ignored by the conditions, e.g. a bank correction), "deposit" or "withdrawal".

Book a transfer the person intends to make into the savings account (as a pair of one-off scheduled items), so the forecast and the bonus tracker count it until the real transfer imports. It doesn’t move any money; say so.

The person’s in-app notifications for this pool: savings bonuses at risk or missed, term deposits maturing, money over a bonus cap, late bills and accounts forecast to dip below zero. Current items first; resolved ones have resolvedAt set.

Mark notifications read, by id or {"all": true}.

Everyone with a super (retirement) fund in the pool: date of birth, salary, funds and balances, this financial year’s concessional contributions against the cap, whether employer contributions are arriving on time, and each fund’s fees and insurance as charged (feesFromHistory).

One person’s super details and funds.

Concessional (employer, salary sacrifice, deducted personal) and non-concessional contributions for a financial year (e.g. "2026-27", default this one) against the caps, with carry-forward of unused cap, bring-forward, what’s expected by 30 June, and a Division 293 flag. Years before the history starts need totals entered (update_retirement_member priorConcessional).

Did the employer’s super contributions arrive, and on time? Each payday since 1 July 2026 (payday super: due 7 business days after payday) or each quarter before then, with what was owed, what arrived and when. Needs a salary and a linked pay on the member.

Projects a member’s super to retirement (never before preservation age), by financial year, in future and today’s dollars. What-ifs: extraConcessional and extraNonConcessional (per year), returnRate (percent, after fees and tax), inflation, wageGrowth, retirementAge. Also the actual month-end balances so far.

Investment returns (after fees) per financial year across a member’s funds, worked out from balances and contributions, with a suggested return to assume in projections.

A fund’s transactions with what each one is (employer, salary_sacrifice, personal_concessional, personal_non_concessional, contributions_tax, fees, insurance, earnings, rollover_in…), newest first. Balance updates show as adjustments.

Adds a person whose super is tracked: name, dateOfBirth, retirementAge, ruleset ("au" for Australian super, "none" for a plain retirement fund), salaryAnnual (before salary sacrifice), salarySacrificeAnnual, employerRate (only if above the legal minimum), payScheduleId (their pay in Bills & income).

Changes a member’s details. priorConcessional {"2024-25":"27500"} enters concessional totals for years before the history starts, so carry-forward counts them; tsbOverride does the same for total balances on 30 June.

Tracks an account as a super fund for a member (memberId, or member to add one at the same time). Optional starting balance {date, amount}, fees (adminFeeAnnual, feePercent, insuranceAnnual) and assumedReturn for projections; with no fees set, projections use what the fund has been charging. The account becomes a retirement account.

Changes a fund’s fees, assumed return, name, member or whether it’s the primary fund.

Records a fund balance on a date (from a statement or the fund’s website). The first sets the starting balance; later ones book whatever the transactions don’t explain as returns.

Says what a fund transaction is. Use personal_concessional for a personal contribution once a notice of intent to claim a deduction has gone to the fund.

Things owned that count in net worth but aren’t money in a bank: homes, cars, other valuables. Each has today’s value (currentValue; estimated is true when it’s projected from the yearly rate after the latest valuation), its value a year ago, linked loans with what’s owed, equity and LVR.

One asset with its valuations and month-end history of value and debt since it was bought (up to ten years).

Month by month from now: the asset’s value (at its yearly rate, or growth to try another) against what its linked loans will owe on their current projections, with equity and LVR. crossings gives the month it first drops to 80% and 60% LVR, and to its targetLvr if set.

What an asset costs to own, month by month over the last `months` full months and estimated for the next 12: interest and fees on its linked loans, costs and income from the categories picked for it, and how its value moved. net = interest + fees + costs − income − valueChange; below zero it earned more than it cost. For a rental (income categories or an investment loan), yield gives gross, net and cash-on-cash percentages.

Replace which categories count toward an asset: role cost for rates, insurance, strata, upkeep; role income for rent. A parent category includes its subcategories. accountId limits a pick to one account, to keep a rental’s costs apart from the home’s when they share a category. Returns the asset_costs result.

Add a home, car or other valuable. kind is property, vehicle or other. Give purchasedOn and purchasePrice, or value { date, amount } for what it’s worth now, or both. rate is the yearly change used after the latest valuation, as a signed percent ("4" for a home growing 4%, "-15" for a car losing 15%); ask the person rather than assuming. loanIds links mortgages or car loans for equity. Net worth includes it from the purchase date.

Change an asset’s details or rate, or set targetLvr (percent) to see when it gets there in asset_forecast. To record a sale, pass soldOn and salePrice: it drops out of net worth from that day.

What an asset was worth on a date (an appraisal, a bank or website estimate). Values between valuations move smoothly from one to the next; a valuation on the same date replaces the old one.

Set the loans secured against an asset (replaces the list), for equity and LVR. Net worth already counts the loans, so this doesn’t change it.

Share and crypto portfolios (kind) with their market value, cost base, gain and today’s move. Prices are delayed about 15 minutes; pricesAsOf says when. Units and prices are decimal strings in the instrument’s currency; money totals are in the account’s currency.

One portfolio: each holding (units, price, value, cost, gain, weight), month-end value against cost, every trade (and which bank transaction paid for it), and gains locked in by sales (realised).

Searches the pool’s price feed by name or code, e.g. "vanguard australian" or "VAS". kind "crypto" searches the crypto feed ("bitcoin", "SUI").

Records a buy, sell or split in a portfolio, or units received or sent without a trade (side receive/give: an airdrop, staking reward, or a deposit or withdrawal). symbol is the code without a suffix ("VAS", "BTC"); exchange defaults to ASX (also NASDAQ, NYSE, LSE, NZX, TSX, CRYPTO for coins, CASH for money held at an exchange, symbol = its currency). units, price and fees are decimal strings in the instrument’s currency, up to 8 decimal places; for a split, units is new per old ("2" for 2-for-1); for receive, price is the cost per unit (0 for an airdrop). externalRef is the broker’s confirmation number, so the trade is never added twice.

What a broker says is held on a date: [{ symbol, exchange, units, costPrice? }]. Trades are reconciled to it (units they don’t explain become "held before" or adjustment lines). With complete true (the default), anything not listed counts as sold by that date.

A financial year of one portfolio, or every portfolio in the pool’s currency without portfolioId: holdings at each end, the year’s trades, and each sale matched to the parcels it used up (first in, first out) with cost base, proceeds, gain and days held. fy is the calendar year the financial year ends in (2025 is July 2024 to June 2025 in Australia). Totals take losses off short-term gains first, then the 50% discount off long-term gains for Australian pools. Losses carried in from earlier years aren’t known. Money is minor units.