Page Comparison

This page will instruct you on how to integrate your Xero financial software with accessplanit. 

You must be within the Advanced band or higher to integrate with Zynk/Xero as this is a chargeable module/integration. Please speak to your CSM if you are unsure whether you should have access to this feature.

Xero Integration Preparation

Before starting the integration process to connect  accessplanit to your Xero account, please review the following questions and provide the answers to the accessplanit team member that will be supporting you with the set-up of Xero integration

1. Would you like any negative valued invoice items (such as a -£10 discount) to be merged into your positive valued invoice items?
   If you do not handle negative valued invoice items in Xero, this option will evenly absorb any minus figures into the positive values
2. What would you like your default nominal code to be for your invoices? Within Xero this is typically '200'
3. What would you like your default nominal code to be for your transactions? Within Xero this is typically '970'
4. Do you use Xero's Tracking Categories?

Integrating with Xero

To integrate with Xero you will need to download the middleware Zynk. This service has its own charges so please get in touch with Zynk to find out about their annual charge. Zynk converts the Invoices and associated information stored in accessplanitinto accessplanit into information that can be processed and imported into your Xero account.

You will need to download and set up Zynk in the correct way so that it interprets your accessplanit data for Xero, and this guide will walk you through this process. Zynk does not have a download option for Macs (.dmg) so please ensure that you have access to Windows to use this middleware. 

Please note that Xero integration is an additional module. If you do not have this module or you are unsure, please get in touch with your Customer Success Manager.

Downloading Zynk

A trial of Zynk can be obtained from the following website: http://zynk.com/download-trial/

Once you have completed the form, you will receive an email with your Licence Key and a link to download Zynk, click this link to go to your Browser and Download Zynk.

Once you have downloaded and installed Zynk you’ll be asked for your Licence Key.

Click Activate to open Zynk.

Guide to configuring Xero to receive Zynk data

1. Sign up for a Xero trial at https://www.xero.com/uk/signup/
   
   
2.  You will receive an email to confirm your email address. Click on the confirmation to continue.
   
3. You will be taken to a page where you be asked to create a password for your Xero account.
   
4. You’ll then need to complete a small form with your company’s information, then click on ‘Start Trial’. You can use the demo company if you like, as a fresh organisation makes it clearer to see if data has been imported. However, doing this rather than connecting to your actual organisation means that you’re not testing the nominal code/bank account links.
   Image Removed
   
5. You will then need to set up the Private/Public key, there are three steps to complete for this. Please refer to Xero help documentation for further support: a Developer Account for Zynk at https://developer.xero.com/documentation/api-guides/create-publicprivate-key
   Download and install OpenSSL with the default options
   Go to http://slproweb.com/products/Win32OpenSSL.html and download the Win32 Open SSL Light versionImage Removed
   During the installation process, you will be asked for a donation. This is not required and you can untick the option and continue.
   Open Command Prompt as an administrator.
   You will need to open the file location for OpenSSL on your Windows machine via Windows Explorer.
   By default this can be found in: C:\Program Files\OpenSSL-Win64
   When you are in this file location, open the 'bin' folder.
   Image Removed
   When the bin folder has been opened, click into the address bar and type CMD The following command prompt will open:
   Image Removed
   Within Command Prompt, execute the following commands one at a time by pasting in the content and hitting enter/return/
   Note: depending on your Windows version, you may need to right-click to paste rather than using CTRL + V
   Command 1:   cd \OpenSSL-Win32\bin
   Command 2:   openssl genrsa -out privatekey.pem 1024
   Command 3:   openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825
   After this you will be prompted for information such as your country code, state, organisation name, and email address:
   Command 4:   openssl pkcs12 -export -out public_privatekey.pfx -inkey privatekey.pem -in publickey.cer
   After this you will be prompted to enter a password. Make sure to remember the password you have supplied, as you will need it later.
   To set up the Xero app, go to https://api.xero.com and log in using Xero credentials for your account. Then, select "My Apps".Image Removed
   Complete the "Setup an application" form on the left of this page. There are some example details below:
   Application Type = "Private"
   Application Name = "accessplanit"
   Organisation = Name of target Xero organisation
   Select "Upload X509 Certificate File"
   Click Browse.
   Navigate to "C:\OpenSSL-Win32\bin" and select "publickey.cer"
   Image Removed
   Enable "Payroll API"
   Agree to terms and conditions, and click Save.
     Image RemovedOnce you’ve clicked Save you’ll be taken to a new page, on the right-side of the page you will have access to "Consumer Key", "Consumer Secret" and "API endpoint URL". Click the "Show" buttons to view each of these, and copy these values somewhere where you’ll be able to access when configuring Zynk (such as NotePad)Image Removedmyapps/
   
   
   1. Click "New App" in the top right of the page. 
   2. Add a name for your application, such as "accessplanit integration" or "Zynk integration" 
      
      Image Added
   3. In the "Company or Application URL" enter https://zynk.com
   4. Leave the "Privacy Policy URL" empty. 
   5. In the "OAuth2.0 redirect URL" enter https://zynk.com 
      
      Your form should now look like this: 
      
      Image Added
   6. Finally, click the "Create App" button. 
6. Now click the "Generate A Secret" link, once generated, you'll need to copy the "Client ID" and "Client Secret" details into your Zynk connection. 
7. To set up your Zynk - Xero connection, you'll need to have set up a Zynk workflow. There's a guide on how to do this further down this page.
   
   
8. After you've set up your workflow, select one of the Upsert Import tasks to gain access to the Xero Connection property on the right.
   
9. Click in the property and click the New button.
   
   
10. Give the connection a name such as “Xero Connection” and continue.
    Image Removed
    
    
11. Supply the Consumer Key value you copied earlier on into the Consumer Key field.
    
12. Click Browse for the Certificate File, and navigate to "C:\OpenSSL-Win32\bin\" and select "public_privatekey.pfx".Image Removed
13. Supply the password you gave for the certificate earlier in the Certificate Password fieldClient ID and Client Secret keys we copied from Xero earlier
    
    
14. To get a Refresh Token, click "Generate" after entering your Client ID and Client Secret keys.
    
    
15. Select an Organisation from the list, if none appear, click the refresh button. 
    
    
16. Click "Finish" and your connection is set up.
    
    
17. You should be able to test your workflow from there, either with a local test file or a connection to accessplanit . Make sure you have the latest version of Zynk (http://zynk.com/download/), or the updated file format we supply from our platform may not import correctly.

How to set up a Zynk Workflow for Xero

1. Within Zynk go to File and select “Import”.
   
2. Click Browse to find the Template Workflow provided by accessplanit. If you have not yet been provided with this please speak to your Implementation Manager or your Customer Success Manager).
   
3. Double Click on the Xero Workflow to open the settings for this workflow.
   
4. Click on the first HTTP Task.
   
   
5. Within the settings on the right, add the following URL. Make sure you change the ‘your system name here’ to your platform’s name and change the encrypted code. Your implementation manager will be able to provide you with this:
   
   https://yoursystemnamehere.accessplanit.com/accessplantest/services/sageintegration.asmx/GetInvoices?encrypted=1234567890123456789mode=2
   
   

   Please be careful when inputting URLs into Zynk as it will not validate what you have entered is correct.

   If you are unsure, copy and paste yourplatform’s URL up to:

   https://yoursystemnamehere.accessplanit.com/

   You will then need:      /accessplan/ or /accessplantest/
   depending on if you are using the test or live environment at this point.

   Then add:         /services/sageintegration.asmx/GetInvoices?encrypted=

   Then add the encrypted ID for your training provider which your Implementation Manager or CSM at accessplanit will provide to you, followed by

   &mode=2.
   
   

6. Select the last “HTTP Task” from your workflow task list and change options in the right panel as follows
   
   

7. Within the settings on the right, add the following URL. Make sure you change the ‘your system name here’ to your platform’s name and change the encrypted code. Your implementation manager will be able to provide you with this:https://yoursystemnamehere.accessplanit.com/accessplantest/services/sageintegration.asmx/GetInvoices?encrypted=1234567890123456789&dm=2&changeExportStatus=1&mode=2
   
   Note that if you want to keep testing the output fromaccessplanit, rather than only new customers/invoices/transactions created since the last export, you should use the following URL instead to reset the last export date:
   https://yoursystemnamehere.accessplanit.com/accessplantest/services/sageintegration.asmx/ResetLastExportTime?encrypted=1234567890123456789&dm=2&mode=2
   
   

8. Before continuing, ensure that Xero is not open on any machine, otherwise the files will be locked and the imports will fail.
   
   

9. Click Run, which will prompt you to name and save your workflow.
   

10. If you wish to save the workflow and not run it at this time, click Save.
    

11. After the workflow has been run, status messages and errors/issues can be found in the footer section on Zynk:

What information is sent to Xero from accessplanit?

There are four sets of data in the Xero XML feed

• Contact Data
• Invoice Data
• Credit Note Data
• Payment Data

Contact Data

Invoice Data

Credit Note Data

Payment Data

Troubleshooting Errors

Here are some common errors which crop up which implementing Zynk/Xero

1. No connection to Xero
   This usually means that step 7 in Guide to configuring Xero to receive Zynk data has not yet been completed. You will need to select each Upsert tasks Import task and update the Xero Connection property on the right with your Xero connection details (full instructions above).
   
   
2. XLST Compile Error
   The XLST files have not been referenced correctly. You will need to get a copy of the four standard XLST files from your key contact at accessplanit, store these on your machine in a place where they cannot be accidentally be sent to Delegates (such as in a dedicated folder in My Documents), then link each XLST task to the file using the XLST File property on the right.