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

A list of transactions. More...

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

Public Member Functions

 Transaction (string transactionId=default(string), string type=default(string), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string instrumentUid=default(string), DateTimeOffset transactionDate=default(DateTimeOffset), DateTimeOffset settlementDate=default(DateTimeOffset), decimal units=default(decimal), TransactionPrice transactionPrice=default(TransactionPrice), CurrencyAndAmount totalConsideration=default(CurrencyAndAmount), decimal? exchangeRate=default(decimal?), string transactionCurrency=default(string), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), string counterpartyId=default(string), string source=default(string), DateTimeOffset entryDateTime=default(DateTimeOffset))
 Initializes a new instance of the Transaction 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 (Transaction input)
 Returns true if Transaction instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

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...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 A set of instrument identifiers that can resolve the transaction to a unique instrument. More...
 
string InstrumentUid [get, set]
 The unqiue 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...
 
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...
 
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...
 

Detailed Description

A list of transactions.

Constructor & Destructor Documentation

◆ Transaction() [1/2]

Lusid.Sdk.Model.Transaction.Transaction ( )
inlineprotected

Initializes a new instance of the Transaction class.

◆ Transaction() [2/2]

Lusid.Sdk.Model.Transaction.Transaction ( string  transactionId = default(string),
string  type = default(string),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
string  instrumentUid = default(string),
DateTimeOffset  transactionDate = default(DateTimeOffset),
DateTimeOffset  settlementDate = default(DateTimeOffset),
decimal  units = default(decimal),
TransactionPrice  transactionPrice = default(TransactionPrice),
CurrencyAndAmount  totalConsideration = default(CurrencyAndAmount),
decimal?  exchangeRate = default(decimal?),
string  transactionCurrency = default(string),
Dictionary< string, PerpetualProperty properties = default(Dictionary<string, PerpetualProperty>),
string  counterpartyId = default(string),
string  source = default(string),
DateTimeOffset  entryDateTime = default(DateTimeOffset) 
)
inline

Initializes a new instance of the Transaction 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).
instrumentIdentifiersA set of instrument identifiers that can resolve the transaction to a unique instrument..
instrumentUidThe unqiue 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).
transactionPricetransactionPrice.
totalConsiderationtotalConsideration (required).
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..
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..
entryDateTimeThe asAt datetime that the transaction was added to LUSID..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if Transaction instances are equal

Parameters
inputInstance of Transaction to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ CounterpartyId

string Lusid.Sdk.Model.Transaction.CounterpartyId
getset

The identifier for the counterparty of the transaction.

The identifier for the counterparty of the transaction.

◆ EntryDateTime

DateTimeOffset Lusid.Sdk.Model.Transaction.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.Transaction.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.

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.Transaction.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.

◆ InstrumentUid

string Lusid.Sdk.Model.Transaction.InstrumentUid
getset

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

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

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.Transaction.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.

◆ SettlementDate

DateTimeOffset Lusid.Sdk.Model.Transaction.SettlementDate
getset

The settlement date of the transaction.

The settlement date of the transaction.

◆ Source

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

◆ TotalConsideration

CurrencyAndAmount Lusid.Sdk.Model.Transaction.TotalConsideration
getset

Gets or Sets TotalConsideration

◆ TransactionCurrency

string Lusid.Sdk.Model.Transaction.TransactionCurrency
getset

The transaction currency.

The transaction currency.

◆ TransactionDate

DateTimeOffset Lusid.Sdk.Model.Transaction.TransactionDate
getset

The date of the transaction.

The date of the transaction.

◆ TransactionId

string Lusid.Sdk.Model.Transaction.TransactionId
getset

The unique identifier for the transaction.

The unique identifier for the transaction.

◆ TransactionPrice

TransactionPrice Lusid.Sdk.Model.Transaction.TransactionPrice
getset

Gets or Sets TransactionPrice

◆ Type

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