TransactionUpdated
Smile emits this message in two circumstances:
- A transaction is not reopened, but the due date or comments are changed. Smile does not change the transaction value.
- A reopened transaction is closed. Smile adds the new transaction value to the account balance.
Message header
The following table lists the parameters in the TransactionUpdated message header.
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 | "TransactionUpdated" |
eventType | string | "TransactionUpdated" |
Message body
For itemised transactions (invoices, RCTIs and itemised credits
and debits), the message body contains the
<ItemisedTransactionDetailEvent> element and has the following
format:
{http://xml.inomial.com/smile/2.xsd}ItemisedTransactionDetailEvent
For all other transactions, the message body contains the
<TransactionDetailEvent> element and has the following format:
{http://xml.inomial.com/smile/2.xsd}TransactionDetailEvent
Example: The <ItemisedTransactionDetailEvent> element
This example shows an ItemisedTransactionDetailEvent XML document that contains the <ItemisedTransactionDetailEvent> element. This example is for an itemised (invoice) transaction.
<ItemisedTransactionDetailEvent xmlns="http://xml.inomial.com/smile/2.xsd">
<transactionEventType>TransactionUpdated</transactionEventType>
<transaction>
<version>2.0</version>
<transactionType>Invoice</transactionType>
<company>1</company>
<usn>1000000008</usn>
<transactionNumber>21435540</transactionNumber>
<currency>AUD</currency>
<amount>221.55</amount>
<accountType>1</accountType>
<gstAmount>20.14</gstAmount>
<entryTimestamp>2012-07-31T10:00:00.000+10:00</entryTimestamp>
<salesReportCategory>invoice</salesReportCategory>
<formattedAmount currency="AUD" formatted="$221.55">221.55</formattedAmount>
<formattedGstAmount currency="AUD" formatted="$20.14">20.14</formattedGstAmount>
<unallocatedAmount>0.00</unallocatedAmount>
<enteredByUsn>1000000016</enteredByUsn>
<logTimestamp>2012-08-09T13:52:44.629+10:00</logTimestamp>
<formattedUnallocatedAmount currency="AUD" formatted="$0.00">0.00</formattedUnallocatedAmount>
<transactionDate>2012-07-31+10:00</transactionDate>
<dueDate>2012-08-21+10:00</dueDate>
<openDate>2012-07-31+10:00</openDate>
<closeDate>2012-08-09+10:00</closeDate>
<quoteNumber>21435540</quoteNumber>
<createdByUsn>1000000016</createdByUsn>
<discount>0.00</discount>
<transactionSource>Bulk</transactionSource>
<transactionItem>
<usn>2142426499</usn>
<lineNumber>0</lineNumber>
<itemCode>007459</itemCode>
<chargeFrom>2012-07-17+10:00</chargeFrom>
<chargeTo>2012-07-30+10:00</chargeTo>
<description>Invoice item description</description>
<quantity>1.000</quantity>
<currency>AUD</currency>
<amount>2.26</amount>
<isGst>false</isGst>
<chargeGst>true</chargeGst>
<discount>0.00</discount>
<count>0</count>
<gstAmount>0.230000</gstAmount>
<salesReportCategory>unknown</salesReportCategory>
</transactionItem>
<transactionItem>
<usn>2142426499</usn>
<lineNumber>1</lineNumber>
<itemCode>007460</itemCode>
<chargeFrom>2012-07-17+10:00</chargeFrom>
<chargeTo>2012-07-30+10:00</chargeTo>
<description>Invoice item description</description>
<quantity>1.000</quantity>
<currency>AUD</currency>
<amount>4.52</amount>
<isGst>false</isGst>
<chargeGst>true</chargeGst>
<discount>0.00</discount>
<count>0</count>
<gstAmount>0.450000</gstAmount>
<salesReportCategory>unknown</salesReportCategory>
</transactionItem>
<transactionItem>
<usn>2142426499</usn>
<lineNumber>2</lineNumber>
<itemCode>007458</itemCode>
<chargeFrom>2012-07-31+10:00</chargeFrom>
<chargeTo>2012-07-31+10:00</chargeTo>
<description>Early termination charge</description>
<quantity>1.000</quantity>
<currency>AUD</currency>
<amount>194.62</amount>
<isGst>false</isGst>
<chargeGst>true</chargeGst>
<discount>0.00</discount>
<count>0</count>
<gstAmount>19.460000</gstAmount>
<salesReportCategory>unknown</salesReportCategory>
</transactionItem>
<transactionItem>
<usn>2142426499</usn>
<lineNumber>3</lineNumber>
<itemCode>round</itemCode>
<chargeFrom>2012-07-31+10:00</chargeFrom>
<chargeTo>2012-07-31+10:00</chargeTo>
<description>Rounding adjustment</description>
<quantity>1.000</quantity>
<currency>AUD</currency>
<amount>0.01</amount>
<isGst>false</isGst>
<chargeGst>true</chargeGst>
<discount>0.00</discount>
<count>0</count>
<gstAmount>0.000000</gstAmount>
<salesReportCategory>round</salesReportCategory>
</transactionItem>
<transactionItem>
<usn>2142426499</usn>
<lineNumber>4</lineNumber>
<itemCode>gst</itemCode>
<chargeFrom>2012-07-31+10:00</chargeFrom>
<chargeTo>2012-07-31+10:00</chargeTo>
<description>Includes 10% GST</description>
<quantity>1.000</quantity>
<currency>AUD</currency>
<amount>20.14</amount>
<isGst>true</isGst>
<chargeGst>false</chargeGst>
<discount>0.00</discount>
<count>0</count>
<gstAmount>0.000000</gstAmount>
<salesReportCategory>gst</salesReportCategory>
</transactionItem>
</transaction>
</ItemisedTransactionDetailEvent>