SimulateInput

Inputs accepted by simulate.

series — series identifier; see SeriesCode.
subscriptionDate — the ISO-8601 date the certificate was subscribed. Must be on or after the series’ subscriptionStartDate.
units — principal in EUR (1 unit = €1). Must respect the series’ [minUnits, maxUnits] window.
asOfDate — optional ISO-8601 date the simulation should report against; defaults to today (UTC).
includeSchedule — when true, populates SimulateResult.schedule with one row per completed quarter. Defaults to false.
irsRate — optional override for the IRS withholding rate applied at each capitalization (e.g. 0.28 for 28%). Defaults to the series’ defaultIrsRate.

Properties

readonly optional asOfDate?: string;

readonly optional includeSchedule?: boolean;

readonly optional irsRate?: number;

readonly series: SeriesCode;

readonly subscriptionDate: string;

readonly units: number;