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
How planner fields behave
Section titled “How planner fields behave”- Names ignore capitalization.
age,AGE, andAge_primaryare all the same. - Trend helpers like
LAG,ROLLING_*, orPCT_CHANGEonly accept raw field names (for examplenet_worth). They cannot take expressions such asnet_worth - expenses.
Numeric fields
Section titled “Numeric fields”| Field (aliases) | What it represents |
|---|---|
age, age_primary | Current age of the primary (whole years). |
calendar_year | Calendar year of the plan e.g., 2035. |
year_index | 0-based year index in the projection (0 for first year). |
invested_assets | Total cash and securities value (net worth excluding real estate and debt). |
net_worth | Total household net worth. |
total_debt | Outstanding debt balance across all loans. |
real_estate_equity | Total equity across every property in the plan. |
taxable_balance | Combined taxable brokerage balance. |
roth_balance | Total Roth account balance. |
traditional_balance | Total traditional (pre-tax) retirement balance. |
withdrawal_amount | Net withdrawal from investment accounts for the current year: security sales plus dividend/interest income minus purchases. Reinvested dividends net to zero. |
consumption | Total annual consumption: regular expenses, personal property expenses, and debt interest (excluding rental property costs, taxes, and debt principal). |
inflation_rate | Annual inflation rate used by the planner for the current year. |
Boolean fields
Section titled “Boolean fields”| Field | What it represents |
|---|---|
debt_free | TRUE once the plan pays off every modeled debt. |
Planner-only helper functions
Section titled “Planner-only helper functions”These helpers wrap FinZot calculations and each takes one number. Use them the same way you would a spreadsheet function:
| Function | Use it when you want to… |
|---|---|
FUTURE_DOLLARS(amount) | Inflate today’s dollars into the selected plan year using FinZot’s inflation table. |