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

FundingLegAllOf More...

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

Public Types

enum class  InstrumentTypeEnum {
  QuotedSecurity = 1 , InterestRateSwap = 2 , FxForward = 3 , Future = 4 ,
  ExoticInstrument = 5 , FxOption = 6 , CreditDefaultSwap = 7 , InterestRateSwaption = 8 ,
  Bond = 9 , EquityOption = 10 , FixedLeg = 11 , FloatingLeg = 12 ,
  BespokeCashFlowsLeg = 13 , Unknown = 14 , TermDeposit = 15 , ContractForDifference = 16 ,
  EquitySwap = 17 , CashPerpetual = 18 , CapFloor = 19 , CashSettled = 20 ,
  CdsIndex = 21 , Basket = 22 , FundingLeg = 23 , FxSwap = 24 ,
  ForwardRateAgreement = 25 , SimpleInstrument = 26 , Repo = 27 , Equity = 28 ,
  ExchangeTradedOption = 29 , ReferenceInstrument = 30 , ComplexBond = 31 , InflationLinkedBond = 32 ,
  InflationSwap = 33 , SimpleCashFlowLoan = 34 , TotalReturnSwap = 35 , InflationLeg = 36
}
 The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg More...
 

Public Member Functions

 FundingLegAllOf (DateTimeOffset startDate=default(DateTimeOffset), DateTimeOffset maturityDate=default(DateTimeOffset), LegDefinition legDefinition=default(LegDefinition), decimal? notional=default(decimal?), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
 Initializes a new instance of the FundingLegAllOf 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 (FundingLegAllOf input)
 Returns true if FundingLegAllOf instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 FundingLegAllOf ()
 Initializes a new instance of the FundingLegAllOf class. More...
 

Properties

InstrumentTypeEnum InstrumentType [get, set]
 The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg More...
 
DateTimeOffset StartDate [get, set]
 The start date of the instrument. This is normally synonymous with the trade-date. More...
 
DateTimeOffset MaturityDate [get, set]
 The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates beyond their last payment date. More...
 
LegDefinition LegDefinition [get, set]
 Gets or Sets LegDefinition More...
 
decimal? Notional [get, set]
 The initial notional of the Funding Leg instrument. When "RequiresFundingLegHistory" property key is present in transaction key, during a GetValuation endpoint call (for instance), this field would overriden by the Funding Leg history's notional and this notional field would not be used in the pricing and accrual calculations. As such, we recommend setting this to 0 or not setting it at all. Please see the following Notebook example and Knowledge Base article: Notebook: https://github.com/finbourne/sample-notebooks/blob/master/examples/use-cases/instruments/Funding%20Leg%20Swap.ipynb Knowledge Base article: https://support.lusid.com/knowledgebase/article/KA-01764/ More...
 

Detailed Description

FundingLegAllOf

Member Enumeration Documentation

◆ InstrumentTypeEnum

The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg

The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg

Enumerator
QuotedSecurity 

Enum QuotedSecurity for value: QuotedSecurity

InterestRateSwap 

Enum InterestRateSwap for value: InterestRateSwap

FxForward 

Enum FxForward for value: FxForward

Future 

Enum Future for value: Future

ExoticInstrument 

Enum ExoticInstrument for value: ExoticInstrument

FxOption 

Enum FxOption for value: FxOption

CreditDefaultSwap 

Enum CreditDefaultSwap for value: CreditDefaultSwap

InterestRateSwaption 

Enum InterestRateSwaption for value: InterestRateSwaption

Bond 

Enum Bond for value: Bond

EquityOption 

Enum EquityOption for value: EquityOption

FixedLeg 

Enum FixedLeg for value: FixedLeg

FloatingLeg 

Enum FloatingLeg for value: FloatingLeg

BespokeCashFlowsLeg 

Enum BespokeCashFlowsLeg for value: BespokeCashFlowsLeg

Unknown 

Enum Unknown for value: Unknown

TermDeposit 

Enum TermDeposit for value: TermDeposit

ContractForDifference 

Enum ContractForDifference for value: ContractForDifference

EquitySwap 

Enum EquitySwap for value: EquitySwap

CashPerpetual 

Enum CashPerpetual for value: CashPerpetual

CapFloor 

Enum CapFloor for value: CapFloor

CashSettled 

Enum CashSettled for value: CashSettled

CdsIndex 

Enum CdsIndex for value: CdsIndex

Basket 

Enum Basket for value: Basket

FundingLeg 

Enum FundingLeg for value: FundingLeg

FxSwap 

Enum FxSwap for value: FxSwap

ForwardRateAgreement 

Enum ForwardRateAgreement for value: ForwardRateAgreement

SimpleInstrument 

Enum SimpleInstrument for value: SimpleInstrument

Repo 

Enum Repo for value: Repo

Equity 

Enum Equity for value: Equity

ExchangeTradedOption 

Enum ExchangeTradedOption for value: ExchangeTradedOption

ReferenceInstrument 

Enum ReferenceInstrument for value: ReferenceInstrument

ComplexBond 

Enum ComplexBond for value: ComplexBond

InflationLinkedBond 

Enum InflationLinkedBond for value: InflationLinkedBond

InflationSwap 

Enum InflationSwap for value: InflationSwap

SimpleCashFlowLoan 

Enum SimpleCashFlowLoan for value: SimpleCashFlowLoan

TotalReturnSwap 

Enum TotalReturnSwap for value: TotalReturnSwap

InflationLeg 

Enum InflationLeg for value: InflationLeg

Constructor & Destructor Documentation

◆ FundingLegAllOf() [1/2]

Lusid.Sdk.Model.FundingLegAllOf.FundingLegAllOf ( )
inlineprotected

Initializes a new instance of the FundingLegAllOf class.

◆ FundingLegAllOf() [2/2]

Lusid.Sdk.Model.FundingLegAllOf.FundingLegAllOf ( DateTimeOffset  startDate = default(DateTimeOffset),
DateTimeOffset  maturityDate = default(DateTimeOffset),
LegDefinition  legDefinition = default(LegDefinition),
decimal?  notional = default(decimal?),
InstrumentTypeEnum  instrumentType = default(InstrumentTypeEnum) 
)
inline

Initializes a new instance of the FundingLegAllOf class.

Parameters
startDateThe start date of the instrument. This is normally synonymous with the trade-date. (required).
maturityDateThe final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates beyond their last payment date. (required).
legDefinitionlegDefinition (required).
notionalThe initial notional of the Funding Leg instrument. When "RequiresFundingLegHistory" property key is present in transaction key, during a GetValuation endpoint call (for instance), this field would overriden by the Funding Leg history's notional and this notional field would not be used in the pricing and accrual calculations. As such, we recommend setting this to 0 or not setting it at all. Please see the following Notebook example and Knowledge Base article: Notebook: https://github.com/finbourne/sample-notebooks/blob/master/examples/use-cases/instruments/Funding%20Leg%20Swap.ipynb Knowledge Base article: https://support.lusid.com/knowledgebase/article/KA-01764/.
instrumentTypeThe available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if FundingLegAllOf instances are equal

Parameters
inputInstance of FundingLegAllOf to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.FundingLegAllOf.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.FundingLegAllOf.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ InstrumentType

InstrumentTypeEnum Lusid.Sdk.Model.FundingLegAllOf.InstrumentType
getset

◆ LegDefinition

LegDefinition Lusid.Sdk.Model.FundingLegAllOf.LegDefinition
getset

Gets or Sets LegDefinition

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.FundingLegAllOf.MaturityDate
getset

The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates beyond their last payment date.

The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount. For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as Constant Maturity Swaps (CMS) often have sensitivities to rates beyond their last payment date.

◆ Notional

decimal? Lusid.Sdk.Model.FundingLegAllOf.Notional
getset

The initial notional of the Funding Leg instrument. When "RequiresFundingLegHistory" property key is present in transaction key, during a GetValuation endpoint call (for instance), this field would overriden by the Funding Leg history's notional and this notional field would not be used in the pricing and accrual calculations. As such, we recommend setting this to 0 or not setting it at all. Please see the following Notebook example and Knowledge Base article: Notebook: https://github.com/finbourne/sample-notebooks/blob/master/examples/use-cases/instruments/Funding%20Leg%20Swap.ipynb Knowledge Base article: https://support.lusid.com/knowledgebase/article/KA-01764/

The initial notional of the Funding Leg instrument. When "RequiresFundingLegHistory" property key is present in transaction key, during a GetValuation endpoint call (for instance), this field would overriden by the Funding Leg history's notional and this notional field would not be used in the pricing and accrual calculations. As such, we recommend setting this to 0 or not setting it at all. Please see the following Notebook example and Knowledge Base article: Notebook: https://github.com/finbourne/sample-notebooks/blob/master/examples/use-cases/instruments/Funding%20Leg%20Swap.ipynb Knowledge Base article: https://support.lusid.com/knowledgebase/article/KA-01764/

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.FundingLegAllOf.StartDate
getset

The start date of the instrument. This is normally synonymous with the trade-date.

The start date of the instrument. This is normally synonymous with the trade-date.


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