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

PortfolioDetails More...

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

Public Types

enum class  AccountingMethodEnum {
  Default = 1 , AverageCost = 2 , FirstInFirstOut = 3 , LastInFirstOut = 4 ,
  HighestCostFirst = 5 , LowestCostFirst = 6 , ProRateByUnits = 7 , ProRateByCost = 8 ,
  ProRateByCostPortfolioCurrency = 9 , IntraDayThenFirstInFirstOut = 10 , LongTermHighestCostFirst = 11 , LongTermHighestCostFirstPortfolioCurrency = 12 ,
  HighestCostFirstPortfolioCurrency = 13 , LowestCostFirstPortfolioCurrency = 14 , MaximumLossMinimumGain = 15 , MaximumLossMinimumGainPortfolioCurrency = 16
}
 The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency. More...
 

Public Member Functions

 PortfolioDetails (string href=default(string), ResourceId originPortfolioId=default(ResourceId), ModelVersion varVersion=default(ModelVersion), string baseCurrency=default(string), ResourceId corporateActionSourceId=default(ResourceId), List< string > subHoldingKeys=default(List< string >), List< string > instrumentScopes=default(List< string >), AccountingMethodEnum ?accountingMethod=default(AccountingMethodEnum?), string amortisationMethod=default(string), string transactionTypeScope=default(string), string cashGainLossCalculationDate=default(string), InstrumentEventConfiguration instrumentEventConfiguration=default(InstrumentEventConfiguration), ResourceId amortisationRuleSetId=default(ResourceId), string taxRuleSetScope=default(string), PortfolioSettlementConfiguration settlementConfiguration=default(PortfolioSettlementConfiguration), StagedModificationsInfo stagedModifications=default(StagedModificationsInfo), List< Link > links=default(List< Link >))
 Initializes a new instance of the PortfolioDetails 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 (PortfolioDetails input)
 Returns true if PortfolioDetails instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 PortfolioDetails ()
 Initializes a new instance of the PortfolioDetails class. More...
 

Properties

AccountingMethodEnumAccountingMethod [get, set]
 The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency. More...
 
string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
ResourceId OriginPortfolioId [get, set]
 Gets or Sets OriginPortfolioId More...
 
ModelVersion VarVersion [get, set]
 Gets or Sets VarVersion More...
 
string BaseCurrency [get, set]
 The base currency of the transaction portfolio. More...
 
ResourceId CorporateActionSourceId [get, set]
 Gets or Sets CorporateActionSourceId More...
 
List< string > SubHoldingKeys [get, set]
 Gets or Sets SubHoldingKeys More...
 
List< string > InstrumentScopes [get, set]
 The resolution strategy used to resolve instruments of transactions/holdings upserted to the transaction portfolio. More...
 
string AmortisationMethod [get, set]
 The amortisation method used by the portfolio for the calculation. Available values: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate. More...
 
string TransactionTypeScope [get, set]
 The scope of the transaction types. More...
 
string CashGainLossCalculationDate [get, set]
 The option when the Cash Gain Loss to be calulated. Default value: SettlementDate. More...
 
InstrumentEventConfiguration InstrumentEventConfiguration [get, set]
 Gets or Sets InstrumentEventConfiguration More...
 
ResourceId AmortisationRuleSetId [get, set]
 Gets or Sets AmortisationRuleSetId More...
 
string TaxRuleSetScope [get, set]
 The scope of the tax rule sets for this portfolio. More...
 
PortfolioSettlementConfiguration SettlementConfiguration [get, set]
 Gets or Sets SettlementConfiguration More...
 
StagedModificationsInfo StagedModifications [get, set]
 Gets or Sets StagedModifications More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

PortfolioDetails

Member Enumeration Documentation

◆ AccountingMethodEnum

The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency.

The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency.

Enumerator
Default 

Enum Default for value: Default

AverageCost 

Enum AverageCost for value: AverageCost

FirstInFirstOut 

Enum FirstInFirstOut for value: FirstInFirstOut

LastInFirstOut 

Enum LastInFirstOut for value: LastInFirstOut

HighestCostFirst 

Enum HighestCostFirst for value: HighestCostFirst

LowestCostFirst 

Enum LowestCostFirst for value: LowestCostFirst

ProRateByUnits 

Enum ProRateByUnits for value: ProRateByUnits

ProRateByCost 

Enum ProRateByCost for value: ProRateByCost

ProRateByCostPortfolioCurrency 

Enum ProRateByCostPortfolioCurrency for value: ProRateByCostPortfolioCurrency

IntraDayThenFirstInFirstOut 

Enum IntraDayThenFirstInFirstOut for value: IntraDayThenFirstInFirstOut

LongTermHighestCostFirst 

Enum LongTermHighestCostFirst for value: LongTermHighestCostFirst

LongTermHighestCostFirstPortfolioCurrency 

Enum LongTermHighestCostFirstPortfolioCurrency for value: LongTermHighestCostFirstPortfolioCurrency

HighestCostFirstPortfolioCurrency 

Enum HighestCostFirstPortfolioCurrency for value: HighestCostFirstPortfolioCurrency

LowestCostFirstPortfolioCurrency 

Enum LowestCostFirstPortfolioCurrency for value: LowestCostFirstPortfolioCurrency

MaximumLossMinimumGain 

Enum MaximumLossMinimumGain for value: MaximumLossMinimumGain

MaximumLossMinimumGainPortfolioCurrency 

Enum MaximumLossMinimumGainPortfolioCurrency for value: MaximumLossMinimumGainPortfolioCurrency

Constructor & Destructor Documentation

◆ PortfolioDetails() [1/2]

Lusid.Sdk.Model.PortfolioDetails.PortfolioDetails ( )
inlineprotected

Initializes a new instance of the PortfolioDetails class.

◆ PortfolioDetails() [2/2]

Lusid.Sdk.Model.PortfolioDetails.PortfolioDetails ( string  href = default(string),
ResourceId  originPortfolioId = default(ResourceId),
ModelVersion  varVersion = default(ModelVersion),
string  baseCurrency = default(string),
ResourceId  corporateActionSourceId = default(ResourceId),
List< string >  subHoldingKeys = default(List<string>),
List< string >  instrumentScopes = default(List<string>),
AccountingMethodEnum accountingMethod = default(AccountingMethodEnum?),
string  amortisationMethod = default(string),
string  transactionTypeScope = default(string),
string  cashGainLossCalculationDate = default(string),
InstrumentEventConfiguration  instrumentEventConfiguration = default(InstrumentEventConfiguration),
ResourceId  amortisationRuleSetId = default(ResourceId),
string  taxRuleSetScope = default(string),
PortfolioSettlementConfiguration  settlementConfiguration = default(PortfolioSettlementConfiguration),
StagedModificationsInfo  stagedModifications = default(StagedModificationsInfo),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the PortfolioDetails class.

Parameters
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
originPortfolioIdoriginPortfolioId (required).
varVersionvarVersion (required).
baseCurrencyThe base currency of the transaction portfolio. (required).
corporateActionSourceIdcorporateActionSourceId.
subHoldingKeyssubHoldingKeys.
instrumentScopesThe resolution strategy used to resolve instruments of transactions/holdings upserted to the transaction portfolio..
accountingMethodThe AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency..
amortisationMethodThe amortisation method used by the portfolio for the calculation. Available values: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate..
transactionTypeScopeThe scope of the transaction types..
cashGainLossCalculationDateThe option when the Cash Gain Loss to be calulated. Default value: SettlementDate..
instrumentEventConfigurationinstrumentEventConfiguration.
amortisationRuleSetIdamortisationRuleSetId.
taxRuleSetScopeThe scope of the tax rule sets for this portfolio..
settlementConfigurationsettlementConfiguration.
stagedModificationsstagedModifications.
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.PortfolioDetails.Equals ( PortfolioDetails  input)
inline

Returns true if PortfolioDetails instances are equal

Parameters
inputInstance of PortfolioDetails to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.PortfolioDetails.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.PortfolioDetails.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.PortfolioDetails.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccountingMethod

AccountingMethodEnum? Lusid.Sdk.Model.PortfolioDetails.AccountingMethod
getset

The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency.

The AccountingMethod used for the portfolio. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency.

◆ AmortisationMethod

string Lusid.Sdk.Model.PortfolioDetails.AmortisationMethod
getset

The amortisation method used by the portfolio for the calculation. Available values: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate.

The amortisation method used by the portfolio for the calculation. Available values: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate.

◆ AmortisationRuleSetId

ResourceId Lusid.Sdk.Model.PortfolioDetails.AmortisationRuleSetId
getset

Gets or Sets AmortisationRuleSetId

◆ BaseCurrency

string Lusid.Sdk.Model.PortfolioDetails.BaseCurrency
getset

The base currency of the transaction portfolio.

The base currency of the transaction portfolio.

◆ CashGainLossCalculationDate

string Lusid.Sdk.Model.PortfolioDetails.CashGainLossCalculationDate
getset

The option when the Cash Gain Loss to be calulated. Default value: SettlementDate.

The option when the Cash Gain Loss to be calulated. Default value: SettlementDate.

◆ CorporateActionSourceId

ResourceId Lusid.Sdk.Model.PortfolioDetails.CorporateActionSourceId
getset

Gets or Sets CorporateActionSourceId

◆ Href

string Lusid.Sdk.Model.PortfolioDetails.Href
getset

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.

◆ InstrumentEventConfiguration

InstrumentEventConfiguration Lusid.Sdk.Model.PortfolioDetails.InstrumentEventConfiguration
getset

◆ InstrumentScopes

List<string> Lusid.Sdk.Model.PortfolioDetails.InstrumentScopes
getset

The resolution strategy used to resolve instruments of transactions/holdings upserted to the transaction portfolio.

The resolution strategy used to resolve instruments of transactions/holdings upserted to the transaction portfolio.

◆ Links

List<Link> Lusid.Sdk.Model.PortfolioDetails.Links
getset

Gets or Sets Links

◆ OriginPortfolioId

ResourceId Lusid.Sdk.Model.PortfolioDetails.OriginPortfolioId
getset

Gets or Sets OriginPortfolioId

◆ SettlementConfiguration

PortfolioSettlementConfiguration Lusid.Sdk.Model.PortfolioDetails.SettlementConfiguration
getset

Gets or Sets SettlementConfiguration

◆ StagedModifications

StagedModificationsInfo Lusid.Sdk.Model.PortfolioDetails.StagedModifications
getset

Gets or Sets StagedModifications

◆ SubHoldingKeys

List<string> Lusid.Sdk.Model.PortfolioDetails.SubHoldingKeys
getset

Gets or Sets SubHoldingKeys

◆ TaxRuleSetScope

string Lusid.Sdk.Model.PortfolioDetails.TaxRuleSetScope
getset

The scope of the tax rule sets for this portfolio.

The scope of the tax rule sets for this portfolio.

◆ TransactionTypeScope

string Lusid.Sdk.Model.PortfolioDetails.TransactionTypeScope
getset

The scope of the transaction types.

The scope of the transaction types.

◆ VarVersion

ModelVersion Lusid.Sdk.Model.PortfolioDetails.VarVersion
getset

Gets or Sets VarVersion


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