getFutureBilling()

FutureInvoiceList getFutureBilling(string usn, FutureInvoiceRequest request)

This method returns a future invoice list for an account, including subscriptions, for given invoicing end date(s).

Parameters

usn: Format: string; Purpose: Specifies the USN of the account.
request: Format: FutureInvoiceRequest XML; Purpose: Defines a FutureInvoiceRequest XML document that specifies the invoicing end date(s).

Example: A FutureInvoiceRequest XML document

This example shows a FutureInvoiceRequest XML document specifying invoicing end dates of 30/06/2015 and 31/07/2015.

<FutureInvoiceRequest xmlns="http://xml.inomial.com/smile/2.xsd">
  <InvoicingEnd>2015-06-30+10:00</InvoicingEnd>
  <InvoicingEnd>2015-07-31+10:00</InvoicingEnd>
</FutureInvoiceRequest>

Results

This method returns a future invoice list for an account, including subscriptions, for given invoicing end date(s).

There are no messages defined by this method.

Example: A returned FutureInvoiceList XML document

This example shows a returned FutureInvoiceList XML document for account USN 2142421375. Invoicing end dates 2015-06-30+10.00 and 2015-07-31+10.00 are given as parameters. Subscription USN 2142421417 and 2142421425 belong to this account.

<Subscription xmlns="http://xml.inomial.com/smile/2.xsd">
<FutureInvoiceList xmlns:="http://xml.inomial.com/smile/2.xsd" xmlns:="http://ws.inomial.com/smile.2">
  <AccountUSN>2142421375</AccountUSN>
  <FutureInvoice>
    <InvoicingEnd>2015-06-30+10:00</InvoicingEnd>
    <RatingStatus>UpToDate</RatingStatus>
    <Invoice>
      <version>2.0</version>
      <transactionType>Quote</transactionType>
      <company>1</company>
      <usn>2142421375</usn>
      <currency>AUD</currency>
      <amount>72.00</amount>
      <accountType>1</accountType>
      <gstAmount>2.00</gstAmount>
      <salesReportCategory>invoice</salesReportCategory>
      <formattedAmount currency="AUD" formatted="$72.00">72.00</formattedAmount>
      <formattedGstAmount currency="AUD" formatted="$2.00">2.00</formattedGstAmount>
      <unallocatedAmount>77.00</unallocatedAmount>
      <formattedUnallocatedAmount currency="AUD" formatted="$77.00">77.00</formattedUnallocatedAmount>
      <transactionDate>2015-06-12+10:00</transactionDate>
      <openDate>2015-06-12+10:00</openDate>
      <createdByUsn>2142420773</createdByUsn>
      <transactionSource>Bulk</transactionSource>
      <transactionItem>
        <usn>2142421417</usn>
        <lineNumber>0</lineNumber>
        <itemCode>000285</itemCode>
        <chargeFrom>2015-07-01+10:00</chargeFrom>
        <chargeTo>2015-07-31+10:00</chargeTo>
        <description>Recurring Easy5 (01/07/2015 - 31/07/2015)</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>20.00</amount>
        <isGst>false</isGst>
        <chargeGst>true</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>2.00</gstAmount>
        <salesReportCategory>adsl</salesReportCategory>
      </transactionItem>
      <transactionItem>
        <usn>2142421417</usn>
        <lineNumber>2</lineNumber>
        <itemCode>gst</itemCode>
        <chargeFrom>2015-06-12+10:00</chargeFrom>
        <chargeTo>2015-06-12+10:00</chargeTo>
        <description>Includes 10% GST</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>2.00</amount>
        <isGst>true</isGst>
        <chargeGst>false</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.00</gstAmount>
        <salesReportCategory>gst</salesReportCategory>
      </transactionItem>
      <transactionItem>
        <usn>2142421425</usn>
        <lineNumber>1</lineNumber>
        <itemCode>005001</itemCode>
        <chargeFrom>2015-07-01+10:00</chargeFrom>
        <chargeTo>2015-07-31+10:00</chargeTo>
        <description>RTR recurring charge</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>50.00</amount>
        <isGst>false</isGst>
        <chargeGst>false</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.00</gstAmount>
        <salesReportCategory>recurring</salesReportCategory>
      </transactionItem>
    </Invoice>
  </FutureInvoice>
  <FutureInvoice>
    <InvoicingEnd>2015-07-31+10:00</InvoicingEnd>
    <RatingStatus>UpToDate</RatingStatus>
    <Invoice>
      <version>2.0</version>
      <transactionType>Quote</transactionType>
      <company>1</company>
      <usn>2142421375</usn>
      <currency>AUD</currency>
      <amount>50.00</amount>
      <accountType>1</accountType>
      <gstAmount>0.00</gstAmount>
      <salesReportCategory>invoice</salesReportCategory>
      <formattedAmount currency="AUD" formatted="$50.00">50.00</formattedAmount>
      <formattedGstAmount currency="AUD" formatted="$0.00">0.00</formattedGstAmount>
      <unallocatedAmount>275.00</unallocatedAmount>
      <formattedUnallocatedAmount currency="AUD" formatted="$275.00">275.00</formattedUnallocatedAmount>     
      <transactionDate>2015-06-12+10:00</transactionDate>
      <openDate>2015-06-12+10:00</openDate>
      <createdByUsn>2142420773</createdByUsn>
      <transactionSource>Bulk</transactionSource>
      <transactionItem>
        <usn>2142421425</usn>
        <lineNumber>0</lineNumber>
        <itemCode>005001</itemCode>
        <chargeFrom>2015-08-01+10:00</chargeFrom>
        <chargeTo>2015-08-31+10:00</chargeTo>
        <description>RTR recurring charge</description>
        <quantity>1</quantity>
        <currency>AUD</currency>
        <amount>50.00</amount>
        <isGst>false</isGst>
        <chargeGst>false</chargeGst>
        <discount>0</discount>
        <count>0</count>
        <gstAmount>0.00</gstAmount>
        <salesReportCategory>recurring</salesReportCategory>
      </transactionItem>
    </Invoice>
  </FutureInvoice>
</FutureInvoiceList>

Faults

NoSuchItemException

This fault is returned when the specified USN does not match an account.

InvalidRequestException

This fault is returned when the specified USN is not an account.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetFutureBilling usn filename

usn: Purpose: Specifies the USN of the account.
filename: Purpose: Defines the filename of the FutureInvoiceRequest XML document.

Note: For more information about the Java client and the options it accepts, see Java client syntax.