getInvoiceGrouping()

InvoiceGroupings getInvoiceGrouping(string invoiceGroupingId)

This method returns the invoice grouping for the given ID.

Parameters

invoiceGroupingId: Format: string; Purpose: Specifies the ID of the invoice grouping to retrieve.

Results

This method returns an InvoiceGroupings XML document containing information about the invoice grouping.

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>
</InvoiceGroupings>

Faults

NoSuchItemException

This fault is returned when an invoice grouping for the invoice grouping ID does not exist or has been deleted.

Java client syntax

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

invoiceGroupingId: Purpose: Specifies the ID of the invoice grouping.

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