createInvoiceGrouping()

void createInvoiceGrouping(NewInvoiceGrouping newInvoiceGroupingRequest)

This method creates a new invoice grouping.

Parameters

newInvoiceGroupingRequest: Format: NewInvoiceGrouping XML; Purpose: Defines a NewInvoiceGrouping XML document that specifies the invoice grouping to create.

Example: A NewInvoiceGrouping XML document

This example shows a NewInvoiceGrouping XML document.

A NewInvoiceGrouping XML document contains the following optional elements:

<InvoiceGroupingOverrides>: (Optional) Overrides the description on the roll up transaction item and the charge types of which charges will be rolled up.
<ActiveFrom>: (Optional) The date from which charges will be rolled up.
<ActiveTo>: (Optional) The date up to which charges will be rolled up.

Note: If both <ActiveFrom> and <ActiveTo> fields are blank, charges for any date will be rolled up.

<NewInvoiceGrouping xmlns="http://xml.inomial.com/smile/2.xsd">
  <Account>2142424304</Account>
  <InvoiceGroupingConfiguration key="58ac9ef6-bad2-4584-b5c2-3eb2639cd5ed">All charges</InvoiceGroupingConfiguration>
  <RollupToSubscription>2142424304</RollupToSubscription>
  <ActiveTo>2015-03-31</ActiveTo>
  <Subscriptions>
    <Subscription>2142424338</Subscription> 
    <Subscription>2142424320</Subscription>
  </Subscriptions>
  <InvoiceGroupingOverrides>
    <RollupDescription>Overriding Rollup description {0,date} - {1,date}</RollupDescription>
    <ChargeTypes>
      <ChargeType key="6">Manually entered charge</ChargeType>
    </ChargeTypes>
  </InvoiceGroupingOverrides> 
</NewInvoiceGrouping>

Results

This method does not return any output.

There are no messages defined by this method.

Faults

InvalidRequestException

This fault is returned when

the account is not provided
the invoice grouping configuration reference is not provided
the ActiveFrom date is not before the ActiveTo date
the invoice grouping configuration is currently inactive
the RollupToSubscription is not a subscription of the account
a Subscription entry is blank
a listed Subscription is not a subscription of the account
a listed Subscription has an existing invoice grouping active period overlapping the requested invoice grouping

NoSuchItemException

This fault is returned when

the account does not exist
the invoice grouping configuration reference does not exist
a charge type specified in InvoiceGroupingOverrides does not exist
the RollupToSubscription does not exist
a listed Subscription does not exist

Java client syntax

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

filename: Purpose: Defines the filename of the NewInvoiceGrouping XML document.

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