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

event paying out the cumulative delayed-compensation pot on a secondary-market loan-facility trade whose actual SettleDate is strictly after Transaction/default/ContractualSettlementDate. Generated on the trade's actual SettleDate; amount equals the integrated daily increment over the open-on-the-left, closed-on-the-right interval (ContractualSettlementDate, min(SettleDate, EarlyTerminationDate)]. Forecast accuracy depends entirely on the user's recorded SettleDate being a realistic estimate; if the user fudges the settle date well into the future, the cashflow forecast will be wrong by the same factor. Amount is always positive on the wire. Buyer-vs-seller sign is applied downstream by the transaction-template specification, mirroring how BuyFacility / SellFacility already invert their cash legs against the same payload. More...

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

Public Member Functions

 LoanFacilityDelayedCompensationPaymentEvent (DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset exDate=default(DateTimeOffset), string currency=default(string), decimal amount=default(decimal), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the LoanFacilityDelayedCompensationPaymentEvent 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 (LoanFacilityDelayedCompensationPaymentEvent input)
 Returns true if LoanFacilityDelayedCompensationPaymentEvent 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

 LoanFacilityDelayedCompensationPaymentEvent ()
 Initializes a new instance of the LoanFacilityDelayedCompensationPaymentEvent 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 PaymentDate [get, set]
 Date that the delayed-compensation pot is due to be paid. Kept as a separate field so a configurable settlement-to-payment lag can be introduced later if the pot accrues using daily OIS rates; in the first delivery PaymentDate equals ExDate. More...
 
DateTimeOffset ExDate [get, set]
 Date that the delayed-compensation pot is calculated up to. Equals the trade&#39;s actual SettleDate after any active TradeAmendments at the firing effectiveAt. More...
 
string Currency [get, set]
 Currency of the payment, in the contract domestic currency. fx-conversion to the facility currency is handled downstream in the same way as for LoanInterestRepaymentEvent. More...
 
decimal Amount [get, set]
 Cumulative pot value to be paid out on PaymentDate, expressed in the event&#39;s Currency. Always positive on the wire; buyer-vs-seller sign is applied by the transaction-template specification per the original trade side. 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

event paying out the cumulative delayed-compensation pot on a secondary-market loan-facility trade whose actual SettleDate is strictly after Transaction/default/ContractualSettlementDate. Generated on the trade&#39;s actual SettleDate; amount equals the integrated daily increment over the open-on-the-left, closed-on-the-right interval (ContractualSettlementDate, min(SettleDate, EarlyTerminationDate)]. Forecast accuracy depends entirely on the user&#39;s recorded SettleDate being a realistic estimate; if the user fudges the settle date well into the future, the cashflow forecast will be wrong by the same factor. Amount is always positive on the wire. Buyer-vs-seller sign is applied downstream by the transaction-template specification, mirroring how BuyFacility / SellFacility already invert their cash legs against the same payload.

Constructor & Destructor Documentation

◆ LoanFacilityDelayedCompensationPaymentEvent() [1/2]

Lusid.Sdk.Model.LoanFacilityDelayedCompensationPaymentEvent.LoanFacilityDelayedCompensationPaymentEvent ( )
inlineprotected

Initializes a new instance of the LoanFacilityDelayedCompensationPaymentEvent class.

◆ LoanFacilityDelayedCompensationPaymentEvent() [2/2]

Lusid.Sdk.Model.LoanFacilityDelayedCompensationPaymentEvent.LoanFacilityDelayedCompensationPaymentEvent ( DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset  exDate = default(DateTimeOffset),
string  currency = default(string),
decimal  amount = default(decimal),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the LoanFacilityDelayedCompensationPaymentEvent class.

Parameters
paymentDateDate that the delayed-compensation pot is due to be paid. Kept as a separate field so a configurable settlement-to-payment lag can be introduced later if the pot accrues using daily OIS rates; in the first delivery PaymentDate equals ExDate..
exDateDate that the delayed-compensation pot is calculated up to. Equals the trade&#39;s actual SettleDate after any active TradeAmendments at the firing effectiveAt..
currencyCurrency of the payment, in the contract domestic currency. fx-conversion to the facility currency is handled downstream in the same way as for LoanInterestRepaymentEvent. (required).
amountCumulative pot value to be paid out on PaymentDate, expressed in the event&#39;s Currency. Always positive on the wire; buyer-vs-seller sign is applied by the transaction-template specification per the original trade side. (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 "LoanFacilityDelayedCompensationPaymentEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if LoanFacilityDelayedCompensationPaymentEvent instances are equal

Parameters
inputInstance of LoanFacilityDelayedCompensationPaymentEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Amount

decimal Lusid.Sdk.Model.LoanFacilityDelayedCompensationPaymentEvent.Amount
getset

Cumulative pot value to be paid out on PaymentDate, expressed in the event&#39;s Currency. Always positive on the wire; buyer-vs-seller sign is applied by the transaction-template specification per the original trade side.

Cumulative pot value to be paid out on PaymentDate, expressed in the event&#39;s Currency. Always positive on the wire; buyer-vs-seller sign is applied by the transaction-template specification per the original trade side.

◆ Currency

string Lusid.Sdk.Model.LoanFacilityDelayedCompensationPaymentEvent.Currency
getset

Currency of the payment, in the contract domestic currency. fx-conversion to the facility currency is handled downstream in the same way as for LoanInterestRepaymentEvent.

Currency of the payment, in the contract domestic currency. fx-conversion to the facility currency is handled downstream in the same way as for LoanInterestRepaymentEvent.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.LoanFacilityDelayedCompensationPaymentEvent.ExDate
getset

Date that the delayed-compensation pot is calculated up to. Equals the trade&#39;s actual SettleDate after any active TradeAmendments at the firing effectiveAt.

Date that the delayed-compensation pot is calculated up to. Equals the trade&#39;s actual SettleDate after any active TradeAmendments at the firing effectiveAt.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.LoanFacilityDelayedCompensationPaymentEvent.PaymentDate
getset

Date that the delayed-compensation pot is due to be paid. Kept as a separate field so a configurable settlement-to-payment lag can be introduced later if the pot accrues using daily OIS rates; in the first delivery PaymentDate equals ExDate.

Date that the delayed-compensation pot is due to be paid. Kept as a separate field so a configurable settlement-to-payment lag can be introduced later if the pot accrues using daily OIS rates; in the first delivery PaymentDate equals ExDate.


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