Cyprus financial calculators with optional OAuth access to personal saved calculations.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Analyses an investment portfolio from its transaction history: net invested capital, current value, absolute return, chain-linked time-weighted return (TWR), CAGR on initial invested capital, per-sub-portfolio breakdown and allocation shares, with multi-currency support via per-transaction FX rates. Use to analyze actual portfolio ledgers or current holdings and valuation data. Require real transactions/holdings and a current valuation for each holding; require FX rates where currencies differ. TWR needs a valuation immediately before each later external cash flow and at the end date; report null with its reason when absent. Equal and opposite same-day movements between sleeves in the base currency net to an internal transfer for combined TWR; confirm both legs before using that treatment. Missing acquisition cost may use the disclosed performance-from-today behavior. Never create transactions or holdings records.
Reporting currency (e.g. EUR). Transactions in another currency require fxRate.
One entry per account, broker or strategy sleeve.
Optional ISO date (YYYY-MM-DD) used as the CAGR end date. Defaults to today.
Optional label for the portfolio.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Analyses an investment portfolio from its transaction history: net invested capital, current value, absolute return, chain-linked time-weighted return (TWR), CAGR on initial invested capital, per-sub-portfolio breakdown and allocation shares, with multi-currency support via per-transaction FX rates. Use to analyze actual portfolio ledgers or current holdings and valuation data. Require real transactions/holdings and a current valuation for each holding; require FX rates where currencies differ. TWR needs a valuation immediately before each later external cash flow and at the end date; report null with its reason when absent. Equal and opposite same-day movements between sleeves in the base currency net to an internal transfer for combined TWR; confirm both legs before using that treatment. Missing acquisition cost may use the disclosed performance-from-today behavior. Never create transactions or holdings records.
| Argument | Type | Description |
|---|---|---|
| asOfDate | string | Optional ISO date (YYYY-MM-DD) used as the CAGR end date. Defaults to today. |
| baseCurrency* | string | Reporting currency (e.g. EUR). Transactions in another currency require fxRate. |
| portfolioName | string | Optional label for the portfolio. |
| subPortfolios* | array | One entry per account, broker or strategy sleeve. |
{
"type": "object",
"required": [
"baseCurrency",
"subPortfolios"
],
"properties": {
"asOfDate": {
"type": "string",
"description": "Optional ISO date (YYYY-MM-DD) used as the CAGR end date. Defaults to today."
},
"baseCurrency": {
"type": "string",
"description": "Reporting currency (e.g. EUR). Transactions in another currency require fxRate."
},
"portfolioName": {
"type": "string",
"description": "Optional label for the portfolio."
},
"subPortfolios": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"if": {
"required": [
"type"
],
"properties": {
"type": {
"const": "holdings"
}
}
},
"then": {
"required": [
"holdings"
]
}
},
{
"if": {
"required": [
"type"
],
"properties": {
"type": {
"const": "cash_flow"
}
}
},
"then": {
"required": [
"transactions"
]
}
}
],
"required": [
"name",
"currency"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"enum": [
"cash_flow",
"holdings"
],
"type": "string",
"description": "cash_flow: transaction ledger sleeve. holdings: EOD snapshot sleeve valued from holdings closes (transactions may be empty)."
},
"currency": {
"type": "string",
"description": "Currency the transactions are denominated in."
},
"holdings": {
"type": "array",
"items": {
"type": "object",
"required": [
"symbol",
"shares",
"currentPrice"
],
"properties": {
"isin": {
"type": "string"
},
"name": {
"type": "string"
},
"notes": {
"type": "string"
},
"fxRate": {
"type": "number",
"description": "Legacy alias for fxRateToBase.",
"exclusiveMinimum": 0
},
"shares": {
"type": "number",
"exclusiveMinimum": 0
},
"symbol": {
"type": "string",
"description": "Ticker, e.g. VWCE."
},
"asOfDate": {
"type": "string",
"description": "Bar date of currentPrice (YYYY-MM-DD)."
},
"currency": {
"type": "string"
},
"yahooSymbol": {
"type": "string",
"description": "Resolved Yahoo symbol, e.g. VWCE.MI."
},
"acquiredDate": {
"type": "string",
"description": "Vintage powering per-holding CAGR (YYYY-MM-DD)."
},
"avgCostPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"currentPrice": {
"type": "number",
"exclusiveMinimum": 0
},
"fxRateToBase": {
"type": "number",
"exclusiveMinimum": 0
},
"ownershipShare": {
"type": "number",
"maximum": 1,
"minimum": 0
}
},
"additionalProperties": false
},
"maxItems": 200,
"description": "Positions for a holdings sleeve. Omitted avgCostPrice tracks returns from today (day-1 return 0%)."
},
"cashLabel": {
"type": "string",
"description": "Cash bucket label (e.g. emergency, savings, collateral, current)."
},
"cashBalance": {
"type": "number",
"minimum": 0,
"description": "Uninvested cash swept into a holdings sleeve's value (counts 1:1 on invested and current value)."
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"type",
"amount"
],
"properties": {
"date": {
"type": "string",
"description": "ISO date (YYYY-MM-DD)."
},
"type": {
"enum": [
"Deposit",
"Withdrawal",
"Value"
],
"type": "string",
"description": "Deposit/Withdrawal are cash flows; Value is a portfolio valuation snapshot."
},
"amount": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"fxRate": {
"type": "number",
"description": "Units of sub-portfolio currency per one unit of base currency. Required when currencies differ.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
},
"maxItems": 1000,
"minItems": 0,
"description": "Ledger for cash_flow sleeves. May be empty for holdings sleeves (valued from holdings closes)."
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "One entry per account, broker or strategy sleeve."
}
}
}Forensic audit of a mortgage statement: replays the loan day by day and grid-searches the bank's interest convention (Actual/365, Actual/360 or Actual/Actual day count; monthly, semi-annual or annual capitalisation; exact or 2-decimal daily rounding), ranks candidates by RMS error against the bank's own running balance, and reports the interest overcharge implied by the best fit. Use to audit an actual mortgage statement. Require statement rows, at least one usable interest rate and balance checkpoints sufficient to fit the calculation. Reuse only extracted facts; inferred day-count and capitalization conventions are estimates, not confirmed bank terms.
| Argument | Type | Description |
|---|---|---|
| rows* | array | Parsed statement rows in chronological order. At least one row must carry ratePct. |
| topN | integer | How many ranked candidate conventions to return (default 3). |
| rules | object | Skip the grid search and test one explicit convention. |
| includeRowDetail | boolean | Include the per-row expected balance / delta / flag detail (can be large). |
{
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"signedAmount"
],
"properties": {
"date": {
"type": "string",
"description": "ISO date (YYYY-MM-DD)."
},
"kind": {
"enum": [
"drawdown",
"payment",
"interest_post",
"fee",
"adjustment",
"other"
],
"type": "string",
"description": "Row type. interest_post rows are the bank's own interest charges and are what the audit compares against."
},
"ratePct": {
"type": "number",
"maximum": 30,
"minimum": 0,
"description": "Annual nominal rate in effect from this row onwards, percent."
},
"description": {
"type": "string"
},
"balanceAfter": {
"type": "number",
"description": "Outstanding balance the statement reports after this row, EUR. Used as the fit checkpoint."
},
"signedAmount": {
"type": "number",
"description": "Positive increases the outstanding balance (drawdown, interest posting, fee); negative reduces it (payment)."
}
},
"additionalProperties": false
},
"maxItems": 2000,
"minItems": 1,
"description": "Parsed statement rows in chronological order. At least one row must carry ratePct."
},
"topN": {
"type": "integer",
"default": 3,
"maximum": 10,
"minimum": 1,
"description": "How many ranked candidate conventions to return (default 3)."
},
"rules": {
"type": "object",
"properties": {
"dayCount": {
"oneOf": [
{
"enum": [
360,
365
],
"type": "number"
},
{
"enum": [
"actual"
],
"type": "string"
}
]
},
"dailyRounding": {
"type": [
"number",
"null"
],
"description": "Decimals for daily interest rounding, or null for exact."
},
"fixedCapDates": {
"type": "array",
"items": {
"type": "string",
"description": "MM-DD"
}
},
"capitalization": {
"enum": [
"daily",
"monthly",
"quarterly",
"semiannual",
"annual"
],
"type": "string"
},
"ignoreBankCapRows": {
"type": "boolean",
"description": "Do not add the bank's own interest postings to the simulated balance (default true)."
},
"capitalizationAnchor": {
"enum": [
"month_end",
"first_disbursement",
"fixed_dates"
],
"type": "string"
}
},
"description": "Skip the grid search and test one explicit convention."
},
"includeRowDetail": {
"type": "boolean",
"description": "Include the per-row expected balance / delta / flag detail (can be large)."
}
}
}Calculates Cyprus Capital Gains Tax on an immovable property disposal using 2025 or 2026 rules, including CPI indexation, year-specific lifetime exemptions, the 20% CGT rate and the 0.4% property transfer fee. Use for Cyprus capital-gains tax on an immovable-property sale. Obtain the actual acquisition price and year, disposal tax year, sale price and property type; ask for missing essentials. Tax-year rules default to 2026; supply 2025 for a disposal in that year. Currency defaults to EUR only as a modelling convention. Omission of isFirstDisposal means no lifetime exemption is claimed; do not infer eligibility.
| Argument | Type | Description |
|---|---|---|
| taxYear | string | Disposal tax year; defaults to the current 2026 rules and selects year-specific lifetime allowances. |
| currency | string | EUR (default) or CYP for pre-2008 purchases (converted at 0.585274). |
| agentFees | number | Estate agent / legal fees deducted from the sale price, EUR. |
| salePrice* | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| propertyType* | string | Drives the year-specific lifetime exemption: 2025 general/plot €17,086, qualifying main residence €85,430 and agricultural land €25,629; 2026 general/plot €30,000, qualifying main residence €150,000 and agricultural land €50,000; other €0. |
| acquisitionYear* |
Calculates Cyprus income tax, employee/self-employed SI, GESY and take-home pay. Employee SI and first-employment relief use qualifying employment remuneration only; rent does not increase employee SI. GESY uses the shared €180,000 personal ceiling. Use for a Cyprus resident or non-resident employee or sole proprietor tax estimate. Before calling, confirm whether a stated salary is monthly or annual and confirm employment category (private, civil or self-employed); do not infer either. Supply gross annual salary in EUR (use explicit 0 for self-employed-only cases); self-employed calculations also need turnover and occupational category. Identify when 2026 tax rules are a default rather than a user-supplied year. Optional incomes, deductions, tax year and eligibility facts must come from the user. Employee Social Insurance applies to qualifying employment remuneration only; passive rental income does not increase employee SI. Article 8(21A)/(23A) exemptions are based on qualifying employment remuneration only; GESY's €180,000 annual personal ceiling is shared across salary, self-employment, pension and income-earner categories. Never infer exemption eligibility.
| Argument | Type | Description |
|---|---|---|
| donations | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| evExpense | number | |
| interestPaid | number | Interest paid on rental property. |
| propertyYear | integer | Year the property was acquired. |
| rentalIncome | number | Annual rental income in EUR. |
Estimates the Cyprus state (contributory) pension amount at retirement using official contribution schedules and current 2026 pension income-tax bands, based on accumulated insurance units and contribution history. Use to estimate contributory Cyprus state pension entitlement and amount at retirement. Results apply the current 2026 pension income-tax bands; projected contribution amounts use the published SI rate increases in 2029, 2034 and 2039. Reuse supplied facts and ask only for missing essentials: mode and retirement age are always required; quick mode also needs current age, years worked and total insurance units; advanced mode needs the actual non-empty yearly contribution record. Ask for dependants or state the zero-dependants assumption before presenting a personalized result. Never infer contribution history. Units are per calendar year; a legacy year-to-units map is accepted.
| Argument | Type | Description |
|---|---|---|
| mode* | string | Calculation mode. |
| currentAge | integer | Current age (quick mode only). |
| dependents | integer | Number of dependents (spouse/children); raises the basic pension multiplier. |
| yearlyUnits | array | object | Advanced mode only. Insurance units earned per calendar year, e.g. [{"year":2003,"units":5.2}]. Units per year must be between 0 and the statutory maximum for that year (about 5.3-6.0; 6.0 for years after 2026). A legacy object map {"2003": 5.2} is also accepted. Years worked and total units are derived from this array, so yearsWorked/totalInsuranceUnits are ignored in advanced mode. |
| yearsWorked | number |
Estimates the Cyprus unemployment benefit using statutory percentage-point dependant additions and a capped earnings-related supplement, and separately assesses entitlement when qualifying facts are supplied. Use to estimate the conditional Cyprus unemployment benefit amount and separately assess entitlement. The basic rate is 60%, plus 20 percentage points for a dependent spouse and 10 percentage points per dependent child or other dependant (up to three); the earnings-related supplement is 50% of supplementary insurance earnings, capped at one weekly basic insurable earning. Require the claim date, relevant-year insurable earnings and dependants to estimate an amount. Ask for qualifying insurance history, employee status, unemployment registration and availability for work before claiming entitlement; when those facts are missing, state that entitlement is undetermined and ask each missing follow-up question. Do not infer those facts from annual earnings.
| Argument | Type | Description |
|---|---|---|
| isEmployee | boolean | Whether the claimant was insured as an employee rather than self-employed. |
| applicationDate* | string | Actual claim date as YYYY-MM-DD. |
| dependentSpouse* | boolean | Whether the claimant has a dependent spouse not in paid work; ask if unknown. |
| dependentChildren* | integer | Actual number of dependent children or other dependants; ask if unknown (benefit calculation caps at 3). |
| annualGrossEarnings* |
Compares the annual running cost of an electric car against a petrol/diesel car in Cyprus, splitting charging between spare solar production, home grid electricity and public chargers, and reporting yearly savings and payback on the extra purchase cost. Use to compare EV and petrol/diesel running costs. Ask for actual annual distance, vehicle consumption, fuel price, charging shares and tariffs for each active charging source; when solar charging is selected, require available spare solar production. Reuse supplied facts and ask only for missing essentials. Omitted extra purchase cost means no payback estimate.
| Argument | Type | Description |
|---|---|---|
| evOther | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| iceOther | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| evRoadTax | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| fuelPrice* | number | Fuel price in EUR per litre. |
| iceRoadTax | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| iceService | number | Annual servicing cost of the petrol/diesel car, EUR. |
| spareSolar | number |
Compares the Cyprus tax on an employee stock option exercise under the 2025 benefit-in-kind rules (progressive income tax) and the 2026 approved-scheme rules (flat 8% within caps), including the 2x salary annual cap and the €1m rolling 10-year lifetime cap. Use to compare Cyprus tax on an employee's share-option exercise. Require actual annual salary, share count, exercise and market prices, and user-confirmed approved-scheme status before any personalized calculation or call. If status is missing or unclear, ask one concise question first; do not infer it, call with an assumed status, or present option gain, tax, savings, or other personalized option figures before confirmation. Amounts are EUR and per-share prices are EUR/share.
| Argument | Type | Description |
|---|---|---|
| marketPrice* | number | Market price per share at exercise, EUR. |
| exercisePrice* | number | Strike price per share, EUR. |
| numberOfShares* | number | Number of options being exercised. |
| isApprovedScheme* | boolean | Whether the plan has approved-scheme status under 2026 rules; ask the user and use only their explicit confirmation. Never infer or assume this value. |
| annualGrossSalary* | number | Gross annual salary in EUR (sets the marginal band and the 2x annual cap). |
| prior10YearOptionIncome |
Compares a taxable investment (option 1) against a tax-deductible vehicle such as a provident fund or life-insurance savings plan (option 2), matching the true out-of-pocket cost of both and applying entry/exit fees, AUM fees, commission and exit tax. Use to compare taxable investment with a tax-deductible investment vehicle. Require the annual contribution, the user's tax-relief rate and option 2's management fee. Reuse supplied facts and ask only for missing essentials. Disclosed forecast returns and optional omitted fee/tax inputs are modelling assumptions; do not invent personal contribution amounts.
| Argument | Type | Description |
|---|---|---|
| maxYears | integer | Horizon in years (default 30). |
| opt2AumFee* | number | Annual management fee on option 2, percent. |
| opt1ExitFee | number | One-off exit fee on option 1, EUR. |
| opt1ExitTax | number | Tax on option 1 gains at exit, percent. |
| opt2ExitTax | number | Tax on option 2 at exit, percent. |
| opt1EntryFee | number | One-off entry fee on option 1, EUR. |
| netInvestment* | number | Annual GROSS contribution into option 2, EUR. Option 1 receives the equivalent out-of-pocket amount. |
Compares buying a home against renting using actual period mortgage payments and symmetric investment of whichever scenario has lower cash costs. Mortgage contributions stop after payoff; purchase/sale costs, maintenance, rent inflation and investment returns are included. Use only to compare buying a Cyprus home with renting over a stated horizon. Use financial facts stated or confirmed for this scenario. Do not carry values from another chat or scenario into the calculation until the user explicitly confirms the relevant values. Ask for any missing core term: property price, monthly rent, down payment and whether it is EUR or percent, mortgage rate, and mortgage term. If the deposit is given without a unit (for example, '20'), ask whether it means EUR or percent before interpreting, converting, deriving a loan amount, or calling this tool. Never infer the unit from context. Optional growth, inflation and return assumptions require user acceptance when not stated. Mortgage payments end at payoff, and cost differences are invested by the lower-cost side. After calculating, briefly summarize every material modelling default used (including defaults supplied in the call) and costs excluded or treated as zero; use structuredContent.assumptions for defaults and exclusions returned by the API.
| Argument | Type | Description |
|---|---|---|
| legalFees | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| stampDuty | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| agencyFees | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| downPayment* | number | Deposit amount. If the user gives no unit, ask whether it is EUR or a percentage before interpreting or calculating. |
Diffs two saved calculations (inputs and results) field by field. Use for 'compare my mortgage before/after' style questions instead of reconstructing the diff from two loads. Encrypted sides report locked instead of contents.
| Argument | Type | Description |
|---|---|---|
| calculationIdA* | string | First saved calculation id. |
| calculationIdB* | string | Second saved calculation id. |
{
"type": "object",
"required": [
"calculationIdA",
"calculationIdB"
],
"properties": {
"calculationIdA": {
"type": "string",
"format": "uuid",
"description": "First saved calculation id."
},
"calculationIdB": {
"type": "string",
"format": "uuid",
"description": "Second saved calculation id."
}
},
"additionalProperties": false
}Deletes one saved calculation belonging to the authenticated API key's user. Use when the user asks to delete or forget a saved scenario. Works on encrypted saves too.
| Argument | Type | Description |
|---|---|---|
| calculationId* | string | ID returned by list_saved_calculations. |
{
"type": "object",
"required": [
"calculationId"
],
"properties": {
"calculationId": {
"type": "string",
"format": "uuid",
"description": "ID returned by list_saved_calculations."
}
},
"additionalProperties": false
}Returns official Cyprus Social Insurance reference tables for a given year. Use to retrieve official Cyprus social-insurance reference figures for a user-specified calendar year. Reuse a year already given or ask for the missing year; do not assume which tax/reference year applies.
| Argument | Type | Description |
|---|---|---|
| year* | integer | Reference year. |
{
"type": "object",
"required": [
"year"
],
"properties": {
"year": {
"type": "integer",
"minimum": 1981,
"description": "Reference year."
}
},
"additionalProperties": false
}Lists metadata of an authenticated user's saved calculations by calculator type. Use so an agent can help a user find a previously saved scenario before loading it. Never returns encrypted contents.
| Argument | Type | Description |
|---|---|---|
| sort | string | recent = most recently updated first (default), oldest = least recently updated, created_desc/created_asc by creation date, name_asc/name_desc alphabetical. Cursor paging only applies to 'recent'. |
| limit | integer | |
| cursor | string | nextCursor from the previous page, compound <updatedAt>|<id> with an id tie-break so rows sharing updatedAt never skip. Preferred over offset for stable paging (sort: recent only). |
| offset | integer | Rows to skip. Use with limit for page-number paging. |
| calculationType | string | Omit to list saved calculations across every calculator type. |
| calculationTypes | array | Filter by several calculator types at once. Takes precedence over calculationType. |
{
"type": "object",
"required": [],
"properties": {
"sort": {
"enum": [
"recent",
"oldest",
"created_desc",
"created_asc",
"name_asc",
"name_desc"
],
"type": "string",
"title": "Sort order",
"default": "recent",
"description": "recent = most recently updated first (default), oldest = least recently updated, created_desc/created_asc by creation date, name_asc/name_desc alphabetical. Cursor paging only applies to 'recent'."
},
"limit": {
"type": "integer",
"title": "Page size",
"default": 20,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string",
"title": "Cursor",
"description": "nextCursor from the previous page, compound <updatedAt>|<id> with an id tie-break so rows sharing updatedAt never skip. Preferred over offset for stable paging (sort: recent only)."
},
"offset": {
"type": "integer",
"title": "Offset",
"default": 0,
"minimum": 0,
"description": "Rows to skip. Use with limit for page-number paging."
},
"calculationType": {
"enum": [
"income-tax",
"state-pension",
"retirement-planner",
"unemployment-benefit",
"capital-gains",
"investment-comparison"
],
"type": "string",
"title": "Calculator type",
"description": "Omit to list saved calculations across every calculator type."
},
"calculationTypes": {
"type": "array",
"items": {
"enum": [
"income-tax",
"state-pension",
"retirement-planner",
"unemployment-benefit",
"capital-gains",
"investment-comparison"
],
"type": "string"
},
"title": "Calculator types filter",
"description": "Filter by several calculator types at once. Takes precedence over calculationType."
}
},
"additionalProperties": false
}Loads one saved calculation belonging to the authenticated API key's user. Use after list_saved_calculations to retrieve full details of a specific saved scenario. Locked saves return locked: true and no contents.
| Argument | Type | Description |
|---|---|---|
| calculationId* | string | ID returned by list_saved_calculations. |
{
"type": "object",
"required": [
"calculationId"
],
"properties": {
"calculationId": {
"type": "string",
"format": "uuid",
"description": "ID returned by list_saved_calculations."
}
},
"additionalProperties": false
}Optimizes Cyprus LTD company-director remuneration for monetary inputs up to €1,000,000, with a fixed solver evaluation budget. Use for a Cyprus LTD director remuneration comparison. Monetary inputs may not exceed €1,000,000; larger values are rejected before solving. Require company profit/revenue, deductible expenses, tax year and domicile status; reuse supplied data and request missing essentials. The default €2,000 corporate administration cost is a disclosed modelling assumption.
| Argument | Type | Description |
|---|---|---|
| taxYear* | string | Tax/legislation year. Supported: 2025, 2026. |
| isNonDomiciled* | boolean | Non-dom status; exempts dividends from SDC. |
| operatingExpenses* | number | Annual deductible operating expenses in EUR (maximum €1,000,000). |
| corporateGrossProfit* | number | Annual company turnover/revenue in EUR, before operating expenses. Maximum supported value: €1,000,000. |
| annualCorporateAdminCost | number | Annual corporate admin, audit and compliance costs in EUR (Cyprus Companies Law Cap. 113). Defaults to 2000; maximum €1,000,000. |
| directorSalaryAllocation | number | Optional fixed director salary in EUR (maximum €1,000,000); omit to run the bounded solver for the optimal split. |
Turns pasted bank mortgage-statement rows into audit_mortgage_statement inputs. Use to extract supported fields from actual mortgage statement text. Report missing fields and do not create or infer statement rows.
| Argument | Type | Description |
|---|---|---|
| text* | string | Pasted statement lines (date + description + amount per row, optional balance and rate%). |
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "Pasted statement lines (date + description + amount per row, optional balance and rate%)."
}
},
"additionalProperties": false
}Extracts structured contribution history from pasted Cyprus Social Insurance Services pension statement text. Use to extract supported contribution years and units from an actual pasted Cyprus Social Insurance statement. Do not fill gaps or create contribution records; report missing or unreadable details to the caller.
| Argument | Type | Description |
|---|---|---|
| text* | string | Pasted statement text. |
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "Pasted statement text."
}
},
"additionalProperties": false
}Turns pasted broker CSV or ledger text into analyze_portfolio transactions. Use to extract supported transactions from actual pasted broker CSV or ledger text. Require the source text and actual base currency, report missing/unreadable values, and never create transactions or assume EUR. Output rows can be sent to analyze_portfolio.
| Argument | Type | Description |
|---|---|---|
| text* | string | Pasted broker CSV or ledger lines (date + type + amount per row). |
| baseCurrency* | string | Actual base currency used for the parsed portfolio. Required; do not assume EUR. |
{
"type": "object",
"required": [
"text",
"baseCurrency"
],
"properties": {
"text": {
"type": "string",
"minLength": 1,
"description": "Pasted broker CSV or ledger lines (date + type + amount per row)."
},
"baseCurrency": {
"type": "string",
"minLength": 1,
"description": "Actual base currency used for the parsed portfolio. Required; do not assume EUR."
}
},
"additionalProperties": false
}Builds a monthly budget from a list of expenses at any frequency: normalises everything to a monthly basis, tiers each item (T1 fixed essentials, T2 variable essentials, T3 lifestyle, T4 discretionary), and returns disposable income, savings rate, the biggest optimisable leak and a surplus projection. Use to summarize a household's actual monthly net income and expense items. Ask for the actual expense ledger or item amounts; never fabricate expenses. Entries without a frequency are treated as monthly and disclosed. Omitted investment contributions are treated as zero and disclosed.
| Argument | Type | Description |
|---|---|---|
| expenses* | array | Expense items. Known catalogue keys (mortgageRent, groceries, netflix, fuel, ...) are tiered automatically; otherwise pass an explicit tier. |
| projectionYears | integer | Horizon of the surplus projection (default 10). |
| monthlyNetIncome* | number | Take-home monthly income, EUR (net of tax, social insurance and GESY); zero is valid but savings rate is unavailable. |
| targetSavingsRate | number | Savings-rate goal as a percent of net income. |
| monthlyInvestments | number | Recurring monthly investments/savings, EUR. |
| expectedAnnualReturn | number | Assumed annual return on invested surplus, percent (default 0). |
Runs a deterministic projection plus Monte Carlo simulation of a retirement savings plan, aggregating active pension streams before applying personal income tax allowances and the shared GESY ceiling. Use for a retirement savings sustainability or portfolio-longevity projection. Reuse the user's ages, savings, contributions and planned monthly spending; ask for each missing essential input and never use example personal values. Values are EUR, contributions/drawdown are monthly, and ages are years. Supply pensionStreams to include Cyprus or foreign pension income; concurrent streams are aggregated before applying the personal progressive allowance, one foreign-pension allowance and the shared €180,000 GESY ceiling. Foreign pensions use the 2026 flat 5% rate above €5,000 unless a net override is supplied. Omitted state pension means pension income is excluded. Returns, inflation, horizon and simulation count use disclosed modelling assumptions when omitted. Runs without seed are stochastic; a supplied seed makes identical inputs repeatable for the same implementation version.
| Argument | Type | Description |
|---|---|---|
| seed | integer | Optional unsigned 32-bit seed for repeatable runs with identical inputs and implementation versions. Omit to keep the run stochastic. |
| endAge | integer | Planning horizon age (default 90). |
| currentAge* | integer | Age today. |
| simulations | integer | Monte Carlo runs (default 1000). |
| statePension | number | Expected monthly state pension in EUR. |
Saves a calculator scenario to the authenticated user's stored history. Use when the user asks to save, keep or remember a scenario. Stores the inputs unencrypted (with server-computed results) so list/load can return them later.
| Argument | Type | Description |
|---|---|---|
| name | string | Display name for the saved scenario. |
| inputs* | object | Tool-style inputs for the matching calculator (same shape its calculator tool accepts). |
| calculationType* | string | Calculator type to save under. |
{
"type": "object",
"required": [
"calculationType",
"inputs"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"description": "Display name for the saved scenario."
},
"inputs": {
"type": "object",
"description": "Tool-style inputs for the matching calculator (same shape its calculator tool accepts).",
"additionalProperties": true
},
"calculationType": {
"enum": [
"income-tax",
"state-pension",
"retirement-planner",
"unemployment-benefit",
"capital-gains",
"investment-comparison"
],
"type": "string",
"description": "Calculator type to save under."
}
},
"additionalProperties": false
}Simulates a Cyprus unit-linked life insurance policy and calculates tax and returns from executed withdrawals only. Requests above available funds are capped and flagged; self-funded surrender taxes are included in household cash flows and IRR. Use to model withdrawals from an existing Cyprus life-insurance policy. Require actual policy terms, tax rate, historical policy records and future premium/withdrawal projections; ask for missing items and never generate policy history. Amounts requested above available funds are limited to executed proceeds, and tax/return figures follow those executed cash flows. Forecast returns are assumptions and must be identified as such.
| Argument | Type | Description |
|---|---|---|
| age* | integer | Current age of the policyholder. |
| aumFee* | number | Annual management fee as a percent of fund value. |
| gender* | string | Used to look up mortality rates. |
| scenario | string | Which scenario to report as the primary result (default userInput). All three are always returned for comparison. |
| monthlyFee* | number | Fixed policy fee charged each month, EUR. |
| taxBracket* | number | Marginal income tax rate applied to taxable surrender amounts and to premium relief, percent. |
Simulates a Cyprus mortgage with a payment schedule that reconciles paid amounts to principal and interest. Supports fixed then variable periods, monthly overpayments, lump sums and interest-only loans; interest-only minimum payments track the remaining balance, with principal due at maturity. KFIK and cash-collateral configurations are not available through this API. Use only to estimate a Cyprus mortgage payment, amortization, overpayments or rate scenarios. Require the actual loan amount, term, selected fixed-period length and the rate inputs for each phase that applies; never substitute example loan terms or rates. EUR amounts and annual percentage rates are expected. For document checklists or general mortgage information, do not call the calculator; answer or research directly without narrating tool selection.
| Argument | Type | Description |
|---|---|---|
| fixedRate | number | Actual all-in annual fixed rate in percent, required when a fixed period applies. |
| bankMargin | number | Actual bank margin in annual percentage points added to the variable base rate; do not split an all-in rate without confirmation. |
| closureFee | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| upfrontFees | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| mortgageType | string | Repayment structure. Defaults to capital_and_interest. |
| ercPercentage | number |
Renames a saved calculation and/or replaces its inputs (recomputing results). Use when the user asks to rename a save or re-run it with different inputs. Encrypted saves stay locked.
| Argument | Type | Description |
|---|---|---|
| name | string | New display name. |
| inputs | object | Replacement tool-style inputs; results are recomputed server-side. |
| calculationId* | string | ID returned by list_saved_calculations. |
{
"type": "object",
"required": [
"calculationId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"description": "New display name."
},
"inputs": {
"type": "object",
"description": "Replacement tool-style inputs; results are recomputed server-side.",
"additionalProperties": true
},
"calculationId": {
"type": "string",
"format": "uuid",
"description": "ID returned by list_saved_calculations."
}
},
"additionalProperties": false
}| integer |
| Calendar year the property was acquired. |
| isFirstDisposal | boolean | Whether the lifetime first-disposal exemption is being claimed. Omission means no exemption is claimed. |
| acquisitionPrice* | number | Purchase price in the original currency. |
{
"type": "object",
"required": [
"acquisitionPrice",
"acquisitionYear",
"salePrice",
"propertyType"
],
"properties": {
"taxYear": {
"enum": [
"2025",
"2026"
],
"type": "string",
"default": "2026",
"description": "Disposal tax year; defaults to the current 2026 rules and selects year-specific lifetime allowances."
},
"currency": {
"enum": [
"EUR",
"CYP"
],
"type": "string",
"default": "EUR",
"description": "EUR (default) or CYP for pre-2008 purchases (converted at 0.585274)."
},
"agentFees": {
"type": "number",
"minimum": 0,
"description": "Estate agent / legal fees deducted from the sale price, EUR."
},
"salePrice": {
"type": "number",
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero.",
"exclusiveMinimum": 0
},
"propertyType": {
"enum": [
"plot",
"house",
"agricultural",
"other"
],
"type": "string",
"description": "Drives the year-specific lifetime exemption: 2025 general/plot €17,086, qualifying main residence €85,430 and agricultural land €25,629; 2026 general/plot €30,000, qualifying main residence €150,000 and agricultural land €50,000; other €0."
},
"acquisitionYear": {
"type": "integer",
"minimum": 1960,
"description": "Calendar year the property was acquired."
},
"isFirstDisposal": {
"type": "boolean",
"description": "Whether the lifetime first-disposal exemption is being claimed. Omission means no exemption is claimed."
},
"acquisitionPrice": {
"type": "number",
"description": "Purchase price in the original currency.",
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}| salaryIncome* |
| number |
| Gross annual salary in EUR. |
| spouseIncome | number |
| taxesPrepaid | object |
| exemptionType | string | Minds in Cyprus Art. 8(21B), applied only when eligibility conditions are met. |
| isNonDomicile | boolean | Cyprus non-domicile status; exempts rental and deposit-interest SDC where applicable. |
| maritalStatus | string |
| pensionIncome | object |
| propertyPrice | number | Property price for wear-and-tear allowance. |
| providentFund | number | Total provident/PEPP fund contribution in EUR. |
| dividendIncome | number | Annual dividend income in EUR. |
| employmentType* | string | 'private' for private sector (8.8% SI), 'civil' for civil service (4.45% SI), 'self-employed' for sole proprietor (16.6% SI on deemed/actual, 4% GESY). Required; the API does not assume a category. |
| tradeUnionSubs | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| hasRentalIncome | boolean | Whether rental income applies. |
| rentPaidPrimary | number |
| mindsEligibility | object | Facts used to validate Minds in Cyprus Art. 8(21B). Omit or leave incomplete to receive no 8(21B) deduction. |
| hasDividendIncome | boolean | Whether dividend income applies. |
| legislationVersion | string | Tax/legislation year. Supported: 2025, 2026. |
| cryptoTradingIncome | number | Annual taxable cryptoasset trading gains in EUR. From tax year 2026 the amount is taxed at 8% separately from progressive PIT; do not include non-taxable investment disposals. |
| housingInterestPaid | number |
| selfEmployedDetails | object | Sole-proprietor schedule: net profit = turnover − expenses − capitalAllowances − lossBroughtForward (floor 0). |
| homeInsurancePremium | number |
| innovativeInvestment | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| numDependentChildren | integer |
| depositInterestIncome | number | Annual deposit interest in EUR. Standard interest is subject to 17% SDC for Cyprus-domiciled individuals, rather than progressive PIT; GESY still applies. |
| isDividendNonDomicile | boolean | Non-dom status for dividends. |
| energyEfficiencyExpense | number |
| firstEmploymentDeduction | string |
| qualifiesForFirstEmployment | boolean |
{
"type": "object",
"allOf": [
{
"if": {
"required": [
"employmentType"
],
"properties": {
"employmentType": {
"const": "self-employed"
}
}
},
"then": {
"required": [
"selfEmployedDetails"
],
"properties": {
"selfEmployedDetails": {
"required": [
"turnover",
"occupationalCategory"
]
}
}
}
}
],
"required": [
"salaryIncome",
"employmentType"
],
"properties": {
"donations": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"evExpense": {
"type": "number",
"minimum": 0
},
"interestPaid": {
"type": "number",
"minimum": 0,
"description": "Interest paid on rental property."
},
"propertyYear": {
"type": "integer",
"description": "Year the property was acquired."
},
"rentalIncome": {
"type": "number",
"minimum": 0,
"description": "Annual rental income in EUR."
},
"salaryIncome": {
"type": "number",
"minimum": 0,
"description": "Gross annual salary in EUR."
},
"spouseIncome": {
"type": "number",
"minimum": 0
},
"taxesPrepaid": {
"type": "object",
"properties": {
"sdcWithheld": {
"type": "number",
"minimum": 0
},
"gesyWithheld": {
"type": "number",
"minimum": 0
},
"payeWithheld": {
"type": "number",
"minimum": 0
},
"provisionalInstallments": {
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
},
"exemptionType": {
"enum": [
"none",
"article_8_21a",
"article_8_23a",
"article_8_21b_minds_in_cyprus"
],
"type": "string",
"description": "Minds in Cyprus Art. 8(21B), applied only when eligibility conditions are met."
},
"isNonDomicile": {
"type": "boolean",
"description": "Cyprus non-domicile status; exempts rental and deposit-interest SDC where applicable."
},
"maritalStatus": {
"enum": [
"single",
"married",
"cohabiting"
],
"type": "string"
},
"pensionIncome": {
"type": "object",
"properties": {
"cyprusPension": {
"type": "number",
"minimum": 0
},
"foreignPension": {
"type": "number",
"minimum": 0
},
"foreignPensionTaxMethod": {
"enum": [
"flat_5_percent",
"progressive"
],
"type": "string"
}
},
"additionalProperties": false
},
"propertyPrice": {
"type": "number",
"minimum": 0,
"description": "Property price for wear-and-tear allowance."
},
"providentFund": {
"type": "number",
"minimum": 0,
"description": "Total provident/PEPP fund contribution in EUR."
},
"dividendIncome": {
"type": "number",
"minimum": 0,
"description": "Annual dividend income in EUR."
},
"employmentType": {
"enum": [
"private",
"civil",
"self-employed"
],
"type": "string",
"description": "'private' for private sector (8.8% SI), 'civil' for civil service (4.45% SI), 'self-employed' for sole proprietor (16.6% SI on deemed/actual, 4% GESY). Required; the API does not assume a category."
},
"tradeUnionSubs": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"hasRentalIncome": {
"type": "boolean",
"description": "Whether rental income applies."
},
"rentPaidPrimary": {
"type": "number",
"minimum": 0
},
"mindsEligibility": {
"type": "object",
"properties": {
"cyprusStartDate": {
"type": "string",
"format": "date",
"description": "Date the Cyprus employment or business began."
},
"recognizedUniversityDegree": {
"type": "boolean",
"description": "Holds a degree recognized by the Cyprus Council for the Recognition of Higher Education Qualifications."
},
"cyprusTaxResidentInClaimYear": {
"type": "boolean",
"description": "Cyprus tax resident in the claim year; not required for the commencement year."
},
"first12MonthsQualifyingIncome": {
"type": "number",
"minimum": 0,
"description": "Qualifying Cyprus remuneration or business profits in the first 12 months after starting."
},
"nonResidentForPriorSevenYears": {
"type": "boolean",
"description": "Not Cyprus tax resident throughout the seven years before starting."
},
"residentBeforePriorSevenYears": {
"type": "boolean",
"description": "Cyprus tax resident in a year before those seven years."
},
"fullTimeForeignEmploymentMonthsPrior84": {
"type": "number",
"maximum": 84,
"minimum": 0,
"description": "Months of full-time foreign employment during the preceding 84 months."
}
},
"description": "Facts used to validate Minds in Cyprus Art. 8(21B). Omit or leave incomplete to receive no 8(21B) deduction.",
"additionalProperties": false
},
"hasDividendIncome": {
"type": "boolean",
"description": "Whether dividend income applies."
},
"legislationVersion": {
"enum": [
"2025",
"2026"
],
"type": "string",
"description": "Tax/legislation year. Supported: 2025, 2026."
},
"cryptoTradingIncome": {
"type": "number",
"minimum": 0,
"description": "Annual taxable cryptoasset trading gains in EUR. From tax year 2026 the amount is taxed at 8% separately from progressive PIT; do not include non-taxable investment disposals."
},
"housingInterestPaid": {
"type": "number",
"minimum": 0
},
"selfEmployedDetails": {
"type": "object",
"properties": {
"expenses": {
"type": "number",
"minimum": 0
},
"turnover": {
"type": "number",
"minimum": 0
},
"capitalAllowances": {
"type": "number",
"minimum": 0
},
"lossBroughtForward": {
"type": "number",
"minimum": 0
},
"occupationalCategory": {
"type": "string",
"minLength": 1,
"description": "Official year-specific MLSI occupational category driving weekly deemed earnings. Ask for the actual occupation and use the up-to/over-10-years variant where the schedule distinguishes practice duration."
},
"useActualEarningsForSI": {
"type": "boolean",
"description": "Pay SI on actual profit when higher than deemed."
}
},
"description": "Sole-proprietor schedule: net profit = turnover − expenses − capitalAllowances − lossBroughtForward (floor 0).",
"additionalProperties": false
},
"homeInsurancePremium": {
"type": "number",
"minimum": 0
},
"innovativeInvestment": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"numDependentChildren": {
"type": "integer",
"minimum": 0
},
"depositInterestIncome": {
"type": "number",
"minimum": 0,
"description": "Annual deposit interest in EUR. Standard interest is subject to 17% SDC for Cyprus-domiciled individuals, rather than progressive PIT; GESY still applies."
},
"isDividendNonDomicile": {
"type": "boolean",
"description": "Non-dom status for dividends."
},
"energyEfficiencyExpense": {
"type": "number",
"minimum": 0
},
"firstEmploymentDeduction": {
"enum": [
"",
"20",
"50"
],
"type": "string"
},
"qualifiesForFirstEmployment": {
"type": "boolean"
}
},
"additionalProperties": false
}| Actual years with insurance contributions (quick mode); do not infer from age or employment duration. |
| retirementAge* | integer | Planned retirement age. |
| totalInsuranceUnits | number | Actual accumulated Cyprus insurance units/points (quick mode); do not infer from salary or years worked. |
{
"type": "object",
"allOf": [
{
"if": {
"required": [
"mode"
],
"properties": {
"mode": {
"const": "quick"
}
}
},
"then": {
"required": [
"currentAge",
"yearsWorked",
"totalInsuranceUnits"
]
}
},
{
"if": {
"required": [
"mode"
],
"properties": {
"mode": {
"const": "advanced"
}
}
},
"then": {
"required": [
"yearlyUnits"
]
}
}
],
"required": [
"mode",
"retirementAge"
],
"properties": {
"mode": {
"enum": [
"quick",
"advanced"
],
"type": "string",
"description": "Calculation mode."
},
"currentAge": {
"type": "integer",
"maximum": 70,
"minimum": 18,
"description": "Current age (quick mode only)."
},
"dependents": {
"type": "integer",
"maximum": 10,
"minimum": 0,
"description": "Number of dependents (spouse/children); raises the basic pension multiplier."
},
"yearlyUnits": {
"type": [
"array",
"object"
],
"items": {
"type": "object",
"required": [
"year",
"units"
],
"properties": {
"year": {
"type": "integer",
"minimum": 1981,
"description": "Calendar year of the contributions."
},
"units": {
"type": "number",
"maximum": 6,
"minimum": 0,
"description": "Insurance units earned that year."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Advanced mode only. Insurance units earned per calendar year, e.g. [{\"year\":2003,\"units\":5.2}]. Units per year must be between 0 and the statutory maximum for that year (about 5.3-6.0; 6.0 for years after 2026). A legacy object map {\"2003\": 5.2} is also accepted. Years worked and total units are derived from this array, so yearsWorked/totalInsuranceUnits are ignored in advanced mode.",
"patternProperties": {
"^[0-9]{4}$": {
"type": "number",
"maximum": 6,
"minimum": 0
}
},
"additionalProperties": false
},
"yearsWorked": {
"type": "number",
"maximum": 49,
"minimum": 0,
"description": "Actual years with insurance contributions (quick mode); do not infer from age or employment duration."
},
"retirementAge": {
"type": "integer",
"maximum": 67,
"minimum": 63,
"description": "Planned retirement age."
},
"totalInsuranceUnits": {
"type": "number",
"minimum": 0,
"description": "Actual accumulated Cyprus insurance units/points (quick mode); do not infer from salary or years worked."
}
}
}| number |
| Actual gross insurable earnings in EUR for the contribution year selected by applicationDate. |
| registeredUnemployed | boolean | Whether registered unemployed with the competent offices. |
| weeksSinceFirstInsurance | integer | Weeks elapsed since first insurance; at least 26 required. |
| actualBasicInsurancePoints | number | Actual paid basic insurance points accumulated by claim date; 0.5 required for entitlement. |
| capableAndAvailableForWork | boolean | Whether capable of and available for work during the claim. |
| relevantYearInsurancePoints | number | Actual plus assimilated insurance points in the relevant contribution year; at least 0.39 required. |
{
"type": "object",
"required": [
"applicationDate",
"annualGrossEarnings",
"dependentSpouse",
"dependentChildren"
],
"properties": {
"isEmployee": {
"type": "boolean",
"description": "Whether the claimant was insured as an employee rather than self-employed."
},
"applicationDate": {
"type": "string",
"format": "date",
"description": "Actual claim date as YYYY-MM-DD."
},
"dependentSpouse": {
"type": "boolean",
"description": "Whether the claimant has a dependent spouse not in paid work; ask if unknown."
},
"dependentChildren": {
"type": "integer",
"minimum": 0,
"description": "Actual number of dependent children or other dependants; ask if unknown (benefit calculation caps at 3)."
},
"annualGrossEarnings": {
"type": "number",
"minimum": 0,
"description": "Actual gross insurable earnings in EUR for the contribution year selected by applicationDate."
},
"registeredUnemployed": {
"type": "boolean",
"description": "Whether registered unemployed with the competent offices."
},
"weeksSinceFirstInsurance": {
"type": "integer",
"minimum": 0,
"description": "Weeks elapsed since first insurance; at least 26 required."
},
"actualBasicInsurancePoints": {
"type": "number",
"minimum": 0,
"description": "Actual paid basic insurance points accumulated by claim date; 0.5 required for entitlement."
},
"capableAndAvailableForWork": {
"type": "boolean",
"description": "Whether capable of and available for work during the claim."
},
"relevantYearInsurancePoints": {
"type": "number",
"minimum": 0,
"description": "Actual plus assimilated insurance points in the relevant contribution year; at least 0.39 required."
}
},
"additionalProperties": false
}| Spare solar production available for charging, kWh per year. |
| evInsurance | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| extraEvCost | number | Extra purchase cost of the EV versus the petrol/diesel alternative, EUR. |
| iceInsurance | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| iceOilChange | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| evConsumption* | number | EV consumption in Wh per km (e.g. 170). |
| homeGridShare | number | Share of home charging drawn from the grid, percent. |
| annualDistance* | number | Kilometres driven per year. |
| iceConsumption* | number | Petrol/diesel consumption in litres per 100 km. |
| projectionYears | integer | Horizon of the cumulative savings series (default 10). |
| solarDirectShare | number | Share of home charging covered directly by solar, percent. |
| chargingEfficiency | number | Wall-to-battery charging efficiency, percent (default 92). |
| publicChargingPrice | number | Public charging price in EUR per kWh. |
| gridElectricityPrice | number | Home electricity price in EUR per kWh. |
{
"type": "object",
"allOf": [
{
"if": {
"required": [
"homeGridShare"
],
"properties": {
"homeGridShare": {
"exclusiveMinimum": 0
}
}
},
"then": {
"required": [
"gridElectricityPrice"
]
}
},
{
"if": {
"required": [
"solarDirectShare"
],
"properties": {
"solarDirectShare": {
"exclusiveMinimum": 0
}
}
},
"then": {
"required": [
"spareSolar"
]
}
}
],
"required": [
"annualDistance",
"iceConsumption",
"fuelPrice",
"evConsumption"
],
"properties": {
"evOther": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"iceOther": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"evRoadTax": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"fuelPrice": {
"type": "number",
"minimum": 0,
"description": "Fuel price in EUR per litre."
},
"iceRoadTax": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"iceService": {
"type": "number",
"minimum": 0,
"description": "Annual servicing cost of the petrol/diesel car, EUR."
},
"spareSolar": {
"type": "number",
"minimum": 0,
"description": "Spare solar production available for charging, kWh per year."
},
"evInsurance": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"extraEvCost": {
"type": "number",
"minimum": 0,
"description": "Extra purchase cost of the EV versus the petrol/diesel alternative, EUR."
},
"iceInsurance": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"iceOilChange": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"evConsumption": {
"type": "number",
"description": "EV consumption in Wh per km (e.g. 170).",
"exclusiveMinimum": 0
},
"homeGridShare": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Share of home charging drawn from the grid, percent."
},
"annualDistance": {
"type": "number",
"description": "Kilometres driven per year.",
"exclusiveMinimum": 0
},
"iceConsumption": {
"type": "number",
"minimum": 0,
"description": "Petrol/diesel consumption in litres per 100 km."
},
"projectionYears": {
"type": "integer",
"default": 10,
"maximum": 30,
"minimum": 1,
"description": "Horizon of the cumulative savings series (default 10)."
},
"solarDirectShare": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Share of home charging covered directly by solar, percent."
},
"chargingEfficiency": {
"type": "number",
"default": 92,
"maximum": 100,
"minimum": 1,
"description": "Wall-to-battery charging efficiency, percent (default 92)."
},
"publicChargingPrice": {
"type": "number",
"minimum": 0,
"description": "Public charging price in EUR per kWh."
},
"gridElectricityPrice": {
"type": "number",
"minimum": 0,
"description": "Home electricity price in EUR per kWh."
}
},
"additionalProperties": false
}| number |
| Option income already used against the €1m rolling 10-year cap, EUR. |
{
"type": "object",
"required": [
"annualGrossSalary",
"numberOfShares",
"exercisePrice",
"marketPrice",
"isApprovedScheme"
],
"properties": {
"marketPrice": {
"type": "number",
"description": "Market price per share at exercise, EUR.",
"exclusiveMinimum": 0
},
"exercisePrice": {
"type": "number",
"minimum": 0,
"description": "Strike price per share, EUR."
},
"numberOfShares": {
"type": "number",
"description": "Number of options being exercised.",
"exclusiveMinimum": 0
},
"isApprovedScheme": {
"type": "boolean",
"description": "Whether the plan has approved-scheme status under 2026 rules; ask the user and use only their explicit confirmation. Never infer or assume this value."
},
"annualGrossSalary": {
"type": "number",
"minimum": 0,
"description": "Gross annual salary in EUR (sets the marginal band and the 2x annual cap)."
},
"prior10YearOptionIncome": {
"type": "number",
"minimum": 0,
"description": "Option income already used against the €1m rolling 10-year cap, EUR."
}
},
"additionalProperties": false
}| opt1MonthlyFee | number | Fixed monthly fee on option 1, EUR. |
| opt2Commission | number | Percent of the FIRST year's contributions taken as commission. |
| opt2MonthlyFee | number | Fixed monthly fee on option 2, EUR. |
| opt1AnnualReturn | number | Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. |
| opt2AnnualReturn | number | Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. |
| taxDeductionRate* | number | User's marginal tax relief on option 2 contributions, percent. |
| opt2AdditionalFee | number | Additional annual fee on option 2, percent. |
{
"type": "object",
"required": [
"netInvestment",
"taxDeductionRate",
"opt2AumFee"
],
"properties": {
"maxYears": {
"type": "integer",
"default": 30,
"maximum": 60,
"minimum": 1,
"description": "Horizon in years (default 30)."
},
"opt2AumFee": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Annual management fee on option 2, percent."
},
"opt1ExitFee": {
"type": "number",
"minimum": 0,
"description": "One-off exit fee on option 1, EUR."
},
"opt1ExitTax": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Tax on option 1 gains at exit, percent."
},
"opt2ExitTax": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Tax on option 2 at exit, percent."
},
"opt1EntryFee": {
"type": "number",
"minimum": 0,
"description": "One-off entry fee on option 1, EUR."
},
"netInvestment": {
"type": "number",
"description": "Annual GROSS contribution into option 2, EUR. Option 1 receives the equivalent out-of-pocket amount.",
"exclusiveMinimum": 0
},
"opt1MonthlyFee": {
"type": "number",
"minimum": 0,
"description": "Fixed monthly fee on option 1, EUR."
},
"opt2Commission": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Percent of the FIRST year's contributions taken as commission."
},
"opt2MonthlyFee": {
"type": "number",
"minimum": 0,
"description": "Fixed monthly fee on option 2, EUR."
},
"opt1AnnualReturn": {
"type": "number",
"default": 5,
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default."
},
"opt2AnnualReturn": {
"type": "number",
"default": 5,
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default."
},
"taxDeductionRate": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "User's marginal tax relief on option 2 contributions, percent."
},
"opt2AdditionalFee": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Additional annual fee on option 2, percent."
}
},
"additionalProperties": false
}| monthlyRent* | number | Current monthly rent, EUR. |
| transferFees | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| homeInsurance | number | Annual home insurance, EUR. |
| propertyPrice* | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| rentFurniture | number | One-off furnishing cost when renting, EUR. |
| agentCommission | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| maintenanceFixed | number | Annual maintenance in EUR when not using the percentage. |
| fittingsFurniture | number | One-off furnishing cost when buying, EUR. |
| localAuthorityTax | number | Annual local authority tax, EUR. |
| mortgageTermYears* | integer | Mortgage term in years. |
| propertyTaxYearly | number | Annual property tax, EUR. |
| transferTaxOnSale | number | Assumed transfer tax on exit, percent (default 0%). |
| commonAreaExpenses | number | Monthly communal charges when renting, EUR. |
| rentYearlyIncrease | number | Assumed annual rent increase, percent (default 2). |
| analysisPeriodYears | integer | Comparison horizon in years (default 30). |
| salesCommissionRate | number | Assumed selling commission on exit, percent (default 5%). |
| generalInflationRate | number | Assumed annual inflation, percent (default 2). |
| investmentReturnRate | number | Assumed annual investment return, percent (default 5). |
| mortgageInterestRate* | number | Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. |
| maintenancePercentage | number | Annual maintenance as a percent of property value (model default 1%). |
| securityDepositMonths | number | Deposit expressed in months of rent. |
| downPaymentIsPercentage* | boolean | True only when the user explicitly confirms the deposit is a percentage; false only when they explicitly confirm it is EUR. Ask if unclear; never infer. |
| propertyAppreciationRate | number | Assumed annual property appreciation, percent (default 3). |
| useMaintenancePercentage | boolean | Use the percentage instead of the fixed maintenance figure (default true). |
{
"type": "object",
"required": [
"propertyPrice",
"monthlyRent",
"downPayment",
"downPaymentIsPercentage",
"mortgageInterestRate",
"mortgageTermYears"
],
"properties": {
"legalFees": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"stampDuty": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"agencyFees": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"downPayment": {
"type": "number",
"minimum": 0,
"description": "Deposit amount. If the user gives no unit, ask whether it is EUR or a percentage before interpreting or calculating."
},
"monthlyRent": {
"type": "number",
"description": "Current monthly rent, EUR.",
"exclusiveMinimum": 0
},
"transferFees": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"homeInsurance": {
"type": "number",
"minimum": 0,
"description": "Annual home insurance, EUR."
},
"propertyPrice": {
"type": "number",
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero.",
"exclusiveMinimum": 0
},
"rentFurniture": {
"type": "number",
"minimum": 0,
"description": "One-off furnishing cost when renting, EUR."
},
"agentCommission": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"maintenanceFixed": {
"type": "number",
"minimum": 0,
"description": "Annual maintenance in EUR when not using the percentage."
},
"fittingsFurniture": {
"type": "number",
"minimum": 0,
"description": "One-off furnishing cost when buying, EUR."
},
"localAuthorityTax": {
"type": "number",
"minimum": 0,
"description": "Annual local authority tax, EUR."
},
"mortgageTermYears": {
"type": "integer",
"maximum": 40,
"minimum": 1,
"description": "Mortgage term in years."
},
"propertyTaxYearly": {
"type": "number",
"minimum": 0,
"description": "Annual property tax, EUR."
},
"transferTaxOnSale": {
"type": "number",
"default": 0,
"minimum": 0,
"description": "Assumed transfer tax on exit, percent (default 0%)."
},
"commonAreaExpenses": {
"type": "number",
"minimum": 0,
"description": "Monthly communal charges when renting, EUR."
},
"rentYearlyIncrease": {
"type": "number",
"default": 2,
"minimum": 0,
"description": "Assumed annual rent increase, percent (default 2)."
},
"analysisPeriodYears": {
"type": "integer",
"default": 30,
"maximum": 50,
"minimum": 1,
"description": "Comparison horizon in years (default 30)."
},
"salesCommissionRate": {
"type": "number",
"default": 5,
"minimum": 0,
"description": "Assumed selling commission on exit, percent (default 5%)."
},
"generalInflationRate": {
"type": "number",
"default": 2,
"description": "Assumed annual inflation, percent (default 2)."
},
"investmentReturnRate": {
"type": "number",
"default": 5,
"description": "Assumed annual investment return, percent (default 5)."
},
"mortgageInterestRate": {
"type": "number",
"maximum": 25,
"minimum": 0,
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default."
},
"maintenancePercentage": {
"type": "number",
"default": 1,
"minimum": 0,
"description": "Annual maintenance as a percent of property value (model default 1%)."
},
"securityDepositMonths": {
"type": "number",
"minimum": 0,
"description": "Deposit expressed in months of rent."
},
"downPaymentIsPercentage": {
"type": "boolean",
"description": "True only when the user explicitly confirms the deposit is a percentage; false only when they explicitly confirm it is EUR. Ask if unclear; never infer."
},
"propertyAppreciationRate": {
"type": "number",
"default": 3,
"description": "Assumed annual property appreciation, percent (default 3)."
},
"useMaintenancePercentage": {
"type": "boolean",
"default": true,
"description": "Use the percentage instead of the fixed maintenance figure (default true)."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"corporateGrossProfit",
"operatingExpenses",
"taxYear",
"isNonDomiciled"
],
"properties": {
"taxYear": {
"enum": [
"2025",
"2026"
],
"type": "string",
"description": "Tax/legislation year. Supported: 2025, 2026."
},
"isNonDomiciled": {
"type": "boolean",
"description": "Non-dom status; exempts dividends from SDC."
},
"operatingExpenses": {
"type": "number",
"maximum": 1000000,
"minimum": 0,
"description": "Annual deductible operating expenses in EUR (maximum €1,000,000)."
},
"corporateGrossProfit": {
"type": "number",
"maximum": 1000000,
"minimum": 0,
"description": "Annual company turnover/revenue in EUR, before operating expenses. Maximum supported value: €1,000,000."
},
"annualCorporateAdminCost": {
"type": "number",
"default": 2000,
"maximum": 1000000,
"minimum": 0,
"description": "Annual corporate admin, audit and compliance costs in EUR (Cyprus Companies Law Cap. 113). Defaults to 2000; maximum €1,000,000."
},
"directorSalaryAllocation": {
"type": "number",
"maximum": 1000000,
"minimum": 0,
"description": "Optional fixed director salary in EUR (maximum €1,000,000); omit to run the bounded solver for the optimal split."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"monthlyNetIncome",
"expenses"
],
"properties": {
"expenses": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"amount"
],
"properties": {
"key": {
"type": "string",
"description": "Catalogue key or free-form label."
},
"tier": {
"enum": [
"T1",
"T2",
"T3",
"T4"
],
"type": "string",
"description": "Override the automatic tier."
},
"amount": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"category": {
"type": "string",
"description": "Optional grouping label (housing, transportation, ...)."
},
"frequency": {
"enum": [
"monthly",
"weekly",
"quarterly",
"semiannual",
"yearly",
"oneoff"
],
"type": "string",
"default": "monthly",
"description": "Payment frequency; everything is normalised to monthly. Default monthly."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Expense items. Known catalogue keys (mortgageRent, groceries, netflix, fuel, ...) are tiered automatically; otherwise pass an explicit tier."
},
"projectionYears": {
"type": "integer",
"default": 10,
"maximum": 40,
"minimum": 1,
"description": "Horizon of the surplus projection (default 10)."
},
"monthlyNetIncome": {
"type": "number",
"minimum": 0,
"description": "Take-home monthly income, EUR (net of tax, social insurance and GESY); zero is valid but savings rate is unavailable."
},
"targetSavingsRate": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Savings-rate goal as a percent of net income."
},
"monthlyInvestments": {
"type": "number",
"minimum": 0,
"description": "Recurring monthly investments/savings, EUR."
},
"expectedAnnualReturn": {
"type": "number",
"default": 0,
"description": "Assumed annual return on invested surplus, percent (default 0)."
}
}
}| inflationRate |
| number |
| Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. |
| retirementAge* | integer | Planned retirement age. |
| currentSavings* | number | Current investable savings balance in EUR. |
| pensionStreams | array | Optional annual pension streams that offset retirement drawdown. Concurrent streams are aggregated before applying progressive tax, the single 2026 foreign-pension €5,000 allowance, and the shared personal GESY ceiling. A supplied netAnnualOverride is treated as already net and is used as-is. |
| monthlyDrawdown* | number | Planned monthly withdrawal in retirement in EUR. |
| monthlyContribution* | number | Monthly contribution until retirement in EUR. |
| expectedAnnualReturn | number | Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. |
| expectedAnnualReturnRetirement | number | Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. |
{
"type": "object",
"required": [
"currentAge",
"retirementAge",
"currentSavings",
"monthlyContribution",
"monthlyDrawdown"
],
"properties": {
"seed": {
"type": "integer",
"maximum": 4294967295,
"minimum": 0,
"description": "Optional unsigned 32-bit seed for repeatable runs with identical inputs and implementation versions. Omit to keep the run stochastic."
},
"endAge": {
"type": "integer",
"default": 90,
"description": "Planning horizon age (default 90)."
},
"currentAge": {
"type": "integer",
"minimum": 18,
"description": "Age today."
},
"simulations": {
"type": "integer",
"default": 1000,
"maximum": 5000,
"minimum": 100,
"description": "Monte Carlo runs (default 1000)."
},
"statePension": {
"type": "number",
"minimum": 0,
"description": "Expected monthly state pension in EUR."
},
"inflationRate": {
"type": "number",
"default": 2.5,
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default."
},
"retirementAge": {
"type": "integer",
"minimum": 18,
"description": "Planned retirement age."
},
"currentSavings": {
"type": "number",
"minimum": 0,
"description": "Current investable savings balance in EUR."
},
"pensionStreams": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"kind",
"startAge",
"currency",
"fxRateToEur",
"grossAnnual"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"cyprus",
"foreign"
],
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string"
},
"startAge": {
"type": "number",
"minimum": 0
},
"fxRateToEur": {
"type": "number",
"exclusiveMinimum": 0
},
"grossAnnual": {
"type": "number",
"minimum": 0
},
"netAnnualOverride": {
"type": [
"number",
"null"
],
"minimum": 0
}
},
"additionalProperties": false
},
"description": "Optional annual pension streams that offset retirement drawdown. Concurrent streams are aggregated before applying progressive tax, the single 2026 foreign-pension €5,000 allowance, and the shared personal GESY ceiling. A supplied netAnnualOverride is treated as already net and is used as-is."
},
"monthlyDrawdown": {
"type": "number",
"description": "Planned monthly withdrawal in retirement in EUR."
},
"monthlyContribution": {
"type": "number",
"description": "Monthly contribution until retirement in EUR."
},
"expectedAnnualReturn": {
"type": "number",
"default": 6,
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default."
},
"expectedAnnualReturnRetirement": {
"type": "number",
"default": 4,
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default."
}
},
"additionalProperties": false
}| projections* |
| array |
| Future years to simulate. |
| historicalData* | array | Actual policy history; the last entry's endingBalance is the simulation's opening balance, and the 3/4-year lookbacks drive the safe limit. |
| brokerReturnRate | number | Annual return of the broker account, percent (used with useDifferentBrokerReturn). |
| investmentReturn* | number | Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. Expected annual return inside the policy. |
| capitalSumInsured* | number | Death benefit / sum insured, EUR. Mortality cost applies to the amount at risk above the fund value. |
| contractStartYear* | integer | Calendar year the policy started. Partial surrenders are only tax-free from the 4th policy year. |
| reinvestWithdrawals | boolean | When true, net withdrawals are reinvested in a broker account and IRR is computed on combined wealth. |
| useDifferentBrokerReturn | boolean | Use brokerReturnRate instead of investmentReturn for the broker account. |
{
"type": "object",
"required": [
"contractStartYear",
"age",
"gender",
"capitalSumInsured",
"aumFee",
"monthlyFee",
"investmentReturn",
"taxBracket",
"historicalData",
"projections"
],
"properties": {
"age": {
"type": "integer",
"maximum": 90,
"minimum": 18,
"description": "Current age of the policyholder."
},
"aumFee": {
"type": "number",
"maximum": 10,
"minimum": 0,
"description": "Annual management fee as a percent of fund value."
},
"gender": {
"enum": [
"male",
"female"
],
"type": "string",
"description": "Used to look up mortality rates."
},
"scenario": {
"enum": [
"maxTaxFree",
"userInput",
"noWithdrawals"
],
"type": "string",
"description": "Which scenario to report as the primary result (default userInput). All three are always returned for comparison."
},
"monthlyFee": {
"type": "number",
"minimum": 0,
"description": "Fixed policy fee charged each month, EUR."
},
"taxBracket": {
"type": "number",
"maximum": 60,
"minimum": 0,
"description": "Marginal income tax rate applied to taxable surrender amounts and to premium relief, percent."
},
"projections": {
"type": "array",
"items": {
"type": "object",
"required": [
"year",
"monthlyPremium"
],
"properties": {
"year": {
"type": "integer"
},
"isSelfFunded": {
"type": "boolean",
"description": "Premium funded by withdrawing from the policy itself; costs a 5% spread each month."
},
"monthlyPremium": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"plannedWithdrawal": {
"type": "number",
"minimum": 0,
"description": "Withdrawal to attempt in this year (userInput scenario only)."
}
}
},
"maxItems": 60,
"minItems": 1,
"description": "Future years to simulate."
},
"historicalData": {
"type": "array",
"items": {
"type": "object",
"required": [
"year",
"endingBalance",
"premiumsPaid",
"withdrawalsMade"
],
"properties": {
"year": {
"type": "integer"
},
"premiumsPaid": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"endingBalance": {
"type": "number",
"minimum": 0,
"description": "Fund value at 31 December, EUR."
},
"withdrawalsMade": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "Actual policy history; the last entry's endingBalance is the simulation's opening balance, and the 3/4-year lookbacks drive the safe limit."
},
"brokerReturnRate": {
"type": "number",
"description": "Annual return of the broker account, percent (used with useDifferentBrokerReturn)."
},
"investmentReturn": {
"type": "number",
"description": "Annual percentage value (e.g. 2.5 for 2.5%). Supply the actual rate unless the user accepts a stated modelling default. Expected annual return inside the policy."
},
"capitalSumInsured": {
"type": "number",
"minimum": 0,
"description": "Death benefit / sum insured, EUR. Mortality cost applies to the amount at risk above the fund value."
},
"contractStartYear": {
"type": "integer",
"description": "Calendar year the policy started. Partial surrenders are only tax-free from the 4th policy year."
},
"reinvestWithdrawals": {
"type": "boolean",
"description": "When true, net withdrawals are reinvested in a broker account and IRR is computed on combined wealth."
},
"useDifferentBrokerReturn": {
"type": "boolean",
"description": "Use brokerReturnRate instead of investmentReturn for the broker account."
}
}
}| Early repayment charge, percent of the balance. |
| ercPeriodYears | integer | Years the early repayment charge applies. |
| mortgageAmount* | number | EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero. |
| feesAddedToLoan | boolean | Whether upfront fees are capitalised into the loan. |
| loanPeriodYears* | integer | Loan term in years. |
| fixedPeriodYears* | integer | Actual number of years at the fixed rate before variable pricing (0 means fully variable); ask if unknown. |
| variableBaseRate | number | Actual annual reference rate (such as ECB or Euribor) in percent, for the variable phase. |
| monthlyOverpayment | number | Extra amount paid each month, EUR. |
| lumpSumOverpayments | array | One-off overpayments. |
| overpaymentPeriodType | string | When overpayments are made across the term. |
| overpaymentYearsCount | integer | Number of years overpayments run when period type is first/last. |
{
"type": "object",
"required": [
"mortgageAmount",
"loanPeriodYears",
"fixedPeriodYears"
],
"properties": {
"fixedRate": {
"type": "number",
"maximum": 25,
"minimum": 0,
"description": "Actual all-in annual fixed rate in percent, required when a fixed period applies."
},
"bankMargin": {
"type": "number",
"maximum": 25,
"minimum": 0,
"description": "Actual bank margin in annual percentage points added to the variable base rate; do not split an all-in rate without confirmation."
},
"closureFee": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"upfrontFees": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
},
"mortgageType": {
"enum": [
"capital_and_interest",
"interest_only"
],
"type": "string",
"default": "capital_and_interest",
"description": "Repayment structure. Defaults to capital_and_interest."
},
"ercPercentage": {
"type": "number",
"minimum": 0,
"description": "Early repayment charge, percent of the balance."
},
"ercPeriodYears": {
"type": "integer",
"minimum": 0,
"description": "Years the early repayment charge applies."
},
"mortgageAmount": {
"type": "number",
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero.",
"exclusiveMinimum": 0
},
"feesAddedToLoan": {
"type": "boolean",
"description": "Whether upfront fees are capitalised into the loan."
},
"loanPeriodYears": {
"type": "integer",
"maximum": 40,
"minimum": 1,
"description": "Loan term in years."
},
"fixedPeriodYears": {
"type": "integer",
"minimum": 0,
"description": "Actual number of years at the fixed rate before variable pricing (0 means fully variable); ask if unknown."
},
"variableBaseRate": {
"type": "number",
"maximum": 25,
"minimum": 0,
"description": "Actual annual reference rate (such as ECB or Euribor) in percent, for the variable phase."
},
"monthlyOverpayment": {
"type": "number",
"minimum": 0,
"description": "Extra amount paid each month, EUR."
},
"lumpSumOverpayments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": 1,
"description": "Month number from the start of the loan."
},
"amount": {
"type": "number",
"minimum": 0,
"description": "EUR amount. Supply the actual value when applicable; use 0 only when confirmed to be zero."
}
}
},
"description": "One-off overpayments."
},
"overpaymentPeriodType": {
"enum": [
"full",
"first",
"last"
],
"type": "string",
"description": "When overpayments are made across the term."
},
"overpaymentYearsCount": {
"type": "integer",
"minimum": 0,
"description": "Number of years overpayments run when period type is first/last."
}
},
"additionalProperties": false
}