POST api/orders/valuation

Gets the estimated order valuation

Request Information

URI Parameters

None.

Body Parameters

Order instruction

Name	Description	Type	Additional information
clientID	Unique client identifier.	integer	None.
registrationReference	External registration reference.	string	None.
securityCode	ASX code for the order.	string	Required
buySell	Buy / sell indicator.	enBuySell	Required
priceType	Order price type.	enOrderPriceType	Required
price	Order price in dollars. ie. 11.45. Required for limit orders.	decimal number	None.
quantity	Quantity of the order (either quantity or trade value is required).	decimal number	None.
tradeValue	Trade value of the order (either quantity or trade value is required).	decimal number	None.
validityType	Order validity type.	enOrderValidityType	Required
expiryDate	Order expiry date. Required if order validity type is GoodTillDate.	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.
reference	External reference for an order. Use this field to link an order with one on your system.	string	None.
miscellaneousTags	Use this field to add any number of tags onto an order for processing on your system.	Collection of string	None.
PIN	User PIN. Use this if PIN validation is required.	string	None.
CustomBrokerageFee	Custom Brokerage Fee for dollar override.	decimal number	None.
CustomBrokeragePercent	Custom Brokerage Percent for percent override.	decimal number	None.
ClientBrokerageScheduleID	Client Brokerage Schedule identifier.	integer	None.
SRN	Securityholder Reference Number.	string	String length: inclusive between 0 and 255

Request Formats

application/json, text/json

Sample:

{
  "clientID": 12345,
  "registrationReference": null,
  "securityCode": "BHP",
  "buySell": 1,
  "priceType": 1,
  "price": 1.25,
  "quantity": 500.0,
  "tradeValue": null,
  "validityType": 3,
  "expiryDate": null,
  "creatorID": 12345,
  "reference": null,
  "miscellaneousTags": [
    "TAG1",
    "TAG2",
    "TAG3"
  ],
  "PIN": "1234",
  "CustomBrokerageFee": 66.0,
  "CustomBrokeragePercent": 0.154,
  "ClientBrokerageScheduleID": 884433,
  "SRN": null
}

application/xml, text/xml

Sample:

<OrderCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <ClientBrokerageScheduleID>884433</ClientBrokerageScheduleID>
  <CustomBrokerageFee>66</CustomBrokerageFee>
  <CustomBrokeragePercent>0.154</CustomBrokeragePercent>
  <PIN>1234</PIN>
  <SRN i:nil="true" />
  <buySell>Buy</buySell>
  <clientID>12345</clientID>
  <creatorID>12345</creatorID>
  <expiryDate i:nil="true" />
  <miscellaneousTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>TAG1</d2p1:string>
    <d2p1:string>TAG2</d2p1:string>
    <d2p1:string>TAG3</d2p1:string>
  </miscellaneousTags>
  <price>1.25</price>
  <priceType>Limit</priceType>
  <quantity>500</quantity>
  <reference i:nil="true" />
  <registrationReference i:nil="true" />
  <securityCode>BHP</securityCode>
  <tradeValue i:nil="true" />
  <validityType>DayOnly</validityType>
</OrderCreation>

Response Information

Resource Description

Estimated order valuation that includes the brokerage, GST, fees and total order value

OrderEstimateValuation

Name	Description	Type	Additional information
Brokerage	Total order brokerage amount	decimal number	None.
GST	Total order GST amount	decimal number	None.
TotalValue	Total order value	decimal number	None.
Fees	Fees charged inclusive of GST	Collection of OrderEstimateValuation+FeeDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "Brokerage": 100.0,
  "GST": 10.0,
  "TotalValue": 110.0,
  "Fees": [
    {
      "FeeScheduleType": 1,
      "Amount": 2.0
    }
  ]
}

application/xml, text/xml

Sample:

<OrderEstimateValuation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order">
  <Brokerage>100</Brokerage>
  <Fees>
    <OrderEstimateValuation.FeeDetails>
      <Amount>2</Amount>
      <FeeScheduleType>ACHFee</FeeScheduleType>
    </OrderEstimateValuation.FeeDetails>
  </Fees>
  <GST>10</GST>
  <TotalValue>110</TotalValue>
</OrderEstimateValuation>

Error Response Information

Resource Description

Estimated order valuation that includes the brokerage, GST, fees and total order value

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>