The module will let you manage the integration of your clients details, invoices and transactions into QuickBooks database.
Data can be synchronized manually as well as automatically with the use of cron job. Thanks to logs you will be able to preview all information on exported data.

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

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

The content of the package to upload should look like this.

The file is located in 'modules/addons/QuickBooks/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

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

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

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

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

1. Log in to: https://developer.intuit.com/

Use your QuickBooks account details to sign in.

• Fill out domain and applicable URLs in 'App URLs' section.
• Categorize your application
• Tell about regulated industries that use your application
• Define the country where your app is hosted
  

Save the changes when all data is provided.

Only once ready you will get access to your Keys & Credentials section.

https://yourdomain.com/admin/addonmodules.php?quickBooksCallbackOauth2

Note that your 'admin' folder might have a different name than the default one. The provided URL also has to start with https:// .
You will find the already customized address in your module configuration.
Keep in mind that the presented URLs are only exemplary and you need to use the details provided in your QuickBooks Online panel.
The Launch URL and Disconnect URL fields are optional since the module does not use them.
Note that your application data need to be complete to make it work on the production mode.
In this section, you will also find:

• Client ID
• Client Secret

These keys are very important, you will need them in the very next step of the module configuration. Please keep them safe.

Here you will have to generate a token that will be used to enable Webhooks for synchronization.

First of all, provide a valid Endpoint URL to the 'webhooks.php' file. That is what such a URL may look like. Please remove 'yourdomain.com' and insert your actual address.

https://yourdomain.com/modules/addons/QuickBooks/webhooks.php

Note: The provided URL has to start with https:// .

Then select the required events that will be triggered.

It will be necessary during the module configuration.

Currently, your 'Connection Status' is 'Not Connected'. In order to establish a connection with QuickBooks Online, press the connection button:

It will allow the module to authenticate your identity in QuickBooks system and let your WHMCS connect with it.
These are your QuickBooks keys that you have generated in the previous step:

• Client ID
• Client Secret
• Sandbox - if you have used 'Production' to generate 'Keys,' unmark this checkbox.

From now on, you will be able to use your QuickBooks Online For WHMCS module.

Use the token generated as explained in steps 7 and 8 in the API Keys section.
Keep in mind that you must use an adequate token. 'Development' Webhooks - when sandbox is used and 'Production' Webhooks token when used in the live environment.

• The first cron job is run only once. It exports all clients, invoices, and transactions to QuickBooks as soon as our module is activated in your WHMCS.
  You may also modify this cron command and export clients and invoices from a selected time range. The cron line will look like the one below:

  php -q modules/addons/QuickBooks/cron/synchronization.php --export --invoices-from=

for example:

 php -q modules/addons/QuickBooks/cron/synchronization.php --export --invoices-from=2018-01-01

In the above case, clients with their invoices since 01.01.2018 will be exported to QuickBooks.

• The second cron is optional to run - it will check if there are any invoices in QuickBooks panel that were manually paid.
  If yes, the relevant transactions will be also added to the corresponding invoices in WHMCS and thus they will also be automatically marked as paid.
  

Note: Please refer to the Tips section to learn how to import the QuickBooks clients, invoices, and their transactions into the WHMCS system using the CLI cron job commands.

If the connection with QuickBooks has been set up properly, currency details will be visible.

• View Home Currency
• MultiCurrency status
  

The above data are synchronized with your QuickBooks account.

Simply tick the ones you are interested in.

Clients synchronization:

• Create - performed on the client's creation
• Update - takes place when the client account has been updated
• Synchronize Client Statuses - when selected, the client status in QuickBooks will be automatically changed to the corresponding one after that has been changed in WHMCS

Invoices synchronization:

• Create - performed on invoice creation
• Update - takes place when an invoice has been updated or altered
• Delete - takes place when an invoice has been deleted
• Delete Cancelled - tick to remove the already canceled WHMCS invoices from QuickBooks Online
• Add Funds Invoice - if checked, the synchronization of 'Add Funds' (Add Credit) invoices will be disabled
• Zero Invoice - if checked, the synchronization for invoices that amount to 0 will be disabled
• Prevent Duplication - this option will block the attempt to send the WHMCS invoice to QuickBooks if the same invoice ID already exists in the QuickBooks Online panel.
  This option should not be used in case there are more than one WHMCS or other systems synchronized with the single QuickBooks Online account as well as the 'Synchronize Invoice Number' option cannot be selected.
• Synchronize Invoice Number - before assigning the next subsequent WHMCS invoice number, the module will first export that invoice to QuickBooks, where the subsequent invoice number will be generated by QuickBooks itself.
  This number will be then assigned as the subsequent number to the WHMCS invoice. To use this invoice synchronization with QuickBooks, the 'Custom transaction numbers ' option located in 'Settings' → 'Sales' of QuickBooks Online configuration panel must be disabled.
  Moreover, this option also cannot be used along with the 'Prevent Duplication' feature of module configuration. Thanks to this feature you can also use the module along with more than one WHMCS or other systems synchronized with the single QuickBooks Online account.

Payments synchronization:

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

Refunds synchronization:

• Create - performed 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 are displayed as one point on the dashboard called 'Payments'

Credit synchronization:

• Create - performed when the invoice credit has been created
• Update - synchronization is performed when the credit is updated via the "Manage Credits" option
• Delete - synchronization when the credit is deleted via the "Manage Credits" option
• Negative Amount - synchronization of negative amount of credits
• Add - synchronization when the credit is added to the invoice
• Remove - synchronization when the credit is removed from the invoice
• Create Payment - a payment to deposit is created in QuickBooks when the invoice credit is created
• Delete Payment - the payment to deposit is deleted from QuickBooks when the invoice credit is deleted in the admin area

Choose other options from the dropdown menu to set up.

• Tax Zero-Rated - used when a charged item is not taxed
• Tax Type:
  • Exclusive - tax is added to the price
  • Inclusive 0 - price includes the tax
  • Out of scope of GTS
    Note: Keep in mind that by default there is a WHMCS tax type pre-selected.
• Client Display Name Format - use available tag fields to adjust the displayed name view.
• Customer Tax ID Custom Field - select the custom field with Tax ID value, it will be synchronized with the QuickBooks "Tax Registration Number" field
• Gateway Fee Account - define the relation between WHMCS transaction fees and the QuickBooks deposit account. For more info on bank deposit configuration please refer to this article.
• Fee Gateways - Select single gateways that will be excluded from transaction fees. If a client pays with a payment gateway other than chosen here, transaction fees will be added to the account selected in the above-mentioned Gateway Fee Account.
  Leave this field blank to enable fee deposits for all gateways.
• Shorten Transaction ID - select this option to cut every payment Transaction ID that is longer than 21 characters (limit of signs allowed by QuickBooks Online).
  In case the transaction ID in WHMCS is longer, it will be cut to allow successful export of such transaction.
• Debug Mode - if selected, logs will be stored in the ' Module Log' section

Note: If you want to enable these notifications you also have to set up the following additional cron job runs hourly or daily depending on the chosen 'Time' option:

php -q /your_whmcs/modules/addons/QuickBooks/cron/cron.php --failureNotifications

Remember to 'Save Changes' when your configuration is ready.

Once the module has been properly connected with QuickBooks and the entire configuration is complete, we can move on to the 'Export' section.

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

• ID
• date when it was created
• client assigned to the invoice
• items on the invoice
• status
• a total sum.

• press 'Toggle Filters' to use the filter to find invoices from the specified period of 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.

Note: Only transactions with already exported invoices are on the list of available to export.

• ID
• Client assigned
• Date when it was created
• Payment Method
• Description
• Amount In and Out
• Fee

• 'Toggle Filters' to use filter to find transactions from the specified period if time
• perform mass export of all checked transactions
• export individual transactions to QuickBooks.

• ID
• Amount
• User First and Last name
• Company name
• Date of creating
• Associated currency

• 'Toggle Filters' to use filter to find transactions from the specified period of time
• perform mass export of all checked transactions
• export individual transactions to QuickBooks.

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 configure relations either manually or automatically.

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 yet as well as those already exported.

• Update Record - this button can be used to update a relation manually. If the item has been changed in the QuickBooks Online panel, but that change has not been reflected in the module, the update will be aborted.
  You can choose to ignore the difference and potentially overwrite the change by enabling the 'Force Update' option. This is to prevent unintentional overwriting of changes made in the panel.
• Change Lock Status - this button can be used to lock or unlock automatic changes to the record. When an attempt to change a locked record is made, the attempt will be blocked and an appropriate notification will be displayed in the logs.
  All imported items will be locked by default, as showcased in this use case.

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 items that can be assigned to exported products.
Select the item manually and save the changes or use the 'Match Products' option to automatically find relations.

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

• Update Record - this button can be used to update a relation manually. If the item has been changed in the QuickBooks Online panel, but that change has not been reflected in the module, the update will be aborted.
  You can choose to ignore the difference and potentially overwrite the change by enabling the 'Force Update' option. This is to prevent unintentional overwriting of changes made in the panel.
  By default, updating invoice relations will not affect the relations of the items on that invoice. You can, however, enable this option by clicking on 'Update Items Relations.'
• Change Lock Status - this button can be used to lock or unlock automatic changes to the record. When an attempt to change a locked record is made, the attempt will be blocked and an appropriate notification will be displayed in the logs.
  All imported items will be locked by default, as showcased in this use case.

When you click the button in the 'Action' section, you can set relations for the previously chosen payment method.

Note: In order to be able to assign an account to a currency, this currency must be previously properly configured in the QuickBooks Online panel → 'Account'.

It is possible to configure the payment gateway account where transaction fees will be delivered.
In order to properly configure gateway fees, go back to 'Configuration' → 'Synchronization Settings', there select an account in 'Gateway Fee Account'.
Make sure you have selected your account that is related to WHMCS transactions. Once an invoice is exported, a transaction fee will be stored on the selected account.
You may check logs to see if the action has been completed successfully.

Use the 'Match Transactions' button to automatically find an existing relation in QuickBooks without a manual search for every single transaction.
You will get an extended list with information for which of the transactions a match has been found.

• Update Record - this button can be used to update a relation manually. If the item has been changed in the QuickBooks Online panel, but that change has not been reflected in the module, the update will be aborted.
  You can choose to ignore the difference and potentially overwrite the change by enabling the 'Force Update' option. This is to prevent unintentional overwriting of changes made in the panel.
• Change Lock Status - this button can be used to lock or unlock automatic changes to the record. When an attempt to change a locked record is made, the attempt will be blocked and an appropriate notification will be displayed in the logs.
  All imported items will be locked by default, as showcased in this use case.

Use the 'Match Credits' button to automatically find an existing relation in QuickBooks without a manual search for every single credit.

• Update Record - this button can be used to update a relation manually. If the item has been changed in the QuickBooks Online panel, but that change has not been reflected in the module, the update will be aborted.
  You can choose to ignore the difference and potentially overwrite the change by enabling the 'Force Update' option. This is to prevent unintentional overwriting of changes made in the panel.
• Change Lock Status - this button can be used to lock or unlock automatic changes to the record. When an attempt to change a locked record is made, the attempt will be blocked and an appropriate notification will be displayed in the logs.

Press ' Add New' button to create a custom rule.
Important! Please remember that 'Custom Rules' are based on regular PHP expressions. An exemplary 'Custom Rule' is car(.*)

• Name - a friendly name of the rule
• Custom Rule → for example car(.*) which is a regular PHP expression
• Priority - the higher the number, the lower the priority, use integers only
• QuickBooks Service - select a service that will be checked with the rule
  

Press 'Save Changes' when ready.

You may edit its specification at any moment, just press the icon marked on the screen (1).
Delete (2) unused rules from the list.

All you have to do is press the 'Match Products/Domains/Invoices' etc. button. You will be asked to confirm the action and soon after that the process of looking for matches stars.
Once ready, you will see a full list with results. Successfully found matches in green and no match found for an item in red.
Found relations will be set automatically.

• Email - keep in mind that email addresses must be identical (only 1:1 match)
• Name - keep in mind that names must be identical (only 1:1 match)
• ID - 1:1 match only, when the ID is shortened, the relation must be set up manually ('Shorten Transaction ID' option is on)

Use the action button to see related items.

The first one - 'Summary' - contains data on the number of exported clients, invoices and payments together with refunds.
The number includes exports carried out in all possible ways.
The second table contains information on crons. You may see here when the last cron was run and what time period it covered.

It includes specific scenarios that illustrate typical use cases and explains how the module's features can be applied in practice.
Reviewing these scenarios will give you a better understanding of how to use the module effectively.

There is no need to start over because you can import everything effortlessly and reliably. See the instructions below to learn how.

Here is a list of commands:

• importClients
• importInvoices
• importTransactions

And the cron itself:

php -q /yourWHMCS/modules/addons/QuickBooks/cron/synchronization.php --importInvoices --from='2022-09-09'

Run the cron with each of the commands as needed, the date modifier is optional, if it is not included, all items from the category will be imported.

If there was no such real payment, the invoice will be marked as 'Unpaid'.

• importClients
• importInvoices
• importTransactions
  

for example:

php -q /yourWHMCS/modules/addons/QuickBooks/cron/synchronization.php --importInvoices --from='2022-09-09'

or without a specified date:

php -q /yourWHMCS/modules/addons/QuickBooks/cron/synchronization.php --importTransactions

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Opt for the Open Source version of your QuickBooks Online For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Required param missing, need to supply the required value for the API Required parameter TxnTaxDetail.TaxLineDetail.TaxLine.TaxRateRef is missing in the request.

Solution: Make sure that relations for the tax rules are set up correctly.

Property QuickBooksDSK\IPPPayment::$ProjectRef does not exist. Class QuickBooksSDK\IPPPayment

Solution:
1. Open your QuickBooks account.
2. Proceed to the Advanced tab.
3. Select Edit in the Accounting section.
4. Uncheck the Close the books box/toggle or change the closing date.
5. Select Save and then Done.
More information on this error can be found on the official Intuit site

• Navigate to the Relation: Transaction tab, search for the correct transaction and update the relationship accordingly.
  

If the issue persists:

• Delete the incorrect transaction from QuickBooks.
• Remove the corresponding entry from the WHMCS database using the following query, replacing invoice_id = "304" with the actual invoice ID from the URL.

 DELETE FROM quickbooks_payments WHERE quickbooks_payments.invoice_id = "304";

• Export the transaction again to ensure the correct assignment is automatically set.