Personal tools
Namespaces

Variants
Actions

QuickBooks Desktop For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Cron Jobs)
(→‎About QuickBooks Desktop For WHMCS)
Line 8: Line 8:
 
*'''Module Features:'''
 
*'''Module Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 10px 0px 0px 30px;"|✔ Export Manually:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ Clients
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 45px;"|✔ Invoices And Transactions
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+
|style="padding: 0px 0px 0px 45px;"|✔ Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Export Automatically:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Clients
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Invoices
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Transactions
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Invoices Refunds
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Invoices Merge
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Import Synchronization:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Clients
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Invoices
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Transactions
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Manage Relations:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Clients With Automatching
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Custom Client Field
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Products With Automatching
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Invoices With Automatching
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Tax Rules
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Currencies With Payment Deposits
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Default Product Item
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Default Domain Item
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Default Account For Products
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Tax Zero-Rated
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Home Currency
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Automatic Export Settings
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Export And Cron Run Summary
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Web Connector Task
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ View Logs
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Set Web Connector Account
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
Line 24: Line 111:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 0px 30px;"|✔ Refunds Support
 
|}
 
|}
 
{|
 
{|
Line 30: Line 117:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V5 and V6
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.3 Up To PHP 7
 
|}
 
|}
−
*'''Requirements:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔  
+
|style="padding: 0px 0px 10px 30px;"|✔ Supports WHMCS V6 and V7
 
|}
 
|}
 +
*'''Requirements:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ PHP 5.3
+
|style="padding: 10px 0px 0px 30px;"|✔ QuickBooks Desktop
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔
+
|style="padding: 0px 0px 30px 30px;"|✔ QuickBooks Web Connector
 
|}
 
|}
  

Revision as of 17:30, 1 February 2017

Contents

About QuickBooks Desktop For WHMCS

QuickBooks Desktop For WHMCS module allows integration between the two systems and helps you improve your accounting management.

This module synchronizes the clients, invoices and transactions details gathered in your WHMCS with QuickBooks database.
You can integrate the data either manually or automatically using cron job. It is also possible to preview all information on exported data thanks to logs.

  • Module Features:
✔ Export Manually:
✔ Clients
✔ Invoices And Transactions
✔ Products
✔ Export Automatically:
✔ Clients
✔ Invoices
✔ Transactions
✔ Products
✔ Invoices Refunds
✔ Invoices Merge
✔ Import Synchronization:
✔ Clients
✔ Invoices
✔ Transactions
✔ Products
✔ Manage Relations:
✔ Clients With Automatching
✔ Custom Client Field
✔ Products With Automatching
✔ Invoices With Automatching
✔ Tax Rules
✔ Currencies With Payment Deposits
✔ Define Default Product Item
✔ Define Default Domain Item
✔ Define Default Account For Products
✔ Define Tax Zero-Rated
✔ Define Home Currency
✔ Define Automatic Export Settings
✔ View Export And Cron Run Summary
✔ View Web Connector Task
✔ View Logs
✔ Set Web Connector Account
  • General Info:
✔ Multi-Currency Support
✔ Refunds Support
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS V6 and V7
  • Requirements:
✔ QuickBooks Desktop
✔ QuickBooks Web Connector

Installation

This tutorial will show you how to successfully install and configure QuickBooks Desktop For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to your client area and download QuickBooks Desktop For WHMCS.
QBD 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like on the following screen.

QBD 2.png
3. When you install QuickBooks Desktop for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/QuickBooks_Desktop/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

QBD 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products'.

QBD 4.png
5. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules' . Afterwards, find 'QuickBooks Desktop' and press 'Activate' button.

QBD 5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, check required group of administrators and press 'Save Changes'.

QBD 6.png
7. You have just successfully installed QuickBooks Desktop For WHMCS!

You can access your module under 'Addons' → 'QuickBooks Desktop'.

Configuration and Management

QuickBooks Desktop For WHMCS is a module which allows you to export any data on clients, invoices and transactions directly to QuickBooks Desktop.

Configuration

1. To configure your module properly, first you have to add new account.

To do so proceed to 'Addons' → 'QuickBooks Desktop' → 'Settings' → 'Accounts'.

QBD 12.png
In order to use the module fully, your account will be linked to Web Connector, a tool allowing integration beetween your WHMCS system and QuickBooks Desktop.

Provide the necessary information. You can also define when the data will be synchronized automatically.

QBD 13.png
Your account should appear on the list. It can be switched on/off, edited or deleted. For the proper configuration, you need to download the file for Web Connector now, as shown below.
QBD 14.png
Open the file in the QuickBooks Web Connector.
You should see Web Connector window.

You have successfully added your account!

QBD 16.png
2. To use the module properly, remember to set the relations correctly.

It is possible to manually declare relations between WHMCS clients, products as well as invoices and corresponding to them QuickBooks Desktop elements.
This feature is especially helpful when you need to avoid confusion and misunderstandings.
Please note that this is an extra option, which gives the possibility to manually configure relations.

Relation: Clients

The first possible relations to be declared are relations between WHMCS clients and QuickBooks customers.

Proceed to 'Relation' → 'Clients,' you will find there a list of all clients, with their email addresses, that exist in WHMCS,
those who have not been exported to QuickBooks Desktop yet as well as those already exported.
This functionality is especially helpful when one of your clients has more than one account in WHMCS, but you do not want to double accounts in QuickBooks Desktop.
Then you can simply assign such client to an already existing customer in QuickBooks Desktop.

QBD 23.png

Relation: Custom Client Fields

When you go to 'Relation' → Custom Client Fields' , you will find a list of fields which appear in the client profile.
QBD 24.png

Relation: Products

Products relations can be declared manually and for each product separately along with those declared in 'Configuration' → 'Synchronization Settings.' '

Proceed to 'Relation' → 'Products,' you will find there a list of all products with their type and payment standard.
In the last column there is a dropdown menu with all QuickBooks Desktop items that can be assigned to exported products.

QBD 25.png

Relation: Invoices

In 'Relation' → 'Invoices' directory, you will find a list of all WHMCS invoices with their ID, date of creation, assigned client, total sum on it and status.

It is possible to assign such WHMCS invoice to another invoice already exported to QuickBooks Desktop. Just choose such from dropdown menu and save changes.
Transactions between the two invoices will be synchronized then.

QBD 27.png

Relation: Tax Rules

In 'Relation' → 'Tax Rules' directory, you will find a list of defined taxes rules.
Assign each rule to a specific QuickBooks tax. Select one from a dropdown menu and save changes.
QBD 28.png

Relation: Currencies

In 'Relation' → 'Currencies' directory, you will find a list of defined currencies.
Assign each currency to a specific one from QuickBooks Desktop. Select one from a dropdown menu and save changes.
QBD 26.png
3. Synchronization Settings - decide which of the possible synchronization options you want to enable.

Tick the ones you are interested in.

There are:

Clients synchronization:

  • Create - done on client's creation
  • Update - takes place when client account has been updated
  • Delete - takes place when client has been deleted

Invoices synchronization:

  • Create - done on invoice creation
  • Update - takes place when an invoice has been updated or altered
  • Delete - takes place when an invoice has been deleted

Payments synchronization:

  • Create - done when a transaction has been completed
  • Delete - takes place when a transaction has been deleted by an admin

Refunds synchronization:

  • Create - done when a refund has been completed
  • Delete - takes place when a refund has been deleted by an admin
    Please note that both payments and refunds are handled together and in dashboard are summarized as one point called 'Payments'

Products synchronization:

  • Create - done on product creation
  • Update - takes place when a product has been updated or altered
  • Delete - takes place when a product has been deleted

Query synchronization:

  • Invoices Query - done before invoice creation
  • Payments Query - takes place before payment creation
Apart from choosing required synchronization options, you have to decide here, which items from QuickBooks Desktop, 'Products ' and 'Domains' will be associated with.
Note: Default Product will be used only when tehre is no relation set for the selected product in 'Relation: Product' section.

Choose other options from the dropdown menu to set up.

  • Tax Zero-Rated - used when charged item is not taxed
  • Shorten the Transaction ID - select this option to cut every payment Transaction ID that is longer than 21 characters.
  • Define your Home Currency

Press Save Changes button.

You can also set the default task that will be run automatically.
QBD 17.png
All the tasks and their statuses will be displayed in Task tab.
QBD 18.png

Management

At this section we will show you the possibilities of QuickBooks Desktop For WHMCS.

Once it has been properly connected with QuickBooks Desktop and all the configuration is now ready, we can move on to 'Export' section.

Export

Our module allows several ways to export any data gathered in your WHMCS.

Read the below points to learn what data can be synchronized with QuickBooks Desktop and what are the possible means of such synchronizations.

Clients

The first option offered by our module is the export of clients from WHMCS to QuickBooks Desktop, proceed to 'Export' → 'Clients.' You will see here a list of all clients who exist in your WHMCS and have not been synchronized with QuickBooks yet.
Use filter to find clients with their account created during the specified period of time.
QBD 19.png
Now, you can manually export all of the clients available on the list or choose only some of them.
Check boxes next to the clients you are going to export and press 'Export' button as marked on the screen.
If you want to export only one client you can do it by pressing 'Export' button located in 'Action' column next to the name of the client.
QBD 20.png
If a client has already been exported from WHMCS to QuickBooks, they will no longer be visible on the list.
All clients newly added to WHMCS will be automatically synchronized with QuickBooks unless otherwise stated in 'Synchronization Settings.'

Invoices

The other choice is the export of invoices.
Proceed to 'Export' → 'Invoices' and you will find a list of all invoices existing in our WHMCS that have not been synchronized with QuickBooks yet.
In details you will find information on the invoice:
  • ID
  • date when it was created
  • client assigned to the invoice
  • items on the invoice
  • its status
  • a total sum.
Just like in case of clients:
  • press 'Toggle Filters' to use filter to find invoices from specified period if time
  • perform mass export of all checked invoices
  • export individual invoices to QuickBooks.
    Use buttons marked on the screen to perform the above enumerated actions.
QBD 21.png
Once you have exported some of the invoices you will see their number along with the number of any transactions connected with them in 'Summary' table on the dashboard.
QBD 22.png
Keep in mind that all newly added (after the first usage of QuickBooks For WHMCS) invoices and transactions are automatically synchronized and exported to QuickBooks Desktop
unless otherwise stated in 'Synchronization Settings.'

Cron Jobs

Properly set up cron job with a recommended interval is responsible for synchronization of any updates done on invoices or clients' accounts.

All changes will be immediately visible in QuickBooks Desktop, after cron job has run, without any additional actions taken manually from QuickBooks Desktop For WHMCS.
Whenever you commit changes in your WHMCS system, running a cron job is not needed, as all the information will be automatically retrieved.

It is recommended to run cron job every six hour in order to synchronize the data between QuickBooks Desktop and WHMCS.
To do so use the 'php -q /var/www/whmcs/modules/addons/QuickBooksDesktop/cron/cron.php' cron with the following arguments: '--syncClients --syncInvoices --syncPayments --syncProducts'.

In order to import new clients, invoices or products from QuickBooks Desktop to your WHMCS, run the 'php -q /var/www/whmcs/modules/addons/QuickBooksDesktop/cron/cron.php' cron
with the following arguments: '--importClients --importInvoices --importPayments --importProducts' once a day.

Logs

In 'Logs' tab there are enumerated ALL actions on clients, invoices and transactions.
No matter if they were taken manually in the module, automatically or by a cron job.
Find there a list of all entries with precisely described details and an exact date of the action.
QBD 29.png
Clear all the entries or delete only some of them. Use buttons marked on the screen above.

Dashboard

'Dashboard' includes two useful and user-friendly tables.

The first one, 'Export Summary' contains data on the number of exported clients, invoices and payments.
The number includes exports done in all possible manners.
The second table shows information about the number of tasks performed including their statuses.

QBD 30.png

Documentation

The very last tab 'Documentation' once clicked will redirect you to the article you are currently reading!

Tips

1. Please note that QuickBooks Desktop supports the services of One Time type only. Other billing cycles cannot be added.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. It may happen that taxes are counted incorrectly for invoices with multiple items where part of the items is taxed and some are not. Please, be careful!
3. In case you encounter any issues with installation and configuration please make sure you have php7.0-mcrypt and php7.0-soap installed.

Without that the module will not work properly.

4. When .htaccess is enabled the module may not work due to the lack of connection between QuickBooks Web Connector and WHMCS system.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=QuickBooks_Desktop_For_WHMCS&oldid=29307"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community
QuickBooks Desktop For WHMCS