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

A request to create or update an Order. More...

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

Public Member Functions

 OrderRequest (Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), decimal quantity=default(decimal), string side=default(string), ResourceId orderBookId=default(ResourceId), ResourceId portfolioId=default(ResourceId), ResourceId id=default(ResourceId), string state=default(string), string type=default(string), string timeInForce=default(string), DateTimeOffset date=default(DateTimeOffset), CurrencyAndAmount price=default(CurrencyAndAmount), CurrencyAndAmount limitPrice=default(CurrencyAndAmount), CurrencyAndAmount stopPrice=default(CurrencyAndAmount), ResourceId orderInstruction=default(ResourceId), ResourceId package=default(ResourceId))
 Initializes a new instance of the OrderRequest 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 (OrderRequest input)
 Returns true if OrderRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

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

Properties

Dictionary< string, PerpetualPropertyProperties [get, set]
 Client-defined properties associated with this order. More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 The instrument ordered. More...
 
decimal Quantity [get, set]
 The quantity of given instrument ordered. More...
 
string Side [get, set]
 The client&#39;s representation of the order&#39;s side (buy, sell, short, etc) More...
 
ResourceId OrderBookId [get, set]
 Gets or Sets OrderBookId More...
 
ResourceId PortfolioId [get, set]
 Gets or Sets PortfolioId More...
 
ResourceId Id [get, set]
 Gets or Sets Id More...
 
string State [get, set]
 The order&#39;s state (examples: New, PartiallyFilled, ...) More...
 
string Type [get, set]
 The order&#39;s type (examples: Limit, Market, ...) More...
 
string TimeInForce [get, set]
 The order&#39;s time in force (examples: Day, GoodTilCancel, ...) More...
 
DateTimeOffset Date [get, set]
 The date on which the order was made More...
 
CurrencyAndAmount Price [get, set]
 Gets or Sets Price More...
 
CurrencyAndAmount LimitPrice [get, set]
 Gets or Sets LimitPrice More...
 
CurrencyAndAmount StopPrice [get, set]
 Gets or Sets StopPrice More...
 
ResourceId OrderInstruction [get, set]
 Gets or Sets OrderInstruction More...
 
ResourceId Package [get, set]
 Gets or Sets Package More...
 

Detailed Description

A request to create or update an Order.

Constructor & Destructor Documentation

◆ OrderRequest() [1/2]

Lusid.Sdk.Model.OrderRequest.OrderRequest ( )
inlineprotected

Initializes a new instance of the OrderRequest class.

◆ OrderRequest() [2/2]

Lusid.Sdk.Model.OrderRequest.OrderRequest ( Dictionary< string, PerpetualProperty properties = default(Dictionary<string, PerpetualProperty>),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
decimal  quantity = default(decimal),
string  side = default(string),
ResourceId  orderBookId = default(ResourceId),
ResourceId  portfolioId = default(ResourceId),
ResourceId  id = default(ResourceId),
string  state = default(string),
string  type = default(string),
string  timeInForce = default(string),
DateTimeOffset  date = default(DateTimeOffset),
CurrencyAndAmount  price = default(CurrencyAndAmount),
CurrencyAndAmount  limitPrice = default(CurrencyAndAmount),
CurrencyAndAmount  stopPrice = default(CurrencyAndAmount),
ResourceId  orderInstruction = default(ResourceId),
ResourceId  package = default(ResourceId) 
)
inline

Initializes a new instance of the OrderRequest class.

Parameters
propertiesClient-defined properties associated with this order..
instrumentIdentifiersThe instrument ordered. (required).
quantityThe quantity of given instrument ordered. (required).
sideThe client&#39;s representation of the order&#39;s side (buy, sell, short, etc) (required).
orderBookIdorderBookId.
portfolioIdportfolioId.
idid (required).
stateThe order&#39;s state (examples: New, PartiallyFilled, ...).
typeThe order&#39;s type (examples: Limit, Market, ...).
timeInForceThe order&#39;s time in force (examples: Day, GoodTilCancel, ...).
dateThe date on which the order was made.
priceprice.
limitPricelimitPrice.
stopPricestopPrice.
orderInstructionorderInstruction.
packagepackage.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if OrderRequest instances are equal

Parameters
inputInstance of OrderRequest to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Date

DateTimeOffset Lusid.Sdk.Model.OrderRequest.Date
getset

The date on which the order was made

The date on which the order was made

◆ Id

ResourceId Lusid.Sdk.Model.OrderRequest.Id
getset

Gets or Sets Id

◆ InstrumentIdentifiers

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

The instrument ordered.

The instrument ordered.

◆ LimitPrice

CurrencyAndAmount Lusid.Sdk.Model.OrderRequest.LimitPrice
getset

Gets or Sets LimitPrice

◆ OrderBookId

ResourceId Lusid.Sdk.Model.OrderRequest.OrderBookId
getset

Gets or Sets OrderBookId

◆ OrderInstruction

ResourceId Lusid.Sdk.Model.OrderRequest.OrderInstruction
getset

Gets or Sets OrderInstruction

◆ Package

ResourceId Lusid.Sdk.Model.OrderRequest.Package
getset

Gets or Sets Package

◆ PortfolioId

ResourceId Lusid.Sdk.Model.OrderRequest.PortfolioId
getset

Gets or Sets PortfolioId

◆ Price

CurrencyAndAmount Lusid.Sdk.Model.OrderRequest.Price
getset

Gets or Sets Price

◆ Properties

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

Client-defined properties associated with this order.

Client-defined properties associated with this order.

◆ Quantity

decimal Lusid.Sdk.Model.OrderRequest.Quantity
getset

The quantity of given instrument ordered.

The quantity of given instrument ordered.

◆ Side

string Lusid.Sdk.Model.OrderRequest.Side
getset

The client&#39;s representation of the order&#39;s side (buy, sell, short, etc)

The client&#39;s representation of the order&#39;s side (buy, sell, short, etc)

◆ State

string Lusid.Sdk.Model.OrderRequest.State
getset

The order&#39;s state (examples: New, PartiallyFilled, ...)

The order&#39;s state (examples: New, PartiallyFilled, ...)

◆ StopPrice

CurrencyAndAmount Lusid.Sdk.Model.OrderRequest.StopPrice
getset

Gets or Sets StopPrice

◆ TimeInForce

string Lusid.Sdk.Model.OrderRequest.TimeInForce
getset

The order&#39;s time in force (examples: Day, GoodTilCancel, ...)

The order&#39;s time in force (examples: Day, GoodTilCancel, ...)

◆ Type

string Lusid.Sdk.Model.OrderRequest.Type
getset

The order&#39;s type (examples: Limit, Market, ...)

The order&#39;s type (examples: Limit, Market, ...)


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