<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>- Setting up the API Application</strong></p><p><br></p><p><br></p><p>The Halo Accounts Integrator is required to integrate with the following Accounting Software/Tools:</p><p><br></p><ul><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/1480" target="_blank" rel="noopener noreferrer"><strong>Sage 50 UK</strong></a> - The Account Integrator has been updated to be compatible with Sage UK v32 (2026).</li><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/1292" target="_blank" rel="noopener noreferrer"><strong>Sage 50 Canada</strong></a></li><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/1291" target="_blank" rel="noopener noreferrer"><strong>QuickBooks Desktop (All regions)</strong></a></li></ul><p><br></p><p>The Halo Accounts Integrator must be run on the same network as the Accounting Software but connects to Halo using the Halo API.</p><p><br></p><p>The latest version can always be downloaded from here - <a href="https://s3.halopsa.com/HaloAccountsIntegrator.zip" id="isPasted">https://s3.halopsa.com/HaloAccountsIntegrator.zip</a></p><p><br></p><p>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.</p><p><br></p><p><strong><span style="font-size: 14pt;">Setting up the API Application</span></strong></p><p>After downloading the Accounts Integrator, you can create an API only agent a<span style="font-size: 11pt;">t no additional license usage. This is done by creating a ne</span>w agent and giving them administrator permissions via the Administrator role, then enabling the checkbox on the setting "API Only Agent" from the "Details" tab of the agent creation screen.</p><p><br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZkMTJlYjlmLWU2YjAtNDJjNC1iOGU1LTM5NzNhZWE4ZDEyMiJ9.oQG9wC9mPFJXCHrkOJKGjP99a0IcMXp7fK3MYtAke_Q" width="1134" height="1079" class="fr-fic fr-dii"><br><strong><span style="font-size: 10pt;">Fig 1. API agent.</span></strong></p><p><br></p><p>Go to Configuration > Integrations > Halo API.</p><p><br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjI4NjgwNDFlLWE0NzUtNDU5YS04M2U5LTE3YzlhMDM0OGZhNyJ9.ZKptYO-uiDcoCrLYQfMkfGtz4erxxBuVJRXEF4GEV-k" class="fr-fic fr-fil fr-dib" width="555" height="288"><strong><span style="font-size: 10pt;">Fig 2. Halo API module.<br></span></strong></p><p>Click into this module and then "View Application" (there will be a "New" button near the top right hand side of the list).</p><p><br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM1YmVjMWNlLWI1YWQtNGNkNi1iY2Y4LTYwYmVjZmI4Yjc0YiJ9.VP2YfcRnK3n05ejkrmbZyQ-a1ICU-I05gvOH0zkYGgw" class="fr-fic fr-fil fr-dib" width="649" height="685"><strong><span style="font-size: 10pt;">Fig 3. View Applications button.</span></strong></p><p><br></p><p>Begin to create a new application.</p><p><br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZhMDIyZWI2LWVjMWItNDdiZi05YWFjLTE3NmRkMGE0ODI3YyJ9.88_sSIyLqrWBsxxSbg8UB9nsBXQpjD84QycVoaFaM7I" class="fr-fic fr-fil fr-dib" width="619" height="357"><strong><span style="font-size: 10pt;">Fig 4. Creating an application.<br></span></strong></p><p>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.<br><br></p><p>Set the Login Type to "Agent" and choose the API Agent account which has been created.</p><p><br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk5MTUxOGEyLTk3ZTMtNDliYS04ZWMwLTcwOTA2NzkyZDU2NyJ9.kC-L-bDuMwvV_baoLq4W2N2thm_2wbDUUlH8PmCnOuY" width="1113" height="925" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; text-align: left; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; 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; width: 907px; height: 752.943px; max-width: none !important;" id="isPasted" class="fr-fil fr-dib"><strong><span style="font-size: 10pt;">Fig 5. Application configuration.</span></strong></p><p><br><strong><em>Note: Admin privileges will need to be granted for the initial import of Tax rates.</em></strong><em><br></em><br></p><p>Go to the "Permissions" tab of the API application, after clicking save. 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.</p><p><br><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRiMDkyYjEyLTBlYzQtNDIxYS05NjAzLTIyZmNmNzZlOWMwMiJ9.T7LlSQi2iu-dDxU-ZqArhTFQeW6RZXWSWO2l_LMw4m0" class="fr-fic fr-fil fr-dib" width="305" height="599"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ODEwMTJhLWE0MDgtNDhiNy04NmFmLWYwN2E3NTcwZTgyMCJ9.VVztOPdl7bs_2kZiVZzHtldiokAPJiOCXrtexoANN3g" class="fr-fic fr-fil fr-dib" width="229" height="94"></p><p><strong><span style="font-size: 10pt;">Fig 6. Permissions.</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Additional Permissions</span></strong></p><p>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.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjI1MWRmNWRiLWY0M2YtNDYwOS04Y2I2LTNjNjM4Zjg2MzdiMiJ9.rA9SM5eIM7me3ins9seDsqrfvvOTO6SrZ6Sv5MGgSrg" class="fr-fic fr-fil fr-dib" width="1168" height="531"></p><p><strong><span style="font-size: 10pt;">Fig 7. Permissions.</span></strong></p><p><br></p><p>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</p>
