LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.InterestPaymentEvent Class Reference

Interest Payment event (INTR). A cash distribution of interest from a debt issuer to its noteholders, carrying a per-unit absolute interest rate on each CashElection. Supports Mandatory (single declared election) and MandatoryWithChoices (one election per offered currency) participation. More...

Inheritance diagram for Lusid.Sdk.Model.InterestPaymentEvent:
Inheritance graph
[legend]

Public Member Functions

 InterestPaymentEvent (DateTimeOffset recordDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset? responseDeadline=default(DateTimeOffset?), DateTimeOffset? marketDeadline=default(DateTimeOffset?), DateTimeOffset? announcementDate=default(DateTimeOffset?), List< CashElection > cashElections=default(List< CashElection >), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the InterestPaymentEvent 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 (InterestPaymentEvent input)
 Returns true if InterestPaymentEvent 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

 InterestPaymentEvent ()
 Initializes a new instance of the InterestPaymentEvent 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 RecordDate [get, set]
 The record-date cut-off determining entitlement. Required. Map from the vendor RecordDate (NOT the ExDate sentinel). More...
 
DateTimeOffset PaymentDate [get, set]
 The date the interest is paid to noteholders. Required. Also the effective date of the event. More...
 
DateTimeOffset? ResponseDeadline [get, set]
 The holder-instruction deadline. Required for MandatoryWithChoices; must be null for Mandatory. More...
 
DateTimeOffset? MarketDeadline [get, set]
 The market-organisation deadline. Required for MandatoryWithChoices; must be null for Mandatory. More...
 
DateTimeOffset? AnnouncementDate [get, set]
 The date the event was announced by the issuer. Optional. More...
 
List< CashElectionCashElections [get, set]
 The cash elections for this event. For Mandatory participation a single declared election is supplied with IsDeclared, IsDefault and IsChosen all true; for MandatoryWithChoices one entry per offered currency is supplied, with exactly one declared, one default and one chosen. Every election carries a per-unit absolute (signed) DividendRate and an ExchangeRate of 1. 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

Interest Payment event (INTR). A cash distribution of interest from a debt issuer to its noteholders, carrying a per-unit absolute interest rate on each CashElection. Supports Mandatory (single declared election) and MandatoryWithChoices (one election per offered currency) participation.

Constructor & Destructor Documentation

◆ InterestPaymentEvent() [1/2]

Lusid.Sdk.Model.InterestPaymentEvent.InterestPaymentEvent ( )
inlineprotected

Initializes a new instance of the InterestPaymentEvent class.

◆ InterestPaymentEvent() [2/2]

Lusid.Sdk.Model.InterestPaymentEvent.InterestPaymentEvent ( DateTimeOffset  recordDate = default(DateTimeOffset),
DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset?  responseDeadline = default(DateTimeOffset?),
DateTimeOffset?  marketDeadline = default(DateTimeOffset?),
DateTimeOffset?  announcementDate = default(DateTimeOffset?),
List< CashElection cashElections = default(List<CashElection>),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the InterestPaymentEvent class.

Parameters
recordDateThe record-date cut-off determining entitlement. Required. Map from the vendor RecordDate (NOT the ExDate sentinel)..
paymentDateThe date the interest is paid to noteholders. Required. Also the effective date of the event..
responseDeadlineThe holder-instruction deadline. Required for MandatoryWithChoices; must be null for Mandatory..
marketDeadlineThe market-organisation deadline. Required for MandatoryWithChoices; must be null for Mandatory..
announcementDateThe date the event was announced by the issuer. Optional..
cashElectionsThe cash elections for this event. For Mandatory participation a single declared election is supplied with IsDeclared, IsDefault and IsChosen all true; for MandatoryWithChoices one entry per offered currency is supplied, with exactly one declared, one default and one chosen. Every election carries a per-unit absolute (signed) DividendRate and an ExchangeRate of 1. (required).
instrumentEventTypeThe 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 "InterestPaymentEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.InterestPaymentEvent.Equals ( InterestPaymentEvent  input)
inline

Returns true if InterestPaymentEvent instances are equal

Parameters
inputInstance of InterestPaymentEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.InterestPaymentEvent.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.InterestPaymentEvent.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.InterestPaymentEvent.AnnouncementDate
getset

The date the event was announced by the issuer. Optional.

The date the event was announced by the issuer. Optional.

◆ CashElections

List<CashElection> Lusid.Sdk.Model.InterestPaymentEvent.CashElections
getset

The cash elections for this event. For Mandatory participation a single declared election is supplied with IsDeclared, IsDefault and IsChosen all true; for MandatoryWithChoices one entry per offered currency is supplied, with exactly one declared, one default and one chosen. Every election carries a per-unit absolute (signed) DividendRate and an ExchangeRate of 1.

The cash elections for this event. For Mandatory participation a single declared election is supplied with IsDeclared, IsDefault and IsChosen all true; for MandatoryWithChoices one entry per offered currency is supplied, with exactly one declared, one default and one chosen. Every election carries a per-unit absolute (signed) DividendRate and an ExchangeRate of 1.

◆ MarketDeadline

DateTimeOffset? Lusid.Sdk.Model.InterestPaymentEvent.MarketDeadline
getset

The market-organisation deadline. Required for MandatoryWithChoices; must be null for Mandatory.

The market-organisation deadline. Required for MandatoryWithChoices; must be null for Mandatory.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.InterestPaymentEvent.PaymentDate
getset

The date the interest is paid to noteholders. Required. Also the effective date of the event.

The date the interest is paid to noteholders. Required. Also the effective date of the event.

◆ RecordDate

DateTimeOffset Lusid.Sdk.Model.InterestPaymentEvent.RecordDate
getset

The record-date cut-off determining entitlement. Required. Map from the vendor RecordDate (NOT the ExDate sentinel).

The record-date cut-off determining entitlement. Required. Map from the vendor RecordDate (NOT the ExDate sentinel).

◆ ResponseDeadline

DateTimeOffset? Lusid.Sdk.Model.InterestPaymentEvent.ResponseDeadline
getset

The holder-instruction deadline. Required for MandatoryWithChoices; must be null for Mandatory.

The holder-instruction deadline. Required for MandatoryWithChoices; must be null for Mandatory.


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