LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.PortfolioHolding Class Reference

A list of holdings. More...

Inheritance diagram for Lusid.Sdk.Model.PortfolioHolding:
Inheritance graph
[legend]

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?), CurrencyAndAmount notionalCost=default(CurrencyAndAmount), CurrencyAndAmount amortisedCost=default(CurrencyAndAmount), CurrencyAndAmount amortisedCostPortfolioCcy=default(CurrencyAndAmount), CurrencyAndAmount variationMargin=default(CurrencyAndAmount), CurrencyAndAmount variationMarginPortfolioCcy=default(CurrencyAndAmount), List< SettlementSchedule > settlementSchedule=default(List< SettlementSchedule >))
 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&#39;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, PerpetualPropertySubHoldingKeys [get, set]
 The sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; domain. These are configured on a transaction portfolio. More...
 
Dictionary< string, PropertyProperties [get, set]
 The properties which have been requested to be decorated onto the holding. These will be from the &#39;Instrument&#39; or &#39;Holding&#39; 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...
 
CurrencyAndAmount NotionalCost [get, set]
 Gets or Sets NotionalCost More...
 
CurrencyAndAmount AmortisedCost [get, set]
 Gets or Sets AmortisedCost More...
 
CurrencyAndAmount AmortisedCostPortfolioCcy [get, set]
 Gets or Sets AmortisedCostPortfolioCcy More...
 
CurrencyAndAmount VariationMargin [get, set]
 Gets or Sets VariationMargin More...
 
CurrencyAndAmount VariationMarginPortfolioCcy [get, set]
 Gets or Sets VariationMarginPortfolioCcy More...
 
List< SettlementScheduleSettlementSchedule [get, set]
 Where no. of days ahead has been specified, future dated settlements will be captured here. 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?),
CurrencyAndAmount  notionalCost = default(CurrencyAndAmount),
CurrencyAndAmount  amortisedCost = default(CurrencyAndAmount),
CurrencyAndAmount  amortisedCostPortfolioCcy = default(CurrencyAndAmount),
CurrencyAndAmount  variationMargin = default(CurrencyAndAmount),
CurrencyAndAmount  variationMarginPortfolioCcy = default(CurrencyAndAmount),
List< SettlementSchedule settlementSchedule = default(List<SettlementSchedule>) 
)
inline

Initializes a new instance of the PortfolioHolding class.

Parameters
instrumentScopeThe scope in which the holding&#39;s instrument is in..
instrumentUidThe unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required).
subHoldingKeysThe sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; domain. These are configured on a transaction portfolio..
propertiesThe properties which have been requested to be decorated onto the holding. These will be from the &#39;Instrument&#39; or &#39;Holding&#39; domain..
holdingTypeThe code for the type of the holding e.g. P, B, C, R, F etc. (required).
unitsThe total number of units of the holding. (required).
settledUnitsThe total number of settled units of the holding. (required).
costcost (required).
costPortfolioCcycostPortfolioCcy (required).
transactiontransaction.
currencyThe holding currency..
holdingTypeNameThe decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc..
holdingIdA 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..
notionalCostnotionalCost.
amortisedCostamortisedCost.
amortisedCostPortfolioCcyamortisedCostPortfolioCcy.
variationMarginvariationMargin.
variationMarginPortfolioCcyvariationMarginPortfolioCcy.
settlementScheduleWhere no. of days ahead has been specified, future dated settlements will be captured here..

Member Function Documentation

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.PortfolioHolding.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject 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
inputInstance 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

◆ AmortisedCost

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.AmortisedCost
getset

Gets or Sets AmortisedCost

◆ AmortisedCostPortfolioCcy

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.AmortisedCostPortfolioCcy
getset

Gets or Sets AmortisedCostPortfolioCcy

◆ 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.

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.

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.

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.

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&#39;s instrument is in.

The scope in which the holding&#39;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.

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

◆ NotionalCost

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.NotionalCost
getset

Gets or Sets NotionalCost

◆ 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 &#39;Instrument&#39; or &#39;Holding&#39; domain.

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

◆ SettledUnits

decimal Lusid.Sdk.Model.PortfolioHolding.SettledUnits
getset

The total number of settled units of the holding.

The total number of settled units of the holding.

◆ SettlementSchedule

List<SettlementSchedule> Lusid.Sdk.Model.PortfolioHolding.SettlementSchedule
getset

Where no. of days ahead has been specified, future dated settlements will be captured here.

Where no. of days ahead has been specified, future dated settlements will be captured here.

◆ SubHoldingKeys

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.PortfolioHolding.SubHoldingKeys
getset

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

The sub-holding properties which identify the holding. Each property will be from the &#39;Transaction&#39; 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 total number of units of the holding.

◆ VariationMargin

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.VariationMargin
getset

Gets or Sets VariationMargin

◆ VariationMarginPortfolioCcy

CurrencyAndAmount Lusid.Sdk.Model.PortfolioHolding.VariationMarginPortfolioCcy
getset

Gets or Sets VariationMarginPortfolioCcy


The documentation for this class was generated from the following file: