Install & Upgrade Instructions

Installation Instructions

Check your Database Password!

Ensure mysqli is installed and your database password does not contain the following special characters (all others are compatible) + / # % ‘ ?

  1. Backup your WHMCS files & database as well as your QuickBooks Online Data. This module has been fully tested but nothing is more important than the safety of your data!
  2. Ensure your system requirements meet the needs of our module: PHP 5.3+, mysqli, mcrypt and oauth. You will see module / installation errors if any of those PHP extensions are not installed.
  3. Upload the contents of the whmcs_root folder to the root of your WHMCS folder. Only the quickbooks_sync folder will be added to your modules/addons folder – no files will be overwritten.
  4. Go to the Setup -> Addon Modules panel in your admin & activate the MyWorks WHMCS QuickBooks Online Automatic Sync Module.
  5. Enter your License key, and check the rest of the module configuration options, ensure Sandbox is OFF, and choose the WHMCS admin user with all privileges. Click Save.
  6. Then go to Addons > MyWorks QuickBooks Sync > Settings  > QBO Connection
    1. Click the button to Connect to Intuit, and login on the popup window that results. Continue to Authorize until the process is finished and you see the green Connected text. You are now connected!
  7. Go to the Settings & Logs > Cron Setup menu and setup the background data cron – we recommend it’s run once every day – one hour before your WHMCS daily automation actions are set to run (in Setup > Automation Settings). This cron fetches and updates QBO & WHMCS background data – it doesn’t actually sync anything.
  8. Click the Refresh Data button in the menu bar to run the cron for the first time.
  9. Visit every item in the Map menu to set all of your mappings to ensure that data is being pushed accurately over to QuickBooks Online. Use the Auto-Map Clients button to auto-match existing WHMCS clients to existing QBO clients – if the names match, they will be matched automatically. All future clients created will be automatically matched.
  10. Now, go to Setup -> Addon Modules -> WHMCS QuickBooks Online Module > Configure. Choose the default products for product syncing, select any other options you’d like and hit save.
  11. If you have any issues first getting the module to work, don’t forget to check out the Logs page in our menu bar – it will show you any errors present.
  12. Setup is now complete! If you wish to manually push over Invoices, Clients, Payments or Products to QBO, you can do this under the Push and Pull menus.

Upgrade Instructions

  1. Check our changelog to familiarize yourself with the new module features and make yourself aware of any special upgrade instructions needed.
  2. Upload the latest quickbooks_sync folder to replace the one in modules/addons
  3. Visit your Setup > Addon Modules page.
  4. Click Configure for the MyWorks WHMCS QuickBooks Automatic Sync module, configure any new options and click Save.
  5. Go to Addons > MyWorks QuickBooks and manually run the cron.
  6. Ensure all your mappings are set under the Configure Mappings menu.
  7. That’s it!
Updated on August 17, 2017

Was this article helpful?