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

A list of output transactions. More...

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

Public Types

enum class  TransactionStatusEnum { Active = 1 , Amended = 2 , Cancelled = 3 }
 The status of the transaction. The available values are: Active, Amended, Cancelled More...
 

Public Member Functions

 OutputTransaction (string transactionId=default(string), string type=default(string), string description=default(string), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string instrumentScope=default(string), string instrumentUid=default(string), DateTimeOffset transactionDate=default(DateTimeOffset), DateTimeOffset settlementDate=default(DateTimeOffset), decimal units=default(decimal), decimal transactionAmount=default(decimal), TransactionPrice transactionPrice=default(TransactionPrice), CurrencyAndAmount totalConsideration=default(CurrencyAndAmount), decimal exchangeRate=default(decimal), decimal? transactionToPortfolioRate=default(decimal?), string transactionCurrency=default(string), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), string counterpartyId=default(string), string source=default(string), TransactionStatusEnum? transactionStatus=default(TransactionStatusEnum?), DateTimeOffset entryDateTime=default(DateTimeOffset), DateTimeOffset? cancelDateTime=default(DateTimeOffset?), List< RealisedGainLoss > realisedGainLoss=default(List< RealisedGainLoss >), List< long > holdingIds=default(List< long >), string sourceType=default(string))
 Initializes a new instance of the OutputTransaction 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 (OutputTransaction input)
 Returns true if OutputTransaction instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

TransactionStatusEnumTransactionStatus [get, set]
 The status of the transaction. The available values are: Active, Amended, Cancelled More...
 
string TransactionId [get, set]
 The unique identifier for the transaction. More...
 
string Type [get, set]
 The type of the transaction e.g. &#39;Buy&#39;, &#39;Sell&#39;. The transaction type should have been pre-configured via the System Configuration API endpoint. More...
 
string Description [get, set]
 The description of the transaction. This only exists on transactions generated by LUSID e.g. a holdings adjustment transaction. More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 A set of instrument identifiers that can resolve the transaction to a unique instrument. More...
 
string InstrumentScope [get, set]
 The scope in which the instrument lies. More...
 
string InstrumentUid [get, set]
 The unique Lusid Instrument Id (LUID) of the instrument that the transaction is in. More...
 
DateTimeOffset TransactionDate [get, set]
 The date of the transaction. More...
 
DateTimeOffset SettlementDate [get, set]
 The settlement date of the transaction. More...
 
decimal Units [get, set]
 The number of units transacted in the associated instrument. More...
 
decimal TransactionAmount [get, set]
 The total value of the transaction in the transaction currency. More...
 
TransactionPrice TransactionPrice [get, set]
 Gets or Sets TransactionPrice More...
 
CurrencyAndAmount TotalConsideration [get, set]
 Gets or Sets TotalConsideration More...
 
decimal ExchangeRate [get, set]
 The exchange rate between the transaction and settlement currency (settlement currency being represented by the TotalConsideration.Currency). For example if the transaction currency is in USD and the settlement currency is in GBP this this the USD/GBP rate. More...
 
decimal? TransactionToPortfolioRate [get, set]
 The exchange rate between the transaction and portfolio currency. For example if the transaction currency is in USD and the portfolio currency is in GBP this this the USD/GBP rate. More...
 
string TransactionCurrency [get, set]
 The transaction currency. More...
 
Dictionary< string, PerpetualPropertyProperties [get, set]
 Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the &#39;Transaction&#39; domain. More...
 
string CounterpartyId [get, set]
 The identifier for the counterparty of the transaction. More...
 
string Source [get, set]
 The source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration. More...
 
DateTimeOffset EntryDateTime [get, set]
 The asAt datetime that the transaction was added to LUSID. More...
 
DateTimeOffset? CancelDateTime [get, set]
 If the transaction has been cancelled, the asAt datetime that the transaction was cancelled. More...
 
List< RealisedGainLossRealisedGainLoss [get, set]
 The collection of realised gains or losses resulting from relevant transactions e.g. a sale transaction. The cost used in calculating the realised gain or loss is determined by the accounting method defined when the transaction portfolio is created. More...
 
List< long > HoldingIds [get, set]
 The collection of single identifiers for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio. More...
 
string SourceType [get, set]
 The type of source that the transaction originated from, eg: InputTransaction, InstrumentEvent, HoldingAdjustment More...
 

Detailed Description

A list of output transactions.

Member Enumeration Documentation

◆ TransactionStatusEnum

The status of the transaction. The available values are: Active, Amended, Cancelled

The status of the transaction. The available values are: Active, Amended, Cancelled

Enumerator
Active 

Enum Active for value: Active

Amended 

Enum Amended for value: Amended

Cancelled 

Enum Cancelled for value: Cancelled

Constructor & Destructor Documentation

◆ OutputTransaction() [1/2]

Lusid.Sdk.Model.OutputTransaction.OutputTransaction ( )
inlineprotected

Initializes a new instance of the OutputTransaction class.

◆ OutputTransaction() [2/2]

Lusid.Sdk.Model.OutputTransaction.OutputTransaction ( string  transactionId = default(string),
string  type = default(string),
string  description = default(string),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
string  instrumentScope = default(string),
string  instrumentUid = default(string),
DateTimeOffset  transactionDate = default(DateTimeOffset),
DateTimeOffset  settlementDate = default(DateTimeOffset),
decimal  units = default(decimal),
decimal  transactionAmount = default(decimal),
TransactionPrice  transactionPrice = default(TransactionPrice),
CurrencyAndAmount  totalConsideration = default(CurrencyAndAmount),
decimal  exchangeRate = default(decimal),
decimal?  transactionToPortfolioRate = default(decimal?),
string  transactionCurrency = default(string),
Dictionary< string, PerpetualProperty properties = default(Dictionary<string, PerpetualProperty>),
string  counterpartyId = default(string),
string  source = default(string),
TransactionStatusEnum transactionStatus = default(TransactionStatusEnum?),
DateTimeOffset  entryDateTime = default(DateTimeOffset),
DateTimeOffset?  cancelDateTime = default(DateTimeOffset?),
List< RealisedGainLoss realisedGainLoss = default(List<RealisedGainLoss>),
List< long >  holdingIds = default(List<long>),
string  sourceType = default(string) 
)
inline

Initializes a new instance of the OutputTransaction class.

Parameters
transactionIdThe unique identifier for the transaction. (required).
typeThe type of the transaction e.g. &#39;Buy&#39;, &#39;Sell&#39;. The transaction type should have been pre-configured via the System Configuration API endpoint. (required).
descriptionThe description of the transaction. This only exists on transactions generated by LUSID e.g. a holdings adjustment transaction..
instrumentIdentifiersA set of instrument identifiers that can resolve the transaction to a unique instrument..
instrumentScopeThe scope in which the instrument lies..
instrumentUidThe unique Lusid Instrument Id (LUID) of the instrument that the transaction is in. (required).
transactionDateThe date of the transaction. (required).
settlementDateThe settlement date of the transaction. (required).
unitsThe number of units transacted in the associated instrument. (required).
transactionAmountThe total value of the transaction in the transaction currency..
transactionPricetransactionPrice.
totalConsiderationtotalConsideration.
exchangeRateThe exchange rate between the transaction and settlement currency (settlement currency being represented by the TotalConsideration.Currency). For example if the transaction currency is in USD and the settlement currency is in GBP this this the USD/GBP rate..
transactionToPortfolioRateThe exchange rate between the transaction and portfolio currency. For example if the transaction currency is in USD and the portfolio currency is in GBP this this the USD/GBP rate..
transactionCurrencyThe transaction currency..
propertiesSet of unique transaction properties and associated values to stored with the transaction. Each property will be from the &#39;Transaction&#39; domain..
counterpartyIdThe identifier for the counterparty of the transaction..
sourceThe source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration..
transactionStatusThe status of the transaction. The available values are: Active, Amended, Cancelled.
entryDateTimeThe asAt datetime that the transaction was added to LUSID..
cancelDateTimeIf the transaction has been cancelled, the asAt datetime that the transaction was cancelled..
realisedGainLossThe collection of realised gains or losses resulting from relevant transactions e.g. a sale transaction. The cost used in calculating the realised gain or loss is determined by the accounting method defined when the transaction portfolio is created..
holdingIdsThe collection of single identifiers for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio..
sourceTypeThe type of source that the transaction originated from, eg: InputTransaction, InstrumentEvent, HoldingAdjustment.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if OutputTransaction instances are equal

Parameters
inputInstance of OutputTransaction to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CancelDateTime

DateTimeOffset? Lusid.Sdk.Model.OutputTransaction.CancelDateTime
getset

If the transaction has been cancelled, the asAt datetime that the transaction was cancelled.

If the transaction has been cancelled, the asAt datetime that the transaction was cancelled.

◆ CounterpartyId

string Lusid.Sdk.Model.OutputTransaction.CounterpartyId
getset

The identifier for the counterparty of the transaction.

The identifier for the counterparty of the transaction.

◆ Description

string Lusid.Sdk.Model.OutputTransaction.Description
getset

The description of the transaction. This only exists on transactions generated by LUSID e.g. a holdings adjustment transaction.

The description of the transaction. This only exists on transactions generated by LUSID e.g. a holdings adjustment transaction.

◆ EntryDateTime

DateTimeOffset Lusid.Sdk.Model.OutputTransaction.EntryDateTime
getset

The asAt datetime that the transaction was added to LUSID.

The asAt datetime that the transaction was added to LUSID.

◆ ExchangeRate

decimal Lusid.Sdk.Model.OutputTransaction.ExchangeRate
getset

The exchange rate between the transaction and settlement currency (settlement currency being represented by the TotalConsideration.Currency). For example if the transaction currency is in USD and the settlement currency is in GBP this this the USD/GBP rate.

The exchange rate between the transaction and settlement currency (settlement currency being represented by the TotalConsideration.Currency). For example if the transaction currency is in USD and the settlement currency is in GBP this this the USD/GBP rate.

◆ HoldingIds

List<long> Lusid.Sdk.Model.OutputTransaction.HoldingIds
getset

The collection of single identifiers for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.

The collection of single identifiers for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.OutputTransaction.InstrumentIdentifiers
getset

A set of instrument identifiers that can resolve the transaction to a unique instrument.

A set of instrument identifiers that can resolve the transaction to a unique instrument.

◆ InstrumentScope

string Lusid.Sdk.Model.OutputTransaction.InstrumentScope
getset

The scope in which the instrument lies.

The scope in which the instrument lies.

◆ InstrumentUid

string Lusid.Sdk.Model.OutputTransaction.InstrumentUid
getset

The unique Lusid Instrument Id (LUID) of the instrument that the transaction is in.

The unique Lusid Instrument Id (LUID) of the instrument that the transaction is in.

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.OutputTransaction.Properties
getset

Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the &#39;Transaction&#39; domain.

Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the &#39;Transaction&#39; domain.

◆ RealisedGainLoss

List<RealisedGainLoss> Lusid.Sdk.Model.OutputTransaction.RealisedGainLoss
getset

The collection of realised gains or losses resulting from relevant transactions e.g. a sale transaction. The cost used in calculating the realised gain or loss is determined by the accounting method defined when the transaction portfolio is created.

The collection of realised gains or losses resulting from relevant transactions e.g. a sale transaction. The cost used in calculating the realised gain or loss is determined by the accounting method defined when the transaction portfolio is created.

◆ SettlementDate

DateTimeOffset Lusid.Sdk.Model.OutputTransaction.SettlementDate
getset

The settlement date of the transaction.

The settlement date of the transaction.

◆ Source

string Lusid.Sdk.Model.OutputTransaction.Source
getset

The source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration.

The source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration.

◆ SourceType

string Lusid.Sdk.Model.OutputTransaction.SourceType
getset

The type of source that the transaction originated from, eg: InputTransaction, InstrumentEvent, HoldingAdjustment

The type of source that the transaction originated from, eg: InputTransaction, InstrumentEvent, HoldingAdjustment

◆ TotalConsideration

CurrencyAndAmount Lusid.Sdk.Model.OutputTransaction.TotalConsideration
getset

Gets or Sets TotalConsideration

◆ TransactionAmount

decimal Lusid.Sdk.Model.OutputTransaction.TransactionAmount
getset

The total value of the transaction in the transaction currency.

The total value of the transaction in the transaction currency.

◆ TransactionCurrency

string Lusid.Sdk.Model.OutputTransaction.TransactionCurrency
getset

The transaction currency.

The transaction currency.

◆ TransactionDate

DateTimeOffset Lusid.Sdk.Model.OutputTransaction.TransactionDate
getset

The date of the transaction.

The date of the transaction.

◆ TransactionId

string Lusid.Sdk.Model.OutputTransaction.TransactionId
getset

The unique identifier for the transaction.

The unique identifier for the transaction.

◆ TransactionPrice

TransactionPrice Lusid.Sdk.Model.OutputTransaction.TransactionPrice
getset

Gets or Sets TransactionPrice

◆ TransactionStatus

TransactionStatusEnum? Lusid.Sdk.Model.OutputTransaction.TransactionStatus
getset

The status of the transaction. The available values are: Active, Amended, Cancelled

The status of the transaction. The available values are: Active, Amended, Cancelled

◆ TransactionToPortfolioRate

decimal? Lusid.Sdk.Model.OutputTransaction.TransactionToPortfolioRate
getset

The exchange rate between the transaction and portfolio currency. For example if the transaction currency is in USD and the portfolio currency is in GBP this this the USD/GBP rate.

The exchange rate between the transaction and portfolio currency. For example if the transaction currency is in USD and the portfolio currency is in GBP this this the USD/GBP rate.

◆ Type

string Lusid.Sdk.Model.OutputTransaction.Type
getset

The type of the transaction e.g. &#39;Buy&#39;, &#39;Sell&#39;. The transaction type should have been pre-configured via the System Configuration API endpoint.

The type of the transaction e.g. &#39;Buy&#39;, &#39;Sell&#39;. The transaction type should have been pre-configured via the System Configuration API endpoint.

◆ Units

decimal Lusid.Sdk.Model.OutputTransaction.Units
getset

The number of units transacted in the associated instrument.

The number of units transacted in the associated instrument.


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