Interface Order

If true, a comment can be included with a cancellation of the order. In that case, call authorizeOrderCancellation with a CancelOrderOpts.comment.

If true, the comment can be edited by the user using session.prepareEditOrder

If true, the size of the order can be edited by using session.prepareEditOrder

If true, the validity of the order can be edited by using session.prepareEditOrder

only for reading orders: if this is a bond, the currency ISO code to show for the size input field

ExchangeId, as defined by the broker (this must be used for order creations)

For canceled orders: when the order has been canceled.

Already cancelled size of the order.

CashFlow, in the portfolio's currency, that this order has produced.

If the prepared instrument's clearingAccountNoOptions is set, must be one of those values.

A textual comment assigned to the order.

When the order has been created - set in OrderLists.

buy/sell or (for CFD/FX: Long / Short)

CFD/FX entry direction (used by JFD)

When retrieving orders, the externally mapped exchange id. Note that for order creations, this may not be used (use brokerExchangeId).

(in order lists) Name of the exchange, as provided by the broker.

The timestamp of the latest execution.

Already executed size of the order

If there already have been executions of this order, a list of those.

fallback instrument data, as provided by the broker (present if it is retrieved via getOrder or order lists).

If this is true, it is not possible to show a receipt for this order (this is the case if order data is incomplete in order lists).

The id of the order, (present if it is retrieved via getOrder or order lists).

instrument data, as provided by the external instruments dependency (present if it is retrieved via getOrder or order lists).

InstrumentId, as defined by the external dependency (if applicable for the type of order). Only present if the instrument could be matched using the external instruments API. For creation of orders, this must be set.

Whether this order is supposed to open or close a position. If PreparedTrade.availableOrderIntents (and/or the corressponding subscription via availableOrderIntentsToken) is available, it should be set.

Set it to close for orders that are supposed to close an existing position. Note that this is independent of the order's direction (e.g. a short position is closed by a buy order).

True if the order is cancellable.

True if this order is part of a combination order, and it is possible to cancel all parts of the combination order.

limit (and stop etc.) currency to use for this order

If true, the current stop value of this order can be observed. In this case, session.createCurrentStopValueObservable can be used.

Remaining/open size of the order

The visible order number (as opposed to the ID). Some brokers display order numbers to users, and those may be different from the ID.

(AllOrNone/Immediate or Cancel/Fill or Kill)

The OrderModel determines how the order is executed.

If this is true (for open orders only), this order is currently awaiting the execution of a parent order.

Order status as text (may be broker-specific, only used for displaying it to users).

PortfolioId that this order belongs to (present if it is retrieved via getOrder or order lists).

If provided by the broker, the absolute profit/loss this order has produced.

If provided by the broker, the relative profit/loss this order has produced. 1 means +100%

When creating an order, the PxFee structure is used. For retrieving/order lists, see pxFeeValue.

When retrieving an order, the absolute value is here. For order creation, see pxFee

If this is an executed PX order, the transaction will be exposed as the order object. However, internally there are two entities:

• the original order (in database table order)
• the resulting transaction (in database table transaction)

Clients normally do not need to know this, but there is a special case (assigning a stream post to an order afterwards), where the information is required. Note that this is subject to change - this could be improved by adding an assignStreampost() to PxSession which abstracts this away.

For PX trade history: the avg buy quote without fees.

For PX trade history: the avg sell quote without fees.

For PX trade history: duration of the trade

Order IDs of all orders that have been aggregated to this trade.

If supported by the broker, an optional limit can be added to a quote trade.

If this is present and true, a receipt can be shown for the order, but it cannot be retrieved using getOrder (which also means it is not possible to link to the current state of the order). Therefore this order object can simply be serialized and shown as a receipt.

If sell must base on a specific position selected by the user (to be determined via session's getSellPositions).

Order is visible, but it cannot be interacted with (e.g. because it is the discarded part of a combination order). It should be displayed to the user, but visibily disabled.

Overall size of the order. If all fields are set, should be openSize + executedSize + cancelledSize.

Custom unit for the size field. Used by CFD/FX broker to show different units (like CFDs, Lots, etc.) or brokers where different sizeUnits are possible (according to preparedInstrument.sizeUnitsByClearingAccountNo)

HadC speciality.

Symbol of the ordered instrument (used by CFD/FX broker)

the avg buy quote without fees.

the avg sell quote without fees.

Historic order list (used by HadC and CFDFX broker) Contains previous partly closed orders

If true, order changes and cancellations for this order must be directed to an external service. This is handled internally. However, the frontend must display the information to the user according to this flag.