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

CreateTransactionPortfolioRequest More...

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

Public Types

enum  AccountingMethodEnum {
  AccountingMethodEnum.Default = 1, AccountingMethodEnum.AverageCost = 2, AccountingMethodEnum.FirstInFirstOut = 3, AccountingMethodEnum.LastInFirstOut = 4,
  AccountingMethodEnum.HighestCostFirst = 5, AccountingMethodEnum.LowestCostFirst = 6
}
 Determines the accounting treatment given to the transaction portfolio's tax lots. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst More...
 

Public Member Functions

 CreateTransactionPortfolioRequest (string displayName=default(string), string description=default(string), string code=default(string), DateTimeOffset? created=default(DateTimeOffset?), string baseCurrency=default(string), ResourceId corporateActionSourceId=default(ResourceId), AccountingMethodEnum? accountingMethod=default(AccountingMethodEnum?), List< string > subHoldingKeys=default(List< string >), Dictionary< string, Property > properties=default(Dictionary< string, Property >))
 Initializes a new instance of the CreateTransactionPortfolioRequest 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 (CreateTransactionPortfolioRequest input)
 Returns true if CreateTransactionPortfolioRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

AccountingMethodEnum AccountingMethod [get, set]
 Determines the accounting treatment given to the transaction portfolio&#39;s tax lots. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst More...
 
string DisplayName [get, set]
 The name of the transaction portfolio. More...
 
string Description [get, set]
 A description for the transaction portfolio. More...
 
string Code [get, set]
 The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. More...
 
DateTimeOffset Created [get, set]
 The effective datetime at which to create the transaction portfolio. No transactions can be added to the transaction portfolio before this date. Defaults to the current LUSID system datetime if not specified. More...
 
string BaseCurrency [get, set]
 The base currency of the transaction portfolio in ISO 4217 currency code format. More...
 
ResourceId CorporateActionSourceId [get, set]
 Gets or Sets CorporateActionSourceId More...
 
List< string > SubHoldingKeys [get, set]
 A set of unique transaction properties to group the transaction portfolio&#39;s holdings by, perhaps for strategy tagging. Each property must be from the &#39;Transaction&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Transaction/strategies/quantsignal&#39;. Note that sub-holding keys cannot currently be added after the transaction portfolio has been created; see https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information. More...
 
Dictionary< string, PropertyProperties [get, set]
 A set of unique portfolio properties to add custom data to the transaction portfolio. Each property must be from the &#39;Portfolio&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Note these properties must be pre-defined. More...
 

Detailed Description

CreateTransactionPortfolioRequest

Member Enumeration Documentation

◆ AccountingMethodEnum

Determines the accounting treatment given to the transaction portfolio&#39;s tax lots. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

Determines the accounting treatment given to the transaction portfolio&#39;s tax lots. 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

Constructor & Destructor Documentation

◆ CreateTransactionPortfolioRequest() [1/2]

Lusid.Sdk.Model.CreateTransactionPortfolioRequest.CreateTransactionPortfolioRequest ( )
inlineprotected

Initializes a new instance of the CreateTransactionPortfolioRequest class.

◆ CreateTransactionPortfolioRequest() [2/2]

Lusid.Sdk.Model.CreateTransactionPortfolioRequest.CreateTransactionPortfolioRequest ( string  displayName = default(string),
string  description = default(string),
string  code = default(string),
DateTimeOffset?  created = default(DateTimeOffset?),
string  baseCurrency = default(string),
ResourceId  corporateActionSourceId = default(ResourceId),
AccountingMethodEnum accountingMethod = default(AccountingMethodEnum?),
List< string >  subHoldingKeys = default(List<string>),
Dictionary< string, Property properties = default(Dictionary<string, Property>) 
)
inline

Initializes a new instance of the CreateTransactionPortfolioRequest class.

Parameters
displayNameThe name of the transaction portfolio. (required).
descriptionA description for the transaction portfolio..
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required).
createdThe effective datetime at which to create the transaction portfolio. No transactions can be added to the transaction portfolio before this date. Defaults to the current LUSID system datetime if not specified..
baseCurrencyThe base currency of the transaction portfolio in ISO 4217 currency code format. (required).
corporateActionSourceIdcorporateActionSourceId.
accountingMethodDetermines the accounting treatment given to the transaction portfolio&#39;s tax lots. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst.
subHoldingKeysA set of unique transaction properties to group the transaction portfolio&#39;s holdings by, perhaps for strategy tagging. Each property must be from the &#39;Transaction&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Transaction/strategies/quantsignal&#39;. Note that sub-holding keys cannot currently be added after the transaction portfolio has been created; see https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information..
propertiesA set of unique portfolio properties to add custom data to the transaction portfolio. Each property must be from the &#39;Portfolio&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Note these properties must be pre-defined..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if CreateTransactionPortfolioRequest instances are equal

Parameters
inputInstance of CreateTransactionPortfolioRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccountingMethod

AccountingMethodEnum Lusid.Sdk.Model.CreateTransactionPortfolioRequest.AccountingMethod
getset

Determines the accounting treatment given to the transaction portfolio&#39;s tax lots. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

Determines the accounting treatment given to the transaction portfolio&#39;s tax lots. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst

◆ BaseCurrency

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.BaseCurrency
getset

The base currency of the transaction portfolio in ISO 4217 currency code format.

The base currency of the transaction portfolio in ISO 4217 currency code format.

◆ Code

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.Code
getset

The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.

The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.

◆ CorporateActionSourceId

ResourceId Lusid.Sdk.Model.CreateTransactionPortfolioRequest.CorporateActionSourceId
getset

Gets or Sets CorporateActionSourceId

◆ Created

DateTimeOffset Lusid.Sdk.Model.CreateTransactionPortfolioRequest.Created
getset

The effective datetime at which to create the transaction portfolio. No transactions can be added to the transaction portfolio before this date. Defaults to the current LUSID system datetime if not specified.

The effective datetime at which to create the transaction portfolio. No transactions can be added to the transaction portfolio before this date. Defaults to the current LUSID system datetime if not specified.

◆ Description

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.Description
getset

A description for the transaction portfolio.

A description for the transaction portfolio.

◆ DisplayName

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.DisplayName
getset

The name of the transaction portfolio.

The name of the transaction portfolio.

◆ Properties

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

A set of unique portfolio properties to add custom data to the transaction portfolio. Each property must be from the &#39;Portfolio&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Note these properties must be pre-defined.

A set of unique portfolio properties to add custom data to the transaction portfolio. Each property must be from the &#39;Portfolio&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Note these properties must be pre-defined.

◆ SubHoldingKeys

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

A set of unique transaction properties to group the transaction portfolio&#39;s holdings by, perhaps for strategy tagging. Each property must be from the &#39;Transaction&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Transaction/strategies/quantsignal&#39;. Note that sub-holding keys cannot currently be added after the transaction portfolio has been created; see https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information.

A set of unique transaction properties to group the transaction portfolio&#39;s holdings by, perhaps for strategy tagging. Each property must be from the &#39;Transaction&#39; domain and identified by a key in the format {domain}/{scope}/{code}, for example &#39;Transaction/strategies/quantsignal&#39;. Note that sub-holding keys cannot currently be added after the transaction portfolio has been created; see https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information.


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