scenarios

Preview Exit Tax

Estimate the exit tax for a proposed relocation event.

Thin wrapper over tax_engine.exit_taxes.compute_exit_tax. Resolves the residency country at the proposed year (honoring any earlier relocation events on the scenario) and runs the destination handler. Cached per (scenario-hash + proposed-relocation) tuple so the editor's live preview stays under the 200ms budget on repeat keystrokes.

post/api/scenarios/preview-exit-tax

Request

  • Base URL: https://api.retirementlab.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.retirementlab.app/api/scenarios/preview-exit-tax
  • Auth: none declared

Request body

Response

Successful Response

appliesboolean required
amountnumber required
rule_namestring required
from_countrystring required
to_countrystring required
yearinteger required
tax_componentstring required
caveatstring
basis_availableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.