getAccountInfo()

AccountInfo getAccountInfo(string usn)

This method searches by USN for an account and returns an XML document with detailed information about the account.

Parameters

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

Results

This method returns an Account XML document that contains detailed information about the account.

There are no messages defined by this method.

Example: A returned Account XML document

This example shows an Account XML document. The document contains some account properties. For example, billName and emailAddress.

Note: Smile uses the key attribute on the <Timezone>, <AccountTerms> and <Costcentre> elements as an internal identifier.

<AccountInfo xmlns="http://xml.inomial.com/smile/2.xsd">
  <USN>129512142</USN>
  <Invoicee>
    <InvoiceeUsn>2142421482</InvoiceeUsn>
  </Invoicee>
  <InvoicingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>20</CycleDay>
  </InvoicingCycle>
  <RatingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>20</CycleDay>
  </RatingCycle>
  <Timezone key="19">Australia/Sydney</Timezone>
  <AccountTerms key="1">Default terms</AccountTerms>
  <CostCentre key="105">Example cost centre</CostCentre>
  <Properties>
    <Object>
      <String name="billName">Smith</String>
      <String name="billNumber">60</String>
      <String name="billPostCode">3000</String>
      <String name="billState">VIC</String>
      <String name="billSuburb">Melbourne</String>
      <String name="billType">ST</String>
      <String name="emailAddress">demo@example.com</String>
      <String name="name">Example Company Pty Ltd</String>
      <String name="workPhone">+61355501256</String>
    </Object>
  </Properties>
</AccountInfo>

Faults

AuthenticationException

This fault is returned when the caller does not have permission to access the account.

SmileApiException

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.GetAccountInfo usn

usn: Purpose: Specifies the USN of the account to retrieve.

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