template Instrument

This template models a physically settled Dividend option. The holder gets to choose to receive the dividend in cash or in a different form (in shares and/or in a foreign currency).

Signatory: depository, issuer

Field Type Description
depository Party The depository of the instrument.
issuer Party The issuer of the instrument.
id Id An identifier of the instrument.
version Text The instrument’s version.
holdingStandard HoldingStandard The holding standard for holdings referencing this instrument.
description Text A description of the instrument.
expiryDate Date The expiry date of the option.
cashQuantity InstrumentQuantity Dividend paid in cash
sharesQuantity Optional InstrumentQuantity Dividend paid in shares (if applicable)
fxQuantity Optional InstrumentQuantity Dividend paid in a foreign currency (if applicable)
observers PartiesMap The observers of the instrument.
lastEventTimestamp Time (Market) time of the last recorded lifecycle event. If no event has occurred yet, the time of creation should be used.
prevEvents [EventData] A list of previous elections that have been lifecycled on this instrument so far.

Data Types

type T

= Instrument

Type synonym for Instrument.