Inheritance diagram for Lusid.Sdk.Model.AmortisationEventAllOf:

Public Types
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 }
	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 More...

Public Member Functions
	AmortisationEventAllOf (decimal amountReduced=default(decimal), string domCcy=default(string), string payReceive=default(string), string eventStatus=default(string), DateTimeOffset paymentDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the AmortisationEventAllOf class. More...

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

virtual 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 (AmortisationEventAllOf input)
	Returns true if AmortisationEventAllOf instances are equal More...

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

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

Properties
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 More...

decimal	AmountReduced `[get, set]`
	The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event. More...

string	DomCcy `[get, set]`
	Domestic currency of the originating instrument More...

string	PayReceive `[get, set]`
	Is this event in relation to the Pay or Receive leg More...

string	EventStatus `[get, set]`
	What is the event status, is it a known (ie historic) or unknown (ie projected) event? More...

DateTimeOffset	PaymentDate `[get, set]`
	The date the principal payment is to be made. More...

Detailed Description

AmortisationEventAllOf

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

enum Lusid.Sdk.Model.AmortisationEventAllOf.InstrumentEventTypeEnum

strong

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

Enumerator
TransitionEvent	Enum TransitionEvent for value: TransitionEvent
InformationalEvent	Enum InformationalEvent for value: InformationalEvent
OpenEvent	Enum OpenEvent for value: OpenEvent
CloseEvent	Enum CloseEvent for value: CloseEvent
StockSplitEvent	Enum StockSplitEvent for value: StockSplitEvent
BondDefaultEvent	Enum BondDefaultEvent for value: BondDefaultEvent
CashDividendEvent	Enum CashDividendEvent for value: CashDividendEvent
AmortisationEvent	Enum AmortisationEvent for value: AmortisationEvent
CashFlowEvent	Enum CashFlowEvent for value: CashFlowEvent
ExerciseEvent	Enum ExerciseEvent for value: ExerciseEvent
ResetEvent	Enum ResetEvent for value: ResetEvent
TriggerEvent	Enum TriggerEvent for value: TriggerEvent
RawVendorEvent	Enum RawVendorEvent for value: RawVendorEvent
InformationalErrorEvent	Enum InformationalErrorEvent for value: InformationalErrorEvent
BondCouponEvent	Enum BondCouponEvent for value: BondCouponEvent
DividendReinvestmentEvent	Enum DividendReinvestmentEvent for value: DividendReinvestmentEvent
AccumulationEvent	Enum AccumulationEvent for value: AccumulationEvent

Constructor & Destructor Documentation

◆ AmortisationEventAllOf() [1/2]

Lusid.Sdk.Model.AmortisationEventAllOf.AmortisationEventAllOf ( )

inlineprotected

Initializes a new instance of the AmortisationEventAllOf class.

◆ AmortisationEventAllOf() [2/2]

Lusid.Sdk.Model.AmortisationEventAllOf.AmortisationEventAllOf	(	decimal	amountReduced = `default(decimal)`,
		string	domCcy = `default(string)`,
		string	payReceive = `default(string)`,
		string	eventStatus = `default(string)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the AmortisationEventAllOf class.

Parameters

amountReduced	The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event. (required).
domCcy	Domestic currency of the originating instrument (required).
payReceive	Is this event in relation to the Pay or Receive leg (required).
eventStatus	What is the event status, is it a known (ie historic) or unknown (ie projected) event? (required).
paymentDate	The date the principal payment is to be made. (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 (required).

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if AmortisationEventAllOf instances are equal

Parameters

input Instance of AmortisationEventAllOf to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.AmortisationEventAllOf.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AmountReduced

decimal Lusid.Sdk.Model.AmortisationEventAllOf.AmountReduced

getset

The amount reduced in this amortisation event. That is, the difference between the previous notional amount and the current notional amount as set in this event.

◆ DomCcy

string Lusid.Sdk.Model.AmortisationEventAllOf.DomCcy

getset

Domestic currency of the originating instrument

◆ EventStatus

string Lusid.Sdk.Model.AmortisationEventAllOf.EventStatus

getset

What is the event status, is it a known (ie historic) or unknown (ie projected) event?

◆ InstrumentEventType

InstrumentEventTypeEnum Lusid.Sdk.Model.AmortisationEventAllOf.InstrumentEventType

getset

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

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.AmortisationEventAllOf.PaymentDate

getset

The date the principal payment is to be made.

◆ PayReceive

string Lusid.Sdk.Model.AmortisationEventAllOf.PayReceive

getset

Is this event in relation to the Pay or Receive leg

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/AmortisationEventAllOf.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

Constructor & Destructor Documentation

◆ AmortisationEventAllOf() [1/2]

◆ AmortisationEventAllOf() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AmountReduced

◆ DomCcy

◆ EventStatus

◆ InstrumentEventType

◆ PaymentDate

◆ PayReceive