CreateTransactionPortfolioRequest More...

Inheritance diagram for Lusid.Sdk.Model.CreateTransactionPortfolioRequest:

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 }
	Determines the accounting treatment given to the transaction portfolio's tax lots. Default value: AverageCost. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency. 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 >), List< string > instrumentScopes=default(List< string >), 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))
	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's tax lots. Default value: AverageCost. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency. 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's holdings by, perhaps for strategy tagging. Each property must be from the 'Transaction' domain and identified by a key in the format {domain}/{scope}/{code}, for example 'Transaction/strategies/quantsignal'. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information. More...

Dictionary< string, Property >	Properties `[get, set]`
	A set of unique portfolio properties to add custom data to the transaction portfolio. Each property must be from the 'Portfolio' domain and identified by a key in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Note these properties must be pre-defined. More...

List< string >	InstrumentScopes `[get, set]`
	The resolution strategy used to resolve instruments of transactions/holdings upserted to this 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. Available values: Default, SettlementDate, TransactionDate. 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...

Detailed Description

CreateTransactionPortfolioRequest

Member Enumeration Documentation

◆ AccountingMethodEnum

enum Lusid.Sdk.Model.CreateTransactionPortfolioRequest.AccountingMethodEnum

strong

Determines the accounting treatment given to the transaction portfolio's tax lots. Default value: AverageCost. 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

◆ 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>)`,
		List< string >	instrumentScopes = `default(List<string>)`,
		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)`
	)

inline

Initializes a new instance of the CreateTransactionPortfolioRequest class.

Parameters

displayName	The name of the transaction portfolio. (required).
description	A description for the transaction portfolio..
code	The code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio. (required).
created	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..
baseCurrency	The base currency of the transaction portfolio in ISO 4217 currency code format. (required).
corporateActionSourceId	corporateActionSourceId.
accountingMethod	Determines the accounting treatment given to the transaction portfolio's tax lots. Default value: AverageCost. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency..
subHoldingKeys	A set of unique transaction properties to group the transaction portfolio's holdings by, perhaps for strategy tagging. Each property must be from the 'Transaction' domain and identified by a key in the format {domain}/{scope}/{code}, for example 'Transaction/strategies/quantsignal'. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information..
properties	A set of unique portfolio properties to add custom data to the transaction portfolio. Each property must be from the 'Portfolio' domain and identified by a key in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Note these properties must be pre-defined..
instrumentScopes	The resolution strategy used to resolve instruments of transactions/holdings upserted to this portfolio..
amortisationMethod	The amortisation method used by the portfolio for the calculation. Available values: NoAmortisation, StraightLine, EffectiveYield, StraightLineSettlementDate, EffectiveYieldSettlementDate..
transactionTypeScope	The scope of the transaction types..
cashGainLossCalculationDate	The option when the Cash Gain Loss to be calulated. Default value: SettlementDate. Available values: Default, SettlementDate, TransactionDate..
instrumentEventConfiguration	instrumentEventConfiguration.
amortisationRuleSetId	amortisationRuleSetId.
taxRuleSetScope	The scope of the tax rule sets for this portfolio..
settlementConfiguration	settlementConfiguration.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if CreateTransactionPortfolioRequest instances are equal

Parameters

input Instance of CreateTransactionPortfolioRequest to be compared

Returns: Boolean

◆ Equals() [2/2]

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

inline

Returns true if objects are equal

Parameters

input Object 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's tax lots. Default value: AverageCost. Available values: Default, AverageCost, FirstInFirstOut, LastInFirstOut, HighestCostFirst, LowestCostFirst, ProRateByUnits, ProRateByCost, ProRateByCostPortfolioCurrency, IntraDayThenFirstInFirstOut, LongTermHighestCostFirst, LongTermHighestCostFirstPortfolioCurrency, HighestCostFirstPortfolioCurrency, LowestCostFirstPortfolioCurrency, MaximumLossMinimumGain, MaximumLossMinimumGainPortfolioCurrency.

◆ AmortisationMethod

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.AmortisationMethod

getset

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

◆ AmortisationRuleSetId

ResourceId Lusid.Sdk.Model.CreateTransactionPortfolioRequest.AmortisationRuleSetId

getset

Gets or Sets AmortisationRuleSetId

◆ BaseCurrency

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.BaseCurrency

getset

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

◆ CashGainLossCalculationDate

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.CashGainLossCalculationDate

getset

The option when the Cash Gain Loss to be calulated. Default value: SettlementDate. Available values: Default, SettlementDate, TransactionDate.

◆ Code

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.Code

getset

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.

◆ Description

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.Description

getset

A description for the transaction portfolio.

◆ DisplayName

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.DisplayName

getset

The name of the transaction portfolio.

◆ InstrumentEventConfiguration

InstrumentEventConfiguration Lusid.Sdk.Model.CreateTransactionPortfolioRequest.InstrumentEventConfiguration

getset

Gets or Sets InstrumentEventConfiguration

◆ InstrumentScopes

List<string> Lusid.Sdk.Model.CreateTransactionPortfolioRequest.InstrumentScopes

getset

The resolution strategy used to resolve instruments of transactions/holdings upserted to this 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 'Portfolio' domain and identified by a key in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Note these properties must be pre-defined.

◆ SettlementConfiguration

PortfolioSettlementConfiguration Lusid.Sdk.Model.CreateTransactionPortfolioRequest.SettlementConfiguration

getset

Gets or Sets SettlementConfiguration

◆ SubHoldingKeys

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

getset

A set of unique transaction properties to group the transaction portfolio's holdings by, perhaps for strategy tagging. Each property must be from the 'Transaction' domain and identified by a key in the format {domain}/{scope}/{code}, for example 'Transaction/strategies/quantsignal'. See https://support.lusid.com/knowledgebase/article/KA-01879/en-us for more information.

◆ TaxRuleSetScope

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.TaxRuleSetScope

getset

The scope of the tax rule sets for this portfolio.

◆ TransactionTypeScope

string Lusid.Sdk.Model.CreateTransactionPortfolioRequest.TransactionTypeScope

getset

The scope of the transaction types.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/CreateTransactionPortfolioRequest.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ AccountingMethodEnum

Constructor & Destructor Documentation

◆ CreateTransactionPortfolioRequest() [1/2]

◆ CreateTransactionPortfolioRequest() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccountingMethod

◆ AmortisationMethod

◆ AmortisationRuleSetId

◆ BaseCurrency

◆ CashGainLossCalculationDate

◆ Code

◆ CorporateActionSourceId

◆ Created

◆ Description

◆ DisplayName

◆ InstrumentEventConfiguration

◆ InstrumentScopes

◆ Properties

◆ SettlementConfiguration

◆ SubHoldingKeys

◆ TaxRuleSetScope

◆ TransactionTypeScope