Accumulation dividend More...

Inheritance diagram for Lusid.Sdk.Model.AccumulationEvent:

[legend]

Public Member Functions
	AccumulationEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), string dividendCurrency=default(string), decimal dividendRate=default(decimal), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the AccumulationEvent class. More...

override string	ToString ()
	Returns the string presentation of the object More...

override string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (AccumulationEvent input)
	Returns true if AccumulationEvent instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Public Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
	InstrumentEvent (InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the InstrumentEvent class. More...

override string	ToString ()
	Returns the string presentation of the object More...

override bool	Equals (object input)
	Returns true if objects are equal More...

bool	Equals (InstrumentEvent input)
	Returns true if InstrumentEvent instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	AccumulationEvent ()
	Initializes a new instance of the AccumulationEvent class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Protected Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
	InstrumentEvent ()
	Initializes a new instance of the InstrumentEvent class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
DateTimeOffset?	AnnouncementDate `[get, set]`
	Date on which the dividend was announced / declared. More...

string	DividendCurrency `[get, set]`
	Payment currency More...

decimal	DividendRate `[get, set]`
	Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05 More...

DateTimeOffset	ExDate `[get, set]`
	The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. More...

DateTimeOffset	PaymentDate `[get, set]`
	The date the company pays out dividends to shareholders. More...

Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum	InstrumentEventType `[get, set]`
	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.InstrumentEvent
enum class	InstrumentEventTypeEnum { TransitionEvent = 1 , InformationalEvent = 2 , OpenEvent = 3 , CloseEvent = 4 , StockSplitEvent = 5 , BondDefaultEvent = 6 , CashDividendEvent = 7 , AmortisationEvent = 8 , CashFlowEvent = 9 , ExerciseEvent = 10 , ResetEvent = 11 , TriggerEvent = 12 , RawVendorEvent = 13 , InformationalErrorEvent = 14 , BondCouponEvent = 15 , DividendReinvestmentEvent = 16 , AccumulationEvent = 17 , BondPrincipalEvent = 18 , DividendOptionEvent = 19 , MaturityEvent = 20 , FxForwardSettlementEvent = 21 , ExpiryEvent = 22 , ScripDividendEvent = 23 , StockDividendEvent = 24 , ReverseStockSplitEvent = 25 }
	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent More...

Detailed Description

Accumulation dividend

Constructor & Destructor Documentation

◆ AccumulationEvent() [1/2]

Lusid.Sdk.Model.AccumulationEvent.AccumulationEvent ( )

inlineprotected

Initializes a new instance of the AccumulationEvent class.

◆ AccumulationEvent() [2/2]

Lusid.Sdk.Model.AccumulationEvent.AccumulationEvent	(	DateTimeOffset?	announcementDate = `default(DateTimeOffset?)`,
		string	dividendCurrency = `default(string)`,
		decimal	dividendRate = `default(decimal)`,
		DateTimeOffset	exDate = `default(DateTimeOffset)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the AccumulationEvent class.

Parameters

announcementDate	Date on which the dividend was announced / declared..
dividendCurrency	Payment currency (required).
dividendRate	Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05 (required).
exDate	The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. (required).
paymentDate	The date the company pays out dividends to shareholders. (required).
instrumentEventType	The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent (required) (default to "AccumulationEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.AccumulationEvent.BaseValidate ( ValidationContext validationContext )

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.AccumulationEvent.Equals ( AccumulationEvent input )

inline

Returns true if AccumulationEvent instances are equal

Parameters

input Instance of AccumulationEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.AccumulationEvent.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.AccumulationEvent.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.AccumulationEvent.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.InstrumentEvent.

◆ ToString()

override string Lusid.Sdk.Model.AccumulationEvent.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.AccumulationEvent.AnnouncementDate

getset

Date on which the dividend was announced / declared.

◆ DividendCurrency

string Lusid.Sdk.Model.AccumulationEvent.DividendCurrency

getset

Payment currency

◆ DividendRate

decimal Lusid.Sdk.Model.AccumulationEvent.DividendRate

getset

Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.AccumulationEvent.ExDate

getset

The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.AccumulationEvent.PaymentDate

getset

The date the company pays out dividends to shareholders.

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/AccumulationEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AccumulationEvent() [1/2]

◆ AccumulationEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnnouncementDate

◆ DividendCurrency

◆ DividendRate

◆ ExDate

◆ PaymentDate