POST api/orders/{nettingOrderID}/allocation/valuation

Order Allocation Brokerage Valuation

Request Information

URI Parameters

Name	Description	Type	Additional information
nettingOrderID		integer	Required

Body Parameters

Collection of OrderAllocationValuation

Name	Description	Type	Additional information
ClientID	Client ID of client account	integer	Required
Price	Order allocation price in dollars	decimal number	None.
Quantity	Order quantity	decimal number	Required
ValidityType	Order validity type.	enOrderValidityType	Required
ExpiryDate	Order expiry date	string	None.
CreatorID	The person ID whom this order is for. Required if you are submitting this instruction on behalf of a person	integer	None.
ClientBrokerageScheduleIDOverride	Client Brokerage Schedule	integer	None.
CustomBrokerageFeeOverride	Custom Brokerage Fee. ie. 50.50	decimal number	None.
CustomBrokeragePercentOverride	Custom Brokerage Percent. ie. 0.5 = 50%	decimal number	None.
FreeBrokerage	Free brokerage override if true	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1,
    "Price": 10.0,
    "Quantity": 500.0,
    "ValidityType": 6,
    "ExpiryDate": null,
    "CreatorID": 1000,
    "ClientBrokerageScheduleIDOverride": 10000,
    "CustomBrokerageFeeOverride": null,
    "CustomBrokeragePercentOverride": null,
    "FreeBrokerage": false
  },
  {
    "ClientID": 2,
    "Price": 20.0,
    "Quantity": 500.0,
    "ValidityType": 6,
    "ExpiryDate": null,
    "CreatorID": 1000,
    "ClientBrokerageScheduleIDOverride": 10000,
    "CustomBrokerageFeeOverride": null,
    "CustomBrokeragePercentOverride": null,
    "FreeBrokerage": false
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderAllocationValuation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <OrderAllocationValuation>
    <ClientBrokerageScheduleIDOverride>10000</ClientBrokerageScheduleIDOverride>
    <ClientID>1</ClientID>
    <CreatorID>1000</CreatorID>
    <CustomBrokerageFeeOverride i:nil="true" />
    <CustomBrokeragePercentOverride i:nil="true" />
    <ExpiryDate i:nil="true" />
    <FreeBrokerage>false</FreeBrokerage>
    <Price>10</Price>
    <Quantity>500</Quantity>
    <ValidityType>GoodTillCancel</ValidityType>
  </OrderAllocationValuation>
  <OrderAllocationValuation>
    <ClientBrokerageScheduleIDOverride>10000</ClientBrokerageScheduleIDOverride>
    <ClientID>2</ClientID>
    <CreatorID>1000</CreatorID>
    <CustomBrokerageFeeOverride i:nil="true" />
    <CustomBrokeragePercentOverride i:nil="true" />
    <ExpiryDate i:nil="true" />
    <FreeBrokerage>false</FreeBrokerage>
    <Price>20</Price>
    <Quantity>500</Quantity>
    <ValidityType>GoodTillCancel</ValidityType>
  </OrderAllocationValuation>
</ArrayOfOrderAllocationValuation>

Response Information

Resource Description

Collection of OrderAllocationEstimateValuationResult

Name	Description	Type	Additional information
Brokerage	Order allocation brokerage	decimal number	None.
GST	Order allocation GST amount	decimal number	None.
TotalValue	Order allocation value	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Brokerage": 10.0,
    "GST": 1.0,
    "TotalValue": 11.0
  },
  {
    "Brokerage": 20.0,
    "GST": 2.0,
    "TotalValue": 22.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderAllocationEstimateValuationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <OrderAllocationEstimateValuationResult>
    <Brokerage>10</Brokerage>
    <GST>1</GST>
    <TotalValue>11</TotalValue>
  </OrderAllocationEstimateValuationResult>
  <OrderAllocationEstimateValuationResult>
    <Brokerage>20</Brokerage>
    <GST>2</GST>
    <TotalValue>22</TotalValue>
  </OrderAllocationEstimateValuationResult>
</ArrayOfOrderAllocationEstimateValuationResult>

Error Response Information

Resource Description

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>