Overview
The HaloPSA integration supports the transfer of product counts from Huntress to HaloPSA via Software Licenses. Users have the flexibility to configure the integration for either daily or monthly execution. These software licenses can be used to set up recurring invoices, but are not required.
Prerequisites:
- Make sure you have organization mapped in the prior tab.
- Please make sure the API Agent and Application has the following permissions on HaloPSA: (refer to the initial integration setup doc if you haven’t already setup an agent)
- read:softwarelicensing
- edit:softwarelicensing
- read:items
These can be confirmed by visiting Configuration > Integrations > HaloPSA API > Applications in your HaloPSA dashboard on the HaloPSA site.
Your Agent tied to the HaloPSA Application can be configured by visiting Configuration > Teams & Agents > Agents
- Select your agent
- Click on “Permissions”
Set the following permission levels:
“Products Access Level” will need “Read Only”
“Software Licensing Access Level” will need “Read and Modify”
Setting up the Huntress → HaloPSA Billing Sync
This
- Navigate to the integrations page in the Huntress portal and edit your HaloPSA integration. If you need to setup a new HaloPSA follow the instructions for setting up a new integration.
- Once you’re on the configuration page, you will see a Billing tab where you can turn on the billing integration.
- Enable the billing integration and map your Huntress Products to HaloPSA Items. Choose a sync frequency, which can be either daily or monthly. If selecting monthly, you must also specify a particular day each month for the synchronization to occur.
Once the billing synchronization is activated, it's essential to associate your Huntress products with corresponding items in HaloPSA. Software Licenses will be created and associated with these item mappings under the mapped halo client.
Here’s what the end result will look like in Halo:
Testing the Integration
Once you’ve turned the billing sync on, mapped Products → HaloPSA Items and mapped Organizations -> HaloPSA Clients you’re all set. The next step is to run the billing sync and test. Simply click the Sync Now button to queue the sync in the background:
The synchronization process should complete within a few minutes. After it does, you can refresh the billing tab page to see the updated results displayed at the bottom.
The table will show the synchronization results for each organization/product combination, allowing you to see when the sync occurred and whether it was successful. If a sync fails, a message will attempt to explain the reason. However, HaloPSA’s API may return a vague "Internal Server Error," requiring further investigation with our support team.
We can confirm it worked by looking under “Software Licences” within the linked account in HaloPSA:
Setting up Recurring Invoices is optional and not necessary for the billing sync integration to work. Utilize the created software licenses in a way that meets your workflow requirements.
(OPTIONAL) Set up HaloPSA Recurring Invoices
- On the HaloPSA dashboard; from the left hand side menu select `Invoices`
- Click on `Recurring Invoices`
- Top Right Corner of the screen click on “+ New” pill button
- Click on “New Recurring Invoice” option
- On the right hand side of the screen you will see a “Customer Details” section.
- You will need to choose a customer to link the invoice to from the dropdown
- Click on “Add Recurring Item” located towards the center of the page.
- You can search for your item(s) and select them by submitting a value into “Quantity”
- Once you’re done, on the bottom right hand corner of the screen the “Select” pill button will no longer be disabled and you may click on it to save the selection made.
- You will be brought back to the main “Recurring Invoices” screen.
- Click on the edit pencil icon to proceed with mapping a software licence to the selected row item.
- Under “Quantity”, choose “Calculate quantity from Licence count on creation”
- This will have a new section appear underneath called “Licence Quantities”.
- Click on the “+Add” pill button located on the far right of this new section:
- This will render a new menu where you can choose your Licence from the dropdown and make your preferred choices around how you would like to handle the quantity counts:
- Remember to click “Save” at the bottom of the menu.
- You should now see your License appear within the table in the UI:
- Scroll to the bottom of the page and click “Save”
- This will bring you back to the original Edit screen of the recurring invoice.
- Check to make sure everything is setup to your preference and click on “Save” at the bottom of the page: