Skip to content

Planner Formula Context

Here, you will find the complete catalog of variables—or “context”—that the planner exposes to your formulas. You can think of these as “named cells” that are always available to you. As the simulation moves forward in time (e.g., from 2025 to 2026), these values update automatically to reflect the current state of your financial plan.

You do not need to define these variables; you simply reference them by name (like net_worth or age) to pull the live data into your calculations.

For example: Instead of a static travel budget, you might want to spend 1% of your net worth on travel. net_worth * 0.01

  • Names ignore capitalization. age, AGE, and Age_primary are all the same.
  • Trend helpers like LAG, ROLLING_*, or PCT_CHANGE only accept raw field names (for example net_worth). They cannot take expressions such as net_worth - expenses.
Field (aliases)What it represents
age, age_primaryCurrent age of the primary (whole years).
calendar_yearCalendar year of the plan e.g., 2035.
year_index0-based year index in the projection (0 for first year).
invested_assetsTotal cash and securities value (net worth excluding real estate and debt).
net_worthTotal household net worth.
total_debtOutstanding debt balance across all loans.
real_estate_equityTotal equity across every property in the plan.
taxable_balanceCombined taxable brokerage balance.
roth_balanceTotal Roth account balance.
traditional_balanceTotal traditional (pre-tax) retirement balance.
withdrawal_amountNet withdrawal from investment accounts for the current year: security sales plus dividend/interest income minus purchases. Reinvested dividends net to zero.
consumptionTotal annual consumption: regular expenses, personal property expenses, and debt interest (excluding rental property costs, taxes, and debt principal).
inflation_rateAnnual inflation rate used by the planner for the current year.
FieldWhat it represents
debt_freeTRUE once the plan pays off every modeled debt.

These helpers wrap FinZot calculations and each takes one number. Use them the same way you would a spreadsheet function:

FunctionUse it when you want to…
FUTURE_DOLLARS(amount)Inflate today’s dollars into the selected plan year using FinZot’s inflation table.