Push Notification Format

MYOB Advanced sends push notifications in JSON format. This topic describes the structure of the notifications.

Elements

The push notifications that MYOB Advanced sends include the following elements in JSON format.
Element Description
Inserted The rows that are new in the results of the query execution.
Deleted The rows that were in the results of the query execution but are missing after the latest data transaction. You can compare the Inserted and Deleted rows to identify the rows that have been updated.
Query The query for which MYOB Advanced has produced the notification. The value of the element can be either the name of the generic inquiry or the name of the class with the built-in definition.
CompanyId The name of the tenant.
Id The unique identifier of the data transaction in MYOB Advanced that has initiated the notification. The external application can use this identifier to omit duplicated notifications.
TimeStamp

The long value that corresponds to the date and time when the transaction that initiated the notification happened in MYOB Advanced. By using the value of this element, the external application can define the order of notifications.
AdditionalInfo Any additional information that is added to the notification. This element can contain additional information added by the system as well as the custom information. For more information on how to add custom additional information to push notifications, see To Add Additional Information to Push Notifications.

Example

Suppose that push notifications are configured for the Stock Items: Last Modified Date generic inquiry (which displays the InventoryID, StockItem, ItemStatus, and InventoryItem_lastModifiedDateTime columns). MYOB Advanced sends the following notification when the status of the AACOMPUT01 inventory item has been changed from Active to Inactive.
{
  "Inserted":
  [{
    "InventoryID":"AACOMPUT01",
    "StockItem":true,
    "ItemStatus":"Inactive",
    "InventoryItem_lastModifiedDateTime":"2017-05-05T15:16:23.1"
  }],
  "Deleted":
  [{
    "InventoryID":"AACOMPUT01",
    "StockItem":true,
    "ItemStatus":"Active",
    "InventoryItem_lastModifiedDateTime":"2017-05-05T15:16:23.103"
  }],
  "Query":"Stock Items: Last Modified Date",
  "CompanyId":"MyTenant",
  "Id":"1af4d140-5321-41f2-a2ec-50b67f577c6c",
  "TimeStamp":636295833829493672,
  "AdditionalInfo":{}
}