Skip to content

PortfolioResult

This content is not available in your language yet.

Defined in: types/domain.ts:361

Result returned by simulatePortfolio.

Portfolio totals are built by summing cent-quantized cohort fields, so each total* field reconciles byte-for-byte with the corresponding sum across cohorts.

readonly allMatured: boolean;

Defined in: types/domain.ts:370


readonly anyMatured: boolean;

Defined in: types/domain.ts:371


readonly asOfDate: string;

Defined in: types/domain.ts:362


readonly bySeries: readonly PortfolioSeriesBreakdown[];

Defined in: types/domain.ts:372


readonly cohorts: readonly SimulateResult[];

Defined in: types/domain.ts:373


readonly totalAccruedGross: string;

Defined in: types/domain.ts:369


readonly totalInterestGross: string;

Defined in: types/domain.ts:366


readonly totalInterestNet: string;

Defined in: types/domain.ts:367


readonly totalIrsWithheld: string;

Defined in: types/domain.ts:368


readonly totalUnits: number;

Defined in: types/domain.ts:363


readonly totalValueGross: string;

Defined in: types/domain.ts:364


readonly totalValueNet: string;

Defined in: types/domain.ts:365