getHeldBonds()

Bonds getHeldBonds(string usn)

This method returns a list of bonds on an account, including released bonds.

Parameters

usn
Format: string
Purpose: Specifies the USN of the account for which to retrieve bond information.

Results

This method returns a Bonds XML document containing information about bonds on an account.

There are no messages defined by this method.

Example: A returned Bonds XML document

This example shows a Bonds XML document containing information about bonds on an account.

<Bonds xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <ItemisedTransactionDetail>
    <version>2.0</version>
    <transactionType>Bond</transactionType>
    <company>1</company>
    <usn>2142422829</usn>
    <transactionNumber>21431465</transactionNumber>
    <currency>AUD</currency>
    <amount>50.00</amount>
    <accountType>1</accountType>
    <gstAmount>0.00</gstAmount>
    <entryTimestamp>2015-01-12T09:20:01.191+11:00</entryTimestamp>
    <formattedAmount currency="AUD" formatted="$50.00">50.00</formattedAmount>
    <formattedGstAmount currency="AUD" formatted="$0.00">0.00</formattedGstAmount>            
    <unallocatedAmount>50.00</unallocatedAmount>
    <enteredByUsn>2142420815</enteredByUsn>
    <logTimestamp>2015-01-13T09:20:01.195+11:00</logTimestamp>
    <formattedUnallocatedAmount currency="AUD" formatted="$50.00">50.00</formattedUnallocatedAmount>
    <transactionDate>2015-01-12+11:00</transactionDate>
    <openDate>2015-01-13+11:00</openDate>
    <closeDate>2015-01-13+11:00</closeDate>
    <quoteNumber>21431465</quoteNumber>
    <createdByUsn>2142420815</createdByUsn>
    <discount>0.00</discount>
    <transactionSource>Bond</transactionSource>
    <transactionItem>
      <usn>2142422829</usn>
      <lineNumber>0</lineNumber>
      <itemCode>002103</itemCode>
      <chargeFrom>2015-01-12+11:00</chargeFrom>
      <chargeTo>2015-01-12+11:00</chargeTo>
      <description>ADSL modem</description>
      <quantity>1.000</quantity>
      <currency>AUD</currency>
      <amount>50.00</amount>
      <isGst>false</isGst>
      <chargeGst>false</chargeGst>
      <discount>0.00</discount>
      <count>0</count>
      <gstAmount>0.000000</gstAmount>
      <salesReportCategory>bond</salesReportCategory>
    </transactionItem>
  </ItemisedTransactionDetail>
</Bonds>

Faults

NoSuchItemException

This fault is returned when the provided USN does not exist.

InvalidRequestException

This fault is returned when the account USN is not provided.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetHeldBonds usn
usn
Purpose: Specifies the USN of the account for which to retrieve bond information.
Note: For more information about the Java client and the options it accepts, see Java client syntax.