Browse Guides

Pax8 Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><style> p { margin: 0; } span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px; } blockquote blockquote { border-color: #00bcd4; color: #00bcd4; } blockquote blockquote blockquote { border-color: #43a047; color: #43a047; } table.grid { border-collapse: collapse; } table.grid td, table.grid th { border: 1px solid #ddd; } .fr-fic.fr-dib { display: block; margin: 5px auto; } .fr-fic.fr-dib.fr-fir { text-align: right; margin: 5px 0 5px auto; } .fr-fic.fr-dib.fr-fil { text-align: left; margin: 5px auto 5px 0; } .fr-fic.fr-dii { float: none; margin: 5px auto; } .fr-fic.fr-dii.fr-fil { float: left; margin: 5px auto; } .fr-fic.fr-dii.fr-fir { float: right; margin: 5px auto; } img.fr-dib.fr-fir { margin-right: 0; text-align: right; } img.fr-dib.fr-fil { margin-left: 0; text-align: left; } img.fr-dib { margin: 5px auto; display: block; float: none; } img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC; } img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc; } img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box; } </style><style> p { margin: 0; } span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px; } blockquote blockquote { border-color: #00bcd4; color: #00bcd4; } blockquote blockquote blockquote { border-color: #43a047; color: #43a047; } table.grid { border-collapse: collapse; } table.grid td, table.grid th { border: 1px solid #ddd; } .fr-fic.fr-dib { display: block; margin: 5px auto; } .fr-fic.fr-dib.fr-fir { text-align: right; margin: 5px 0 5px auto; } .fr-fic.fr-dib.fr-fil { text-align: left; margin: 5px auto 5px 0; } .fr-fic.fr-dii { float: none; margin: 5px auto; } .fr-fic.fr-dii.fr-fil { float: left; margin: 5px auto; } .fr-fic.fr-dii.fr-fir { float: right; margin: 5px auto; } img.fr-dib.fr-fir { margin-right: 0; text-align: right; } img.fr-dib.fr-fil { margin-left: 0; text-align: left; } img.fr-dib { margin: 5px auto; display: block; float: none; } img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC; } img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc; } img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box; } </style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Pax8 Integration?</strong></p><p><strong>- How to connect to the Pax8 integration&nbsp;</strong></p><p><strong>- Customer Imports</strong></p><p><strong>- Subscription Imports</strong></p><p><strong>- Importing Usage-based subscriptions, Azure Consumption &amp; Arrears data</strong></p><p><strong>- Automatically sync customers and/or subscriptions updates</strong></p><p><strong>- Billing for subscriptions from Pax8</strong></p><p><br></p><p><br></p><p><strong>Related Guides:</strong></p><ul><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/2508" target="_blank" rel="noopener noreferrer"><strong>Licences/Subscriptions Overview</strong></a></li></ul><p><br></p><p><strong><span style="font-size: 14pt;">What is the Pax8 Integration?</span></strong></p><p>The Pax8 integration can be used to import customer and subscription data from Pax8 into Halo. When changes are made to customer/subscriptions in Pax8 these can be automatically synced across to Halo. This allows you to bill for Pax8 subscriptions from Halo. Subscription quantities on the recurring invoice can update automatically when subscriptions are updated in Pax8, with pro-rata calculations automatically added to customer&#39;s the next invoice. This applies to both seat/device based subscriptions as well as usage based subscriptions. The Pax 8 integration is multi-tenanted, allowing you to connect multiple Pax8 tenants (accounts) to your Halo instance.&nbsp;</p><p><br></p><p id="isPasted"><span style="font-size: 12pt;"><strong>Here is a video on the setup of Pax8:</strong></span></p><p><br></p><div style="box-sizing: inherit; font-size: 14px; color: rgb(0, 0, 0); font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; margin-bottom: 50px; font-family: Poppins, sans-serif, Roboto; text-align: start;"><iframe width="560" height="315" src="https://www.youtube.com/embed/i45R78P2E_8?si=OkdHsaBURnzQ2d4w" title="YouTube video player" frameborder="0" allowfullscreen="" style="box-sizing: inherit; border: none;"><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span><span class="fr-mk" style="display: none;">&nbsp;</span></iframe></div><p><strong><span style="font-size: 14pt;">How to connect to the Pax8 Integration&nbsp;</span></strong></p><p>First enable the integration module, navigate to Configuration &gt; Integrations &gt; here enable the &#39;Pax8&#39; module using the &#39;+&#39; icon.</p><p>&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQyYjBjOGYwLWI0MWQtNDQ5Mi1hNjk1LTk3NGUxODBlM2Q3YSJ9.3GAdEd24LZVecGdX1yXoelZu66SUGOv7q-4EhHPSUXg" width="499" height="238" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enable integration module&nbsp;</span></strong></p><p><br></p><p>Once enabled click into the integration module to begin configuration.&nbsp;</p><p><br></p><p>The Pax8 integration is multi-tenanted, therefore you will have an additional option to create a new Pax8 tenant before being taken to the setup page. If you are looking to integrate multiple Pax8 tenants you will have to complete connection for each tenant individually, follow the steps within this guide to connect to a single tenant. When connected add a new Pax8 tenant in Halo and follow the same steps again to connect. This setup is also organised into tabs rather than on a singular page.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQyMzk2NGFmLTA0MWUtNGViMy1hOGIyLTg0MmU2ODM5MGM3OSJ9.-ASCu9G9ONt2c98vdIc-IukGpVIuVFlKnx80Yqbgqrc" width="1204" style="width: 1206px; height: 600.03px;" class="fr-fic fr-dii" height="600"></p><p><strong><span style="font-size: 10pt;">Fig 2. Integration setup page</span></strong></p><p><br></p><p>You will first need to choose the authentication type for this integration. The type &#39;Use the HaloPSA app&#39; is recommended as from 2025 Pax8 is enforcing stricter rules on how API requests are made. Using this type of authentication method will be required if you are managing multiple partner data in Pax8.</p><p><br></p><p><strong><span style="font-size: 12pt;">Connecting Using &#39;Custom Developer App&#39; (Client ID and secret)</span></strong></p><p>To generate a Client ID and Secret for the Pax8 integration, you will need to first do this within your Pax8.&nbsp;</p><p><br></p><p>Click into users on the left hand side in Pax8, you must be on an account with the role partner admin, go into that user and then the &quot;Developer Apps&quot; tab, from here create a developer app and sign off on it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZiMmVlNWMzLTc0MmItNGFmNy1hZGQwLWE2ZWIzZTZiOWM4ZCJ9.17c3lDb2WMcwCp204kebFuR8wYW4m9n9ppNGZ0tjCM4" width="1222" style="width: 1224px; height: 375.683px;" height="376" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 3. Create new developer app in Pax8</span></strong></p><p><br></p><p>Generate and copy your credentials.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg3YTVlMzU0LTA0NDEtNGYxZi05NWI2LTUwNGJjMGYwOTNlMyJ9.YIfkWrl_2WMR3pI10CDZUYRQo2B86rrsrV7clXQBMCY" width="619" height="499" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 4. Generate credentials</span></strong></p><p><br></p><p>From here, you can copy your credentials into Halo in order to authenticate the Pax8 connection.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM0YzkyNGExLThiMTMtNDQ5NC04ODcxLTFjN2ZiMTJhMGZkZCJ9.CRnP8e6XEHswlwrHcfrSCWoPOjNzPHD3nP_87InCB0U" width="459" style="width: 461px; height: 336.723px;" height="337" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 5. Paste credentials into Halo</span></strong></p><p><br></p><p>Test the connection to make sure it is successful.</p><p><br></p><p><strong><span style="font-size: 12pt;">Connect Using &#39;HaloPSA app&#39;</span></strong></p><p><span style="font-size: 11pt;">This authentication method is available from versions 2.184+ of Halo, if you are on a version prior to this you can connect using the custom developer app. But we recommend updating to this connection method when it becomes available in your instance.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p>Set the &#39;Authentication Type&#39; field to be &#39;Use the HaloPSA app&#39; then use the &#39;Login with Pax8&#39; button. A pop-up will display, here enter your email and password to log in to your Pax8 account and authenticate the connection.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NDY2ODk0LWM0OGItNDEzYy1iNWRjLWEwZjk0MGVkYjkyMyJ9._hjDo86FTL4G3u5mviQuU4Ogx762n6WJLCckyqNzl3Y" width="341" style="width: 343px; height: 478.664px;" height="479" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 6. Log in to Pax8</span></strong></p><p><br></p><p>You will now be connected.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Customer Imports</span></strong></p><p>Customers in Halo will need to be mapped to customers in Pax8 to ensure the customer&#39;s subscription details from Pax8 are imported/associated to the correct customer in Halo.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQzMDY4ZWQ3LTY0MDgtNDg3MC04ZjhmLTRjZjc2MWNlNTdmZCJ9.hLNZhMbDfApX8SJSAbNhgHADgfsLfAgRuV_Qi9b_zTc" width="1148" style="width: 1150px; height: 644.173px;" height="644" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 7. Customer configuration</span></strong></p><p><br></p><p>Mappings can be created by adding to the &#39;Customer mappings&#39; table and choosing which pax8 customer to associate to a chosen Halo customer.&nbsp;</p><p><br></p><p>If your customers in both applications have the exact same name you can use the &#39;generate mappings&#39; button to have mappings generated automatically, matching customers on name.&nbsp;</p><p><br></p><p>&nbsp;If you do not yet have customers set up in your Halo instance you can import customers from Pax8 into your Halo instance. Before doing this consider the customer import settings that will determine how customers will be imported:</p><ul><li>Top Level for New Customers - Any customers created from Pax8 will be created under this top level</li><li>Update the Customer&#39;s main Site address in Halo when an existing Customer is imported from Pax8 - When enabled, the main site of the customer in Halo will have it&#39;s address updated to match the address of the customer address in Pax8 each time customers are imported from Pax8.&nbsp;</li><li>Import Inactive/Deleted Customers from Pax8 and update Halo Customers to Inactive - When enabled, inactive and deleted customers will be imported from Pax8.&nbsp;</li></ul><p>Once you are happy with the customer import settings use the &#39;Import customers&#39; button to import customers from Pax8. Any new customers that have been created in Halo from Pax8 will automatically have a mapping added to the table upon import.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Shortcut to open customer in Pax8</span></strong></p><p>Customers that have been created by Pax8 or are mapped to a Pax8 customer will have a shortcut button added to their customer profile to open the customer in Pax8.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRjZGI4ZjJjLTk0ZDUtNDEwZC1iZjlhLTRiMjBjYjY0NTMxNSJ9.lzUDv2g6l2eBEnBaobTjZj7gnjbTvmKZEstY_bl5VwU" width="918" style="width: 920px; height: 238.244px;" height="238" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 8. Open customer in Pax8 shortcut</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Importing Usage-based subscriptions, Azure Consumption &amp; Arrears data</span></strong></p><p><span style="font-size: 11pt;">The Pax8 Integrations allows for the importing of usage-based subscriptions &amp; Azure Consumption data. The behaviour of how this is achieved differs slightly as of version 2.190.1.</span></p><p><br></p><p><span style="font-size: 11pt;">In both cases, usage summaries and usage lines are imported from Pax8 into Halo. Usage summaries will be denoted in Halo by their description having &#39;(Usage Summary)&#39; appended to them. For usage summaries, the linked subscription record in Halo will have a quantity of 1, with the price &amp; cost being set based on the current charges for the month &amp; the Partner total for the Month, respectively (in line with the current usage). Usage lines will be imported as subscriptions, with their quantity being set against the linked subscription in Halo.</span></p><p><br></p><p><span style="font-size: 11pt;">Once the usage based subscriptions are imported you can add the usage summary subscription to a recurring invoice for the customer, each time usage information is imported from Pax8 (daily) the price of the line on the invoice will update automatically to reflect this usage .</span></p><p><br></p><p><span style="font-size: 11pt;">To ensure that Usage/Azure Plan data is imported into the correct Halo customer record, you will need to map/assign the usage summary to the company it is for<span style="font-size: 11pt;" id="isPasted">&nbsp;within Pax8</span>. This can be done in one of two ways: assigning the company to the subscription usage summary in Pax8, or with the use of Pax8 resource groups.&nbsp;</span></p><p><br></p><p><strong><span style="font-size: 12pt;">Mapping the Company to the Subscription usage summary<br></span></strong></p><p>Here are the steps to assign usage to a company in the Pax8 Marketplace:</p><ul><li>Navigate to Manage clients &gt; Subscriptions and select the applicable subscription.</li><li>From the Usage tab, note that if there is no company associated with a specific subscription, it will be noted underneath the Subscription title: &quot;No company assigned&quot;</li><li>To assign a company to the usage, click on the &quot;...&quot; on the far right.</li><li>Click on Assign Company.</li><li>From the Company drop down select the appropriate company to assign the usage to.</li><li>Click Submit.</li></ul><p><img data-fr-image-pasted="true" width="1213" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQwNWM4ZTVjLTQ1ODYtNDA2ZC04MTBmLWRlZTA3ZmFjZWJjMSJ9.9WHYxSAJbv8u_ENWQr8fXc1jt0AsZOyNL_rFBT6HDDw" size="305426" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; max-width: calc(100% - 10px); min-width: 10px; color: rgb(37, 109, 241); font-family: &quot;Times New Roman&quot;; font-size: 14.6667px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; width: 1215px; height: 475.606px;" height="476" class="fr-fic fr-fil fr-dib"></p><p><strong><span style="font-size: 10pt;">Fig 10. Assign company to subscription resource summary</span></strong></p><p><br></p><p><img data-fr-image-pasted="true" width="488" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRjMjRhMzFmLTg5ZjQtNGNjMS1iYThkLTY3ZDVhMGFkYzRlOCJ9.jRPOXX4rPczvv-Smw5Dx_UKWS3989JMNN5hPwmDqS4s" size="13670" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; max-width: calc(100% - 10px); min-width: 10px; color: rgb(37, 109, 241); font-family: &quot;Times New Roman&quot;; font-size: 14.6667px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;" class="fr-fic fr-fil fr-dib"></p><p><strong><span style="font-size: 10pt;">Fig 11. Assign company</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Map subscription usage summary using resource groups&nbsp;</span></strong></p><p>To map in this way first assign all the subscriptions for a customer to single resource group in Pax8.&nbsp;</p><p><br></p><p>Once mapped edit the mapping created for this customer in Halo and enter the name of this resource group in the field highlighted in figure 11.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjdhZmQ0ZGEzLWMyNjEtNDZjNy04ZDI2LTUzYzQyZmEwMjUzZiJ9.QTtm7OASXOwaOZ4ZmIhXWnYOoS3tKvE7nByPwjqjGqc" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 12. Pax8 resource group</span></strong></p><p><br></p><p>This will ensure any subscriptions with this resource group will be imported against this customer.&nbsp;</p><p><br></p><p id="isPasted"><span style="font-size: 11pt;"><strong>Pre v2.190.1</strong></span></p><p>If any of your customer&#39;s subscription usage data is stored against your own company in Pax8 you will need to ensure you have the setting &#39;Include Subscriptions that are stored at your own Company in Pax8&#39; enabled in Halo.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk3NDM4YTE1LWE2N2UtNDgxNC04ZWY4LWVlNWI5MTFmNDgzZSJ9.6QPqMO_gakOpoiBSm1U93s2fjP7YdpbQXUjf-ygwTpc" width="820" style="width: 822px; height: 237.325px;" height="237" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 9. Include Subscriptions that are stored at your own Company in Pax8</span></strong></p><p><br></p><p><strong><span style="font-size: 11pt;">Post v2.190.1</span></strong></p><p><span style="font-size: 11pt;">If there are usage summaries &amp; usage lines that can be imported, they always will be.</span></p><p><br></p><p><span style="font-size: 12pt;"><strong>Billing for Azure Usage</strong></span></p><p>Once you have linked the Azure subscription to a recurring invoice line for the customer in Halo, the price of the recurring invoice line will update on a daily basis in line with usage.&nbsp;</p><p><br></p><p>As Azure usage is billed on a monthly basis, the subscription price will be reset on the 1st of every month when the next period of usage begins. Due to this you must ensure your recurring invoice schedule starts on the 1st of the month and you create this invoice on the 1st of each month to ensure the invoice has the final price for the previous period. If you create the invoice after the subscription price has reset, the line may not have the correct price.</p><p><br></p><p>The subscription price in Halo will then next update when new usage data is obtained from Pax8, as data for the current period does not become available in Pax8 until the 5th of the month, this is when the subscription will update in Halo.&nbsp;</p><p><br></p><p>If using this functionality we recommend utilising <a href="https://usehalo.com/halopsa/guides/2312/" target="_blank" rel="noopener noreferrer">recurring invoice line reviews</a> for lines billing for Azure Usage. This will prompt you to check/review that these lines on a recurring invoice before it is billed each period.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Subscription Imports</span></strong></p><p>Subscriptions can be imported from Pax8 into Halo. Imported subscriptions will show under the &#39;subscriptions&#39; tab against each customer&#39;s profile. Here, you will be able to see which subscriptions the customer has.&nbsp;</p><p><br></p><p>The following subscription data will be imported from Pax8:</p><p><br></p><ul><li>Subscription Name</li><li>Start/End date (commitment term)</li><li>Number of Licences&nbsp;</li><li>Billing Cycle</li><li>Term Duration</li><li>Status&nbsp;</li><li>Purchase cost&nbsp;</li><li>Selling Price</li></ul><p>To import subscriptions stored against your own company in Pax 8, enable the setting &#39;Include Subscriptions that are stored at your own Company in Pax8&#39; on the integration setup page (this will need to be enabled if you have any subscription usage summaries or your customers stored against your company in Pax8).</p><p>&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFhNGE5NTlmLTA5NzEtNDI5NS1hNzUwLWVlMTZmZTkyMDExMyJ9.iqnGBDJSzrmRADvw_z5XgXOw2aclqyAZbydX_pJ76GE" width="778" style="width: 780px; height: 223.36px;" height="223" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 13. Subscription import settings</span></strong></p><p><br></p><p>To import subscriptions use the &#39;Customer Subscriptions to Import&#39; to choose which customer&#39;s subscriptions to import, then hit &#39;Import Subscriptions&#39;. We recommend testing the import with one customer first.&nbsp;</p><p><br></p><p>&quot;Allow Subscription Quantities to be increased from Halo&quot; can be enabled here. When enabled, the Pax8 subscription quantity can be updated from the subscription details in Halo. <em><strong>Note: Quantities can only be increased, not decreased.&nbsp;</strong></em></p><p><br></p><p><em><strong>Note: On versions before version 2.242, you cannot edit the active/inactive flag on subscriptions imported via an integration. From this version onwards, administrators are able to edit this.</strong></em></p><p><br></p><p><strong><span style="font-size: 12pt;">View imported subscriptions</span></strong></p><p>Imported subscriptions will appear under the &#39;Subscriptions&#39; tab against a customer&#39;s profile in Halo. Head to customers &gt; select a customer &gt; subscriptions, here you will see the subscriptions for this customer.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZhMmZiZjc2LTE5M2EtNDk1YS1hNzk5LTUyNzVlYjEwZTBhOCJ9.XEPWYW9ElSk0JPtnH4rImGVljCs8r5Dg1RodbBlD50Q" width="1035" style="width: 1037px; height: 568.013px;" height="568" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 14. Customer subscriptions</span></strong></p><p><br></p><p><strong><span style="font-size: 10pt;"><em>Note: If you are unable to view the subscriptions tab within the customer&#39;s profile, you may need to enable the Software Licencing module.&nbsp;</em></span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Automatically sync customers and/or subscriptions updates</span></strong></p><p>To have updates to customer and/ or subscription details from Pax8 update in Halo automatically enable the Halo integrator for the integration. This is enabled using the setting highlighted in figure 11.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMxNmU0ZDkwLWQ2NmQtNGEzYy05MDAyLTczYTU3YjY0OWY2MyJ9.k1WBqw90TYt_f-_G9p_MP41cciobjsVinHl0l7GdfkM" width="764" style="width: 766px; height: 234.544px;" height="235" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 15. Enable Halo integrator</span></strong></p><p><br></p><p>Once enabled choose which entities you would like to be imported regularly, customers and/or subscriptions. The sync for this integration will run on a daily basis, so the entities will be updated daily.&nbsp;</p><p><br></p><p>A checkbox called &quot;Deactivate Subscriptions in Halo when they are deleted from Pax8 (Halo Integrator only)&quot; which will only show when the Integrator is enabled (Figure 15). Selecting this will make subscriptions that have been deleted in Pax8 inactive in Halo during the import.</p><p><br></p><p><strong><span style="font-size: 14pt;">Importing Products and Recurring Invoices</span></strong></p><p id="isPasted">Products and recurring invoice (RI) lines can be created automatically within the &quot;Subscription Imports&quot; tab. Imported subscriptions match on products using SKU; if no product is found, a new one will be created. When importing products from Pax8 subscriptions the SKU will include an appended identifier for the Commitment and Billing periods. This will be in the format CFQ7TTC0LCHC-0002-<u>P1M-M</u>.</p><p><br></p><ul><li><strong>Import Products and create Invoice lines:&nbsp;</strong>Determines if Products are imported and if Recurring Invoices are updated automatically.<ul style="list-style-type: disc;"><li id="isPasted"><strong>Do not import:</strong> Products will not be imported.</li><li id="isPasted"><strong>Import Pax8 Products:</strong> Creates Products from Pax8.</li><li id="isPasted"><strong>Import Pax8 Products and creating Recurring Invoice Lines:</strong> Creates Products and adds these to Recurring Invoices. The Recurring Invoice the product will be added to will be determined by customer level settings, see the next section for more information on this.&nbsp;</li></ul></li><li><strong>Product Group for new Products:</strong> Any newly created Products will be created within the set Product Group.</li><li><strong>Allow Subscription Quantities to be increased from Halo:</strong> Quantities of Pax8 Subscriptions can be increased from within Halo and transferred over. They cannot be decreased.</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY5YzBkY2Y3LWI5OWItNDVlYi1iMmY5LTRjZTJjYjRlMmI4NSJ9.9h_4_ezoRwlnrlrCirVxDtvRs-rdEc8bOH4tNIR486c" width="730" height="250" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 16. Product import settings.</span></strong></p><p><br></p><p><span style="font-size: 11pt;">If you have chosen &quot;Import Pax8 Products and creating Recurring Invoice Lines&quot; keep in mind only new subscriptions will be added to a recurring invoice. If the Customer already has the imported subscription in Halo (even if not on a recurring invoice) this subscription will be imported but it will not be added to the recurring invoice.&nbsp;</span></p><p><br></p><p><strong><span style="font-size: 12pt;">Determine which Recurring Invoice new subscriptions/products will be added to</span></strong></p><p><span style="font-size: 11pt;">You will need to set which RI new products/subscriptions are automatically added to for each customer.&nbsp;</span></p><p><br></p><p><span style="font-size: 11pt;">To do this, head to Customers &gt; select a customer &gt; Billing tab &gt; Pax8 section.&nbsp;</span></p><p><strong><span style="font-size: 10pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImE4ZDA4YjEyLWRmNzYtNDk2MS05ZTU4LTc1MmU4YjVlZjUwMiJ9.EwJgY9vu0H8eRAo1D3a9olozievtj0m7CafY3w9VnSM" class="fr-fic fr-fil fr-dib" width="1143" style="width: 1145px; height: 703.76px;" height="704"></span></strong></p><p><strong><span style="font-size: 10pt;">Fig 17. Choose which RI new subscriptions from Pax8 are added to</span></strong></p><p><strong><br></strong></p><p><strong>Monthly Recurring Invoice to use for automatic subscription creation -</strong> Here, choose the RI new subscriptions should be added to that are billed on a monthly basis.</p><p><strong>Annual Recurring Invoice to use for automatic subscription creation -</strong> Here, choose the RI new subscriptions should be added to that are billed on a annual basis.</p><p><strong><br></strong></p><p>Keep in mind the billing period for the subscription must match the chosen invoice, if it does not the subscription will be added the newest RI for the Customer that has a matching invoice period. If it cannot be matched, it will not be added. Products will be matched to subscriptions based on SKU.</p><p><strong><br></strong></p><p><strong>Exclude Certain Customers from Automatic RI line creation</strong></p><p>You can exclude chosen customers from having new subscriptions added to recurring invoices automatically by checking &quot;Do not create recurring invoice lines automatically&quot; against the customer profile (Figure 17).&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Bill for subscriptions from Pax8</span></strong></p><p>When billing for subscriptions in Pax8 from Halo the invoice can recalculate automatically based on any quantity changes made to subscriptions in Pax8. This means licences quantities are added/removed in pax8 this will automatically update the recurring invoice in Halo, updating the line quantity and pro-rating the line price based on when the licence change was made.&nbsp;</p><p><br></p><p data-pasted="true">If using this functionality we recommend utilising <a href="https://usehalo.com/halopsa/guides/2312/" target="_blank" rel="noopener noreferrer">recurring invoice line reviews</a>. This will prompt you to check/review that these lines on a recurring invoice before it is billed each period.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Create Halo products for Pax8 subscriptions</span></strong></p><p>Before you can add a subscription to a recurring invoice you will first need to create a product in Halo to represent this subscription. Products can be created under the &#39;Products&#39; module. This must be done as a subscription cannot be added to an invoice directly, instead a product will be added and then the invoice line will be linked to this subscription.&nbsp;</p><p><br></p><p>The product created must have the following configuration:</p><p><br></p><ul><li>Is a Recurring Product = Yes</li><li>Do not track stock = Yes</li><li>Consignable = No&nbsp;</li></ul><p>The name of the product/item you create should reflect the Subscription it represents.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Create Recurring Invoice</span></strong></p><p>First ensure you have the setting shown in figure 12 enabled. This can be found under Configuration &gt; Billing &gt; Recurring Invoices.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjgzZDg1NzQ5LTI4YzktNDRlZS05NzMwLWQ1YWQ0ZDc3NGJhMyJ9.3p-L-xTzS6ZXJJnqGpXyCSxu9W4alU8oiQ1cuyFQaj4" width="744" height="257" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 18. Setting to enable recurring invoice quantities to be calculated using subscription count&nbsp;</span></strong></p><p><br></p><p>Now you will need to create a recurring invoice the customer&#39;s subscription(s), or you can add a line onto an existing recurring invoice you have for the customer.&nbsp;</p><p><br></p><p>Add the product created to represent the subscription to the recurring invoice, add with quantity one as this will later be overridden by the subscription, then edit the line. In the &#39;Quantity&#39; field select &#39;Choose quantity from Subscription count on creation&#39;. This option will allow you to associate a subscription with this line, the quantity of the line item will then adjust based on the quantity of the linked subscription. &nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQyOTg0MzAyLTViM2YtNGU0Zi04MDhiLTZlMDQ3YmNiYTlhNiJ9.xqye5pkiOaxaJetDmKqm4NgYWSwRjzg5qMdnW4YH-Sc" width="1205" style="width: 1207px; height: 364.661px;" class="fr-fic fr-dii" height="365"></p><p><strong><span style="font-size: 10pt;">Fig 19. Calculate line quantity based on subscription count&nbsp;</span></strong></p><p><br></p><p>Add a subscription here, when adding you can also set a quantity of this subscription to be given for free and if there is a minimum quantity.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJkYzE4Y2RjLTEzNWEtNGM3ZC1hY2FhLTk5NzQzOTg2NDkzMSJ9.i99dM8IquaKRS2Og1AewDj9jwtJkxPzNDPY8GfonJy4" width="524" style="width: 526px; height: 474.323px;" height="474" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 20. Add subscription to invoice</span></strong></p><p><br></p><p>It is at this point you can also set pro-rata for the line, there are a number of options to determine how pro-rata is calculated and invoiced. The option &#39;Pro-rata from the date the change occurred&#39; is most commonly used.&nbsp;</p><p><br></p><p>There are also settings here to determine if the price/cost automatically updates on the invoice when they change on the linked invoice.&nbsp;</p><p><br></p><p><strong><em>Note: Multiple subscriptions can be added to a single invoice line to allow you to have a single line representing all the customer&#39;s subscriptions. When billing this way the subscriptions added to the line will share the same price but the quantity of subscriptions will be totalled.&nbsp;</em></strong></p><p><br></p><p>Once the line is saved the quantity, price and cost will be taken from the subscription (tax details will be taken from the item).&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMxZThiMGFlLWVlNjgtNDZiOS05ZjkyLWIwNWY1NjZhMDEzZSJ9.gBZj-uhCLo_85SVw30ekDUXnng6L4SUn2pI0aEmodm8" width="1151" style="width: 1153px; height: 557.242px;" height="557" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 21. Recurring invoice containing subscription</span></strong></p><p><br></p><p>Now the recurring invoice is created each day the quantity of this subscription will be checked, if the subscription quantity has changed the recurring invoice will be updated to reflect this. When the month&#39;s invoice is created any pro-rata amount as a result of subscription changes, will appear on the generated invoice as an additional line (however, this will depend on the Pro-rata option selected).&nbsp;</p><p><br></p><p><strong><em>Note: When a subscription is cancelled in Pax8 it will be removed from the subscription count against the invoice line automatically.&nbsp;</em></strong></p><p><br></p><p><strong>Managing subscriptions on invoices</strong></p><p>In order to manage recurring invoice lines linked to subscriptions being synced from Pax8, the following setting can be enabled in Halo (Found in Configuration &gt; Billing &gt; Recurring Invoices):</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA3YWMzMDEzLTE4M2ItNDcxNi1hYWQ5LWY0Mzg4MzE1MDczNiJ9.uOZshaaRTrxOaHZSy6gIiGb6zuwiOYThqdIXAZMrGi8" width="536" height="42" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 22. Manage subscription options.</span></strong></p><p><br></p><p>With this setting enabled, any subscriptions cancelled in Pax8 will be synced over to be made inactive in Halo. The syncing will occur daily, based on the sync time of the Halo Integrator. Quantity changes in Pax8 will also sync through via the Halo Integrator into Halo, meaning that the quantity updates will happen daily.</p><p><br></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.