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

TransactionRequest More...

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

Public Member Functions

 TransactionRequest (string transactionId=default(string), string type=default(string), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), DateTimeOrCutLabel transactionDate=default(DateTimeOrCutLabel), DateTimeOrCutLabel settlementDate=default(DateTimeOrCutLabel), 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), OtcConfirmation otcConfirmation=default(OtcConfirmation), ResourceId orderId=default(ResourceId), ResourceId allocationId=default(ResourceId), ResourceId custodianAccountId=default(ResourceId))
 Initializes a new instance of the TransactionRequest 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 (TransactionRequest input)
 Returns true if TransactionRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

string TransactionId [get, set]
 The unique identifier of the transaction. More...
 
string Type [get, set]
 The type of the transaction, for example &#39;Buy&#39; or &#39;Sell&#39;. The transaction type must have been pre-configured using the System Configuration API. If not, this operation will succeed but you are not able to calculate holdings for the portfolio that include this transaction. More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 A set of instrument identifiers that can resolve the transaction to a unique instrument. More...
 
DateTimeOrCutLabel TransactionDate [get, set]
 The date of the transaction. More...
 
DateTimeOrCutLabel SettlementDate [get, set]
 The settlement date of the transaction. More...
 
decimal Units [get, set]
 The number of units of the transacted 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 TotalConsideration.Currency). For example, if the transaction currency is USD and the settlement currency is GBP, this would be the appropriate USD/GBP rate. More...
 
string TransactionCurrency [get, set]
 The transaction currency. More...
 
Dictionary< string, PerpetualPropertyProperties [get, set]
 A list of unique transaction properties and associated values to store for the transaction. Each property must 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...
 
OtcConfirmation OtcConfirmation [get, set]
 Gets or Sets OtcConfirmation More...
 
ResourceId OrderId [get, set]
 Gets or Sets OrderId More...
 
ResourceId AllocationId [get, set]
 Gets or Sets AllocationId More...
 
ResourceId CustodianAccountId [get, set]
 Gets or Sets CustodianAccountId More...
 

Detailed Description

TransactionRequest

Constructor & Destructor Documentation

◆ TransactionRequest() [1/2]

Lusid.Sdk.Model.TransactionRequest.TransactionRequest ( )
inlineprotected

Initializes a new instance of the TransactionRequest class.

◆ TransactionRequest() [2/2]

Lusid.Sdk.Model.TransactionRequest.TransactionRequest ( string  transactionId = default(string),
string  type = default(string),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
DateTimeOrCutLabel  transactionDate = default(DateTimeOrCutLabel),
DateTimeOrCutLabel  settlementDate = default(DateTimeOrCutLabel),
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),
OtcConfirmation  otcConfirmation = default(OtcConfirmation),
ResourceId  orderId = default(ResourceId),
ResourceId  allocationId = default(ResourceId),
ResourceId  custodianAccountId = default(ResourceId) 
)
inline

Initializes a new instance of the TransactionRequest class.

Parameters
transactionIdThe unique identifier of the transaction. (required).
typeThe type of the transaction, for example &#39;Buy&#39; or &#39;Sell&#39;. The transaction type must have been pre-configured using the System Configuration API. If not, this operation will succeed but you are not able to calculate holdings for the portfolio that include this transaction. (required).
instrumentIdentifiersA set of instrument identifiers that can resolve the transaction to a unique instrument. (required).
transactionDateThe date of the transaction. (required).
settlementDateThe settlement date of the transaction. (required).
unitsThe number of units of the transacted instrument. (required).
transactionPricetransactionPrice.
totalConsiderationtotalConsideration (required).
exchangeRateThe exchange rate between the transaction and settlement currency (settlement currency being represented by TotalConsideration.Currency). For example, if the transaction currency is USD and the settlement currency is GBP, this would be the appropriate USD/GBP rate..
transactionCurrencyThe transaction currency..
propertiesA list of unique transaction properties and associated values to store for the transaction. Each property must 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..
otcConfirmationotcConfirmation.
orderIdorderId.
allocationIdallocationId.
custodianAccountIdcustodianAccountId.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if TransactionRequest instances are equal

Parameters
inputInstance of TransactionRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AllocationId

ResourceId Lusid.Sdk.Model.TransactionRequest.AllocationId
getset

Gets or Sets AllocationId

◆ CounterpartyId

string Lusid.Sdk.Model.TransactionRequest.CounterpartyId
getset

The identifier for the counterparty of the transaction.

The identifier for the counterparty of the transaction.

◆ CustodianAccountId

ResourceId Lusid.Sdk.Model.TransactionRequest.CustodianAccountId
getset

Gets or Sets CustodianAccountId

◆ ExchangeRate

decimal? Lusid.Sdk.Model.TransactionRequest.ExchangeRate
getset

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

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

◆ InstrumentIdentifiers

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

◆ OrderId

ResourceId Lusid.Sdk.Model.TransactionRequest.OrderId
getset

Gets or Sets OrderId

◆ OtcConfirmation

OtcConfirmation Lusid.Sdk.Model.TransactionRequest.OtcConfirmation
getset

Gets or Sets OtcConfirmation

◆ Properties

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

A list of unique transaction properties and associated values to store for the transaction. Each property must be from the &#39;Transaction&#39; domain.

A list of unique transaction properties and associated values to store for the transaction. Each property must be from the &#39;Transaction&#39; domain.

◆ SettlementDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionRequest.SettlementDate
getset

The settlement date of the transaction.

The settlement date of the transaction.

◆ Source

string Lusid.Sdk.Model.TransactionRequest.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.TransactionRequest.TotalConsideration
getset

Gets or Sets TotalConsideration

◆ TransactionCurrency

string Lusid.Sdk.Model.TransactionRequest.TransactionCurrency
getset

The transaction currency.

The transaction currency.

◆ TransactionDate

DateTimeOrCutLabel Lusid.Sdk.Model.TransactionRequest.TransactionDate
getset

The date of the transaction.

The date of the transaction.

◆ TransactionId

string Lusid.Sdk.Model.TransactionRequest.TransactionId
getset

The unique identifier of the transaction.

The unique identifier of the transaction.

◆ TransactionPrice

TransactionPrice Lusid.Sdk.Model.TransactionRequest.TransactionPrice
getset

Gets or Sets TransactionPrice

◆ Type

string Lusid.Sdk.Model.TransactionRequest.Type
getset

The type of the transaction, for example &#39;Buy&#39; or &#39;Sell&#39;. The transaction type must have been pre-configured using the System Configuration API. If not, this operation will succeed but you are not able to calculate holdings for the portfolio that include this transaction.

The type of the transaction, for example &#39;Buy&#39; or &#39;Sell&#39;. The transaction type must have been pre-configured using the System Configuration API. If not, this operation will succeed but you are not able to calculate holdings for the portfolio that include this transaction.

◆ Units

decimal Lusid.Sdk.Model.TransactionRequest.Units
getset

The number of units of the transacted instrument.

The number of units of the transacted instrument.


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