LUSID representation of a Term Deposit. More...

Inheritance diagram for Lusid.Sdk.Model.TermDeposit:

Public Member Functions
	TermDeposit (DateTimeOffset startDate=default(DateTimeOffset), DateTimeOffset maturityDate=default(DateTimeOffset), decimal contractSize=default(decimal), FlowConventions flowConvention=default(FlowConventions), decimal rate=default(decimal), string domCcy=default(string), InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the TermDeposit 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 (TermDeposit input)
	Returns true if TermDeposit instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Public Member Functions inherited from Lusid.Sdk.Model.LusidInstrument
	LusidInstrument (InstrumentTypeEnum instrumentType=default(InstrumentTypeEnum))
	Initializes a new instance of the LusidInstrument 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 (LusidInstrument input)
	Returns true if LusidInstrument instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	TermDeposit ()
	Initializes a new instance of the TermDeposit 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.LusidInstrument
	LusidInstrument ()
	Initializes a new instance of the LusidInstrument class. More...

IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult >	BaseValidate (ValidationContext validationContext)
	To validate all properties of the instance More...

Properties
DateTimeOffset	StartDate `[get, set]`
	The start date of the instrument. For term deposits this is the start date of the interest calculation period. More...

DateTimeOffset	MaturityDate `[get, set]`
	The maturity date of the instrument. For term deposits this is the last date of the interest calculation period. More...

decimal	ContractSize `[get, set]`
	The principal amount of the term deposit. More...

FlowConventions	FlowConvention `[get, set]`
	Gets or Sets FlowConvention More...

decimal	Rate `[get, set]`
	The fixed rate for the term deposit. Specified as a decimal, e.g 0.03 is meant to be 3% interest More...

string	DomCcy `[get, set]`
	The domestic currency of the instrument. This should be the same as the Currency set on the FlowConventions. You do not need to populate this field for Term Deposits in LUSID as all functionality is driven by the Currency set on the FlowConventions. LUSID will not store values saved on this field. More...

Properties inherited from Lusid.Sdk.Model.LusidInstrument
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 More...

Additional Inherited Members
Public Types inherited from Lusid.Sdk.Model.LusidInstrument
enum	InstrumentTypeEnum { InstrumentTypeEnum.QuotedSecurity = 1, InstrumentTypeEnum.InterestRateSwap = 2, InstrumentTypeEnum.FxForward = 3, InstrumentTypeEnum.Future = 4, InstrumentTypeEnum.ExoticInstrument = 5, InstrumentTypeEnum.FxOption = 6, InstrumentTypeEnum.CreditDefaultSwap = 7, InstrumentTypeEnum.InterestRateSwaption = 8, InstrumentTypeEnum.Bond = 9, InstrumentTypeEnum.EquityOption = 10, InstrumentTypeEnum.FixedLeg = 11, InstrumentTypeEnum.FloatingLeg = 12, InstrumentTypeEnum.BespokeCashFlowsLeg = 13, InstrumentTypeEnum.Unknown = 14, InstrumentTypeEnum.TermDeposit = 15, InstrumentTypeEnum.ContractForDifference = 16, InstrumentTypeEnum.EquitySwap = 17, InstrumentTypeEnum.CashPerpetual = 18, InstrumentTypeEnum.CapFloor = 19, InstrumentTypeEnum.CashSettled = 20, InstrumentTypeEnum.CdsIndex = 21, InstrumentTypeEnum.Basket = 22, InstrumentTypeEnum.FundingLeg = 23, InstrumentTypeEnum.FxSwap = 24, InstrumentTypeEnum.ForwardRateAgreement = 25, InstrumentTypeEnum.SimpleInstrument = 26, InstrumentTypeEnum.Repo = 27, InstrumentTypeEnum.Equity = 28, InstrumentTypeEnum.ExchangeTradedOption = 29, InstrumentTypeEnum.ReferenceInstrument = 30, InstrumentTypeEnum.ComplexBond = 31, InstrumentTypeEnum.InflationLinkedBond = 32, InstrumentTypeEnum.InflationSwap = 33, InstrumentTypeEnum.SimpleCashFlowLoan = 34 }
	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 More...

Detailed Description

LUSID representation of a Term Deposit.

Constructor & Destructor Documentation

◆ TermDeposit() [1/2]

Lusid.Sdk.Model.TermDeposit.TermDeposit ( )

inlineprotected

Initializes a new instance of the TermDeposit class.

◆ TermDeposit() [2/2]

Lusid.Sdk.Model.TermDeposit.TermDeposit	(	DateTimeOffset	startDate = `default(DateTimeOffset)`,
		DateTimeOffset	maturityDate = `default(DateTimeOffset)`,
		decimal	contractSize = `default(decimal)`,
		FlowConventions	flowConvention = `default(FlowConventions)`,
		decimal	rate = `default(decimal)`,
		string	domCcy = `default(string)`,
		InstrumentTypeEnum	instrumentType = `default(InstrumentTypeEnum)`
	)

inline

Initializes a new instance of the TermDeposit class.

Parameters

startDate	The start date of the instrument. For term deposits this is the start date of the interest calculation period. (required).
maturityDate	The maturity date of the instrument. For term deposits this is the last date of the interest calculation period. (required).
contractSize	The principal amount of the term deposit. (required).
flowConvention	flowConvention (required).
rate	The fixed rate for the term deposit. Specified as a decimal, e.g 0.03 is meant to be 3% interest (required).
domCcy	The domestic currency of the instrument. This should be the same as the Currency set on the FlowConventions. You do not need to populate this field for Term Deposits in LUSID as all functionality is driven by the Currency set on the FlowConventions. LUSID will not store values saved on this field..
instrumentType	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 (required) (default to "TermDeposit").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.TermDeposit.Equals ( TermDeposit input )

inline

Returns true if TermDeposit instances are equal

Parameters

input Instance of TermDeposit to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

override string Lusid.Sdk.Model.TermDeposit.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.LusidInstrument.

◆ ToString()

override string Lusid.Sdk.Model.TermDeposit.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ContractSize

decimal Lusid.Sdk.Model.TermDeposit.ContractSize

getset

The principal amount of the term deposit.

◆ DomCcy

string Lusid.Sdk.Model.TermDeposit.DomCcy

getset

The domestic currency of the instrument. This should be the same as the Currency set on the FlowConventions. You do not need to populate this field for Term Deposits in LUSID as all functionality is driven by the Currency set on the FlowConventions. LUSID will not store values saved on this field.

◆ FlowConvention

FlowConventions Lusid.Sdk.Model.TermDeposit.FlowConvention

getset

Gets or Sets FlowConvention

◆ MaturityDate

DateTimeOffset Lusid.Sdk.Model.TermDeposit.MaturityDate

getset

The maturity date of the instrument. For term deposits this is the last date of the interest calculation period.

◆ Rate

decimal Lusid.Sdk.Model.TermDeposit.Rate

getset

The fixed rate for the term deposit. Specified as a decimal, e.g 0.03 is meant to be 3% interest

◆ StartDate

DateTimeOffset Lusid.Sdk.Model.TermDeposit.StartDate

getset

The start date of the instrument. For term deposits this is the start date of the interest calculation period.

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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TermDeposit() [1/2]

◆ TermDeposit() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ContractSize

◆ DomCcy

◆ FlowConvention

◆ MaturityDate

◆ Rate

◆ StartDate