getAvailableInvoiceGroupings()

InvoiceGroupings getAvailableInvoiceGroupings(string usn)

This method returns a list of invoice groupings configured to an account.

Parameters

usn: Format: string; Purpose: Specifies the USN of the account for which to return invoice grouping detail.

Results

This method returns an InvoiceGroupings XML document that contains a list of invoice grouping details.

There are no messages defined by this method.

Example: A returned InvoiceGroupings XML document

This example shows an InvoiceGroupings XML document.

<InvoiceGroupings xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <InvoiceGrouping>
    <InvoiceGroupingId>0e7a9ca0-3e43-4595-bc61-4d78a553e7ba</InvoiceGroupingId>
    <Account>2142424304</Account>
    <InvoiceGroupingConfiguration>
      <InvoiceGroupingConfigurationId>58ac9ef6-bad2-4584-b5c2-3eb2639cd5ed</InvoiceGroupingConfigurationId>
      <Name>Roll up all charge types</Name>
      <Company>1</Company>
      <ItemCode>004798</ItemCode>
    </InvoiceGroupingConfiguration>
    <RollupToSubscription>2142424304</RollupToSubscription>
    <Subscriptions>
      <Subscription>2142424312</Subscription>
      <Subscription>2142424320</Subscription>
    </Subscriptions>
    <ActiveTo>2015-03-31+11:00</ActiveTo>
    <InvoiceGroupingOverrides>
      <RollupDescription>Overriding Rollup description {0,date} - {1,date}</RollupDescription>
      <ChargeTypes>
        <ChargeType key="6">Manually entered charge</ChargeType>
      </ChargeTypes>
    </InvoiceGroupingOverrides>
  </InvoiceGrouping>
  <InvoiceGrouping>
    <InvoiceGroupingId>8f8869c6-7496-4550-91c3-b673ab428edc</InvoiceGroupingId>
    <Account>2142424304</Account>
    <InvoiceGroupingConfiguration>
      <InvoiceGroupingConfigurationId>58ac9ef6-bad2-4584-b5c2-3eb2639cd5ed</InvoiceGroupingConfigurationId>
      <Name>Roll up all charge types</Name>
      <Company>1</Company>
      <ItemCode>004798</ItemCode>
    </InvoiceGroupingConfiguration>
    <RollupToSubscription>2142424304</RollupToSubscription>
    <Subscriptions>
      <Subscription>2142424338</Subscription>
    </Subscriptions>
  </InvoiceGrouping>
</InvoiceGroupings>

Faults

NoSuchItemException

This fault is returned when the account does not exist.

Java client syntax

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

usn: Purpose: Specifies the USN of the account for which to return invoice grouping detail.

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