The details for the cashflow associated with an instrument from a given portfolio. More...

Inheritance diagram for Lusid.Sdk.Model.InstrumentCashFlow:

Public Member Functions
	InstrumentCashFlow (DateTimeOffset paymentDate=default(DateTimeOffset), decimal? amount=default(decimal?), string currency=default(string), ResourceId sourcePortfolioId=default(ResourceId), string sourceTransactionId=default(string), string sourceInstrumentScope=default(string), string sourceInstrumentId=default(string), Dictionary< string, string > diagnostics=default(Dictionary< string, string >), List< Link > links=default(List< Link >))
	Initializes a new instance of the InstrumentCashFlow 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 (InstrumentCashFlow input)
	Returns true if InstrumentCashFlow instances are equal More...

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

Protected Member Functions
	InstrumentCashFlow ()
	Initializes a new instance of the InstrumentCashFlow class. More...

Properties
DateTimeOffset	PaymentDate `[get, set]`
	The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.) More...

decimal?	Amount `[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...

ResourceId	SourcePortfolioId `[get, set]`
	Gets or Sets SourcePortfolioId More...

string	SourceTransactionId `[get, set]`
	The identifier for the parent transaction on the instrument that will pay/receive this cash flow. More...

string	SourceInstrumentScope `[get, set]`
	The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. More...

string	SourceInstrumentId `[get, set]`
	The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. More...

Dictionary< string, string >	Diagnostics `[get, set]`
	Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data. More...

List< Link >	Links `[get, set]`
	Gets or Sets Links More...

Detailed Description

The details for the cashflow associated with an instrument from a given portfolio.

Constructor & Destructor Documentation

◆ InstrumentCashFlow() [1/2]

Lusid.Sdk.Model.InstrumentCashFlow.InstrumentCashFlow ( )

inlineprotected

Initializes a new instance of the InstrumentCashFlow class.

◆ InstrumentCashFlow() [2/2]

Lusid.Sdk.Model.InstrumentCashFlow.InstrumentCashFlow	(	DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		decimal?	amount = `default(decimal?)`,
		string	currency = `default(string)`,
		ResourceId	sourcePortfolioId = `default(ResourceId)`,
		string	sourceTransactionId = `default(string)`,
		string	sourceInstrumentScope = `default(string)`,
		string	sourceInstrumentId = `default(string)`,
		Dictionary< string, string >	diagnostics = `default(Dictionary<string, string>)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the InstrumentCashFlow class.

Parameters

paymentDate	The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.) (required).
amount	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. (required).
sourcePortfolioId	sourcePortfolioId (required).
sourceTransactionId	The identifier for the parent transaction on the instrument that will pay/receive this cash flow. (required).
sourceInstrumentScope	The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required).
sourceInstrumentId	The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required).
diagnostics	Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data. (required).
links	links.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if InstrumentCashFlow instances are equal

Parameters

input Instance of InstrumentCashFlow to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Amount

decimal? Lusid.Sdk.Model.InstrumentCashFlow.Amount

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.

◆ Currency

string Lusid.Sdk.Model.InstrumentCashFlow.Currency

getset

The payment currency of the cash flow.

◆ Diagnostics

Dictionary<string, string> Lusid.Sdk.Model.InstrumentCashFlow.Diagnostics

getset

Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data.

◆ Links

List<Link> Lusid.Sdk.Model.InstrumentCashFlow.Links

getset

Gets or Sets Links

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.InstrumentCashFlow.PaymentDate

getset

The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)

◆ SourceInstrumentId

string Lusid.Sdk.Model.InstrumentCashFlow.SourceInstrumentId

getset

The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.

◆ SourceInstrumentScope

string Lusid.Sdk.Model.InstrumentCashFlow.SourceInstrumentScope

getset

The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.

◆ SourcePortfolioId

ResourceId Lusid.Sdk.Model.InstrumentCashFlow.SourcePortfolioId

getset

Gets or Sets SourcePortfolioId

◆ SourceTransactionId

string Lusid.Sdk.Model.InstrumentCashFlow.SourceTransactionId

getset

The identifier for the parent transaction on the instrument that will pay/receive this cash flow.

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ InstrumentCashFlow() [1/2]

◆ InstrumentCashFlow() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Amount

◆ Currency

◆ Diagnostics

◆ Links

◆ PaymentDate

◆ SourceInstrumentId

◆ SourceInstrumentScope

◆ SourcePortfolioId

◆ SourceTransactionId