Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 3.08 KB

EquitySwap.md

File metadata and controls

28 lines (18 loc) · 3.08 KB

EquitySwap

LUSID representation of an Equity Swap. This instrument has multiple legs, to see how legs are used in LUSID see knowledge base article KA-02252. | Leg Index | Leg Identifier | Description | | --------- | -------------- | ----------- | | 1 | EquityLeg | Cash flows relating to the performance of the underlying equity. | | 2 | FundingLeg | The funding leg of the swap. | | 3 | EquityDividendLeg | Cash flows relating to dividend payments on the underlying equity (optional). | | 4 | AdditionalPayments | Cash flows relating to any additional payments (optional). |

Properties

Name Type Description Notes
startDate OffsetDateTime The start date of the EquitySwap.
maturityDate OffsetDateTime The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.
code String The code of the underlying.
equityFlowConventions FlowConventions
fundingLeg InstrumentLeg
includeDividends Boolean Dividend inclusion flag, if true dividends are included in the equity leg (total return).
initialPrice java.math.BigDecimal The initial equity price of the Equity Swap.
notionalReset Boolean Notional reset flag, if true the notional of the funding leg is reset at the start of every coupon to match the value of the equity leg (equity price at start of coupon times quantity).
quantity java.math.BigDecimal The quantity or number of shares in the Equity Swap.
underlyingIdentifier String External market codes and identifiers for the EquitySwap, e.g. RIC. Supported string (enumeration) values are: [LusidInstrumentId, Isin, Sedol, Cusip, ClientInternal, Figi, RIC, QuotePermId, REDCode, BBGId, ICECode].
equitySwapDividendPaymentTiming String Determines how the payment of dividends is handled for the equity swap. Defaults to paying at the next Equity coupon date. Supported string (enumeration) values are: [PayAtNextEquityCouponDate, PayAtMaturityOfSwap, PayAtNextFundingLegCouponDate, PayAtPaymentDateOfDividendEvent]. [optional]
additionalPayments List<AdditionalPayment> Optional additional payments at a given date e.g. to level off an uneven equity swap. The dates must be distinct and either all payments are Pay or all payments are Receive. [optional]

Back to Model listBack to API listBack to README