Installation & Upgrade Instructions

Installing the module is a straightforward process, simply follow the steps below and feel free to contact us if you need any help.

 

  1. Download the module from https://my.edgehosting.uk/downloads.php

  2. Extract the zip in your WHMCS root directory.

  3. In WHMCS, go to Setup > Addon Modules and activate the module, making sure you grant access to your user role.

  4. Enter your License Key and Company ID provided in your welcome email into the relevant fields.

  5. Copy the displayed Xero Redirect URI from WHMCS then visit https://developer.xero.com/myapps. Click New app and complete the form as per the below:




  6. Click Create app then enter the provided Client ID and Client Secret into WHMCS.

  7. Now you can connect the module to Xero by pressing "Connect to Xero" at Addons > Xero and enter configuration options by going to Addons > Xero > Configuration. When done, press Synchronise All to check that everything is working correctly. 

  8. See this article for help with linking WHMCS payments to Xero.


Note that enabling the Contact sync option matches WHMCS contacts with Xero by (Billing) Company Name followed by Contact Name if no Company Name is set. This will replace contact data in Xero - please do not archive WHMCS linked contacts!


Upgrading

Upgrading to a new release is a simple as extracting the new version's files into your WHMCS root directory, allowing all files to be replaced.


Upgrading from v3 to v4

Xero have deprecated the usage of OAuth 1.0a (which required the generation of a certificate file that was stored on the server and also uploaded to Xero).

When upgrading from v3 to v4 of our module, you will need to create a new App in Xero and re-connect the module to your account. Simply follow the installation instructions above from step 5 onwards. Other than the Xero ID and Secret, there will be configuration to change.

If you have a custom-hook.php file in your module folder, you will need to add the line below to the top of that file:

<?php
namespace EdgeHosting;


Security

Please ensure that when using a web server other than Apache, you replicate the restrictions in the `modules/addons/xero/.htaccess` file.

  • 16 Users Found This Useful
Was this answer helpful?

Related Articles

Custom Contact Link

You can create a custom link to allow you to click from your Xero contact to WHMCS.To do this,...

Setting up the Cron Job

By default, you can enable the sync to take place automatically when the WHMCS daily cron job...

Setting up WHMCS Payment Sync

For invoices to be automatically marked as paid in Xero, you must specify Payment Gateway...

Common Sync Errors

Below you can find a list of common errors, their causes, and steps to resolve: Contacts Sync...

FAQ

Q. How do I find my 'Next Transaction ID'? A. In WHMCS, go to 'Billing' -> 'Transaction...