debt_payoff_plan
Calculate an avalanche-method debt payoff schedule targeting highest-APR debts first, plus YETI to show a purchase's true cost until debt-free.
Instructions
Calculate an avalanche-method debt payoff schedule with YETI multiplier.
Auto-discovers CREDIT/LIABILITY accounts that have an 'apr' slot set. Set APRs via set_account_slot (e.g., set_account_slot("Liabilities:Visa", "apr", "23.49")).
Assumptions the schedule is computed under: interest compounds monthly at apr/12 on the running balance; one payment per debt per month starting this month; extra budget beyond the minimums goes to the highest-APR debt first (avalanche); balances are as of today in the book default currency; amounts round to 0.01. Debts the plan cannot include are CONFESSED in ⚠ lines, never silently dropped: foreign-currency debts with no FX rate, loans with no minimum_payment/loan_term_months to estimate a payment from, and balance-carrying debts with no 'apr' slot.
Returns a compact text summary by default — kill order with
balances/APRs/payoff months, YETI line, totals, debt-free date.
Use verbose=true for the structured dict (per-account
interest_paid / credit_limit / minimum_payment,
plus the structured yeti block) suitable for programmatic
consumers.
YETI (Your Expense's True Impact) shows the true cost of a purchase when carrying debt: "A $1.00 purchase will cost you $1.68 by the time your debt is paid off."
Args: monthly_budget: Total monthly amount available for all debt payments combined additional_purchase: Dollar amount to calculate YETI for (default "1.00") verbose: If false (default), compact text output — optimized for reading and token efficiency. If true, structured JSON, for when you need machine-readable fields rather than a report.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| verbose | No | ||
| monthly_budget | Yes | ||
| additional_purchase | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |