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 belowsupport@magenest.com
Created: 15/04/2016 | By: Magenest | Support Portal: http://servicedesk.izysync.com/servicedesk/customer/portal/26
| Table of Contents | ||
|---|---|---|
|
|
|
...
Introduction
...
Xero Integration extension for Magento 2 is a great tool which that allows you to synchronize accounting data automatically from Magento 2 store to Xero Website.
Extension's page: Xero Integration
Features
Features
- Sync customer data Allows synchronizing and updating Customers from Magento 2 store into to Xero both manually and automatically.Allows synchronizing and updating Products
- Sync product data from Magento 2 store into to Xero both manually and automatically.Allows synchronizing and updating Orders
- Sync order data from Magento 2 store to Xero both manually and automatically.
- Sync invoice data from Magento 2 store into Xero.Allows synchronizing and updating Invoices to Xero both manually and automatically.
- Sync Credit Memos from Magento 2 store into Xero.to Xero both manually and automatically.
- Allow admin to view the sync history log to see what is synchronized between two apps.
- Allow admin to manage the sync queue to see what will be synchronized next.
- Allow admin to request a report on the Backend of Magento 2.
- Support multiple-website
- Add to queue mass action in customer listing, product listing, order/invoice listing, and credit memo listing
- Sync to Xero mass action in customer listing, product listing, order/invoice listing, and credit memo listing
System Requirements
Your store should be running on Magento 2 Community Edition version version 2.3.x and 2.1.x.
How to create a new key
You need to copy the content of the public key to X509 Public Key Certificate field.
+ You can pick up the file content of the public key attached with our extension.
+ Or you can create a new content of public key:
4.x
...
How to create a new consumer key
Video Tutorial
| Widget Connector | ||||||
|---|---|---|---|---|---|---|
|
First, you need to create a Xero consumer key to connect from Magento 2 to Xero if you haven't got one. Go to https://www.xero.com/ and register a Xero accounts (click on "Try Xero for free" or "Free Trial").
Fill in the required information click on "Get started". If everything goes right, Xero sends you an account activation email.
When your account is activated, you can log in on the page https://login.xero.com/.
If you log in to the account for the first time, Xero will ask you to create an organization. Enter the details of your organization. Press on Start Trial, or Buy Now to continue.
Now you can create a new consumer key for Xero account. There are two types of Application Mode you can choose: Private Application Mode or Public Application Mode
For Private Application Mode
In order to create a new consumer key for private app mode, you need to have the public key first. There are two ways for you to get the public key:
You can use the public key file attached to our extension.
Or please follow the steps below to create a new one:
Go to Go to http://developer.xero.com/ > Docs > Advanced Docs > Public/private key pair > Using OpenSSL and run 3 commands to create 2 files: public key.cer and private key.pem
+ Copy and paste content file .cer into magenest/xero/etc/certs/magenest.cer
+ Copy and paste content file .pem into magenest/xero/etc/certs/magenest.pem
When you have file Xero/etc/certs/magenest.cer, copy and paste them into X509.
> 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 public key.cer, please go to 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 Private 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). After that, check . You need to copy and paste the content or upload the file Public key.cer into X509 Public Key Certificate field.
Check the information again then check on choose "I have read and agree to the Xero Developer Platform" & click Save. 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 the "Show" button to get the Consumer Key for Private App Mode.
For Public Application Mode
Navigate to https://app.xero.com/Application to create the Application for Public Mode. You just need to enter Application Name, Url of your company or product and OAuth clallback domain. Then Save button to finish.
Last, click on Show button to take Consumer Key and Consumer Secret for Public App ModeClick on "Show" button to show the Consumer Key & Consumer Secret.
...
Configuration
Set up Xero Account Informations
For this integration you will need to have an account in Xero Website.
First, 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, go to https://login.xero.com/ and login with your account.
At My Applications tab
Copy and paste Consumer Key & Consumer Secret from above into Magento 2 backend configuration like in the picture.
Go to Store > Configuration or Xero Integration > Configuration:
At My Applications tab
Taking Consumer Key that you have just created above and paste into Magento 2 backend configuration. Press Save Config after you've done (refresh the cache if needed). Then, click on Connect Private App Now button for private application mode or Connect Public App Now button for public application mode.
| Note | ||
|---|---|---|
| ||
You need to save config before connecting, this will help you avoid making errors. |
Setting My Applications in Configuration of your Magento 2 store will base on their app mode types.
Private App Mode:
If you choose Private mode, you will have to enter the content of Private Key(.pem) and Public Key(.cer) beside Consumer Key
Public App Mode:
If you choose Public mode, it will require both Consumer Secret and Consumer Key. The expiration for each connection time is 30 minutes. After that, you need to reconnect Magento 2 store to your Xero account.
When Magento 2 store is connected with your Xero account successfully, connection status will be transferred from not connected to connected as below:
At Configure the Accounts Types in Xero tab
The system will take four account types in the chart of account: Bank account, Sale account, Inventory account, Cost and Good Sold account from Xero account into Magento 2 store. Enter the name you would like to use for each account then click on Add all Data to Queue. The default Xero account name will be used if you do not change it. If there is no account on Xero site, the extension will automatically create a new one.
Multiple Website: Enable multiple website synchronization. Note that data will be synced to separated Xero account corresponding to "Store Views - Websites" configuration.
You can check changes to accounts on Xero's website.
Set up Synchronization
Admins are able to choose which type of data to sync from Magento 2 to Xero: Customers, Products(Items in Xero), Orders, Invoices, Credit Memos. In addition, admins can choose the way to synchronize data Immediately use Cron Job. Admins can also Add All data To Queue or add individual data group queue for synchronizing.
| Tip | ||
|---|---|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
At the end of Configuration, admins can quickly navigate to the online documentation as well as support portal for Xero Integration extension:
Payment Mapping
You can map the order payment method with the Xero bank account in Xero Integration > Payment Mapping
- Update Bank Accounts
- Choose the Xero bank account field to map
- Save Mapping
Tax Mapping
Go to Xero Integration > Taxes Mapping
- UpdateTax rates
- Choose the tax field in Xero Tax
- Save Mapping
Add Data to Queue/ Sync instantly to Xero
In customer listing, product listing, order/invoice listing and credit memo listing, you can add data to queue for later processing as mass action.
You can select the data you want to add to queue then choose Actions > Add to queue
You can also sync the selected data instantly to Xero by choosing Actions > Sync to Xero
Process Synchronization
If the App mode is Cron Job, data will be added to the Queue List to be sync after a specific interval. On the Queue List tab, admin can preven any data from being synced by removing them from the Queue list. Admin can also use click on Sync Now to syncall data on the queue list immediately.
Note that syncing time will vary, depending on the size of database.
When the process is completed, go to Xero Integration > View Log to check what has been synced.
- If the data has been synced successfully, the Status will be success
Press Save Config after you've done (refresh the cache if needed).
Click on Connect Now button.
At Configure the Accounts Types in Xero tab
Synchronization Settings
| Note |
|---|
How to distinguish between Immediately mode and Cron Job mode.
Immediately mode seems better than Cron Job mode, but some application mode like private mode only allows 1000 requests a day. So choosing Cron Job will guarantee all data will be synced. Unless you're a partner to Xero and have a special Application, we suggest you should choose Cron Job mode. |
We placed the "Add All Data To Queue" button in the configuration. Admins can easily add all data to Queue within a click.
When the process is done, you can check what is synced in the Reports/Xero Integration/View logs.
- If the data is synced right, the Status will be set to 1 and the Message will be "OK"
- If there's a problem during the syncing process, the Status will be set to 2 error and the Message will contain the Error (like in the 10th record) below.
If you wish to sync data right away, you can press Sync Now button.
Process Synchronization
Note that synchronizing will take some time, the length of time depends on the size of database.
- If the App mode is Cron Job, this is where the created, updated data is stored and are waiting to be synced.
- tab will show the error message
Admin can easily check the synchronization log for the day by clicking on View Request Daily or view individual sync log by clicking on View on Xero
Navigate to Xero Integration > Request Daily Report, admins can easily see their synchronization status.
You can also view the xml data that is synced to Xero. This helps you debug easily in case there is a bug.
...
Main Functions
Video Demonstration
| Widget Connector | ||||||
|---|---|---|---|---|---|---|
|
Main Functions
When a new account is registered
inon the frontend of Magento 2, Xero Integration extension will automatically add a new record
of this account on Xero site. 
Or you can click on Sync Now button within each customer info dashboard to synchronize a specific customer data manually.
- Whenever admins create a new order, invoice, and product or edit them on Magento 2 store successfully, The When admins save information of orders (or products, invoices), the data will be synced automatically to Xero automatically.
- Orders
Admins can synchronize a specific order by manually by clicking on Sync Now button on each order.
- Products
- Invoices
- Products
* Note: The products name must be less than or equal to 50 characters otherwhile it would be cut off to fit in since Xero only allows maximum 50 characters in product name.
In addition, the products SKU must be less than or equal to 30 characters otherwhile it can't be synced to Xero since Xero only allows maximum 30 characters in product SKU.
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.
...
Troubleshooting
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: Item code 'shipping' is not valid
=> Please disconnect and re-connect your Xero account in Xero Integration -> Configuration.
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: Item code 'demo-product' is not valid
=> Please sync related items first, then re-sync the order/invoice or turn on setting “Sync Needed Data”
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: An existing contact could not be found using the specified contact details. The contact name field is required to create a new contact.
=> Please sync related customer first, then re-sync the order/invoice or turn on setting “Sync Needed Data”
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: Organisation is not subscribed to currency
=> Please check your Xero currency and your order currency, make sure that your Xero account support the order currency
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: The specified bank account details does not match a known bank account.
=> Please check your Xero bank account and make sure it is correctly configured in Xero integration configuration.
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: Invoice could not be found
=> Please check invoice error with above errors and then re-sync the order/invoice first
- ERROR MESSAGE: A validation exception occurred; ERROR DETAIL: Invoice not of valid status for modification, This document cannot be edited as it has a payment or credit note allocated to it.
=> This invoice in Xero is already in the status that does not allow to modify anymore.
...
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 within 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