getTransactionList()

TransactionList getTransactionList(string usn, dateTime startTimestamp, dateTime endTimestamp)

This method retrieves a summary list of transaction items on the ledger for a given USN.

The returned transaction list does not include itemised line items. Call getTransaction() to return detailed transaction information.

Parameters

usn
Format: string
Purpose: Specifies the USN of the account for which to retrieve transaction information.
startTimestamp
Format: dateTime
Purpose: Specifies the date and time that starts the date range, for example, 2012-05-01T00:00:00+11:00.
endTimestamp
Format: dateTime
Purpose: Specifies the date and time that ends the date range, for example, 2012-05-31T23:59:59+11:00.

Results

This method returns a TransactionList XML document containing summary information about transactions associated with an account.

There are no messages defined by this method.

Example: A returned TransactionList XML document

This example shows a TransactionList XML document.

<TransactionList xmlns="http://xml.inomial.com/smile/2.xsd" xmlns"http://ws.inomial.com/smile.2">
  <transaction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TransactionDetailType">
    <version>2.0</version>
    <transactionType>Receipt</transactionType>
    <company>1</company>
    <usn>2142422787</usn>
    <transactionNumber>21431499</transactionNumber>
    <currency>AUD</currency>
    <amount>-100.00</amount>
    <accountType>1</accountType>
    <gstAmount>0.00</gstAmount>
    <entryTimestamp>2015-01-13T09:37:25.855+11:00</entryTimestamp>
    <formattedAmount currency="AUD" formatted="$(100.00)">-100.00</formattedAmount>
    <formattedGstAmount currency="AUD" formatted="$0.00">0.00</formattedGstAmount>              
    <unallocatedAmount>-100.00</unallocatedAmount>
    <enteredByUsn>1000000016</enteredByUsn>
    <logTimestamp>2015-01-13T09:37:25.857+11:00</logTimestamp>
    <formattedUnallocatedAmount currency="AUD" formatted="$(100.00)">-100.00</formattedUnallocatedAmount>     
  </transaction>
  <transaction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ItemisedTransactionDetailType">
    <version>2.0</version>
    <transactionType>Invoice</transactionType>
    <company>1</company>
    <usn>2142422787</usn>
    <transactionNumber>21431481</transactionNumber>
    <currency>AUD</currency>
    <amount>100.00</amount>
    <accountType>1</accountType>
    <gstAmount>9.09</gstAmount>
    <entryTimestamp>2015-01-13T09:40:53.715+11:00</entryTimestamp>
    <formattedAmount currency="AUD" formatted="$100.00">100.00</formattedAmount>
    <formattedGstAmount currency="AUD" formatted="$9.09">9.09</formattedGstAmount>            
    <unallocatedAmount>100.00</unallocatedAmount>
    <enteredByUsn>1000000016</enteredByUsn>
    <logTimestamp>2015-01-13T09:40:53.720+11:00</logTimestamp>
    <formattedUnallocatedAmount currency="AUD" formatted="$100.00">100.00</formattedUnallocatedAmount>     
    <transactionDate>2015-01-13+11:00</transactionDate>
    <dueDate>2015-01-25+11:00</dueDate>
    <openDate>2015-01-13+11:00</openDate>
    <closeDate>2015-01-13+11:00</closeDate>
    <quoteNumber>21431481</quoteNumber>
    <createdByUsn>1000000016</createdByUsn>
    <discount>0.00</discount>
    <transactionSource>Manual</transactionSource>
  </transaction>
</TransactionList>

Faults

NoSuchItemException

This fault is returned when the provided account number does not exist.

InvalidRequestException

This fault is returned when the endTimestamp is not after the startTimestamp.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.GetTransactionList usn startTimestamp endTimestamp
usn
Purpose: Specifies the USN of the account for which to retrieve transaction information.
startTimestamp
Purpose: Specifies the date and time that starts the date range.
endTimestamp
Purpose: Specifies the date and time that ends the date range.
Note: For more information about the Java client and the options it accepts, see Java client syntax.