OrderResponseV4
- accountType: string | null
Code Name of the account to which the order has been allocated.
- actionType: string | null enum
Status The status of the last action, for example OK, PENDING, AUTHORISING, DENIED, QUEUED or FAILED.
values- P
E N D I N G - O
K - F
A I L E D - A
U T H O R I S I N G - D
E N I E D - Q
U E U E D
- advisorType: string | null
Code The advisor which is assigned to the account.
- averageType: number | null Format: double
Price Average price traded for an order.
- clientType: integer | null Format: int64
Sequence Number A number that uniquely identifies the last client order action.
- createType: string | null Format: date-time
Date Time Date & time the client order was created. (Server time).
- currencyType: string | null
The currency of the order.
- dataType: object · DataFieldsProperties
Fields Properties that can be added on dataFields property. FixedContigentOrder properties can only be used when the destination is 'FIXED CO'. TrailingContingentOrder properties can only be used whtn the destination is 'TRAILING CO'.
- brokerageType: string | null
Override .minimum A flat $value brokerage override, excluding GST, to 2 decimal places. Applies to Limit or MarketToLimit pricingInstruction only. Overrides the current order only, does not modify the default rate for future trades.
- brokerageType: string Format: string
Override .schedule Schedule for brokerage override.
- fixedType: string Format: date-time
Contingent Order .expiry Date Optional value to set the expiry date of the contingent order. Can only be used when Destination is 'FIXED CO'; otherwise, it will be ignored.
- fixedType: string enum
Contingent Order .trigger Condition The condition that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.
values- Greater
- Less
- Greater
Or Equal - Less
Or Equal
- fixedType: string Format: double
Contingent Order .trigger Price The price that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.
- fixedType: string enum
Contingent Order .trigger Price Type The type of price that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.
values- Last
- Bid
- Ask
- fixedType: string
Contingent Order .trigger Security Security in the form of 'securityCode.exchange' that will trigger the order creation. Required when Destination is 'FIXED CO'; otherwise, it will be ignored.
- originType: string
Of Order max length:512String value that tells the origin of order.
- trailingType: string Format: date-time
Contingent Order .expiry Date Optional value to set the expiry date of the contingent order. Can only be used when Destination is 'TRAILING CO'; otherwise, it will be ignored.
- trailingType: string
Contingent Order .limit Offset The unit or percentage to limit the offset. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored.
- trailingType: string enum
Contingent Order .limit Offset Type The type of unit which the offset limit would apply to. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is 'PRICE'.
values- Price
- Percentage
- Price
Step
- trailingType: string enum
Contingent Order .trailing Direction The direction to recalculate the trigger price. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is 'Up'.
values- Up
- Down
- trailingType: string
Contingent Order .trailing Offset The number of units or percentage where the user would like the stop to be set from the current price. Required when Destination is 'TRAILING CO'; otherwise, it will be ignored.
- trailingType: string enum
Contingent Order .trailing Offset Type The type of unit which trailing offset would apply to. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is 'Price'.
values- Price
- Percentage
- Price
Step
- trailingType: string
Contingent Order .trailing Price The base price for trailing orders. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored.
- trailingType: string
Contingent Order .trailing Step The unit or percentage movement that will cause the trailing price to be reset or recalculated. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored. Default value is '1'.
- trailingType: string enum
Contingent Order .trailing Step Type The type of unit which trailing step would apply to. Optional, use only when Destination is 'TRAILING CO'; otherwise, it will be ignored.
values- Price
- Percentage
- Price
Step
- trailingType: string
Contingent Order .trigger Security Security in the form of 'securityCode.exchange' that will trigger the order creation. Required when Destination is 'TRAILING CO'; otherwise, it will be ignored.
- destinationType: string | null
Destination of the order.
- destinationType: string | null
Order Number Order identifier from external destination (i.e. ASX order identifier).
- destinationType: number | null Format: double
Price Confirmed price from the destination.
- destinationType: string | null
Status Status of an order at destination.
- destinationType: number | null Format: double
Volume Confirmed volume from the destination.
- doneType: number | null Format: double
Value Today Value of trades for the order today.
- doneType: number | null Format: double
Value Total Value of trades for the order.
- doneType: number | null Format: double
Volume Today Volume traded for the order today.
- doneType: number | null Format: double
Volume Total Volume traded for the order.
- effectiveType: number | null Format: double
Done Volume The total done volume minus total volume sourced in trade splits.
- estimatedType: number | null Format: double
Price The estimated price of the order. When the order has a pricing instruction which does not require a price (eg. Best, Market To Limit) the price is estimated from a snapshot of market data. It will not update when the market price changes. When the order is of a Limit type the estimated price will be the specified order price.
- estimatedType: number | null Format: double
Value Estimated value for the order.
- estimatedType: number | null Format: double
Volume Estimated volume for the order.
- exchangeType: string | null
Exchange on which the security is traded.
- expiryType: string | null Format: date-time
Date Time Date and time the order will be removed from the market if it hasn't fully traded. (Exchange time).
- lastType: string | null enum
Action Last action performed on the order, for example, CREATE, CANCEL, PURGE or AMEND.
values- C
R E A T E - A
M E N D - C
A N C E L - P
U R G E
- lifetimeType: string | null
Lifetime of the order. The time for which the order is valid. ie, Date, Fill and Kill.
- marketType: integer | null Format: int64
Data Order Number The Market Data Order Number which can be cross referenced against Market Data.
- marketType: string | null
Detail A comma-separated list of DataSource and DestinationOrderNumber string pairs (in the format of 'DataSource|DestinationOrderNumber') for matching IOS+ orders to market data.
- notesType: stringmax length:512
Custom notes to attach to the order.
- orderType: string
Giver max length:100The client or person who requested the order.
- orderType: string | null
Match Id The identifier for externally created at-risk orders to match to existing parent orders.
- orderType: integer Format: int64
Number Unique order number.
- orderType: number | null Format: double
Price Price set for the order. If the order is set to At Best or At Market this column displays Best or Market. For an At Risk destination, destination volume and price are the same as order volume and price.
- orderType: string | null enum
State Current state of the order. For example ACTIVE or INACTIVE.
ACTIVE- Active, the order can be amended, cancelled and filledINACTIVE- Inactive, the order cannot be amended, cancelled nor filled anymore
values- A
C T I V E - I
N A C T I V E
- orderType: string
Taker max length:100Advisor or company representative who received the order.
- orderType: number | null Format: double
Value The total value of the order.
- orderType: number | null Format: double
Volume Original volume entered.
- parentType: integer | null Format: int64
Order Number Unique parent order number. Populated with the OrderNumber from the Parent Order.
- postType: string | null enum
Trade Status The status of the order for post trade reporting.
values- None
- Open
- Partial
Fill - Filled
- Notice
Of Execution Sent - Matched
- Ticketed
- Confirmed
- priceType: number | null Format: double
Multiplier Security price multiplier.
- pricingType: string | null
Instructions Displays a code representing the price attribute and order attribute of the market order, ie, Limit, Market.
- principalType: boolean | null
Indicates whether an order was crossed with a firm account.
- remainingType: number | null Format: double
Volume Untraded volume remaining in the market.
- rootType: integer | null Format: int64
Parent Order Number Unique root parent order number. Populated with the OrderNumber from the root parent order.
- securityType: string | null
Code Exchange code of the security.
- settlementType: number | null Format: double
Average Price Average price traded for an order expressed in the settlement currency.
- settlementType: number | null Format: double
Done Value Today Value of trades for the order today expressed in the settlement currency.
- settlementType: number | null Format: double
Done Value Total Value of trades for the order expressed in the settlement currency.
- sideType: string | null enum
The side of the order.
values- Buy
- Sell
- Short
- Undetermined
- stateType: string | null
Description Market status description. Describes the value displayed in the corresponding ActionStatus field. For example, if AUTHORISING is the ActionStatus field value, the StateDescription will display the reason the order has been diverted for authorisation.
- subType: string | null
Destination Sub destination of a destination, ie, Destination US, sub-destinations NY, Best Market Server.
- uncommittedType: number | null Format: double
Volume Volume not yet committed to child orders.
- updateType: string | null Format: date-time
Date Time Date & time the client order was updated. (Server time).
