ChargeDeferred

Smile emits this message when a deferred charge is created or updated.

Message header

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

Table 1. ChargeDeferred header parameters
Parameter Type Values
smileMessageType string "ChargeDeferred"
company integer Company that the account holder that the charge is being raised against belongs to
accountType integer Numeric descriptor for the account type. This can also be obtained through the SOAP API method WSAccount.get()
usn string USN identifying the account that the charge is being raised against
chargeId UUID Identifies the charge itself
currency string 3-letter ISO 4217 currency code indicating what currency the charge has been issued in
amount decimal Amount of the charge

Message body

The root element of the message body is <RealisedCharge> and has the following format:
{http://xml.inomial.com/smile/2.xsd}RealisedCharge

Example: The <RealisedCharge element

This example shows an RealisedCharge XML document that contains the <RealisedCharge> element.

<RealisedCharge xmlns="http://xml.inomial.com/smile/2.xsd">
  <ChargeID>0f11aa6a-476a-47e4-87ed-cb4d828579e8</ChargeID>
  <ItemDescriptionID>3gwifimodem</ItemDescriptionID>
  <Description>3G Wireless Modem</Description>
  <ChargeStart>2016-01-15T00:00:00.000+11:00</ChargeStart>
  <ChargeEnd>2016-01-15T00:00:00.000+11:00</ChargeEnd>
  <Quantity>1</Quantity>
  <Count>1</Count>
  <Charge>49.95</Charge>
  <ChargeGST>true</ChargeGST>
  <GSTAmount>4.99</GSTAmount>
  <USN>2142426622</USN>
  <RealisingTransactionItems>
    <TransactionItem>
      <usn>2142426622</usn>
      <lineNumber>0</lineNumber>
      <itemCode>3gwifimodem</itemCode>
      <chargeFrom>2016-01-15+11:00</chargeFrom>
      <chargeTo>2016-01-15+11:00</chargeTo>
      <description>3G Wireless Modem</description>
      <quantity>1</quantity>
      <currency>AUD</currency>
      <amount>49.95</amount>
      <isGst>false</isGst>
      <chargeGst>true</chargeGst>
      <discount>0</discount>
      <count>1</count>
      <gstAmount>4.99</gstAmount>
      <salesReportCategory>invoice</salesReportCategory>
      <excludeFromInvoiceGrouping>false</excludeFromInvoiceGrouping>
      <Object objectId="6118" formId="978" displayName="Name: Example Internet  Colour: Turquoise">
        <String name="companyName">Example Internet</String>
        <String name="colour">Turquoise</String>
      </Object>
      <chargeId>0f11aa6a-476a-47e4-87ed-cb4d828579e8</chargeId>
    </TransactionItem>
  </RealisingTransactionItems>
</RealisedCharge>