getOrderGroupQuote()

ItemisedTransactionDetail getOrderGroupQuote(string orderGroupId) 

This method retrieves a quote for the given order group.

Parameters

orderGroupId
Format: string
Purpose: Specifies the ID of the order group to quote.

Results

This method returns an ItemisedTransactionDetail XML document containing details of the quote.

There are no messages defined by this method.

Example: A returned ItemisedTransactionDetail XML document

This example shows an ItemisedTransactionDetail XML document for an order group with an ADSL subscription on a $30/month plan and no set up charge.

<ItemisedTransactionDetail xmlns="http://xml.inomial.com/smile/2.xsd">
  <version>2.0</version>
  <transactionType>Quote</transactionType>
  <company>1</company>
  <usn>2142472105</usn>
  <transactionNumber>61419503</transactionNumber>
  <currency>AUD</currency>
  <amount>47.40</amount>
  <accountType>1</accountType>
  <gstAmount>4.31</gstAmount>
  <salesReportCategory>invoice</salesReportCategory>
  <formattedAmount currency="AUD" formatted="$47.40">47.40</formattedAmount>
  <formattedGstAmount currency="AUD" formatted="$4.31">4.31</formattedGstAmount>    
  <unallocatedAmount>47.40</unallocatedAmount>
  <glCode>invoice</glCode>
  <formattedUnallocatedAmount currency="AUD" formatted="$47.40">47.40</formattedUnallocatedAmount>     
  <transactionDate>2015-01-14+11:00</transactionDate>
  <openDate>2015-01-14+11:00</openDate>
  <quoteNumber>61419503</quoteNumber>
  <createdByUsn>2142423066</createdByUsn>
  <transactionItem>
    <usn>2142472303</usn>
    <lineNumber>0</lineNumber>
    <itemCode>031640</itemCode>
    <chargeFrom>2015-01-14+11:00</chargeFrom>
    <chargeTo>2015-01-31+11:00</chargeTo>
    <description>ADSL recurring charge</description>
    <quantity>1.000</quantity>
    <currency>AUD</currency>
    <amount>15.84</amount>
    <isGst>false</isGst>
    <chargeGst>true</chargeGst>
    <discount>0</discount>
    <count>0</count>
    <gstAmount>1.58</gstAmount>
    <salesReportCategory>unknown</salesReportCategory>
    <glCode>500</glCode>
  </transactionItem>
  <transactionItem>
    <usn>2142472303</usn>
    <lineNumber>1</lineNumber>
    <itemCode>031640</itemCode>
    <chargeFrom>2015-02-01+11:00</chargeFrom>
    <chargeTo>2015-02-28+11:00</chargeTo>
    <description>ADSL recurring charge</description>
    <quantity>1.000</quantity>
    <currency>AUD</currency>
    <amount>27.27</amount>
    <isGst>false</isGst>
    <chargeGst>true</chargeGst>
    <discount>0</discount>
    <count>0</count>
    <gstAmount>2.73</gstAmount>
    <salesReportCategory>unknown</salesReportCategory>
    <glCode>500</glCode>
  </transactionItem>
  <transactionItem>
    <usn>2142472303</usn>
    <lineNumber>2</lineNumber>
    <itemCode>round</itemCode>
    <chargeFrom>2015-01-14+11:00</chargeFrom>
    <chargeTo>2015-01-14+11:00</chargeTo>
    <description>Rounding adjustment</description>
    <quantity>1</quantity>
    <currency>AUD</currency>
    <amount>-0.02</amount>
    <isGst>false</isGst>
    <chargeGst>true</chargeGst>
    <discount>0</discount>
    <count>0</count>
    <gstAmount>0</gstAmount>
    <salesReportCategory>round</salesReportCategory>
    <glCode>200</glCode>
  </transactionItem>
  <transactionItem>
    <usn>2142472303</usn>
    <lineNumber>3</lineNumber>
    <itemCode>gst</itemCode>
    <chargeFrom>2015-01-14+11:00</chargeFrom>
    <chargeTo>2015-01-14+11:00</chargeTo>
    <description>Includes 10% GST</description>
    <quantity>1</quantity>
    <currency>AUD</currency>
    <amount>4.31</amount>
    <isGst>true</isGst>
    <chargeGst>false</chargeGst>
    <discount>0</discount>
    <count>0</count>
    <gstAmount>0.00</gstAmount>
    <salesReportCategory>gst</salesReportCategory>
  </transactionItem>
</ItemisedTransactionDetail>

Faults

NoSuchItemException

This fault is returned when the order group ID does not exist.

OrderException

This fault is returned when an error occurs trying to quote the order.

InvalidRequestException

This fault is returned when the order cannot be quoted because it has already been placed or cancelled.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetOrderGroupQuote orderGroupId
orderGroupId
Purpose: Specifies the ID of the order group to quote.
Note: For more information about the Java client and the options it accepts, see Java client syntax.