Be sure that your QuickBooks Desktop software is now running and has opened your company file. Then open the generated account file in the QuickBooks Web Connector.
You should see successfully added account in Web Connector window:
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
All the tasks and their statuses will be displayed in Task tab.
|
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.
|
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.
|
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.
|
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.
|
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 from WHMCS.
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.
|
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.
|
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.
|
5. In order to Web Connector connect to your WHMCS correctly your site has to be SSL certified.
|
|