POST api/orders/allocation

Create a set of order allocations.

Request Information

URI Parameters

None.

Body Parameters

List of order allocations

Collection of OrderAllocation

Name	Description	Type	Additional information
ClientID	Client account ID	integer	Required
NettingOrderID	Netting order ID	integer	Required
Quantity	Quantity of allocation	integer	Required
Price	Price	decimal number	None.
ClientBrokerageScheduleID	Client brokerage schedule ID	integer	None.
CustomBrokerageFee	Custom brokerage fee	decimal number	None.
CustomBrokeragePercent	Custom brokerage percent	decimal number	None.
NotesForClient	Notes for client	string	None.
ParentClientRef	Parent client reference. Indicates where the allocation originates from.	string	None.
MasterReference	Omgeo MasterReference _may_ be a duplicate of ParentClientRef - required when allocations are from Omgeo	string	None.
AllocationReference	Omgeo Allocation Reference - required when allocations are from Omgeo. Expected 16 characters.	string	None.
NetAmount	Omgeo Net Cash Amount - required when allocations are from Omgeo	decimal number	None.
TradeValue	Omgeo Total Trade Amount - required when allocations are from Omgeo	decimal number	None.
GSTValue	Omgeo GST Value - required when allocations are from Omgeo	decimal number	None.
IPOFlag	IPOFlag - Indicator allocations for IPO placement allocation	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 111111,
    "NettingOrderID": 123,
    "Quantity": 100,
    "Price": 19.04,
    "ClientBrokerageScheduleID": 2,
    "CustomBrokerageFee": null,
    "CustomBrokeragePercent": null,
    "NotesForClient": "Order Allocation 1",
    "ParentClientRef": null,
    "MasterReference": "MR123",
    "AllocationReference": "AR123",
    "NetAmount": 123.45,
    "TradeValue": 234.56,
    "GSTValue": 12.34,
    "IPOFlag": null
  },
  {
    "ClientID": 222222,
    "NettingOrderID": 321,
    "Quantity": 200,
    "Price": 19.04,
    "ClientBrokerageScheduleID": null,
    "CustomBrokerageFee": 100.0,
    "CustomBrokeragePercent": 0.9,
    "NotesForClient": "Order Allocation 2",
    "ParentClientRef": null,
    "MasterReference": "MR234",
    "AllocationReference": "AR234",
    "NetAmount": 678.9,
    "TradeValue": 567.89,
    "GSTValue": 34.56,
    "IPOFlag": null
  },
  {
    "ClientID": 222222,
    "NettingOrderID": 321,
    "Quantity": 200,
    "Price": 19.04,
    "ClientBrokerageScheduleID": null,
    "CustomBrokerageFee": null,
    "CustomBrokeragePercent": null,
    "NotesForClient": "Order Allocation 3",
    "ParentClientRef": null,
    "MasterReference": "MR345",
    "AllocationReference": "AR345",
    "NetAmount": 98.76,
    "TradeValue": 87.65,
    "GSTValue": 65.43,
    "IPOFlag": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderAllocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <OrderAllocation>
    <AllocationReference>AR123</AllocationReference>
    <ClientBrokerageScheduleID>2</ClientBrokerageScheduleID>
    <ClientID>111111</ClientID>
    <CustomBrokerageFee i:nil="true" />
    <CustomBrokeragePercent i:nil="true" />
    <GSTValue>12.34</GSTValue>
    <IPOFlag i:nil="true" />
    <MasterReference>MR123</MasterReference>
    <NetAmount>123.45</NetAmount>
    <NettingOrderID>123</NettingOrderID>
    <NotesForClient>Order Allocation 1</NotesForClient>
    <ParentClientRef i:nil="true" />
    <Price>19.04</Price>
    <Quantity>100</Quantity>
    <TradeValue>234.56</TradeValue>
  </OrderAllocation>
  <OrderAllocation>
    <AllocationReference>AR234</AllocationReference>
    <ClientBrokerageScheduleID i:nil="true" />
    <ClientID>222222</ClientID>
    <CustomBrokerageFee>100</CustomBrokerageFee>
    <CustomBrokeragePercent>0.9</CustomBrokeragePercent>
    <GSTValue>34.56</GSTValue>
    <IPOFlag i:nil="true" />
    <MasterReference>MR234</MasterReference>
    <NetAmount>678.90</NetAmount>
    <NettingOrderID>321</NettingOrderID>
    <NotesForClient>Order Allocation 2</NotesForClient>
    <ParentClientRef i:nil="true" />
    <Price>19.04</Price>
    <Quantity>200</Quantity>
    <TradeValue>567.89</TradeValue>
  </OrderAllocation>
  <OrderAllocation>
    <AllocationReference>AR345</AllocationReference>
    <ClientBrokerageScheduleID i:nil="true" />
    <ClientID>222222</ClientID>
    <CustomBrokerageFee i:nil="true" />
    <CustomBrokeragePercent i:nil="true" />
    <GSTValue>65.43</GSTValue>
    <IPOFlag i:nil="true" />
    <MasterReference>MR345</MasterReference>
    <NetAmount>98.76</NetAmount>
    <NettingOrderID>321</NettingOrderID>
    <NotesForClient>Order Allocation 3</NotesForClient>
    <ParentClientRef i:nil="true" />
    <Price>19.04</Price>
    <Quantity>200</Quantity>
    <TradeValue>87.65</TradeValue>
  </OrderAllocation>
</ArrayOfOrderAllocation>

Response Information

Resource Description

List of OrderAllocationResult if successful otherwise returns list of OrderAllocationErrorResult if there are any invalid order allocations

Collection of OrderAllocationResult

Name	Description	Type	Additional information
OrderAllocationID	Order allocation ID	integer	None.
NettingOrderID	Netting order ID	integer	None.
ClientID	Client account ID	integer	None.
Quantity	Quantity	integer	None.
Price	Price	decimal number	None.
ClientBrokerageScheduleID	Brokerage schedule	integer	None.
NotesForClient	Notes for client	string	None.
CreatorID	Person that initiates the order allocation	integer	None.
Origin	Origin of order	byte	None.
DateTimeCreated	Creation datetime	date	None.
RegistrationType	Client's registration type	byte	None.

Collection of OrderAllocationErrorResult

Name	Description	Type	Additional information
OrderAllocation	Order allocation info	OrderAllocation	None.
Errors	Errors associated with order allocation creation	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderAllocationID": 1,
    "NettingOrderID": 11,
    "ClientID": 111,
    "Quantity": 50,
    "Price": 10.0,
    "ClientBrokerageScheduleID": 2,
    "NotesForClient": "Allocation 1",
    "CreatorID": 3,
    "Origin": 12,
    "DateTimeCreated": "2024-09-29T14:49:40.5598984+10:00",
    "RegistrationType": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderAllocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <OrderAllocationResult>
    <ClientBrokerageScheduleID>2</ClientBrokerageScheduleID>
    <ClientID>111</ClientID>
    <CreatorID>3</CreatorID>
    <DateTimeCreated>2024-09-29T14:49:40.5598984+10:00</DateTimeCreated>
    <NettingOrderID>11</NettingOrderID>
    <NotesForClient>Allocation 1</NotesForClient>
    <OrderAllocationID>1</OrderAllocationID>
    <Origin>12</Origin>
    <Price>10</Price>
    <Quantity>50</Quantity>
    <RegistrationType>1</RegistrationType>
  </OrderAllocationResult>
</ArrayOfOrderAllocationResult>

application/json, text/json

Sample:

[
  {
    "OrderAllocation": {
      "ClientID": 111111,
      "NettingOrderID": 123,
      "Quantity": 100,
      "Price": 19.04,
      "ClientBrokerageScheduleID": 2,
      "CustomBrokerageFee": null,
      "CustomBrokeragePercent": null,
      "NotesForClient": "Order Allocation 1",
      "ParentClientRef": null,
      "MasterReference": null,
      "AllocationReference": null,
      "NetAmount": null,
      "TradeValue": null,
      "GSTValue": null,
      "IPOFlag": null
    },
    "Errors": [
      "Invalid client"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderAllocationErrorResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <OrderAllocationErrorResult>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Invalid client</d3p1:string>
    </Errors>
    <OrderAllocation>
      <AllocationReference i:nil="true" />
      <ClientBrokerageScheduleID>2</ClientBrokerageScheduleID>
      <ClientID>111111</ClientID>
      <CustomBrokerageFee i:nil="true" />
      <CustomBrokeragePercent i:nil="true" />
      <GSTValue i:nil="true" />
      <IPOFlag i:nil="true" />
      <MasterReference i:nil="true" />
      <NetAmount i:nil="true" />
      <NettingOrderID>123</NettingOrderID>
      <NotesForClient>Order Allocation 1</NotesForClient>
      <ParentClientRef i:nil="true" />
      <Price>19.04</Price>
      <Quantity>100</Quantity>
      <TradeValue i:nil="true" />
    </OrderAllocation>
  </OrderAllocationErrorResult>
</ArrayOfOrderAllocationErrorResult>

Error Response Information

Resource Description

List of OrderAllocationResult if successful otherwise returns list of OrderAllocationErrorResult if there are any invalid order allocations

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>