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

A LUSID Trade Ticket comprising an instrument, a transaction, and a counterparty. More...

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

Public Types

enum class  TradeTicketTypeEnum { LusidTradeTicket = 1 , ExternalTradeTicket = 2 }
 The available values are: LusidTradeTicket, ExternalTradeTicket More...
 

Public Member Functions

 LusidTradeTicket (string transactionId=default(string), string transactionType=default(string), string source=default(string), string transactionDate=default(string), string settlementDate=default(string), CurrencyAndAmount totalConsideration=default(CurrencyAndAmount), decimal units=default(decimal), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), string instrumentScope=default(string), string instrumentName=default(string), LusidInstrument instrumentDefinition=default(LusidInstrument), ResourceId counterpartyAgreementId=default(ResourceId), string counterparty=default(string), List< Property > instrumentProperties=default(List< Property >), List< Property > transactionProperties=default(List< Property >), TradeTicketTypeEnum tradeTicketType=default(TradeTicketTypeEnum))
 Initializes a new instance of the LusidTradeTicket 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 (LusidTradeTicket input)
 Returns true if LusidTradeTicket instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

TradeTicketTypeEnum TradeTicketType [get, set]
 The available values are: LusidTradeTicket, ExternalTradeTicket More...
 
string TransactionId [get, set]
 Transaction ID. Must be unique. More...
 
string TransactionType [get, set]
 Type of transaction for processing. Referenced by Transaction Configuration. More...
 
string Source [get, set]
 Transaction Source. Referenced by Transaction Configuration. More...
 
string TransactionDate [get, set]
 Transaction Date. Date at which transaction is known. More...
 
string SettlementDate [get, set]
 Transaction settlement. Date at which transaction is finalised and realised into the system. More...
 
CurrencyAndAmount TotalConsideration [get, set]
 Gets or Sets TotalConsideration More...
 
decimal Units [get, set]
 Number of units in the transaction. For an OTC this is somewhat interchangeable with the quantity booked in the instrument. As M x N or N x M are equivalent it is advised a client chooses one approach and sticks to it. Arguably either the unit or holding is best unitised. More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 Identifiers for the instrument. More...
 
string InstrumentScope [get, set]
 Scope of instrument More...
 
string InstrumentName [get, set]
 Name of instrument More...
 
LusidInstrument InstrumentDefinition [get, set]
 Gets or Sets InstrumentDefinition More...
 
ResourceId CounterpartyAgreementId [get, set]
 Gets or Sets CounterpartyAgreementId More...
 
string Counterparty [get, set]
 Counterparty More...
 
List< PropertyInstrumentProperties [get, set]
 Set of instrument properties (as defined by client/user). More...
 
List< PropertyTransactionProperties [get, set]
 Set of transaction properties (as defined by client/user). More...
 

Detailed Description

A LUSID Trade Ticket comprising an instrument, a transaction, and a counterparty.

Member Enumeration Documentation

◆ TradeTicketTypeEnum

The available values are: LusidTradeTicket, ExternalTradeTicket

The available values are: LusidTradeTicket, ExternalTradeTicket

Enumerator
LusidTradeTicket 

Enum LusidTradeTicket for value: LusidTradeTicket

ExternalTradeTicket 

Enum ExternalTradeTicket for value: ExternalTradeTicket

Constructor & Destructor Documentation

◆ LusidTradeTicket() [1/2]

Lusid.Sdk.Model.LusidTradeTicket.LusidTradeTicket ( )
inlineprotected

Initializes a new instance of the LusidTradeTicket class.

◆ LusidTradeTicket() [2/2]

Lusid.Sdk.Model.LusidTradeTicket.LusidTradeTicket ( string  transactionId = default(string),
string  transactionType = default(string),
string  source = default(string),
string  transactionDate = default(string),
string  settlementDate = default(string),
CurrencyAndAmount  totalConsideration = default(CurrencyAndAmount),
decimal  units = default(decimal),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
string  instrumentScope = default(string),
string  instrumentName = default(string),
LusidInstrument  instrumentDefinition = default(LusidInstrument),
ResourceId  counterpartyAgreementId = default(ResourceId),
string  counterparty = default(string),
List< Property instrumentProperties = default(List<Property>),
List< Property transactionProperties = default(List<Property>),
TradeTicketTypeEnum  tradeTicketType = default(TradeTicketTypeEnum) 
)
inline

Initializes a new instance of the LusidTradeTicket class.

Parameters
transactionIdTransaction ID. Must be unique. (required).
transactionTypeType of transaction for processing. Referenced by Transaction Configuration. (required).
sourceTransaction Source. Referenced by Transaction Configuration..
transactionDateTransaction Date. Date at which transaction is known. (required).
settlementDateTransaction settlement. Date at which transaction is finalised and realised into the system. (required).
totalConsiderationtotalConsideration (required).
unitsNumber of units in the transaction. For an OTC this is somewhat interchangeable with the quantity booked in the instrument. As M x N or N x M are equivalent it is advised a client chooses one approach and sticks to it. Arguably either the unit or holding is best unitised. (required).
instrumentIdentifiersIdentifiers for the instrument. (required).
instrumentScopeScope of instrument.
instrumentNameName of instrument.
instrumentDefinitioninstrumentDefinition.
counterpartyAgreementIdcounterpartyAgreementId.
counterpartyCounterparty.
instrumentPropertiesSet of instrument properties (as defined by client/user)..
transactionPropertiesSet of transaction properties (as defined by client/user)..
tradeTicketTypeThe available values are: LusidTradeTicket, ExternalTradeTicket (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if LusidTradeTicket instances are equal

Parameters
inputInstance of LusidTradeTicket to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Counterparty

string Lusid.Sdk.Model.LusidTradeTicket.Counterparty
getset

Counterparty

Counterparty

◆ CounterpartyAgreementId

ResourceId Lusid.Sdk.Model.LusidTradeTicket.CounterpartyAgreementId
getset

Gets or Sets CounterpartyAgreementId

◆ InstrumentDefinition

LusidInstrument Lusid.Sdk.Model.LusidTradeTicket.InstrumentDefinition
getset

Gets or Sets InstrumentDefinition

◆ InstrumentIdentifiers

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

Identifiers for the instrument.

Identifiers for the instrument.

◆ InstrumentName

string Lusid.Sdk.Model.LusidTradeTicket.InstrumentName
getset

Name of instrument

Name of instrument

◆ InstrumentProperties

List<Property> Lusid.Sdk.Model.LusidTradeTicket.InstrumentProperties
getset

Set of instrument properties (as defined by client/user).

Set of instrument properties (as defined by client/user).

◆ InstrumentScope

string Lusid.Sdk.Model.LusidTradeTicket.InstrumentScope
getset

Scope of instrument

Scope of instrument

◆ SettlementDate

string Lusid.Sdk.Model.LusidTradeTicket.SettlementDate
getset

Transaction settlement. Date at which transaction is finalised and realised into the system.

Transaction settlement. Date at which transaction is finalised and realised into the system.

◆ Source

string Lusid.Sdk.Model.LusidTradeTicket.Source
getset

Transaction Source. Referenced by Transaction Configuration.

Transaction Source. Referenced by Transaction Configuration.

◆ TotalConsideration

CurrencyAndAmount Lusid.Sdk.Model.LusidTradeTicket.TotalConsideration
getset

Gets or Sets TotalConsideration

◆ TradeTicketType

TradeTicketTypeEnum Lusid.Sdk.Model.LusidTradeTicket.TradeTicketType
getset

The available values are: LusidTradeTicket, ExternalTradeTicket

The available values are: LusidTradeTicket, ExternalTradeTicket

◆ TransactionDate

string Lusid.Sdk.Model.LusidTradeTicket.TransactionDate
getset

Transaction Date. Date at which transaction is known.

Transaction Date. Date at which transaction is known.

◆ TransactionId

string Lusid.Sdk.Model.LusidTradeTicket.TransactionId
getset

Transaction ID. Must be unique.

Transaction ID. Must be unique.

◆ TransactionProperties

List<Property> Lusid.Sdk.Model.LusidTradeTicket.TransactionProperties
getset

Set of transaction properties (as defined by client/user).

Set of transaction properties (as defined by client/user).

◆ TransactionType

string Lusid.Sdk.Model.LusidTradeTicket.TransactionType
getset

Type of transaction for processing. Referenced by Transaction Configuration.

Type of transaction for processing. Referenced by Transaction Configuration.

◆ Units

decimal Lusid.Sdk.Model.LusidTradeTicket.Units
getset

Number of units in the transaction. For an OTC this is somewhat interchangeable with the quantity booked in the instrument. As M x N or N x M are equivalent it is advised a client chooses one approach and sticks to it. Arguably either the unit or holding is best unitised.

Number of units in the transaction. For an OTC this is somewhat interchangeable with the quantity booked in the instrument. As M x N or N x M are equivalent it is advised a client chooses one approach and sticks to it. Arguably either the unit or holding is best unitised.


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