getAccountSummary()

AccountSummary getAccountSummary(string usn)

This method searches by USN for an account and returns an XML document with the account balance, treatment level, aged balances and the number of active subscriptions on this account.

The account's treatment level or disposition is the debtor status of the account, for example, settled, overdue or delinquent. By default the aged balances specify the balances outstanding for 0, 30, 60 and 90+ days. However, your company configuration for aging invoices determines the age groups that appear in the document.

Parameters

usn: Format: string; Purpose: Specifies the USN of the account for which to retrieve the account summary.

Results

This method returns an AccountSummary XML document with information about the account balance, treatment level and aged balances.

There are no messages defined by this method.

Example: A returned AccountSummary XML document

This example shows an AccountSummary XML document. The document contains the account balance ($94), treatment level (settled), the aged balance for 0, 30, 60 and 90+ days and 2 active subscriptions. In this example, the account has a 30 day aged balance of $5 credit and a 90+ day aged balance of $99.

<AccountSummary xmlns="http://xml.inomial.com/smile/2.xsd">
  <USN>2142421391</USN>
  <AccountBalance formatted="94.00" currency="AUD">$94.00</AccountBalance>
  <TreatmentLevel>Settled</TreatmentLevel>
  <AgedBalance>
    <AgedBalanceItem>
      <AgeGroup>0</AgeGroup>
      <AgeGroupName>Current</AgeGroupName>
      <Balance formatted="0" currency="AUD">$0.00</Balance>
    </AgedBalanceItem>
    <AgedBalanceItem>
      <AgeGroup>1</AgeGroup>
      <AgeGroupName>30 days</AgeGroupName>
      <Balance formatted="-5.00" currency="AUD">$(5.00)</Balance>
    </AgedBalanceItem>
    <AgedBalanceItem>
      <AgeGroup>2</AgeGroup>
      <AgeGroupName>60 days</AgeGroupName>
      <Balance formatted="0.00" currency="AUD">$0.00</Balance>
    </AgedBalanceItem>
    <AgedBalanceItem>
      <AgeGroup>3</AgeGroup>
      <AgeGroupName>90+ days</AgeGroupName>
      <Balance formatted="99.00" currency="AUD">$99.00</Balance>
    </AgedBalanceItem>
  </AgedBalance>
  <ActiveSubscriptionCount>2</ActiveSubscriptionCount>
</AccountSummary>

Faults

AccountException

This fault is returned when the account does not exist or could not be retrieved.

Java client syntax

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

usn: Purpose: Specifies the USN of the account for which to retrieve the account summary.

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