Actuarial present value
calculate_actuarial_pvActuarial present value engine. Discount expected cash flows with mortality, survival, and risk adjustment for insurance and benefit obligations, generalising IFRS 17 (fulfilment cash flows), IAS 19 (employee benefits), IFRS 2 (share-based payments), and IAS 37 (provisions). Use this for regulated IFRS/HKFRS obligations only; it does NOT do generic project or scenario probability weighting (use calculate_expected_value). Methods: ifrs17_gmm: cash_flows, discount_rate, risk_adjustment; ifrs17_paa: premiums, claims_cash, acquisition_cash_flows, coverage_periods; ifrs17_vfa: cash_flows, discount_rate, underlying_items_return, risk_adjustment; ias19_puc: projected_benefits, discount_rate, attribution_years; ias37_provision: outcomes, probabilities, discount_rate, periods. Supply exactly one method with its declared inputs (no defaults). An unknown method, a missing input, or an extra field returns an error envelope (code INVALID_ARGUMENT) instead of raising.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | Yes | Formula to apply; the tool description lists the exact inputs each value requires. | |
| periods | No | Number of periods n (>=1). | |
| outcomes | No | Outcome values aligned with probabilities. | |
| premiums | No | Premiums in reporting currency. | |
| cash_flows | No | Projected cash flows in reporting currency, indexed t=1..n. | |
| claims_cash | No | Expected claims in reporting currency. | |
| discount_rate | No | Discount rate as a decimal (0.10 = 10%); pre-tax when method=viu_pre_tax. | |
| probabilities | No | Cumulative success probability per period in [0,1], aligned with cash_flows. | |
| risk_adjustment | No | Explicit risk adjustment for non-financial risk. | |
| coverage_periods | No | Coverage periods for the PAA (>=1). | |
| attribution_years | No | Years of service for attribution (>=1). | |
| projected_benefits | No | Projected benefits per service year. | |
| acquisition_cash_flows | No | Acquisition cash flows in reporting currency. | |
| underlying_items_return | No | Return on underlying items (decimal). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Error detail, present only when status='error'. | |
| steps | No | Ordered computation steps, when the method reports them. | |
| value | No | Primary result: a number for scalar methods, an object for valuation methods. | |
| method | No | Method or tool name that produced the result. | |
| status | Yes | 'ok' on success, 'error' on failure. | |
| ticker | No | Ticker the result pertains to, when applicable. | |
| assumptions | No | Inputs and assumptions used, echoed for traceability. | |
| formula_ref | No | Formula or standards reference for the method. | |
| data_timestamp | No | ISO-8601 UTC timestamp of the underlying data, when fetched. |