Early redemption as a consequence of a bond being called or putted. More...

Inheritance diagram for Lusid.Sdk.Model.EarlyRedemptionEvent:

[legend]

Public Member Functions
	EarlyRedemptionEvent (DateTimeOffset? effectiveDate=default(DateTimeOffset?), string currency=default(string), List< EarlyRedemptionElection > earlyRedemptionElections=default(List< EarlyRedemptionElection >), decimal redemptionPercentage=default(decimal), decimal? pricePerUnit=default(decimal?), decimal? accruedInterestPerUnit=default(decimal?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the EarlyRedemptionEvent 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 (EarlyRedemptionEvent input)
	Returns true if EarlyRedemptionEvent 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
	EarlyRedemptionEvent ()
	Initializes a new instance of the EarlyRedemptionEvent 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?	EffectiveDate `[get, set]`
	Date of redemption. For internally generated European callables, this is set to the exercise date. For internally generated American callables, this is set to the start of the exercise period. More...

string	Currency `[get, set]`
	Currency of the redemption. More...

List< EarlyRedemptionElection >	EarlyRedemptionElections `[get, set]`
	EarlyRedemptionElection for the redemption. Used to trigger the redemption. More...

decimal	RedemptionPercentage `[get, set]`
	Percentage of the issued amount to be redeemed, value between 0 and 1, where 1 is a full redemption More...

decimal?	PricePerUnit `[get, set]`
	The price, or strike, that each unit is redeemed at. More...

decimal?	AccruedInterestPerUnit `[get, set]`
	Unpaid accrued interest also repaid as part of the redemption, per unit. Optional field. If left empty, will be resolved internally by calculating the accrued owed on the EffectiveDate. This process may require additional market data. More...

Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum	InstrumentEventType `[get, set]`
	The Type of Event. Available values: 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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent. 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 , CapitalDistributionEvent = 26 , SpinOffEvent = 27 , MergerEvent = 28 , FutureExpiryEvent = 29 , SwapCashFlowEvent = 30 , SwapPrincipalEvent = 31 , CreditPremiumCashFlowEvent = 32 , CdsCreditEvent = 33 , CdxCreditEvent = 34 , MbsCouponEvent = 35 , MbsPrincipalEvent = 36 , BonusIssueEvent = 37 , MbsPrincipalWriteOffEvent = 38 , MbsInterestDeferralEvent = 39 , MbsInterestShortfallEvent = 40 , TenderEvent = 41 , CallOnIntermediateSecuritiesEvent = 42 , IntermediateSecuritiesDistributionEvent = 43 , OptionExercisePhysicalEvent = 44 , OptionExerciseCashEvent = 45 , ProtectionPayoutCashFlowEvent = 46 , TermDepositInterestEvent = 47 , TermDepositPrincipalEvent = 48 , EarlyRedemptionEvent = 49 , FutureMarkToMarketEvent = 50 , AdjustGlobalCommitmentEvent = 51 , ContractInitialisationEvent = 52 , DrawdownEvent = 53 , LoanInterestRepaymentEvent = 54 , UpdateDepositAmountEvent = 55 , LoanPrincipalRepaymentEvent = 56 , DepositInterestPaymentEvent = 57 , DepositCloseEvent = 58 , LoanFacilityContractRolloverEvent = 59 , RepurchaseOfferEvent = 60 , RepoPartialClosureEvent = 61 , RepoCashFlowEvent = 62 , FlexibleRepoInterestPaymentEvent = 63 , FlexibleRepoCashFlowEvent = 64 , FlexibleRepoCollateralEvent = 65 , ConversionEvent = 66 , FlexibleRepoPartialClosureEvent = 67 , FlexibleRepoFullClosureEvent = 68 , CapletFloorletCashFlowEvent = 69 , EarlyCloseOutEvent = 70 , DepositRollEvent = 71 , ConsentEvent = 72 , DrawingEvent = 73 , CapitalGainsDistributionEvent = 74 , ExchangeOfferEvent = 75 , DutchAuctionEvent = 76 , WorthlessEvent = 77 , PutRedemptionEvent = 78 , LoanFacilityDelayedCompensationPaymentEvent = 79 , InterestPaymentEvent = 80 , PriorityIssueEvent = 81 , ClassActionEvent = 82 }
	The Type of Event. Available values: 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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent. More...

Detailed Description

Early redemption as a consequence of a bond being called or putted.

Constructor & Destructor Documentation

◆ EarlyRedemptionEvent() [1/2]

Lusid.Sdk.Model.EarlyRedemptionEvent.EarlyRedemptionEvent ( )

inlineprotected

Initializes a new instance of the EarlyRedemptionEvent class.

◆ EarlyRedemptionEvent() [2/2]

Lusid.Sdk.Model.EarlyRedemptionEvent.EarlyRedemptionEvent	(	DateTimeOffset?	effectiveDate = `default(DateTimeOffset?)`,
		string	currency = `default(string)`,
		List< EarlyRedemptionElection >	earlyRedemptionElections = `default(List<EarlyRedemptionElection>)`,
		decimal	redemptionPercentage = `default(decimal)`,
		decimal?	pricePerUnit = `default(decimal?)`,
		decimal?	accruedInterestPerUnit = `default(decimal?)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the EarlyRedemptionEvent class.

Parameters

effectiveDate	Date of redemption. For internally generated European callables, this is set to the exercise date. For internally generated American callables, this is set to the start of the exercise period..
currency	Currency of the redemption. (required).
earlyRedemptionElections	EarlyRedemptionElection for the redemption. Used to trigger the redemption. (required).
redemptionPercentage	Percentage of the issued amount to be redeemed, value between 0 and 1, where 1 is a full redemption.
pricePerUnit	The price, or strike, that each unit is redeemed at..
accruedInterestPerUnit	Unpaid accrued interest also repaid as part of the redemption, per unit. Optional field. If left empty, will be resolved internally by calculating the accrued owed on the EffectiveDate. This process may require additional market data..
instrumentEventType	The Type of Event. Available values: 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, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent. (required) (default to "EarlyRedemptionEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.EarlyRedemptionEvent.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.EarlyRedemptionEvent.Equals ( EarlyRedemptionEvent input )

inline

Returns true if EarlyRedemptionEvent instances are equal

Parameters

input Instance of EarlyRedemptionEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.EarlyRedemptionEvent.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.EarlyRedemptionEvent.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccruedInterestPerUnit

decimal? Lusid.Sdk.Model.EarlyRedemptionEvent.AccruedInterestPerUnit

getset

Unpaid accrued interest also repaid as part of the redemption, per unit. Optional field. If left empty, will be resolved internally by calculating the accrued owed on the EffectiveDate. This process may require additional market data.

◆ Currency

string Lusid.Sdk.Model.EarlyRedemptionEvent.Currency

getset

Currency of the redemption.

◆ EarlyRedemptionElections

List<EarlyRedemptionElection> Lusid.Sdk.Model.EarlyRedemptionEvent.EarlyRedemptionElections

getset

EarlyRedemptionElection for the redemption. Used to trigger the redemption.

◆ EffectiveDate

DateTimeOffset? Lusid.Sdk.Model.EarlyRedemptionEvent.EffectiveDate

getset

Date of redemption. For internally generated European callables, this is set to the exercise date. For internally generated American callables, this is set to the start of the exercise period.

◆ PricePerUnit

decimal? Lusid.Sdk.Model.EarlyRedemptionEvent.PricePerUnit

getset

The price, or strike, that each unit is redeemed at.

◆ RedemptionPercentage

decimal Lusid.Sdk.Model.EarlyRedemptionEvent.RedemptionPercentage

getset

Percentage of the issued amount to be redeemed, value between 0 and 1, where 1 is a full redemption

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EarlyRedemptionEvent() [1/2]

◆ EarlyRedemptionEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccruedInterestPerUnit

◆ Currency

◆ EarlyRedemptionElections

◆ EffectiveDate

◆ PricePerUnit

◆ RedemptionPercentage