Difference between revisions of "KashFlow Accounting"
From WHMCS Documentation
| Line 1: | Line 1: | ||
| + | == About this Addon Module == | ||
| + | |||
KashFlow is an accounting system for small businesses, particularly for businesses in the UK. This addon automates the entry of paid invoices into the KashFlow system. | KashFlow is an accounting system for small businesses, particularly for businesses in the UK. This addon automates the entry of paid invoices into the KashFlow system. | ||
The sync process runs as part of the daily cron job and creates clients, invoices, and transactions in KashFlow to mirror the invoice and transaction records in WHMCS. | The sync process runs as part of the daily cron job and creates clients, invoices, and transactions in KashFlow to mirror the invoice and transaction records in WHMCS. | ||
| − | == | + | <table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;"> |
| − | + | <tr> | |
| − | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th> | |
| − | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th> | |
| − | == | + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th> |
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th> | ||
| + | <th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">KashFlow Accounting</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;">N/A</td> | ||
| + | <td style="border:1px #AAA solid;padding:0.2em;color:darkgreen;">Yes</td> | ||
| + | </tr> | ||
| + | </table> | ||
| − | + | == Activating KashFlow Accounting == | |
| − | # | + | You must download and upload this addon before you can activate it through the Admin Area. |
| + | |||
| + | To do this: | ||
| + | |||
| + | # Make certain that your WHMCS installation meets the requirements below. | ||
| + | # [https://marketplace.whmcs.com/product/2546 Download the latest version of the addon.] | ||
# Unzip the files. | # Unzip the files. | ||
| − | # Upload the <tt>kashflow</tt> folder from the ZIP file to the <tt>/modules/addons/</tt> directory in WHMCS. | + | # Upload the <tt>kashflow</tt> folder from the ZIP file to the <tt>/modules/addons/</tt> directory in WHMCS. [[File:kashflow2.png|thumb|Kashflow API Settings]][[File:kashflow3.png|thumb|Kashflow IP Authorisation]][[File:kashflow4.png|thumb|Kashflow Module Configuration]] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[File:kashflow2.png|thumb|Kashflow API Settings]] [[File:kashflow3.png|thumb|Kashflow IP Authorisation]] [[File:kashflow4.png|thumb|Kashflow Module Configuration]] | ||
| − | |||
| − | |||
| − | |||
# Log in to the Kashflow control panel. | # Log in to the Kashflow control panel. | ||
# Go to '''Settings > External Services > API Settings'''. | # Go to '''Settings > External Services > API Settings'''. | ||
# Check the following options: | # Check the following options: | ||
| − | # | + | #* ''Enabled'' |
| − | # | + | #* ''Restrict Access to specific IP Addresses'' |
| − | # | + | #* ''Separate API password'' |
# Click '''edit addresses list'''. | # Click '''edit addresses list'''. | ||
# Add your server's IP address to the '''Authorised IP Addresses''' list. | # Add your server's IP address to the '''Authorised IP Addresses''' list. | ||
# Return to the previous page and enter an API password. | # Return to the previous page and enter an API password. | ||
# Log in to the WHMCS Admin Area. | # Log in to the WHMCS Admin Area. | ||
| − | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. | + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. |
| − | # Click '''Activate'''. | + | # Click '''Activate''' for '''KashFlow Accounting'''. |
| − | # Enter your KashFlow | + | # Click '''Configure'''. |
| + | # Choose the KashFlow payment method and bank account to assign to transactions for each WHMCS payment gateway when syncing. | ||
| + | # Enter your KashFlow username and API password. | ||
| + | # Select the admin role groups who will have access to this addon. | ||
# Click '''Save Changes'''. | # Click '''Save Changes'''. | ||
| − | + | ||
| − | + | == Requirements == | |
| + | |||
| + | The KashFlow API requires SOAP in your server's PHP build. To check whether you have this, go to '''Utilities > System > PHP Info''' in WHMCS. If you do not see references to SOAP, you will need to recompile PHP. | ||
== The Syncing Process == | == The Syncing Process == | ||
| Line 59: | Line 73: | ||
Make sure to configure all of your currencies in both KashFlow and WHMCS. You can find your configured currencies in WHMCS at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''. | Make sure to configure all of your currencies in both KashFlow and WHMCS. You can find your configured currencies in WHMCS at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''. | ||
| − | == | + | == Troubleshooting == |
=== KashFlow: Error Inserting Transaction xx === | === KashFlow: Error Inserting Transaction xx === | ||
| Line 68: | Line 82: | ||
Seeing this error in the logs after Kashflow synchronisation indicates that the client's email address no longer matches the email address in Kashflow. To resolve this, update the client's email address in Kashflow to match it in WHMCS. | Seeing this error in the logs after Kashflow synchronisation indicates that the client's email address no longer matches the email address in Kashflow. To resolve this, update the client's email address in Kashflow to match it in WHMCS. | ||
| + | |||
| + | == Change Log == | ||
| + | |||
| + | ''N/A'' | ||
Revision as of 21:44, 16 March 2022
Contents
About this Addon Module
KashFlow is an accounting system for small businesses, particularly for businesses in the UK. This addon automates the entry of paid invoices into the KashFlow system.
The sync process runs as part of the daily cron job and creates clients, invoices, and transactions in KashFlow to mirror the invoice and transaction records in WHMCS.
| Addon Name | Latest Release | Current Version | Compatible With | Included in WHMCS |
|---|---|---|---|---|
| KashFlow Accounting | N/A | N/A | N/A | Yes |
Activating KashFlow Accounting
You must download and upload this addon before you can activate it through the Admin Area.
To do this:
- Make certain that your WHMCS installation meets the requirements below.
- Download the latest version of the addon.
- Unzip the files.
- Upload the kashflow folder from the ZIP file to the /modules/addons/ directory in WHMCS.
- Log in to the Kashflow control panel.
- Go to Settings > External Services > API Settings.
- Check the following options:
- Enabled
- Restrict Access to specific IP Addresses
- Separate API password
- Click edit addresses list.
- Add your server's IP address to the Authorised IP Addresses list.
- Return to the previous page and enter an API password.
- Log in to the WHMCS Admin Area.
- Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Click Activate for KashFlow Accounting.
- Click Configure.
- Choose the KashFlow payment method and bank account to assign to transactions for each WHMCS payment gateway when syncing.
- Enter your KashFlow username and API password.
- Select the admin role groups who will have access to this addon.
- Click Save Changes.
Requirements
The KashFlow API requires SOAP in your server's PHP build. To check whether you have this, go to Utilities > System > PHP Info in WHMCS. If you do not see references to SOAP, you will need to recompile PHP.
The Syncing Process
If it is enabled, the sync process runs as part of the daily cron job.
- The module can process a maximum of 200 invoices each time.
- The system records errors in the log at Utilities > Activity Log. We recommend that you review this periodically.
- The first few runs may require a longer period of time as they attempt to sync all existing customers and paid invoices.
Multi-Currency Support
Both WHMCS and Kashflow support the use of multiple currencies.
When you use this:
- WHMCS will connect to KashFlow and retrieve the configured currencies.
- WHMCS will match the KashFlow currency codes with the codes in WHMCS.
- When creating client accounts in KashFlow via this integration, WHMCS sends the appropriate currency ID. The currency code must match.
Make sure to configure all of your currencies in both KashFlow and WHMCS. You can find your configured currencies in WHMCS at Configuration () > System Settings > Currencies or, prior to WHMCS 8.0, Setup > Payments > Currencies.
Troubleshooting
KashFlow: Error Inserting Transaction xx
Seeing this error in the logs indicates that the transaction data does not meet Kashflow's requirements. Review the information at Billing > Transactions List and Billing > Invoices to ensure that all transactions and invoices have an assigned payment gateway and that transactions have a transaction ID.
Error Inserting Customer x: Customer Code is not unique
Seeing this error in the logs after Kashflow synchronisation indicates that the client's email address no longer matches the email address in Kashflow. To resolve this, update the client's email address in Kashflow to match it in WHMCS.
Change Log
N/A