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

Event representing the partial closure of a repurchase agreement. Each event reduces the outstanding notional and generates a corresponding receive-leg cashflow. The final maturity cashflow is adjusted accordingly. If multiple events are created, their effects compound. Once the total repaid amount reaches the original purchase price, no further receive-leg cashflows are generated. Any event exceeding the remaining notional is marked with a diagnostic to indicate it is invalid due to excessive repayment. For example, for a repo with a 5% rate, 1% haircut and collateral value of 100 (purchase price = 99), a partial closure of cash amount 10 followed by one of 100 results in only the first event producing a cashflow. The second, exceeding the remaining balance, is ignored and flagged with a diagnostic. The remaining balance is settled at maturity of the repurchase agreement. More...

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

Public Member Functions

 RepoPartialClosureEvent (DateTimeOffset entitlementDate=default(DateTimeOffset), DateTimeOffset settlementDate=default(DateTimeOffset), decimal? cashAmount=default(decimal?), decimal? cashPercentage=default(decimal?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the RepoPartialClosureEvent 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 (RepoPartialClosureEvent input)
 Returns true if RepoPartialClosureEvent 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

 RepoPartialClosureEvent ()
 Initializes a new instance of the RepoPartialClosureEvent 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 EntitlementDate [get, set]
 The date on which the counterparties become entitled to exchange cash as part of a partial closure of the repurchase agreement. The date must be before or on the settlement date, and on or before the maturity date of the repo. This is a required field. More...
 
DateTimeOffset SettlementDate [get, set]
 The date on which the exchange of cash is settled. The date must be on or after the entitlement date, and on or before the maturity date of the repo. This is a required field. More...
 
decimal? CashAmount [get, set]
 The amount of cash to be exchanged as part of a partial closure of the repurchase agreement. It cannot be more than the initial amount of cash at the start of the repo. More...
 
decimal? CashPercentage [get, set]
 Represents the proportion of cash exchanged, as a value between 0 and 1, relative to the total cash involved in the repurchase agreement. This value adjusts with each partial closure, because the total cash amount is reduced. 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. 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
}
 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. More...
 

Detailed Description

Event representing the partial closure of a repurchase agreement. Each event reduces the outstanding notional and generates a corresponding receive-leg cashflow. The final maturity cashflow is adjusted accordingly. If multiple events are created, their effects compound. Once the total repaid amount reaches the original purchase price, no further receive-leg cashflows are generated. Any event exceeding the remaining notional is marked with a diagnostic to indicate it is invalid due to excessive repayment. For example, for a repo with a 5% rate, 1% haircut and collateral value of 100 (purchase price &#x3D; 99), a partial closure of cash amount 10 followed by one of 100 results in only the first event producing a cashflow. The second, exceeding the remaining balance, is ignored and flagged with a diagnostic. The remaining balance is settled at maturity of the repurchase agreement.

Constructor & Destructor Documentation

◆ RepoPartialClosureEvent() [1/2]

Lusid.Sdk.Model.RepoPartialClosureEvent.RepoPartialClosureEvent ( )
inlineprotected

Initializes a new instance of the RepoPartialClosureEvent class.

◆ RepoPartialClosureEvent() [2/2]

Lusid.Sdk.Model.RepoPartialClosureEvent.RepoPartialClosureEvent ( DateTimeOffset  entitlementDate = default(DateTimeOffset),
DateTimeOffset  settlementDate = default(DateTimeOffset),
decimal?  cashAmount = default(decimal?),
decimal?  cashPercentage = default(decimal?),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the RepoPartialClosureEvent class.

Parameters
entitlementDateThe date on which the counterparties become entitled to exchange cash as part of a partial closure of the repurchase agreement. The date must be before or on the settlement date, and on or before the maturity date of the repo. This is a required field..
settlementDateThe date on which the exchange of cash is settled. The date must be on or after the entitlement date, and on or before the maturity date of the repo. This is a required field..
cashAmountThe amount of cash to be exchanged as part of a partial closure of the repurchase agreement. It cannot be more than the initial amount of cash at the start of the repo..
cashPercentageRepresents the proportion of cash exchanged, as a value between 0 and 1, relative to the total cash involved in the repurchase agreement. This value adjusts with each partial closure, because the total cash amount is reduced..
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. (required) (default to "RepoPartialClosureEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if RepoPartialClosureEvent instances are equal

Parameters
inputInstance of RepoPartialClosureEvent to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CashAmount

decimal? Lusid.Sdk.Model.RepoPartialClosureEvent.CashAmount
getset

The amount of cash to be exchanged as part of a partial closure of the repurchase agreement. It cannot be more than the initial amount of cash at the start of the repo.

The amount of cash to be exchanged as part of a partial closure of the repurchase agreement. It cannot be more than the initial amount of cash at the start of the repo.

◆ CashPercentage

decimal? Lusid.Sdk.Model.RepoPartialClosureEvent.CashPercentage
getset

Represents the proportion of cash exchanged, as a value between 0 and 1, relative to the total cash involved in the repurchase agreement. This value adjusts with each partial closure, because the total cash amount is reduced.

Represents the proportion of cash exchanged, as a value between 0 and 1, relative to the total cash involved in the repurchase agreement. This value adjusts with each partial closure, because the total cash amount is reduced.

◆ EntitlementDate

DateTimeOffset Lusid.Sdk.Model.RepoPartialClosureEvent.EntitlementDate
getset

The date on which the counterparties become entitled to exchange cash as part of a partial closure of the repurchase agreement. The date must be before or on the settlement date, and on or before the maturity date of the repo. This is a required field.

The date on which the counterparties become entitled to exchange cash as part of a partial closure of the repurchase agreement. The date must be before or on the settlement date, and on or before the maturity date of the repo. This is a required field.

◆ SettlementDate

DateTimeOffset Lusid.Sdk.Model.RepoPartialClosureEvent.SettlementDate
getset

The date on which the exchange of cash is settled. The date must be on or after the entitlement date, and on or before the maturity date of the repo. This is a required field.

The date on which the exchange of cash is settled. The date must be on or after the entitlement date, and on or before the maturity date of the repo. This is a required field.


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