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

A list of portfolios. More...

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

Public Types

enum class  TypeEnum { Transaction = 1 , Reference = 2 , DerivedTransaction = 3 }
 The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction More...
 
enum class  AccountingMethodEnum {
  Default = 1 , AverageCost = 2 , FirstInFirstOut = 3 , LastInFirstOut = 4 ,
  HighestCostFirst = 5 , LowestCostFirst = 6
}
 . The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst More...
 

Public Member Functions

 Portfolio (string href=default(string), ResourceId id=default(ResourceId), TypeEnum type=default(TypeEnum), string displayName=default(string), string description=default(string), DateTimeOffset created=default(DateTimeOffset), ResourceId parentPortfolioId=default(ResourceId), ModelVersion version=default(ModelVersion), bool isDerived=default(bool), string baseCurrency=default(string), Dictionary< string, Property > properties=default(Dictionary< string, Property >), List< Relationship > relationships=default(List< Relationship >), List< string > instrumentScopes=default(List< string >), AccountingMethodEnum? accountingMethod=default(AccountingMethodEnum?), string amortisationMethod=default(string), string transactionTypeScope=default(string), string cashGainLossCalculationDate=default(string), List< Link > links=default(List< Link >))
 Initializes a new instance of the Portfolio 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 (Portfolio input)
 Returns true if Portfolio instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

TypeEnum Type [get, set]
 The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction More...
 
AccountingMethodEnumAccountingMethod [get, set]
 . The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst More...
 
string Href [get, set]
 The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More...
 
ResourceId Id [get, set]
 Gets or Sets Id More...
 
string DisplayName [get, set]
 The name of the portfolio. More...
 
string Description [get, set]
 The long form description of the portfolio. More...
 
DateTimeOffset Created [get, set]
 The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date. More...
 
ResourceId ParentPortfolioId [get, set]
 Gets or Sets ParentPortfolioId More...
 
ModelVersion _Version [get, set]
 Gets or Sets _Version More...
 
bool IsDerived [get, set]
 Whether or not this is a derived portfolio. More...
 
string BaseCurrency [get, set]
 The base currency of the portfolio. More...
 
Dictionary< string, PropertyProperties [get, set]
 The requested portfolio properties. These will be from the &#39;Portfolio&#39; domain. More...
 
List< RelationshipRelationships [get, set]
 A set of relationships associated to the portfolio. More...
 
List< string > InstrumentScopes [get, set]
 The instrument scope resolution strategy of this portfolio. More...
 
string AmortisationMethod [get, set]
 The amortisation method the portfolio is using in the calculation. This can be &#39;NoAmortisation&#39;, &#39;StraightLine&#39; or &#39;EffectiveYield&#39;. More...
 
string TransactionTypeScope [get, set]
 The scope of the transaction types. More...
 
string CashGainLossCalculationDate [get, set]
 The scope of the transaction types. More...
 
List< LinkLinks [get, set]
 Gets or Sets Links More...
 

Detailed Description

A list of portfolios.

Member Enumeration Documentation

◆ AccountingMethodEnum

. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

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

◆ TypeEnum

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction

Enumerator
Transaction 

Enum Transaction for value: Transaction

Reference 

Enum Reference for value: Reference

DerivedTransaction 

Enum DerivedTransaction for value: DerivedTransaction

Constructor & Destructor Documentation

◆ Portfolio() [1/2]

Lusid.Sdk.Model.Portfolio.Portfolio ( )
inlineprotected

Initializes a new instance of the Portfolio class.

◆ Portfolio() [2/2]

Lusid.Sdk.Model.Portfolio.Portfolio ( string  href = default(string),
ResourceId  id = default(ResourceId),
TypeEnum  type = default(TypeEnum),
string  displayName = default(string),
string  description = default(string),
DateTimeOffset  created = default(DateTimeOffset),
ResourceId  parentPortfolioId = default(ResourceId),
ModelVersion  version = default(ModelVersion),
bool  isDerived = default(bool),
string  baseCurrency = default(string),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
List< Relationship relationships = default(List<Relationship>),
List< string >  instrumentScopes = default(List<string>),
AccountingMethodEnum accountingMethod = default(AccountingMethodEnum?),
string  amortisationMethod = default(string),
string  transactionTypeScope = default(string),
string  cashGainLossCalculationDate = default(string),
List< Link links = default(List<Link>) 
)
inline

Initializes a new instance of the Portfolio class.

Parameters
hrefThe specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime..
idid (required).
typeThe type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction (required).
displayNameThe name of the portfolio. (required).
descriptionThe long form description of the portfolio..
createdThe effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date. (required).
parentPortfolioIdparentPortfolioId.
versionversion.
isDerivedWhether or not this is a derived portfolio..
baseCurrencyThe base currency of the portfolio..
propertiesThe requested portfolio properties. These will be from the &#39;Portfolio&#39; domain..
relationshipsA set of relationships associated to the portfolio..
instrumentScopesThe instrument scope resolution strategy of this portfolio..
accountingMethod. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst.
amortisationMethodThe amortisation method the portfolio is using in the calculation. This can be &#39;NoAmortisation&#39;, &#39;StraightLine&#39; or &#39;EffectiveYield&#39;..
transactionTypeScopeThe scope of the transaction types..
cashGainLossCalculationDateThe scope of the transaction types..
linkslinks.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if Portfolio instances are equal

Parameters
inputInstance of Portfolio to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.Portfolio._Version
getset

Gets or Sets _Version

◆ AccountingMethod

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

. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

◆ AmortisationMethod

string Lusid.Sdk.Model.Portfolio.AmortisationMethod
getset

The amortisation method the portfolio is using in the calculation. This can be &#39;NoAmortisation&#39;, &#39;StraightLine&#39; or &#39;EffectiveYield&#39;.

The amortisation method the portfolio is using in the calculation. This can be &#39;NoAmortisation&#39;, &#39;StraightLine&#39; or &#39;EffectiveYield&#39;.

◆ BaseCurrency

string Lusid.Sdk.Model.Portfolio.BaseCurrency
getset

The base currency of the portfolio.

The base currency of the portfolio.

◆ CashGainLossCalculationDate

string Lusid.Sdk.Model.Portfolio.CashGainLossCalculationDate
getset

The scope of the transaction types.

The scope of the transaction types.

◆ Created

DateTimeOffset Lusid.Sdk.Model.Portfolio.Created
getset

The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date.

The effective datetime at which the portfolio was created. No transactions or constituents can be added to the portfolio before this date.

◆ Description

string Lusid.Sdk.Model.Portfolio.Description
getset

The long form description of the portfolio.

The long form description of the portfolio.

◆ DisplayName

string Lusid.Sdk.Model.Portfolio.DisplayName
getset

The name of the portfolio.

The name of the portfolio.

◆ Href

string Lusid.Sdk.Model.Portfolio.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.

◆ Id

ResourceId Lusid.Sdk.Model.Portfolio.Id
getset

Gets or Sets Id

◆ InstrumentScopes

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

The instrument scope resolution strategy of this portfolio.

The instrument scope resolution strategy of this portfolio.

◆ IsDerived

bool Lusid.Sdk.Model.Portfolio.IsDerived
getset

Whether or not this is a derived portfolio.

Whether or not this is a derived portfolio.

◆ Links

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

Gets or Sets Links

◆ ParentPortfolioId

ResourceId Lusid.Sdk.Model.Portfolio.ParentPortfolioId
getset

Gets or Sets ParentPortfolioId

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.Portfolio.Properties
getset

The requested portfolio properties. These will be from the &#39;Portfolio&#39; domain.

The requested portfolio properties. These will be from the &#39;Portfolio&#39; domain.

◆ Relationships

List<Relationship> Lusid.Sdk.Model.Portfolio.Relationships
getset

A set of relationships associated to the portfolio.

A set of relationships associated to the portfolio.

◆ TransactionTypeScope

string Lusid.Sdk.Model.Portfolio.TransactionTypeScope
getset

The scope of the transaction types.

The scope of the transaction types.

◆ Type

TypeEnum Lusid.Sdk.Model.Portfolio.Type
getset

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction

The type of the portfolio. The available values are: Transaction, Reference, DerivedTransaction


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