The details for the cashflow for a given portfolio. More...

Inheritance diagram for Lusid.Sdk.Model.PortfolioCashFlow:

Public Member Functions
	PortfolioCashFlow (int groupById=default(int), int sequenceNumber=default(int), DateTimeOffset effectiveDate=default(DateTimeOffset), Dictionary< string, PerpetualProperty > subHoldingKeys=default(Dictionary< string, PerpetualProperty >), string type=default(string), string movementName=default(string), CurrencyAndAmount cashflow=default(CurrencyAndAmount), CurrencyAndAmount balance=default(CurrencyAndAmount), decimal fxRate=default(decimal), CurrencyAndAmount cashflowReportingCurrency=default(CurrencyAndAmount), CurrencyAndAmount balanceReportingCurrency=default(CurrencyAndAmount), CurrencyAndAmount translationGainLoss=default(CurrencyAndAmount), CurrencyAndAmount costBasisReportingCurrency=default(CurrencyAndAmount), Transaction transaction=default(Transaction), CurrencyAndAmount unrealisedGainLossReportingCurrency=default(CurrencyAndAmount), List< Link > links=default(List< Link >))
	Initializes a new instance of the PortfolioCashFlow 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 (PortfolioCashFlow input)
	Returns true if PortfolioCashFlow instances are equal More...

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

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

Properties
int	GroupById `[get, set]`
	The groupBy subHoldings and currency. More...

int	SequenceNumber `[get, set]`
	Sequence number determining the order of the cash flow records. More...

DateTimeOffset	EffectiveDate `[get, set]`
	Indicates the date when the cash-flow settles. More...

Dictionary< string, PerpetualProperty >	SubHoldingKeys `[get, set]`
	The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio. More...

string	Type `[get, set]`
	Indicates the record type (Closed, Open, Activity). More...

string	MovementName `[get, set]`
	Indicates the specific movement of the transaction that generated this cash flow. More...

CurrencyAndAmount	Cashflow `[get, set]`
	Gets or Sets Cashflow More...

CurrencyAndAmount	Balance `[get, set]`
	Gets or Sets Balance More...

decimal	FxRate `[get, set]`
	Exchange rate between the currency of this cash flow and the reporting currency. More...

CurrencyAndAmount	CashflowReportingCurrency `[get, set]`
	Gets or Sets CashflowReportingCurrency More...

CurrencyAndAmount	BalanceReportingCurrency `[get, set]`
	Gets or Sets BalanceReportingCurrency More...

CurrencyAndAmount	TranslationGainLoss `[get, set]`
	Gets or Sets TranslationGainLoss More...

CurrencyAndAmount	CostBasisReportingCurrency `[get, set]`
	Gets or Sets CostBasisReportingCurrency More...

Transaction	Transaction `[get, set]`
	Gets or Sets Transaction More...

CurrencyAndAmount	UnrealisedGainLossReportingCurrency `[get, set]`
	Gets or Sets UnrealisedGainLossReportingCurrency More...

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

Detailed Description

The details for the cashflow for a given portfolio.

Constructor & Destructor Documentation

◆ PortfolioCashFlow() [1/2]

Lusid.Sdk.Model.PortfolioCashFlow.PortfolioCashFlow ( )

inlineprotected

Initializes a new instance of the PortfolioCashFlow class.

◆ PortfolioCashFlow() [2/2]

Lusid.Sdk.Model.PortfolioCashFlow.PortfolioCashFlow	(	int	groupById = `default(int)`,
		int	sequenceNumber = `default(int)`,
		DateTimeOffset	effectiveDate = `default(DateTimeOffset)`,
		Dictionary< string, PerpetualProperty >	subHoldingKeys = `default(Dictionary<string, PerpetualProperty>)`,
		string	type = `default(string)`,
		string	movementName = `default(string)`,
		CurrencyAndAmount	cashflow = `default(CurrencyAndAmount)`,
		CurrencyAndAmount	balance = `default(CurrencyAndAmount)`,
		decimal	fxRate = `default(decimal)`,
		CurrencyAndAmount	cashflowReportingCurrency = `default(CurrencyAndAmount)`,
		CurrencyAndAmount	balanceReportingCurrency = `default(CurrencyAndAmount)`,
		CurrencyAndAmount	translationGainLoss = `default(CurrencyAndAmount)`,
		CurrencyAndAmount	costBasisReportingCurrency = `default(CurrencyAndAmount)`,
		Transaction	transaction = `default(Transaction)`,
		CurrencyAndAmount	unrealisedGainLossReportingCurrency = `default(CurrencyAndAmount)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the PortfolioCashFlow class.

Parameters

groupById	The groupBy subHoldings and currency. (required).
sequenceNumber	Sequence number determining the order of the cash flow records. (required).
effectiveDate	Indicates the date when the cash-flow settles..
subHoldingKeys	The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio..
type	Indicates the record type (Closed, Open, Activity). (required).
movementName	Indicates the specific movement of the transaction that generated this cash flow. (required).
cashflow	cashflow (required).
balance	balance (required).
fxRate	Exchange rate between the currency of this cash flow and the reporting currency. (required).
cashflowReportingCurrency	cashflowReportingCurrency (required).
balanceReportingCurrency	balanceReportingCurrency (required).
translationGainLoss	translationGainLoss (required).
costBasisReportingCurrency	costBasisReportingCurrency (required).
transaction	transaction.
unrealisedGainLossReportingCurrency	unrealisedGainLossReportingCurrency (required).
links	links.

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.PortfolioCashFlow.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.PortfolioCashFlow.Equals ( PortfolioCashFlow input )

inline

Returns true if PortfolioCashFlow instances are equal

Parameters

input Instance of PortfolioCashFlow to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Balance

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.Balance

getset

Gets or Sets Balance

◆ BalanceReportingCurrency

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.BalanceReportingCurrency

getset

Gets or Sets BalanceReportingCurrency

◆ Cashflow

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.Cashflow

getset

Gets or Sets Cashflow

◆ CashflowReportingCurrency

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.CashflowReportingCurrency

getset

Gets or Sets CashflowReportingCurrency

◆ CostBasisReportingCurrency

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.CostBasisReportingCurrency

getset

Gets or Sets CostBasisReportingCurrency

◆ EffectiveDate

DateTimeOffset Lusid.Sdk.Model.PortfolioCashFlow.EffectiveDate

getset

Indicates the date when the cash-flow settles.

◆ FxRate

decimal Lusid.Sdk.Model.PortfolioCashFlow.FxRate

getset

Exchange rate between the currency of this cash flow and the reporting currency.

◆ GroupById

int Lusid.Sdk.Model.PortfolioCashFlow.GroupById

getset

The groupBy subHoldings and currency.

◆ Links

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

getset

Gets or Sets Links

◆ MovementName

string Lusid.Sdk.Model.PortfolioCashFlow.MovementName

getset

Indicates the specific movement of the transaction that generated this cash flow.

◆ SequenceNumber

int Lusid.Sdk.Model.PortfolioCashFlow.SequenceNumber

getset

Sequence number determining the order of the cash flow records.

◆ SubHoldingKeys

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.PortfolioCashFlow.SubHoldingKeys

getset

The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio.

◆ Transaction

Transaction Lusid.Sdk.Model.PortfolioCashFlow.Transaction

getset

Gets or Sets Transaction

◆ TranslationGainLoss

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.TranslationGainLoss

getset

Gets or Sets TranslationGainLoss

◆ Type

string Lusid.Sdk.Model.PortfolioCashFlow.Type

getset

Indicates the record type (Closed, Open, Activity).

◆ UnrealisedGainLossReportingCurrency

CurrencyAndAmount Lusid.Sdk.Model.PortfolioCashFlow.UnrealisedGainLossReportingCurrency

getset

Gets or Sets UnrealisedGainLossReportingCurrency

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PortfolioCashFlow() [1/2]

◆ PortfolioCashFlow() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Balance

◆ BalanceReportingCurrency

◆ Cashflow

◆ CashflowReportingCurrency

◆ CostBasisReportingCurrency

◆ EffectiveDate

◆ FxRate

◆ GroupById

◆ Links

◆ MovementName

◆ SequenceNumber

◆ SubHoldingKeys

◆ Transaction

◆ TranslationGainLoss

◆ Type

◆ UnrealisedGainLossReportingCurrency