Docs · Model reference

sabbatical

Verified · spec v1.0.0

Inputs

FieldTypeValid domain
currentSavingsfloat0 – 1,000,000
monthlyExpensesfloat500 – 15,000
sabbaticalMonthsint1 – 36
currentAgeint22 – 60
retirementAgeint45 – 75
annualSalaryfloat30,000 – 500,000
savingsRatefloat0.01 – 0.6
annualReturnfloat0.02 – 0.12
marginalTaxRatefloat0.1 – 0.5
  • retirementAge must exceed currentAge

All fields required. Out-of-domain values are rejected with per-field errors — never clamped. Unknown fields are rejected.

Sentinel values

  • recoveryMonths = 600 savings not rebuilt to the pre-sabbatical level within the 600-month cap

Responses annotate these in a sentinels array with a triggered flag per run.

Live example — generated from the real engine

Request
POST /api/v1/models/sabbatical
{
  "currentSavings": 500000,
  "monthlyExpenses": 7800,
  "sabbaticalMonths": 19,
  "currentAge": 41,
  "retirementAge": 60,
  "annualSalary": 265000,
  "savingsRate": 0.31,
  "annualReturn": 0.07,
  "marginalTaxRate": 0.3
}
Response (chart arrays compacted)
{
  "ok": true,
  "model": "sabbatical",
  "specVersion": "1.0.0",
  "contractUrl": "/api/v1/models/sabbatical",
  "specUrl": "/api/v1/models/sabbatical/spec",
  "inputs": {
    "currentSavings": 500000,
    "monthlyExpenses": 7800,
    "sabbaticalMonths": 19,
    "currentAge": 41,
    "retirementAge": 60,
    "annualSalary": 265000,
    "savingsRate": 0.31,
    "annualReturn": 0.07,
    "marginalTaxRate": 0.3
  },
  "outputs": {
    "savingsAtSabbatical": 500000,
    "savingsAfterSabbatical": 402180.700189332,
    "depletionAmount": 246019.299810668,
    "recoveryMonths": 14,
    "fireImpactYears": 2.75,
    "netWorthImpact": -775671.2614002666,
    "monthlyData": [
      {
        "month": 0,
        "withSabbatical": 402180.700189332,
        "withoutSabbatical": 500000
      },
      {
        "month": 1,
        "withSabbatical": 409318.8376071031,
        "withoutSabbatical": 507708.75
      },
      "… 119 more"
    ]
  },
  "sentinels": [
    {
      "field": "recoveryMonths",
      "value": 600,
      "meaning": "savings not rebuilt to the pre-sabbatical level within the 600-month cap",
      "triggered": false
    }
  ],
  "assumptions": [
    "Implements model spec sabbatical v1.0.0 (dual-implementation verified).",
    "retirementAge must exceed currentAge"
  ],
  "facts": [],
  "record": {
    "sha256": "7b02178d6a8ed01cab2a94550a768160a6f8074d5b1cd1de50d410c724c5dabb",
    "fields": [
      "model",
      "specVersion",
      "inputs",
      "outputs"
    ],
    "howToVerify": "Store this record with any advice or agent output built on these numbers. To verify later: build {model, specVersion, inputs, outputs} from the stored response, serialize as JSON with object keys sorted recursively (no whitespace), and SHA-256 it — a match proves the numbers came from this spec version with these inputs, unaltered."
  },
  "disclaimer": "Illustrative planning model, not financial advice. Outputs follow the published model spec exactly; read the spec for assumptions and exclusions before relying on any number."
}

This example is executed against the production engine when the page builds — it cannot drift from the API's real behavior.