HaloITSM

HaloITSM Guides

Documentation to assist with the setup and configuration of the HaloITSM platform

Guides > Halo Accounts Integrator Setup

Halo Accounts Integrator Setup

The Halo Accounts Integrator is required to integrate with the following Accounting Software/Tools

Sage 50 UK

Sage 50 Canada

Quickbooks Desktop (All regions)


The Halo Accounts Integrator must be run on the same network as the Accounting Software but connects to Halo using the Halo API.


The latest version can always be downloaded from here - https://s3.halopsa.com/HaloAccountsIntegrator.zip


When starting the Halo Accounts Integrator for the first time you need to enter credentials from an API Application created in Halo. This should be configured as below with the Client ID and Secret option. Also ensure that an Agent is chosen in the "Agent to log in as". The permissions for this API Application are inherited from that Agent but also matched with the permissions added to the permissions tab.


Setting up the API Application

  1. After downloading the Accounts Integrator

  2. you can create an API only agent at no additional license usage, this is done by creating a new agent, give them administrator permissions via the role: Administrator and checkbox on the setting "API Only Agent" from the details tab of the agent creation screen:


  3. Go to HaloPSA > Configuration > Integrations > *Search for HaloPSA API*


  4. click into this module and then "View Application" (there will be a "New" button near the top RHS of the list)

  5. Begin to create a new application


  6. Enter a sensible Application Name (such as "Quickbooks Desktop Application or Sage Application") and set the Authentication Method to "Client ID and Secret (Services)" and copy the Client ID and Secret.

  7. Set the Login Type to "Agent" and choose the API Agent account which has been created:

    NB: Admin Privileges will need to be granted for the initial import of Tax rates

  8. Go to the permissions tab of the API application, after clicking save, and for example your accounts integration may need you to turn on "Edit - Items", "Read - Items", "Edit - Customers", "Read - Customers", "Edit - Invoices", "Read - Invoices" and then Save again


Additional Permissions

If there are permissions issues returned in the response of your API request, using the All Standard and All Teams permissions should be used, which encapsulates all the other permissions that show in list. all:standard will remove the need for adding the other permissions such as read: customers, edit: items etc...


Admin is very rarely required for API Applications, and should be avoided where possible. However, Admin privileges will need to be initially granted in order to facilitate an import of Tax rates for Quickbooks Desktop

Popular Guides

Pin It on Pinterest