TransactionReversed

Smile emits this message when it reverses a transaction, that is, raises a transaction that negates another transaction.

Message header

The following table lists the parameters in the TransactionReversed message header.

Table 1. TransactionReversed header parameters
Parameter Type Values
version string "2.0"
usn string The unique subscription number for the account that the transaction applies to
company integer The company ID this account belongs to
currency string The ISO 4217 currency code of this account and transaction
amount decimal The value of this transaction
accountType integer The ID of the account type, as defined in Smile
transactionNumber string The transaction number that Smile generates to identify the transaction
transactionType string "CreditNote", "CreditTransferCredit", "CreditTransferDebit", "DebitNote", "Invoice", "InvoiceReversal", "ItemisedCredit", "ItemisedCreditReversal", "ItemisedDebit", "ItemisedDebitReversal", "Receipt", "ReceiptReversal", "RecipientCreatedTaxInvoice", "RecipientCreatedTaxInvoiceReversal", "Surcharge", "SurchargeReversal", "TransferredCredit" or "TransferredDebit"
smileMessageType string "TransactionReversed"
eventType string "TransactionReversed"

Message body

The message body contains the <TransactionEvent> element and has the following format:
{http://xml.inomial.com/smile/2.xsd}TransactionEvent

Example: The <TransactionEvent> element

This example shows a TransactionEvent XML document that contains the <TransactionEvent> element.

<TransactionEvent xmlns="http://xml.inomial.com/smile/2.xsd">
  <transactionEventType>TransactionReversed</transactionEventType>
  <transaction>
    <version>2.0</version>
    <transactionType>Invoice</transactionType>
    <company>1</company>
    <usn>1000000008</usn>
    <transactionNumber>21435565</transactionNumber>
    <currency>AUD</currency>
    <amount>218.30</amount>
    <accountType>1</accountType>
    <gstAmount>19.85</gstAmount>
    <entryTimestamp>2012-07-31T10:00:00.000+10:00</entryTimestamp>
    <salesReportCategory>invoice</salesReportCategory>
    <formattedAmount currency="AUD" formatted="$218.30">218.30</formattedAmount>
    <formattedGstAmount currency="AUD" formatted="$19.85">19.85</formattedGstAmount>
  </transaction>
  <effectiveDate>2012-08-09+10:00</effectiveDate>
</TransactionEvent>