Integrate with Xero using Zynk

Integrate with Xero using Zynk

 

Steps to integrate with Xero using Zynk

 


Related Help Guide Pages

Learn about what data is shared with Xero via Zynk and how to set up the integration

Connecting accessplanit with Xero using Zynk makes managing your financial data between the two systems much easier and more efficient!

Zynk helps by automatically sending important data like customer information and invoice information from accessplanit to Sage, so you don’t have to enter it manually.

While there are other ways to link Xero with accessplanit, Zynk is an off-the-shelf solution, meaning it’s ready to use without needing any custom development, saving you both time and effort.

image-20241014-145803.png

Please note

You cannot have a Sage and a Xero integration set up at the same time, if you need to switch to Xero from Sage, please contact our support desk.

Follow this page to learn the steps for integrating your finance data with Xero using Zynk.


What information is sent from accessplanit to Xero?

This section outlines what data is provided to Xero as a part of this integration option.

There are four sets of data provided to Xero via Zynk:

  • Customer (Contact) Data

  • Invoice Data

  • Credit Note Data

  • Transactions (Payments) Data

Each set of data is dependant on the last one being successful, for example you cannot integrate your transactions into Xero until you have successfully integrated your invoices!

Customer data

Customer data includes the Accounts & Users that have had Invoices generated since the last export date.

The following information is provided to Xero via Zynk for your customers:

Field in Feed

From (accessplanit)

To (Xero)

Field in Feed

From (accessplanit)

To (Xero)

Name

Account name OR

User name (forename, surname)

Contact Name

EmailAddress

Account email address OR

User email address

Primary Person > Email

AddressLine1

Account Main Address OR

User Main Address

Address > Address

City

Account Main Town OR

User Main Town

Address > City/Town

Region

Account Main County OR

User Main County

Address > State/Region

PostalCode

Account Main Postcode OR

User Main Postcode

Address > Postal/Zip Code

Country

Account Main Country OR

User Main Country

Address > Country

PhoneNumber

Main phone number (Accounts only)

 

Phone/Fax/Mobile/Direct Dial > Number

Invoice data

Invoice data includes the Invoices & Credit Notes that have been generated since the last export date

The following information is provided to Xero via Zynk for your Invoices:

Field in Feed

From (accessplanit)

To (Xero)

Field in Feed

From (accessplanit)

To (Xero)

Number

Invoice Reference

Invoice #

LineAmountTypes

Exclusive if tax is not included, Inclusive if tax is included, or NoTax

“Amounts Are” (Above the Invoice)

Date

Date Generated

Date

DueDate

Due Date

Due Date

CurrencyCode

Currency Code

Currency

Status

Always 'Authorised'

Status

Name

Contact Name

Contact

Type

AccountsReceivable OR

AccountsPayable

‘AccountsReceivable’ creates an invoice,
‘AccountsPayable’ creates a bill.
This defaults to ‘AccountsReceivable’ if not specified.

Description

Invoice line item label

Description

Quantity

Always 1 unless a placeholder has been booked

Qty

UnitAmount

Value of the invoice item net

Unit Price

TaxAmount

Value of the invoice item tax

Can be used to override the tax amount if the value calculated based on the TaxType and LineAmount is not correct

AccountCode

(this is Nominal Code in accessplanit)

Please note that the Xero integration using Zynk will only lookup the Nominal Code stored against Courses, it does not have access to the Nominal Code stored against Vouchers, Products and Services, and Discounts

Defaults to '200'

Account

Credit Note data

Credit Note data includes the Credit Notes that have been generated since the last export date.

The following information is provided to Xero via Zynk for your Credit Notes:

Field in Feed

From (accessplanit)

To (Xero)

Field in Feed

From (accessplanit)

To (Xero)

ExternalID

Credit note ID

Credit Note ID

Number

Credit note reference

Credit Note #

LineAmountTypes

Exclusive if tax is not included, Inclusive if tax is included, or NoTax

Amounts Are

Date

Date generated

Date

DueDate

Date due

Due Date

CurrencyCode

Currency code

Currency

Status

Always 'Authorised'

Status

Name

Contact Name

Contact

Description

Credit note line item label

Description

Quantity

Always 1

Qty

UnitAmount

Value of the credit note item net

Unit Price

TaxAmount

Value of the credit note item tax

Can be used to override the tax amount if the value calculated based on the TaxType and LineAmount is not correct.

Transactional data

Transaction data includes the transactions created since the last export date.

The following information is provided to Xero via Zynk for your transactions:

Field in Feed

From (accessplanit)

Field in Feed

From (accessplanit)

Date

Transaction date

Amount

Transaction amount 

Reference

Does not include external trans ID, always blank

Invoice

 

Number

Invoice Reference

Status

Always 'authorised'

Account

 

Code

 Defaults to 200

Integration Options

Here are the configurable options available for the Xero integration via Zynk:

Merge Negative Invoice Items Into Positive

For finance systems that cannot handle negative numbers, this flag rolls the value of discounts into the positive-valued items, the discount line items will be exported as (£)0. For example an Invoice containing a Course item for £100 and a Discount item for £10 would be pushed into Xero as a £90 Course and a £0 Discount.

 

Default Nominal Code

This Nominal Code will be used for any Invoice Items that are missing a Nominal Code, and for any Invoice Items that are not Courses or Products & Services, if it is empty then 200 will be provided as the Nominal Code instead for this purpose.

 

Default Transaction Nominal Code

This Nominal Code will be used for any Transactions that relate to Invoices that contain multiple Nominal Codes.

If it is empty then 970 will be provided as the Nominal Code instead for this purpose.

 


Preparing for Xero Integration

This step covers the work that needs to be completed before the integration can be set-up.

There are 4 activities to complete to prepare for setting up the Xero Integration.

  1. Complete the Xero specification form

  2. Check your data is ready for the integration

  3. Download & sign up for a trial Zynk

  4. Configure Xero to receive Zynk data

 

Before starting the integration process to connect accessplanit with your Xero account, you will have been provided with a specification form by your Customer Success Manager.

Please complete this form and contact your CSM to discuss the nature of the integration before proceeding. 

 

There are several checks to make to be sure you are ready to start integrating:

  1. Set up your Nominal Codes using Custom List Items

  2. Review the Configurable Options for the integration and work with the accessplanit team to set these

  3. Configure your Tracking Categories (if you require them)

 

 

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.

 

Top tip

If you already have a Xero account, you can skip to step 3

 

  1. Sign up for a Xero trial at https://www.xero.com/uk/signup/

    image-20241017-143432.png

  2. Once you have signed up, you’ll then need to complete a small form with your company’s information, then click on ‘Start Trial’. 

Please note

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 nominal code/bank account links.

image-20241017-144427.png

 

  1. You will then need to set up a Developer Account for Zynk at https://developer.xero.com/myapps/

    1. Click "New App" in the top right of the page. 

      image-20241017-144339.png
    2. Add a name for your application, such as "accessplanit integration" or "Zynk integration" 

    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

    6. Finally, click the "Create App" button. 

  2. Now click the "Generate A Secret" link, once generated, you'll need to copy the "Client ID" and "Client Secret" details, these will be added into your Zynk connection later.

 


Setting up the Zynk Workflow Tasks for Xero

This step covers the set up of the integration within Zynk, this is the most time-consuming and detailed step.

Your Implementation Manager or your Customer Success Manager at accessplanit will provide you with a Template Workflow to import directly into Zynk, this template has been created to save you a lot of set up time!

 

  1. Within Zynk, open the ‘File’ menu and select 'Import'

  2. Click ‘Browse’ and select 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. Move onto the next steps to configure each element of the workflow.

 

There are 10 elements to the Zynk Workflow:

  1. HTTP Task 1
    This task produces and downloads all data since last export as an XML file for the integration to reference

  2. Customers XSLT Transform
    This task takes the customer data from your accessplanit platform and converts it into the format required for Xero

  3. Upsert Contacts
    This task inserts the customer data into Xero

  4. Invoices XSLT Transform
    This task takes the invoice data from your accessplanit platform and converts it into the format required for Xero

  5. Upsert Invoices
    This task inserts the invoice data into Xero

  6. Credit Notes XSLT Transform
    This task takes the credit note data from your accessplanit platform and converts it into the format required for Xero

  7. Upsert Credit Notes
    This task inserts the credit note data into Xero

  8. Transactions XSLT Transform
    This task takes the payment data from your accessplanit platform and converts it into the format required for Xero

  9. Upsert Payments
    This task inserts the transaction data into Xero

  10. HTTP Task 2
    This task feeds back to accessplanit that the sync has completed

 

You only need to configure the two HTTP Tasks and the Xero Connection, please see each section below to learn how to configure them:

Configure the Xero Connection

  1. Click on one of the Upsert tasks

     

  2. You will now be able to access to the ‘Xero Connection’ option on the right.

  3. Click in the option and click the ‘New’ button

  4. Give the connection a name such as “Xero Connection” and continue

  5. Supply the Client ID and Client Secret keys you copied from Xero earlier

  6. To get a Refresh Token, click ‘Generate’ after entering your Client ID and Client Secret keys.

  7. Select an Organisation from the list, if none appear, click the refresh button. 

  8. Click ‘Finish’ and your connection is set up!

Configure the HTTP Tasks

  1. Click on the first HTTP Task

    image-20241018-074342.png

  2. 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 your encrypted code!:

    https://yoursystemnamehere.accessplanit.com/accessplansandbox/services/sageintegration.asmx/GetInvoices?encrypted=1234567890123456789mode=2

    image-20241018-074316.png

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

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

    https://yoursystemnamehere.accessplanit.com/

    You will then need:      /accessplan/ or /accessplansandbox/
    depending on if you are using the sandbox or live environment (you may begin with the sandbox and switch to live later!)

    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.

 

  1. Click on the last HTTP Task

    image-20241018-074159.png

  2. Change the options in the right panel as follows

    image-20241018-074124.png

  3. 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 to the same code provided in HTTP Task 1 https://yoursystemnamehere.accessplanit.com/accessplansandbox/services/sageintegration.asmx/GetInvoices?encrypted=1234567890123456789&dm=2&changeExportStatus=1&mode=2

    Note that if you want to keep testing the output from accessplanit, rather than only new customers/invoices/transactions created since the last export, you should use the following URL instead which resets the last export date so that the same invoices and customers are included each time:
    https://yoursystemnamehere.accessplanit.com/accessplansandbox/services/sageintegration.asmx/ResetLastExportTime?encrypted=1234567890123456789&dm=2&mode=2

  4. Save your Workflow

    image-20241018-074227.png


Testing & enabling your Xero integration

This step outlines how to test your Xero integration using test data in your test environments.

Once your Zynk Workflow is set up, it is time to test that it is working correctly before you enable it to run live!

Testing your Xero Integration

Testing your Xero Integration

  1. Ensure that Xero is not open on any machine, otherwise the files will be locked and the imports will fail.

  2. Check that your HTML tasks both point to your sandbox platform:
    https://yoursystemnamehere.accessplanit.com/accessplansandbox/services/sageintegration…

  3. Within your accessplanit sandbox environment, complete tests for each financial scenario that relates to your processes, this could include:

    1. A booking made through your basket where your customer pays up front (e.g. via a payment gateway)

    2. A booking made through your basket where your customer is invoiced

    3. A payment is recorded against an Invoice

    4. A payment is refunded (e.g. via a Delegate cancellation)

    5. An Invoice is credited

  4. Keep a note of the tests that have been completed, and the expected outcomes of the tests that have been completed

  5. Click Run

    image-20241017-154328.png

  6. Check the outcomes of this testing n the footer section on Zynk

    image-20241017-154407.png

Enabling your Xero Integration

  1. Update your HTML tasks to now both point to your live platform:
    https://yoursystemnamehere.accessplanit.com/accessplan/services/sageintegration…

  2. If you have been testing using Demo Company, update your Xero account to point to your live Xero account/system

  3. Check the outcome of your integration being enabled, against the finance activity in your live platform, after your Zynk integration next runs

 

 



Contact Our Team

If you can't find what you're looking for, access our Support Portal, and our team of experts will be happy to help!

Follow Us

Facebook|height=20 LinkedIn|height=20 Instagram|height=20 Twitter|height=20

Copyright © 2025 accessplanit.

Social media icons by icons8.com