GET api/brand/{brandID}/open-orders

Get all open orders. Can be used to reconcile external systems.

Request Information

URI Parameters

Name	Description	Type	Additional information
brandID	Brand ID to filter on.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Contract notes.

Collection of Order

Name	Description	Type	Additional information
OrderID	TPP order identifier.	integer	None.
ClientID	TPP client identifier.	integer	None.
ClientRef	Account reference from 3rd party front office systems.	string	None.
OrderRef	Reference of order given by 3rd party front office systems.	string	None.
NettingOrderID	Netting reference used for aggregating brokerage and settlement.	integer	None.
SecurityCode	Instrument code.	string	None.
BuySell	Buy/Sell indicator.	enBuySell	None.
Quantity	Quantity of the order.	integer	None.
QuantityBooked	Quantity booked to the order.	integer	None.
OrderStatus	Order status.	enOrderStatus	None.
VWAP	Volume Weighted Average Price of trades currently booked (Note: may be blank/omitted).	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderID": 100001207,
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "OrderRef": "",
    "NettingOrderID": 5792062,
    "SecurityCode": "BHP",
    "BuySell": 1,
    "Quantity": 100,
    "QuantityBooked": 0,
    "OrderStatus": 1,
    "VWAP": 0.0
  },
  {
    "OrderID": 100001208,
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "OrderRef": "",
    "NettingOrderID": 5792063,
    "SecurityCode": "BHP",
    "BuySell": 1,
    "Quantity": 145,
    "QuantityBooked": 0,
    "OrderStatus": 1,
    "VWAP": 0.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.DataAccess.LLB.Contracts.ExternalMessagingSender">
  <Order>
    <BuySell>Buy</BuySell>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <NettingOrderID>5792062</NettingOrderID>
    <OrderID>100001207</OrderID>
    <OrderRef></OrderRef>
    <OrderStatus>Active</OrderStatus>
    <Quantity>100</Quantity>
    <QuantityBooked>0</QuantityBooked>
    <SecurityCode>BHP</SecurityCode>
    <VWAP>0</VWAP>
  </Order>
  <Order>
    <BuySell>Buy</BuySell>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <NettingOrderID>5792063</NettingOrderID>
    <OrderID>100001208</OrderID>
    <OrderRef></OrderRef>
    <OrderStatus>Active</OrderStatus>
    <Quantity>145</Quantity>
    <QuantityBooked>0</QuantityBooked>
    <SecurityCode>BHP</SecurityCode>
    <VWAP>0</VWAP>
  </Order>
</ArrayOfOrder>