A list of holdings. More...

Inheritance diagram for Lusid.Sdk.Model.PortfolioHolding:

Public Member Functions
	PortfolioHolding (string instrumentScope=default(string), string instrumentUid=default(string), Dictionary< string, PerpetualProperty > subHoldingKeys=default(Dictionary< string, PerpetualProperty >), Dictionary< string, Property > properties=default(Dictionary< string, Property >), string holdingType=default(string), decimal units=default(decimal), decimal settledUnits=default(decimal), CurrencyAndAmount cost=default(CurrencyAndAmount), CurrencyAndAmount costPortfolioCcy=default(CurrencyAndAmount), Transaction transaction=default(Transaction), string currency=default(string), string holdingTypeName=default(string), long? holdingId=default(long?))
	Initializes a new instance of the PortfolioHolding 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 (PortfolioHolding input)
	Returns true if PortfolioHolding instances are equal More...

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

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

Properties
string	InstrumentScope `[get, set]`
	The scope in which the holding's instrument is in. More...

string	InstrumentUid `[get, set]`
	The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. 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...

Dictionary< string, Property >	Properties `[get, set]`
	The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain. More...

string	HoldingType `[get, set]`
	The code for the type of the holding e.g. P, B, C, R, F etc. More...

decimal	Units `[get, set]`
	The total number of units of the holding. More...

decimal	SettledUnits `[get, set]`
	The total number of settled units of the holding. More...

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

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

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

string	Currency `[get, set]`
	The holding currency. More...

string	HoldingTypeName `[get, set]`
	The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc. More...

long?	HoldingId `[get, set]`
	A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio. More...

Detailed Description

A list of holdings.

Constructor & Destructor Documentation

◆ PortfolioHolding() [1/2]

Lusid.Sdk.Model.PortfolioHolding.PortfolioHolding ( )

inlineprotected

Initializes a new instance of the PortfolioHolding class.

◆ PortfolioHolding() [2/2]

Lusid.Sdk.Model.PortfolioHolding.PortfolioHolding	(	string	instrumentScope = `default(string)`,
		string	instrumentUid = `default(string)`,
		Dictionary< string, PerpetualProperty >	subHoldingKeys = `default(Dictionary<string, PerpetualProperty>)`,
		Dictionary< string, Property >	properties = `default(Dictionary<string, Property>)`,
		string	holdingType = `default(string)`,
		decimal	units = `default(decimal)`,
		decimal	settledUnits = `default(decimal)`,
		CurrencyAndAmount	cost = `default(CurrencyAndAmount)`,
		CurrencyAndAmount	costPortfolioCcy = `default(CurrencyAndAmount)`,
		Transaction	transaction = `default(Transaction)`,
		string	currency = `default(string)`,
		string	holdingTypeName = `default(string)`,
		long?	holdingId = `default(long?)`
	)

inline

Initializes a new instance of the PortfolioHolding class.

Parameters

instrumentScope	The scope in which the holding's instrument is in..
instrumentUid	The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required).
subHoldingKeys	The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio..
properties	The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain..
holdingType	The code for the type of the holding e.g. P, B, C, R, F etc. (required).
units	The total number of units of the holding. (required).
settledUnits	The total number of settled units of the holding. (required).
cost	cost (required).
costPortfolioCcy	costPortfolioCcy (required).
transaction	transaction.
currency	The holding currency..
holdingTypeName	The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc..
holdingId	A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if PortfolioHolding instances are equal

Parameters

input Instance of PortfolioHolding to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Cost

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.Cost

getset

Gets or Sets Cost

◆ CostPortfolioCcy

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.CostPortfolioCcy

getset

Gets or Sets CostPortfolioCcy

◆ Currency

string Lusid.Sdk.Model.PortfolioHolding.Currency

getset

The holding currency.

◆ HoldingId

long? Lusid.Sdk.Model.PortfolioHolding.HoldingId

getset

A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.

◆ HoldingType

string Lusid.Sdk.Model.PortfolioHolding.HoldingType

getset

The code for the type of the holding e.g. P, B, C, R, F etc.

◆ HoldingTypeName

string Lusid.Sdk.Model.PortfolioHolding.HoldingTypeName

getset

The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc.

◆ InstrumentScope

string Lusid.Sdk.Model.PortfolioHolding.InstrumentScope

getset

The scope in which the holding's instrument is in.

◆ InstrumentUid

string Lusid.Sdk.Model.PortfolioHolding.InstrumentUid

getset

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

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.PortfolioHolding.Properties

getset

The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain.

◆ SettledUnits

decimal Lusid.Sdk.Model.PortfolioHolding.SettledUnits

getset

The total number of settled units of the holding.

◆ SubHoldingKeys

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.PortfolioHolding.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.PortfolioHolding.Transaction

getset

Gets or Sets Transaction

◆ Units

decimal Lusid.Sdk.Model.PortfolioHolding.Units

getset

The total number of units of the holding.

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

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PortfolioHolding() [1/2]

◆ PortfolioHolding() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Cost

◆ CostPortfolioCcy

◆ Currency

◆ HoldingId

◆ HoldingType

◆ HoldingTypeName

◆ InstrumentScope

◆ InstrumentUid

◆ Properties

◆ SettledUnits

◆ SubHoldingKeys

◆ Transaction

◆ Units