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

CreateDerivedTransactionPortfolioRequest More...

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

Public Types

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

 CreateDerivedTransactionPortfolioRequest (string displayName=default(string), string description=default(string), string code=default(string), ResourceId parentPortfolioId=default(ResourceId), DateTimeOffset? created=default(DateTimeOffset?), ResourceId corporateActionSourceId=default(ResourceId), AccountingMethodEnum? accountingMethod=default(AccountingMethodEnum?), List< string > subHoldingKeys=default(List< string >), List< string > instrumentScopes=default(List< string >), string amortisationMethod=default(string), string transactionTypeScope=default(string), string cashGainLossCalculationDate=default(string), ResourceId amortisationRuleSetId=default(ResourceId))
 Initializes a new instance of the CreateDerivedTransactionPortfolioRequest 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 (CreateDerivedTransactionPortfolioRequest input)
 Returns true if CreateDerivedTransactionPortfolioRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

AccountingMethodEnumAccountingMethod [get, set]
 . The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst More...
 
string DisplayName [get, set]
 The name of the derived transaction portfolio. More...
 
string Description [get, set]
 A description for the derived transaction portfolio. More...
 
string Code [get, set]
 The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio. More...
 
ResourceId ParentPortfolioId [get, set]
 Gets or Sets ParentPortfolioId More...
 
DateTimeOffset? Created [get, set]
 This will be auto-populated to be the parent portfolio creation date. More...
 
ResourceId CorporateActionSourceId [get, set]
 Gets or Sets CorporateActionSourceId More...
 
List< string > SubHoldingKeys [get, set]
 A set of unique transaction properties to group the derived 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;. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information. More...
 
List< string > InstrumentScopes [get, set]
 The resolution strategy used to resolve instruments of transactions/holdings upserted to this derived portfolio. More...
 
string AmortisationMethod [get, set]
 The amortisation method used by the portfolio for the calculation. The available values are: 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, TransactionDate/SettlementDate. Defaults to SettlementDate. More...
 
ResourceId AmortisationRuleSetId [get, set]
 Gets or Sets AmortisationRuleSetId More...
 

Detailed Description

CreateDerivedTransactionPortfolioRequest

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

Constructor & Destructor Documentation

◆ CreateDerivedTransactionPortfolioRequest() [1/2]

Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.CreateDerivedTransactionPortfolioRequest ( )
inlineprotected

Initializes a new instance of the CreateDerivedTransactionPortfolioRequest class.

◆ CreateDerivedTransactionPortfolioRequest() [2/2]

Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.CreateDerivedTransactionPortfolioRequest ( string  displayName = default(string),
string  description = default(string),
string  code = default(string),
ResourceId  parentPortfolioId = default(ResourceId),
DateTimeOffset?  created = default(DateTimeOffset?),
ResourceId  corporateActionSourceId = default(ResourceId),
AccountingMethodEnum accountingMethod = default(AccountingMethodEnum?),
List< string >  subHoldingKeys = default(List<string>),
List< string >  instrumentScopes = default(List<string>),
string  amortisationMethod = default(string),
string  transactionTypeScope = default(string),
string  cashGainLossCalculationDate = default(string),
ResourceId  amortisationRuleSetId = default(ResourceId) 
)
inline

Initializes a new instance of the CreateDerivedTransactionPortfolioRequest class.

Parameters
displayNameThe name of the derived transaction portfolio. (required).
descriptionA description for the derived transaction portfolio..
codeThe code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio. (required).
parentPortfolioIdparentPortfolioId (required).
createdThis will be auto-populated to be the parent portfolio creation date..
corporateActionSourceIdcorporateActionSourceId.
accountingMethod. The available values are: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst.
subHoldingKeysA set of unique transaction properties to group the derived 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;. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information..
instrumentScopesThe resolution strategy used to resolve instruments of transactions/holdings upserted to this derived portfolio..
amortisationMethodThe amortisation method used by the portfolio for the calculation. The available values are: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate.
transactionTypeScopeThe scope of the transaction types..
cashGainLossCalculationDateThe option when the Cash Gain Loss to be calulated, TransactionDate/SettlementDate. Defaults to SettlementDate..
amortisationRuleSetIdamortisationRuleSetId.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if CreateDerivedTransactionPortfolioRequest instances are equal

Parameters
inputInstance of CreateDerivedTransactionPortfolioRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccountingMethod

AccountingMethodEnum? Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.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.CreateDerivedTransactionPortfolioRequest.AmortisationMethod
getset

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

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

◆ AmortisationRuleSetId

ResourceId Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.AmortisationRuleSetId
getset

Gets or Sets AmortisationRuleSetId

◆ CashGainLossCalculationDate

string Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.CashGainLossCalculationDate
getset

The option when the Cash Gain Loss to be calulated, TransactionDate/SettlementDate. Defaults to SettlementDate.

The option when the Cash Gain Loss to be calulated, TransactionDate/SettlementDate. Defaults to SettlementDate.

◆ Code

string Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.Code
getset

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

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

◆ CorporateActionSourceId

ResourceId Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.CorporateActionSourceId
getset

Gets or Sets CorporateActionSourceId

◆ Created

DateTimeOffset? Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.Created
getset

This will be auto-populated to be the parent portfolio creation date.

This will be auto-populated to be the parent portfolio creation date.

◆ Description

string Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.Description
getset

A description for the derived transaction portfolio.

A description for the derived transaction portfolio.

◆ DisplayName

string Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.DisplayName
getset

The name of the derived transaction portfolio.

The name of the derived transaction portfolio.

◆ InstrumentScopes

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

The resolution strategy used to resolve instruments of transactions/holdings upserted to this derived portfolio.

The resolution strategy used to resolve instruments of transactions/holdings upserted to this derived portfolio.

◆ ParentPortfolioId

ResourceId Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.ParentPortfolioId
getset

Gets or Sets ParentPortfolioId

◆ SubHoldingKeys

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

A set of unique transaction properties to group the derived 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;. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information.

A set of unique transaction properties to group the derived 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;. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information.

◆ TransactionTypeScope

string Lusid.Sdk.Model.CreateDerivedTransactionPortfolioRequest.TransactionTypeScope
getset

The scope of the transaction types.

The scope of the transaction types.


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