Messages from/to Visma Net

Details of communication between UI Automation and Visma Net.

UI Automation & Visma Net Communication

When a UI Automation in Visma Net is started by the user, either by starting an action from the drop-down menu “actions” in a screen, or from starting a new screen (menu). Visma Net will send some initial information to the UI Automation application front end.

Init message from Visma Net - for Action UI Automation

{
  "command": "init",  // Informs the UI Automation that it is being provided with the “init”-command
  "messageTarget": "<string>", // URL of ERP host page, the URL of the “screen” that the iframe runs within
  "primaryKey": "<string>", // ID of the entity in the ERP host page (customerID/supplierID/supplierInvoiceID). This value is set to 0 when the default value of the series is “<NY>”.
  "secondaryKey": "<string>", // Document type for Supplier Invoices, will be set to null in all other cases
  "companyId": "<int64>", // Current Company ID
  "user": "<string>", // Current User ID (email)
  "language": "<string>", // Current User’s UI language
  "tenantId": "<guid>", // Current User’s Tenant ID
  "branchId": "<string>", // Current Branch ID
  "userChangesPresent": "<boolean>" // Will be True if there are changes in the ERP host page
}

Init message from Visma Net - for Menu UI Automation

{
  "command": "init",  // Informs the UI Automation that it is being provided with the “init”-command
  "messageTarget": "<string>", // URL of ERP host page, the URL of the “screen” that the iframe runs within
  "companyId": "<int64>", // Current Company ID
  "user": "<string>", // Current User ID (email)
  "language": "<string>", // Current User’s UI language
  "tenantId": "<guid>", // Current User’s Tenant ID
  "branchId": "<string>", // Current Branch ID

}

Available front-end messages to be sent to Visma Net

Cancel (Action UI Automation)

{
  "command": "cancel",  // Closes screen/panel where service page is loaded
}

Refresh (Action UI Automation, Menu UI Automation)

{
  "command": "refresh",  // Informs host page to refresh/reload current document/UI
}

Open (Action UI Automation, Menu UI Automation)

{
  "command": "open",  // Informs host page to open new document/UI in case of creating new customer/supplier/supplier invoice
  "primaryKey": "<string>",  // ID of the host page document
}

Init (Action UI Automation)


{
  "command": "init",  // Informs the host to do initialization based on provided caption, height, width
  "responsecmd": "<string>",  // The value of the response message’s “command”-property that will be sent back from the host after receiving this init-request
  "caption": "<string>",   // Caption to be set on host panel
  "height": "<int64>",  // Height to be set on host panel
  "width": "<int64>",  // Width to be set on host panel
}
Last modified November 28, 2025