bayesline.api.equity.PortfolioHoldingsReportSettings

model PortfolioHoldingsReportSettings

Settings for a portfolio holdings report.

Fields

Field	Type	Required	Default
calendar	CalendarSettings	No	factory
currency	str	Yes
date_aggregation	Literal[‘last’]	No	'last'
forward_fill	bool	No	True
portfolio_hierarchy_settings	PortfolioHierarchySettings	Yes
report_type	Literal[‘portfolio_holdings’]	No	'portfolio_holdings'
unpack	bool	No	True

Validators

Validator	Mode	Fields
validate_forward_fill	after	forward_fill
validate_unpack	after	unpack

field calendar: CalendarSettings [Optional]

field currency: str [Required]

field date_aggregation: Literal['last'] [Optional]

field forward_fill: bool [Optional]

Compatibility flag retained for existing clients. Holdings are always forward-filled on demand, so False is rejected.

Validated by:

validate_forward_fill

field portfolio_hierarchy_settings: PortfolioHierarchySettings [Required]

field report_type: Literal['portfolio_holdings'] [Optional]

Report type discriminator

field unpack: bool [Optional]

Compatibility flag for legacy report clients. Portfolio holdings reports are always unpacked, so False is rejected.

Validated by:

validate_unpack

validator validate_forward_fill(mode=after)

Validates:

forward_fill

validator validate_unpack(mode=after)

Validates:

unpack