<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 Peppol e-Invoicing via Tickstar?</strong></p><p><strong>- Installing the Integration</strong></p><p><strong>- Authentication Configuration</strong></p><p><strong>- Integration Customisation</strong></p><p id="isPasted"><strong>- Enabling the Integration</strong></p><p><strong>- Invoicing Syncing and Error Logs</strong></p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">What is Peppol e-Invoicing via Tickstar?</span></strong></p><p>Peppol e-Invoicing via Tickstar allows you to configure the Peppol (Pan-European Public Procurement Online) e-Invoicing integration to send your invoices via the Peppol Network using Tickstar Access Point.</p><p><br></p><p><strong id="isPasted"><span style="font-size: 12pt;">Prerequisites</span><span style="font-size: 14pt;"><em>: </em></span></strong></p><ul><li style="font-style: italic;"><span style="font-size: 11pt;"><em>You must have purchased and configured your account with Tickstar (the access point into the Peppol network) and have your credentials available for storing in Halo.</em></span></li><li style="font-style: italic;"><span style="font-size: 11pt;"><em>Your Halo tenant must be on version 2.214+ to ensure the runbook installs itself correctly.</em></span></li></ul><p><br></p><p><strong><span style="font-size: 14pt;">Installing the Integration</span></strong></p><p>This integration is provided via an Integration Runbook, so doesn't show directly in Configuration > Integrations. </p><p><br></p><p>Instead, you will need to navigate to the Runbook Repository, found under Configuration > Integrations - Custom Integrations > Integration Runbooks (button) > Globe Icon (top right, just under your profile icon).</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY1OWIzMDcwLTJlNDktNGU1YS1hZTE0LTkzYWYzYTg3NzZjMiJ9.8JuU2R5gdB_E8azZFjTyHlQLbQrSKEcgdikwIxMblt0" class="fr-fic fr-fil fr-dib" width="1890" style="width: 1892px; height: 489.981px;" height="490"></p><p><strong><span style="font-size: 10pt;">Fig 1. Runbook Repository </span></strong></p><p><br></p><p>Which will open the Repository, from which you can select 'Peppol e-Invoicing (via Tickstar)':</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjlkYmVjZjNiLTQ3NTUtNDA2NS1iZmZjLTJlZWJjNzBkM2IyZSJ9.pBRd6FuodyNlsuOjdXgFc9Pau9ncvYY66qyFG3XiNpo" class="fr-fic fr-fil fr-dib" width="1879" height="754"></p><p><strong><span style="font-size: 10pt;">Fig 2. Runbook for Peppol e-Invoicing in the repository</span></strong></p><p><br></p><p>Once it opens, choose 'Install to Halo' from the top bar and the integration will install itself. </p><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">Authentication Configuration</span></strong></p><p>Once the integration is installed, you need to configure your credentials (both to access Halo's and Tickstar's APIs). </p><p><br></p><p><span style="font-size: 12pt;"><strong>Halo</strong></span></p><p>Firstly, we must configure an API application to allow this integration to access your API, more details of which can be found in the section "Creating an API Application" of our guide <a data-fr-linked="true" href="https://usehalo.com/halopsa/guides/2267" id="isPasted" target="_blank" rel="noopener noreferrer">Runbooks - Authorising API Access into Your Own Halo Instance</a>.</p><p><br></p><p>As you configure this, make sure to use 'Client Credentials' and ensure that both the API agent and the API application has permission to read and modify invoices. Note down your Client ID and Secret as you will need them later. </p><p><br></p><p>Once your API app is configured navigate to Configuration > Integrations > Custom Integrations > Custom Integrations > "Peppol e-Invoicing | HaloPSA API".</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjExODMxNWYyLTUzNDMtNDUzNi05ODlkLTBjZTViYTI2MTQyZSJ9.0OG7SG9_PeH5y_0x9Zx2BvKlTyPO8nGw485Yz9PSuZE" class="fr-fic fr-fil fr-dib" width="1311" style="width: 1313px; height: 931.076px;" height="931"></p><p><strong><span style="font-size: 10pt;">Fig 3. Peppol e-Invoicing custom integration </span></strong></p><p><br></p><p>You will need to adjust the following:</p><ul><li>'Access Token URL': Replace 'YOURHALOURL.com' with your Halo URL</li><li>Client ID: Your Client ID </li><li>Client Secret: Your Client Secret</li></ul><p><br></p><p><strong><span style="font-size: 12pt;">Tickstar</span></strong></p><p id="isPasted">Navigate to Configuration > Integrations > Custom Integrations > Custom Integrations > "Peppol e-Invoicing | Tickstar API".</p><p><br></p><p>You will need to adjust the following: </p><ul><li>Client ID: The username of your Tickstar user</li><li>Client Secret: The password of your Tickstar user</li></ul><p> </p><p><strong id="isPasted"><span style="font-size: 14pt;">Integration Customisation</span></strong></p><p><span style="font-size: 11pt;">To ensure that invoices are transferred successfully into the Peppol network, every transaction must conform to the standard format which contains specific mandatory fields for both the seller (MSP), the buyer (MSP's client) and the transaction itself.</span></p><p><br></p><p><span style="font-size: 11pt;"><span style="font-size: 11pt;">Therefore, the integration requires some configuration before it can be used, to ensure all transaction details are properly recorded. </span> </span></p><p><br></p><p><strong id="isPasted"><span style="font-size: 12pt;">Assumptions</span></strong></p><p>The following assumptions have been made when developing this integration: </p><ul><li>All transactions occur within one country (the seller and all buyers are in the same country)</li><li>All transactions occur in Euros (EUR)</li><li>All transactions are commercial (B2B) transactions (Peppol code 380)</li><li>All invoices in Halo need to be sent to the Peppol network</li><li>The sales tax used is VAT<ul><li>VAT is a single, flat rate</li><li>The standard VAT rate is used</li><li>VAT Is applied across all products </li><li>VAT is applied to every transaction</li></ul></li><li>All payments are accepted using one method (bank transfer, credit card etc)</li></ul><p>If your invoicing situation falls outside these assumptions, please contact us through our support channels so we can advise further (support@halopsa.com). </p><p><br></p><p><strong id="isPasted"><span style="font-size: 12pt;">Client Configuration</span></strong></p><p>The following fields must be completed on all clients (address to be configured on the client's main site) who you will invoice through the Peppol network. </p><ul><li>Name: Client's Legal Name</li><li>Address Line 1: Client's Street Name</li><li>Address Line 3: Client's City </li><li>Address Line 5: Client's Postal code</li><li id="isPasted">Reference: Client's Business ID</li><li>Tax Number: Client's Tax/VAT Number</li><li>Accounts Email Address: Client's Accounts Email Address</li></ul><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjdmNDdmYjIzLWY5MDYtNDRkYS1iMTYzLTdmMzEwMWU3ZDk3MSJ9.qA7wN1QYW-6tZ-ElKHhFGYil34-vaLXmFFaswdRTdjo" class="fr-fic fr-fil fr-dib" width="1649" style="width: 1651px; height: 815.577px;" height="816"></p><p><strong><span style="font-size: 10pt;">Fig 4. Client details to update </span></strong></p><p><br></p><p><em><strong>Note: If you invoice more than one location (Halo Site), you need to make sure each site has the address completed as above.</strong></em></p><p><br></p><p><strong id="isPasted"><span style="font-size: 12pt;">MSP Configuration</span></strong></p><p>As the seller's details remain static between transactions, these have been hard-coded into the XML body (rather than be pulled from the relevant client each time as above). </p><p><br></p><p>To edit these, firstly navigate to Configuration > Integrations > Custom Integrations > Integration Runbooks (button) > "Peppol e-Invoicing (via Tickstar)" and open to the 'Flow Chart' tab and open the step highlighted in figure 5.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ5OTgwNDYxLTcxYTMtNGQ1Mi05NjM1LWVlOTFlMjMzZDQxNyJ9.d3CayrpFh9mr1_p5mCsh55cbTyVyHCg7j4bY31kAyvc" class="fr-fic fr-fil fr-dib" width="1393" style="width: 1395px; height: 726.385px;" height="726"></p><p><strong><span style="font-size: 10pt;">Fig 5. Edit step "POST Invoice to Tickstar"</span></strong></p><p><br></p><p>Then click 'Edit Method': </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc1MzBkZTE0LTcwNTYtNDVhZC04Y2Y4LTM4N2UxMzczNjE3MiJ9.-wL3EQBPrdDyKwDPeCYKGTwnRIfICWJoL0GytplMdV8" class="fr-fic fr-fil fr-dib" width="1651" style="width: 1653px; height: 622.687px;" height="623"></p><p><strong><span style="font-size: 10pt;">Fig 6. Edit Method</span></strong></p><p><br></p><p>Then open the 'Body' tab: </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY5MDRhNjhkLTFkYmYtNDM5Ni1hYjQzLThmZjgxMzE2OGFlYyJ9.2To9arQDBXMZ_hcpH3i-c7OFs74tz2aw4eoGWrl8Bsw" class="fr-fic fr-fil fr-dib" width="1505" style="width: 1507px; height: 696.682px;" height="697"></p><p><strong><span style="font-size: 10pt;">Fig 7. Body Tab</span></strong></p><p><br></p><p>Comments (the green text at the end of some lines) has been added to the XML (language used to transfer documents over the Peppol network) to make it easier to understand what each property does. </p><p><br></p><p>Unless you have a good understanding of Peppol standards and the formatting of its XMLs, you should not edit ANY line except the ones listed below in exactly the way described below. Except where specified otherwise, you should only edit the white coloured text on each line of the XML.</p><ul><li>Line 6 (Seller's Peppol ID): replace with your Peppol ID</li><li>Line 48 (Seller's Peppol ID): replace the salmon coloured '0208' with your Peppol country code and the white text with your Peppol ID</li><li>Line 50 (Seller's Trading Name): replace with your trading name</li><li>Line 53: (Seller's Street Address): replace with your street address</li><li>Line 54: (Seller's City): replace with your city</li><li>Line 55: (Seller's Postal Code): replace with your postal code</li><li>Line 57: (Seller's Country: replace with your ISO country code</li><li>Line 61: (Seller's VAT/TAX Number): replace with your VAT number</li><li>Line 67 (Seller's Official Name): replace with your official (legal) name</li><li>Line 68 (Seller's Company Number): replace the salmon coloured '0208' with the Peppol country code you transact in and the white text with your Company ID</li><li>Line 74 (Buyers Peppol Country Code): replace ONLY the salmon coloured '0208' with the country code you transact in</li><li>Line 83: (Buyer's ISO Country Code): replace the ISO country code with country you are transacting in</li><li>Line 87: (Buyer's VAT Country): replace ONLY the white text 'Be' with the country code you are transacting in</li><li>Line 94 (Client's Peppol Country Code): replace ONLY the salmon coloured '0208' with the Peppol country code you are transacting in</li><li>Line 99 (Payment method): replace the salmon coloured 'Credit transfer' and the white coloured '30' with your payment method</li><li>Line 102 (Buyer's Account Number): replace with your payment account number </li><li>Line 103 (Buyer's Account Name): replace with the name on your payment account</li><li>Line 105: (Buyer's BIC/SWIFT Code): replace with the BIC/Swift code on your payment account</li><li>Line 116 (VAT Percentage): Replace with VAT percentage rate charged in the country you transact in</li></ul><p><br></p><p><strong id="isPasted"><span style="font-size: 12pt;">Invoice Configuration</span></strong></p><p>You must ensure that every invoice generated within Halo for remission through the Peppol Network has all of these fields populated: </p><ul><li>Invoice ID: auto-generated</li><li>Due Date: auto-generated but it is your responsibility to ensure that Halo's due date settings are correctly configured</li><li>Net Total: auto-generated but it is your responsibility to ensure all pricing is correct </li><li>VAT Total: auto-generated but it is your responsibility to ensure Halo's Tax setting are correctly configured</li><li>Gross Total: auto-generated but it is your responsibility to ensure that pricing and Tax are correctly configured </li></ul><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">Enabling the Integration</span></strong></p><p>Finally, to enable this integration, you must navigate to the integration runbook (Configuration > Integrations > Custom Integrations > Integration Runbooks (button) > Peppol e-Invoicing (via Tickstar)).</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjBhMDA0MzNhLWQ1M2UtNGUyMi05MTc1LWZlYTZlYmIyYTRjZiJ9.8x_hMKqGUo5yrFyndEJ28IkfAOOLDnJA9Dg5QLiXDXE" class="fr-fic fr-fil fr-dib" width="2197" height="781"></p><p><strong><span style="font-size: 10pt;">Fig 8. Peppol e-Invoicing (via Tickstar)) Runbook</span></strong></p><p><br></p><p>Scroll down to the 'Events' section of the 'Details' tab:</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImEzNTA4Nzk1LTA1NDItNDZiNS1hMjZhLTQxMzcxMTkyM2JhMiJ9.HdFRrb-QZft5sh89_rtcSDA-ThCl5MZZaCbUIGlJR0Y" class="fr-fic fr-fil fr-dib" width="2193" height="580"></p><p><strong><span style="font-size: 10pt;">Fig 9. Events section of Runbook</span></strong></p><p><br></p><p>Add a new event for 'Invoice Created'.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI4ODMxYmI4LTI1MWQtNDcwMi1hMTNkLTRlZWRkMmJlNzc0YSJ9.TipndPcxT1H8zp9NFcfJN4FRRxvqTggufObAEBAuKMs" class="fr-fic fr-fil fr-dib" width="734" height="415"></p><p><strong><span style="font-size: 10pt;">Fig 10. Invoice created event</span></strong></p><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">Invoicing Syncing and Error Logs</span></strong></p><p>Once an invoice is created, the integration will automatically run and attempt to post the invoice to Tickstar. Tickstar will then validate the format of the transaction XML it receives and either accept the transaction or return an error explaining why it failed validation. </p><p><br></p><p>For all successful transactions, the integration will insert the Tickstar Transaction ID into the "Internal Note" of the invoice.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ0YzcxZmJiLTZkMGEtNGM0MC05NTY0LTBlMGM0M2ExZDI1ZSJ9.rMLkbtQqVZ4-QJiFwcDGZA6a3lIkAEZGTNNTP8ahfy4" class="fr-fic fr-fil fr-dib" width="1620" height="801"></p><p><strong><span style="font-size: 10pt;">Fig 11. Tickstar Transaction ID against the invoice internal note</span></strong></p><p><br></p><p>For transactions that fail validation, further information is available on the 'Logs' tab on the runbook but also in Tickstar (where further information may be available). </p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVmYTA3MWM5LWYxY2YtNGNlZS1iZDA0LWNjZjQwNDdjNDAyZCJ9.l05DP0iTWAcb810QqZyQYkOCeZ4alf03Vxd8wrZbdEM" class="fr-fic fr-fil fr-dib" width="2137" height="319"></p><p><strong><span style="font-size: 10pt;">Fig 12. Runbook Logs</span></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc5MzE4NDkxLWQ1YjUtNDdmYi1iNTkyLWJiZjZmNzk2MTBhMCJ9.CkpE8OLd8_H9gu7O07fVz50r2MGJSx7VXUws7zaob58" class="fr-fic fr-fil fr-dib" width="2135" style="width: 2137px; height: 443.987px;" height="444"></p><p><strong><span style="font-size: 10pt;">Fig 13. Additional logs in Tickstar</span></strong></p><p><br></p>
