An individual row containing details of a single cashflow in the diary. More...

Inheritance diagram for Lusid.Sdk.Model.InstrumentPaymentDiaryRow:

Public Member Functions
	InstrumentPaymentDiaryRow (decimal quantity=default(decimal), string currency=default(string), DateTimeOffset paymentDate=default(DateTimeOffset), string payOrReceive=default(string), DateTimeOffset accrualStart=default(DateTimeOffset), DateTimeOffset accrualEnd=default(DateTimeOffset), string cashFlowType=default(string), bool isCashFlowDetermined=default(bool), bool isCashFlowHistoric=default(bool), decimal discountFactor=default(decimal), decimal discountedExpectedCashFlowAmount=default(decimal), decimal? dayCountFraction=default(decimal?), decimal? forwardRate=default(decimal?), decimal? resetRate=default(decimal?), decimal? spread=default(decimal?))
	Initializes a new instance of the InstrumentPaymentDiaryRow 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 (InstrumentPaymentDiaryRow input)
	Returns true if InstrumentPaymentDiaryRow instances are equal More...

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

Properties
decimal	Quantity `[get, set]`
	The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it. More...

string	Currency `[get, set]`
	The payment currency of the cash flow. More...

DateTimeOffset	PaymentDate `[get, set]`
	The date at which the given cash flow is due to be paid. More...

string	PayOrReceive `[get, set]`
	Does the cash flow belong to the Pay or Receive leg. More...

DateTimeOffset	AccrualStart `[get, set]`
	The date on which accruals start for this cashflow. More...

DateTimeOffset	AccrualEnd `[get, set]`
	The date on which accruals end for this cashflow. More...

string	CashFlowType `[get, set]`
	The type of cashflow. More...

bool	IsCashFlowDetermined `[get, set]`
	Is the cashflow determined as of the effective date time. More...

bool	IsCashFlowHistoric `[get, set]`
	Has the cashflow been paid, i.e. has it become a historic cashflow, as of the date and time pointed to be effectiveAt. More...

decimal	DiscountFactor `[get, set]`
	Weighting factor to discount cashflow to the present value. More...

decimal	DiscountedExpectedCashFlowAmount `[get, set]`
	The expected cashflow amount taking into account the discount factor. More...

decimal?	DayCountFraction `[get, set]`
	The day count fraction, if appropriate. More...

decimal?	ForwardRate `[get, set]`
	Forward rate for cash flow if appropriate. (as in for a rates fixed or floating leg) More...

decimal?	ResetRate `[get, set]`
	The value of the reset, if any. More...

decimal?	Spread `[get, set]`
	The spread that exists on the payoff. More...

Detailed Description

An individual row containing details of a single cashflow in the diary.

Constructor & Destructor Documentation

◆ InstrumentPaymentDiaryRow()

Lusid.Sdk.Model.InstrumentPaymentDiaryRow.InstrumentPaymentDiaryRow	(	decimal	quantity = `default(decimal)`,
		string	currency = `default(string)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		string	payOrReceive = `default(string)`,
		DateTimeOffset	accrualStart = `default(DateTimeOffset)`,
		DateTimeOffset	accrualEnd = `default(DateTimeOffset)`,
		string	cashFlowType = `default(string)`,
		bool	isCashFlowDetermined = `default(bool)`,
		bool	isCashFlowHistoric = `default(bool)`,
		decimal	discountFactor = `default(decimal)`,
		decimal	discountedExpectedCashFlowAmount = `default(decimal)`,
		decimal?	dayCountFraction = `default(decimal?)`,
		decimal?	forwardRate = `default(decimal?)`,
		decimal?	resetRate = `default(decimal?)`,
		decimal?	spread = `default(decimal?)`
	)

inline

Initializes a new instance of the InstrumentPaymentDiaryRow class.

Parameters

quantity	The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it..
currency	The payment currency of the cash flow..
paymentDate	The date at which the given cash flow is due to be paid..
payOrReceive	Does the cash flow belong to the Pay or Receive leg..
accrualStart	The date on which accruals start for this cashflow..
accrualEnd	The date on which accruals end for this cashflow..
cashFlowType	The type of cashflow..
isCashFlowDetermined	Is the cashflow determined as of the effective date time..
isCashFlowHistoric	Has the cashflow been paid, i.e. has it become a historic cashflow, as of the date and time pointed to be effectiveAt..
discountFactor	Weighting factor to discount cashflow to the present value..
discountedExpectedCashFlowAmount	The expected cashflow amount taking into account the discount factor..
dayCountFraction	The day count fraction, if appropriate..
forwardRate	Forward rate for cash flow if appropriate. (as in for a rates fixed or floating leg).
resetRate	The value of the reset, if any..
spread	The spread that exists on the payoff..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if InstrumentPaymentDiaryRow instances are equal

Parameters

input Instance of InstrumentPaymentDiaryRow to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.InstrumentPaymentDiaryRow.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccrualEnd

DateTimeOffset Lusid.Sdk.Model.InstrumentPaymentDiaryRow.AccrualEnd

getset

The date on which accruals end for this cashflow.

◆ AccrualStart

DateTimeOffset Lusid.Sdk.Model.InstrumentPaymentDiaryRow.AccrualStart

getset

The date on which accruals start for this cashflow.

◆ CashFlowType

string Lusid.Sdk.Model.InstrumentPaymentDiaryRow.CashFlowType

getset

The type of cashflow.

◆ Currency

string Lusid.Sdk.Model.InstrumentPaymentDiaryRow.Currency

getset

The payment currency of the cash flow.

◆ DayCountFraction

decimal? Lusid.Sdk.Model.InstrumentPaymentDiaryRow.DayCountFraction

getset

The day count fraction, if appropriate.

◆ DiscountedExpectedCashFlowAmount

decimal Lusid.Sdk.Model.InstrumentPaymentDiaryRow.DiscountedExpectedCashFlowAmount

getset

The expected cashflow amount taking into account the discount factor.

◆ DiscountFactor

decimal Lusid.Sdk.Model.InstrumentPaymentDiaryRow.DiscountFactor

getset

Weighting factor to discount cashflow to the present value.

◆ ForwardRate

decimal? Lusid.Sdk.Model.InstrumentPaymentDiaryRow.ForwardRate

getset

Forward rate for cash flow if appropriate. (as in for a rates fixed or floating leg)

◆ IsCashFlowDetermined

bool Lusid.Sdk.Model.InstrumentPaymentDiaryRow.IsCashFlowDetermined

getset

Is the cashflow determined as of the effective date time.

◆ IsCashFlowHistoric

bool Lusid.Sdk.Model.InstrumentPaymentDiaryRow.IsCashFlowHistoric

getset

Has the cashflow been paid, i.e. has it become a historic cashflow, as of the date and time pointed to be effectiveAt.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.InstrumentPaymentDiaryRow.PaymentDate

getset

The date at which the given cash flow is due to be paid.

◆ PayOrReceive

string Lusid.Sdk.Model.InstrumentPaymentDiaryRow.PayOrReceive

getset

Does the cash flow belong to the Pay or Receive leg.

◆ Quantity

decimal Lusid.Sdk.Model.InstrumentPaymentDiaryRow.Quantity

getset

The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.

◆ ResetRate

decimal? Lusid.Sdk.Model.InstrumentPaymentDiaryRow.ResetRate

getset

The value of the reset, if any.

◆ Spread

decimal? Lusid.Sdk.Model.InstrumentPaymentDiaryRow.Spread

getset

The spread that exists on the payoff.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentPaymentDiaryRow()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccrualEnd

◆ AccrualStart

◆ CashFlowType

◆ Currency

◆ DayCountFraction

◆ DiscountedExpectedCashFlowAmount

◆ DiscountFactor

◆ ForwardRate

◆ IsCashFlowDetermined

◆ IsCashFlowHistoric

◆ PaymentDate

◆ PayOrReceive

◆ Quantity

◆ ResetRate

◆ Spread