Browse Guides

Avalara 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><div><div><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><span style="font-size: 11pt;"><strong>In this guide we will cover:</strong></span></p><p><span style="font-size: 11pt;"><strong>- Enabling the Avalara Module</strong></span></p><p><span style="font-size: 11pt;"><strong>- Connecting to Avalara</strong></span></p><p><span style="font-size: 11pt;"><strong>- Importing Customers</strong></span></p><p><span style="font-size: 11pt;"><strong>- Syncing Entities</strong></span></p><p><span style="font-size: 11pt;"><strong>- Voiding an Invoice</strong></span></p><p><span style="font-size: 11pt;"><strong>- Excluding Customers</strong></span></p><p><br></p><p><br></p><p><span style="font-size: 14pt;"><strong>What is the Avalara Integration?</strong></span></p><p><span style="font-size: 11pt;">The Avalara integration allows you to complete a two way sync of customers between your Halo and Avalara instance. You can also send invoices, quotes and sales orders to Avalara from Halo. When sending these entities they will be created in Avalara, using Avalara&#39;s tax functionalities to calculate the correct tax rates, this will then be synced back to Halo, updating the entity in Halo with the correct tax rates.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 14pt;"><strong>Enabling the Avalara Module</strong></span></p><p><span style="font-size: 11pt;">To connect to Avalara, navigate to the Integrations page and turn on the module by hovering over the module and clicking the plus icon.</span></p><p><span style="font-size: 11pt;">&nbsp;</span></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY5YTdiMzJhLTY3NDYtNGM3MS04OWJkLWYxZGMwNDVkY2E1OSJ9.fPyCPd9FLP5y1A7Gv1i6uAOXW-M88Lp_O711WdiyyOs" class="fr-fic fr-fil fr-dib" width="986" style="width: 986px; height: 236.987px;" height="236.987"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the Avalara module.</span></strong></p><p><br></p><p><span style="font-size: 14pt;"><strong>Connecting to Avalara<br></strong></span></p><p><span style="font-size: 11pt;">Once enabled, click onto &#39;Avalara tenants&#39; and then click new tenant in the top right.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">Then fill in in the information for your Avalara URL in the name field and your username and password.</span></p><p><span style="font-size: 11pt;">&nbsp;</span></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg3NzAwOWY0LWRhNTctNGZkZS1hZTA5LTRjMzg3NTMxNmZiNCJ9.rUTcbv9MSnOMHbQAIxaN1fN7vWUm07D1wcn2TBUOeoI" class="fr-fic fr-fil fr-dib" width="973" style="width: 973px; height: 251.966px;" height="251.966"></p><p><span style="font-size: 10pt;"><strong>Fig 2. Connecting to Avalara.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">Your details will likely be for a production environment not a developer instance. Your username and password should be your Avalara login details (Company ID will automatically populate once you connect and choose a company).</span></p><p><br></p><p><span style="font-size: 11pt;">Make sure to save your details before adding the company and clicking on &quot;Test Configuration&quot;. If you want to see if it has connected, you can click Fn + F12 to open the web browser developer console and see the status: 200 (Connection is OK).</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg2NTk0N2VkLWM0ZTgtNDZjMC1hMTNjLWYxYjUyYzg2YTlkNCJ9.YdApx_MKTE7yqdIEmdArCm9Q8kBJxfLSk9aawyTnF1g" class="fr-fic fr-fil fr-dib" width="808" height="519"></p><p><span style="font-size: 10pt;"><strong>Fig 3. Test Configuration button.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">Then, navigate back to the Avalara main screen so you can set the Default tenant. You will also have an option to set the &quot;Customer property to use for Transaction Customer Code&quot;.</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImIyMjA0Y2I1LWRhYjYtNGIwNy1iYjkwLWY2NGJhYTUyNDhkYyJ9.WcwaSuJEn0HFGjfhvvbVE5OLwBLqAsy8tr2gXqViiZ8" class="fr-fic fr-fil fr-dib" width="874" style="width: 876px; height: 479.693px;" height="480"></p><p><strong><span style="font-size: 10pt;">Fig 4. Setting the default tenant.</span></strong></p><p><br></p><p><span style="font-size: 11pt;"><strong>Customer property to use for Transaction Customer Code -&nbsp;</strong>The property chosen here will be used as the &quot;Customer Code&quot; for each transaction synced to Avalara. You can choose between syncing the customer name or the customer ID for your accounting integration. If syncing the name this will be cropped to 50 characters due to string limits in Avalara.&nbsp;</span></p><p><br></p><p id="isPasted"><span style="font-size: 14pt;"><strong>Importing Customers<br></strong></span></p><p><span style="font-size: 11pt;">So we can authenticate this connection in Avalara, navigate into the Avalara tenant you just created and click Create Certificate from within the customers tab.</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM0OTM2YmI0LTlhYjgtNDRhNS1hM2M4LWYxOWExODZkZWFiOSJ9.TtFGsIVgjznRmZNms6yTYlvVlX427NKMtZwuWsmolhg" class="fr-fic fr-fil fr-dib" width="1209" style="width: 1211px; height: 288.417px;" height="288"></p><p><span style="font-size: 10pt;"><strong>Fig 5. Customers tab.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">When clicking on Create Certificate, you should see this screen popup.</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM0YWFlY2VmLTc4MjgtNGQzOC04ZTYyLTc0OGRkY2ZjYjVhZSJ9.kZwmXrK7JurSkICmliNFPdtblVm0zvXJrN-POihd5yM" class="fr-fic fr-fil fr-dib" width="931" height="513"></p><p><span style="font-size: 10pt;"><strong>Fig 6. Provisioned popup.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">Then you can import clients using the &quot;Import Customers&quot; button. These will match on name so you will need to ensure the customer names in Avalara and Halo are an exact match to prevent duplication.&nbsp;</span></p><p><br></p><p><span style="font-size: 14pt;"><strong>Syncing Entities<br></strong></span></p><p><span style="font-size: 11pt;">Then, you can choose what entities you would like to sync to Avalara in the &#39;Syncing to Avalara&#39; tab.</span></p><p><span style="font-size: 11pt;">You can include or exclude Credit Notes and Bills as entities to sync. On older versions, Credit Notes and Bills cannot be excluded from the sync. &nbsp;&nbsp;</span></p><p><span style="font-size: 11pt;">&nbsp;</span></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNmMjQwZTQxLTk1ZGEtNDUxOC05MzMwLTdmNTQwNzE5M2ZlMSJ9.6PkPYNxU1dGCSUYen_uWU9tZyrSc8ppl716XC1Vdy6o" class="fr-fic fr-fil fr-dib" width="625" height="462"></p><p><span style="font-size: 10pt;"><strong>Fig 7. Selecting entities to sync.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">The clients sync will pass information about the client back to Avalara. Invoices, Quotes, POs and SOs will sync across to Avalara when a button is pressed in the individual entity unless the &#39;Sync Taxes Automatically&#39; checkbox is checked. Improvements have been made to the integration to reduce the number of API calls made when syncing entities. This will&nbsp;</span><span style="font-size: 11pt;">improve the cost effectiveness of the integration.&nbsp;</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMyNGRlZWRhLTk4NDYtNDU1OS1hMTRmLTZjNzcyYzZiYmVhYSJ9.R1JpJadkjMKL4FhWo8ydAnN_Ew4lootJ7q3zA7Rloqg" class="fr-fic fr-fil fr-dib" width="407" height="102"></p><p><span style="font-size: 10pt;"><strong>Fig 8. Syncing taxes.</strong></span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><strong>Sync Entities as Committed -&nbsp;</strong>When checked all entities that sync to Avalara will be synced as &#39;committed&#39;.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">You can select which entities you would like to sync as committed.&nbsp;</span></p><p><br></p><p><span style="font-size: 10pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJhZDhlNzNlLTFmYTEtNDkyYi1iNTNmLTE2YjVjNjg5NDlkYyJ9.Rly4RV0HU4pESYCtcPLrQeIVzx31EB0cT8ZzI0bwhaM" class="fr-fic fr-fil fr-dib" width="467" height="236"></span></p><p><strong>Fig 9. Choose entities to sync as committed.&nbsp;</strong></p><p><strong><br></strong></p><p><span style="font-size: 11pt;">Any entities not selected here will sync to Avalara as &#39;uncommitted&#39;. If &#39;Entities to Sync as Committed&#39; is left blank all entities will sync as committed.&nbsp;</span></p><p><br></p><p><span style="font-size: 11pt;">Then, you will need to set a default tax code, default item and a default client. These defaults define what should sync to Avalara in the case of a client, item or tax code not being able to be returned from Avalara, however this should not be the case, but it is an Avalara requirement to be set.</span></p><p><br></p><p><span style="font-size: 11pt;">The last part necessary is to set the Default Item at Item Group level to define the type of item that this group will be used for. This means that you will need to ensure that your items are grouped correctly (e.g. Software in a dedicated software group).&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;"><strong>*The group level setting is not currently applying the Avalara default item to each item in the group, the Avalara default item must be set from within the &quot;Billing&quot; tab of the item, or imported (Check to make sure you can match to existing items using the name field as the unique identifier, and then you can have a second column header to update the Avalara default item called &quot;iavalaraitemcode&quot; which is where you set the field for the Avalara item.*</strong></span></p><p><br></p><p><strong><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJhZDUyNDY2LWZjMGYtNDY1Ny05NzFjLTA4YzY1YWM4YTQxNSJ9.VsUzfbhMA7RsMJ3OWIexGiBSOti6iAoakXg-LJhA9ok" class="fr-fic fr-fil fr-dib" width="438" height="145"></span></strong></p><p><strong><span style="font-size: 10pt;">Fig 10. Import example.</span></strong></p><p><br></p><p><strong><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMxZjA0OGE2LTY3MzAtNDI2OC1hZTIyLWU1YjE3YThiMWUzZiJ9.aBZ01dj0AZTtlz1GjqTzC8bkSGeiB3lG4dcNZ7Xco1c" class="fr-fic fr-fil fr-dib" width="897" height="303"></span></strong></p><p><span style="font-size: 10pt;"><strong>Fig 11. Import options.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">The import screen should include the name of the Product and the Default Avalara product.</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk3NGQ5MmI4LWNkOWEtNDc4NS04ZTA0LTVmZWRiYjIwOWNjNCJ9.dSjRDUNFZo-A62CCS7wTOkkMLP4MpEvmCYZecPLHu88" class="fr-fic fr-fil fr-dib" width="567" style="width: 567px; height: 685.616px;" height="685.616"></p><p><span style="font-size: 10pt;"><strong>Fig 12. Default item.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">Then your taxes will be calculated by Avalara. The lines of the address used by Avalara are address line 1 and the ZIP code so these will need to be set correctly in your clients/sites.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">If you are looking to sync taxes manually instead of automatically, then you will need to click this button in each entity i.e. an invoice. With the setting in the integration &quot;Sync Taxes Automatically&quot; turned off, you will need to manually use this button to sync i.e. invoices to Avalara.</span></p><p><span style="font-size: 11pt;">&nbsp;</span></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhjZjdiYWViLTMwNDktNGRkMC1iOTdlLTRmNDkxMjA1MjQyYyJ9.Lf5No3f9NpRS2sZXeGXXnQCVyI1E6KxUwBmXOO3F1-8" class="fr-fic fr-fil fr-dib" width="326" height="208"></p><p><span style="font-size: 10pt;"><strong>Fig 13. Sync to Avalara button.</strong></span></p><p><br></p><p><span style="font-size: 12pt;"><strong>Identifying Transactions</strong></span></p><p id="isPasted"><span style="font-size: 11pt;">When transactions are synced to Avalara the name of the customer will be used as the customer code for the transaction, making it easier to identify which transactions relate to which customers.&nbsp;</span></p><p><br></p><p><span style="font-size: 14pt;"><strong>Voiding an Invoice</strong></span></p><p><span style="font-size: 11pt;">Within Configuration &gt; Billing &gt; General Settings, you can enable the following setting.</span></p><p><br></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjMjY5OGQ4LTA5YzUtNGEzYy05MzUzLTYyNDU5NDFmMWJlNyJ9.guvQVe9meelLSyAWBapsTl7E54_Phuuf1t_gB_mw27E" class="fr-fic fr-fil fr-dib"></span></p><p><span style="font-size: 10pt;"><strong>Fig 14. Void an invoice option.</strong></span></p><p><br></p><p><span style="font-size: 11pt;">When enabled and voiding invoices in Halo, this settings means that the transactions will also void in Avalara. Voiding an Invoice will reset the related invoice entities in Halo such as the Labour will go back into ready for invoicing and it will roll back a Recurring Invoice &#39;Next Creation Date&#39;.</span></p><p><br></p><p><span style="font-size: 14pt;"><strong>Excluding Customers</strong></span></p><p><span style="font-size: 11pt;">Within the &quot;Billing&quot; tab of a customer, you can set the Avalara tenant used, this can be set to exclude the customer from Avalara. This can be useful if needing to exclude certain customers from automatic tax.</span></p><p><br></p><p><span style="font-size: 11pt;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU1Yjk2MTJiLTk1MzYtNDVkYy04ZTIzLTkyMDE2ODgwOTA3YyJ9.LR2BI9q3uF-RsJlI15odjDWePn26tF1DePh3CL1Fmoc" class="fr-fic fr-fil fr-dib" width="1037" style="width: 1039px; height: 328.321px;" height="328"></span></p><p><br></p><span style="font-size: 10pt;"><p><strong>Fig 15. Exclude a customer from Avalara.</strong></p></span><br><p><span style="font-size: 11pt;">A button will show on the Billing tab of a Customer to clear the link to the Avalara tenant.</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0YThjYWFjLWViODMtNGI0Ny1hYjZkLWJhNzhmN2FlM2FmNiJ9.-Im-z8QdpzWer6ko80wz4HcOLGTubkcHC9rYMz5I5tY" class="fr-fic fr-fil fr-dib" width="757" height="386"></p><p><strong><span style="font-size: 10pt;">Fig 16. Clear Avalara Tenant button.</span></strong></p><p><br></p></div></div>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.