A list of transactions. More...

Inheritance diagram for Lusid.Sdk.Model.Transaction:

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
	Transaction (string transactionId=default(string), string type=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), 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), OtcConfirmation otcConfirmation=default(OtcConfirmation), TransactionStatusEnum? transactionStatus=default(TransactionStatusEnum?), DateTimeOffset? cancelDateTime=default(DateTimeOffset?), ResourceId orderId=default(ResourceId), ResourceId allocationId=default(ResourceId), CustodianAccount custodianAccount=default(CustodianAccount))
	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
TransactionStatusEnum?	TransactionStatus `[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. 'Buy', 'Sell'. 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	InstrumentScope `[get, set]`
	The scope in which the transaction's 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...

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, PerpetualProperty >	Properties `[get, set]`
	Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the 'Transaction' 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...

OtcConfirmation	OtcConfirmation `[get, set]`
	Gets or Sets OtcConfirmation More...

DateTimeOffset?	CancelDateTime `[get, set]`
	If the transaction has been cancelled, the asAt datetime that the transaction was cancelled. More...

ResourceId	OrderId `[get, set]`
	Gets or Sets OrderId More...

ResourceId	AllocationId `[get, set]`
	Gets or Sets AllocationId More...

CustodianAccount	CustodianAccount `[get, set]`
	Gets or Sets CustodianAccount More...

Detailed Description

A list of transactions.

Member Enumeration Documentation

◆ TransactionStatusEnum

enum Lusid.Sdk.Model.Transaction.TransactionStatusEnum

strong

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

◆ 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	instrumentScope = `default(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)`,
		OtcConfirmation	otcConfirmation = `default(OtcConfirmation)`,
		TransactionStatusEnum?	transactionStatus = `default(TransactionStatusEnum?)`,
		DateTimeOffset?	cancelDateTime = `default(DateTimeOffset?)`,
		ResourceId	orderId = `default(ResourceId)`,
		ResourceId	allocationId = `default(ResourceId)`,
		CustodianAccount	custodianAccount = `default(CustodianAccount)`
	)

inline

Initializes a new instance of the Transaction class.

Parameters

transactionId	The unique identifier for the transaction. (required).
type	The type of the transaction e.g. 'Buy', 'Sell'. The transaction type should have been pre-configured via the System Configuration API endpoint. (required).
instrumentIdentifiers	A set of instrument identifiers that can resolve the transaction to a unique instrument..
instrumentScope	The scope in which the transaction's instrument lies..
instrumentUid	The unique Lusid Instrument Id (LUID) of the instrument that the transaction is in. (required).
transactionDate	The date of the transaction. (required).
settlementDate	The settlement date of the transaction. (required).
units	The number of units transacted in the associated instrument. (required).
transactionPrice	transactionPrice.
totalConsideration	totalConsideration (required).
exchangeRate	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..
transactionCurrency	The transaction currency..
properties	Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the 'Transaction' domain..
counterpartyId	The identifier for the counterparty of the transaction..
source	The source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration..
entryDateTime	The asAt datetime that the transaction was added to LUSID..
otcConfirmation	otcConfirmation.
transactionStatus	The status of the transaction. The available values are: Active, Amended, Cancelled.
cancelDateTime	If the transaction has been cancelled, the asAt datetime that the transaction was cancelled..
orderId	orderId.
allocationId	allocationId.
custodianAccount	custodianAccount.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if objects are equal

Parameters

input Object 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

input Instance 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

◆ AllocationId

ResourceId Lusid.Sdk.Model.Transaction.AllocationId

getset

Gets or Sets AllocationId

◆ CancelDateTime

DateTimeOffset? Lusid.Sdk.Model.Transaction.CancelDateTime

getset

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

◆ CounterpartyId

string Lusid.Sdk.Model.Transaction.CounterpartyId

getset

The identifier for the counterparty of the transaction.

◆ CustodianAccount

CustodianAccount Lusid.Sdk.Model.Transaction.CustodianAccount

getset

Gets or Sets CustodianAccount

◆ EntryDateTime

DateTimeOffset Lusid.Sdk.Model.Transaction.EntryDateTime

getset

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.

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.Transaction.InstrumentIdentifiers

getset

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

◆ InstrumentScope

string Lusid.Sdk.Model.Transaction.InstrumentScope

getset

The scope in which the transaction's instrument lies.

◆ InstrumentUid

string Lusid.Sdk.Model.Transaction.InstrumentUid

getset

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

◆ OrderId

ResourceId Lusid.Sdk.Model.Transaction.OrderId

getset

Gets or Sets OrderId

◆ OtcConfirmation

OtcConfirmation Lusid.Sdk.Model.Transaction.OtcConfirmation

getset

Gets or Sets OtcConfirmation

◆ 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 'Transaction' domain.

◆ SettlementDate

DateTimeOffset Lusid.Sdk.Model.Transaction.SettlementDate

getset

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.

◆ TotalConsideration

CurrencyAndAmount Lusid.Sdk.Model.Transaction.TotalConsideration

getset

Gets or Sets TotalConsideration

◆ TransactionCurrency

string Lusid.Sdk.Model.Transaction.TransactionCurrency

getset

The transaction currency.

◆ TransactionDate

DateTimeOffset Lusid.Sdk.Model.Transaction.TransactionDate

getset

The date of the transaction.

◆ TransactionId

string Lusid.Sdk.Model.Transaction.TransactionId

getset

The unique identifier for the transaction.

◆ TransactionPrice

TransactionPrice Lusid.Sdk.Model.Transaction.TransactionPrice

getset

Gets or Sets TransactionPrice

◆ TransactionStatus

TransactionStatusEnum? Lusid.Sdk.Model.Transaction.TransactionStatus

getset

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

◆ Type

string Lusid.Sdk.Model.Transaction.Type

getset

The type of the transaction e.g. 'Buy', 'Sell'. 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 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/Transaction.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ TransactionStatusEnum

Constructor & Destructor Documentation

◆ Transaction() [1/2]

◆ Transaction() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AllocationId

◆ CancelDateTime

◆ CounterpartyId

◆ CustodianAccount

◆ EntryDateTime

◆ ExchangeRate

◆ InstrumentIdentifiers

◆ InstrumentScope

◆ InstrumentUid

◆ OrderId

◆ OtcConfirmation

◆ Properties

◆ SettlementDate

◆ Source

◆ TotalConsideration

◆ TransactionCurrency

◆ TransactionDate

◆ TransactionId

◆ TransactionPrice

◆ TransactionStatus

◆ Type

◆ Units