Thank you for purchasing our extension. If you have any questions that are beyond the scope of this document, do not hesitate to leave us an email via our email address below.

Created: 15/11/2016 | By: Magenest | Support Portal: http://servicedesk.izysync.com/servicedesk/customer/portal/26 

Introduction

Xero Integration extension for Magento 2 is a great tool which allows you to synchronize accounting data automatically from Magento 2 store to Xero Website. 

Extension's page: Xero Integration

Features

• Allows synchronizing and updating a specific or all Customers from Magento 2 store to Xero both manually and automatically. 
• Allows synchronizing and updating a specific or all Products from Magento 2 store to Xero both manually and automatically. 
• Allows synchronizing a specific or all Orders from Magento 2 store to Xero both manually and automatically.
• Allows synchronizing a specific or all Invoices from Magento 2 store to Xero both manually and automatically.
• Allows synchronizing Credit Memos from Magento 2 store to Xero both manually and automatically. 
• Allow admin to view the log to see what is synchronized between two apps. 
• Allow admin to manage the sync queue to see what will be synchronized next. 
• Allow admins to follow the request report on Backend of Magento 2. 

System Requirements

Your store should be running on Magento 2 Community Edition version 2.0.x or 2.1.x. 

How to create a new consumer key 

It is necessary to create a new consumer key for the connection between Magento 2 and Xero. 

First of all, go to https://www.xero.com/ and register an Xero accounts (click on "Try xero for free" or "Free Trial"). If you already have an account, you can skip this step. 

Fill in the form the information of your Organization and press "Get started". If everything is right, Xero will inform you to check your email and activate your account. 

When your account is activated, you can login on the page https://login.xero.com/. 

If you log in the account for the first time, Xero will ask you to create an organization. Enter the name of your organization and choose other information. Press on Start Trial, or Buy Now to continue. 

Now you can create a new consumer key after login your Xero account. 

In order to create a new consumer key, you need to have the public key first. There are two ways for you to get the public key: 

 You can pick up the file content of the public key attached with our extension.  

 Or please follow the steps below to create a new one: 

Go to http://developer.xero.com/ > Docs then search with Create a public/private key pair

Create a public/private key pair page appears as below. Follow the user guide of Xero to get 2 file: public key.cer and private key.pem. 

When you have file Xero/etc/certs/magenest.cer, copy and paste them into X509. 

You will see the Xero accounting interface after you've done the last step but now we need to continue our setup, go to this site: https://app.xero.com/Application to create the Application.

Choose the application mode (usually is Private), application name (the name for the application is not very important), choose your organization (this is where the Magento 2 data will be synced into).

Check the information again then choose "I have read and agree to the Xero Developer Platform". After that click Save button. 

If everything goes right, you will see the following content. By now we have done everything on the Xero site, now move to your magento 2 backend but don't close this site. 

Click on "Show" button to get the Consumer Key. 

Configuration

Set up Xero Account Informations 

Go to Store > Configuration or Xero Integration > Configuration: 

Set up Synchronization 

Admins are able to decide whether to synchronize data in Synchronization Settings tab: Customers, Products(Items in Xero), Orders, Invoices, Credit Memos. In addition, admins can choose the way to synchronize data between Immediately mode and Cron Job mode.  Admins can click on Add All Customers To Queue button to add all existed customer data to queue. It is the same with Products(Item in Xero), Orders, Invoices, Credit Memos tab.  

At the end of Configuration, admins can use "Add All Data To Queue" button to add all existed data to Queue, including Customers, Products, Orders, Invoices, Credit Memos. 

Process Synchronization 

If the App mode is Cron Job, Queue page is the place which the created, updated data is stored in and are waiting to be synced. If you wish to sync data right away, you can press Sync Now button. 

Note that synchronizing will take some time, the length of time depends on the size of database. 

When the process is done, go to Xero Integration > View Log check what is synced in the grid.

• If the data is synced right, the Status will be success and the Message will be "OK"
• If there's a problem during syncing process, the Status will be error and the Message tab will show the error message like the record below. 

Moreover, admin can easily check the synchronization with View Request Daily button and View On Xero button. 

Navigate to Xero Integration > Request Daily Report, admins can easily follow their sychronization status.  

• Whenever admin creat a new order, invoice, and product or edit them on Magento 2 store successfully. The data will be synced to Xero automatically. 
  
  
  • Orders

Admins can synchronize a specific order by manually, click on Sync Now button on each order.  

• Products

For each product, this extension created Xero Integration tab that allows admins to synchronize a specific product to Xero. 

• Invoices + Credit Memos: 

Synchronizing a specific data is the same with Invoice. 

Update

• When a new update is available, we will provide you with a new package containing our updated extension.
• You will have to delete the module directory and repeat the installing steps above.
• Flush the config cache. Your store and newly installed module should be working as expected.

Support

• We will reply to support requests after 2 business days.
• We will offer lifetime free update and 6 months free support for all of our paid products. Support includes answering questions related to our products, bug/error fixing to make sure our products fit well in your site exactly like our demo.
• Support DOES NOT include other series such as customizing our products, installation and uninstallation service.

Once again, thank you for purchasing our extension. If you have any questions relating to this extension, please do not hesitate to contact us for support.

Magenest