KashFlow Accounting - Revision history

SarahK at 20:06, 11 May 2022

2022-05-11T20:06:40Z

SarahK at 19:50, 25 April 2022

2022-04-25T19:50:29Z

SarahK at 21:44, 16 March 2022

2022-03-16T21:44:50Z

SarahK at 17:35, 9 September 2021

2021-09-09T17:35:16Z

SarahK: /* Installation */

2020-08-27T20:34:13Z

‎Installation

SarahK at 16:36, 5 August 2020

2020-08-05T16:36:41Z

Joshua: /* The Syncing Process */

2018-11-13T13:02:49Z

‎The Syncing Process

Joshua: /* The Syncing Process */

2018-11-13T13:02:23Z

‎The Syncing Process

John: /* Installation */

2016-10-14T23:30:25Z

‎Installation

John at 14:16, 1 April 2015

2015-04-01T14:16:11Z

@@ Line 59: / Line 59: @@
 * The module can process a maximum of 200 invoices each time.
-* The system records errors in the log at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > [[Activity Log]]'''. We recommend that you review this periodically.
+* The system records errors in the log at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''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.

@@ Line 52: / Line 52: @@
 == 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 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 ==
@@ Line 59: / Line 59: @@
 * 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 system records errors in the log at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''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.
@@ Line 71: / Line 71: @@
 # 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 (<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 ==

@@ Line 1: / Line 1: @@
 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.
-== Additional Requirements ==
+<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
+<tr>
-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.
+<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>
-== Installation ==
+<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
-To install this addon:
+== Activating KashFlow Accounting ==
-# Download the latest version from <tt>https://marketplace.whmcs.com/product/2546</tt>.
+You must download and upload this addon before you can activate it through the Admin Area.
 # 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]]
 # Log in to the Kashflow control panel.
 # Go to '''Settings > External Services > API Settings'''.
 # Check the following options:
-## ''Enabled''
+#* ''Enabled''
-## ''Restrict Access to specific IP Addresses''
+#* ''Restrict Access to specific IP Addresses''
-## ''Separate API password''
+#* ''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 (<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 ysername and API password.
+# Click '''Configure'''.
 # Click '''Save Changes'''.
-# When the new selection of fields appears, choose the KashFlow payment method and bank account to assign to transactions for each WHMCS payment gateway when syncing.
-# Save your changes.
+== Requirements ==
 == 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'''.
-== Common Problems ==
+== Troubleshooting ==
 === 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.

@@ Line 1: / Line 1: @@
-KashFlow is an accounting system primarily for UK small businesses but with customers worldwide and this addon module for WHMCS 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.
-Once installed & configured, the sync process runs as part of the daily cron and creates clients, invoices & transactions in KashFlow to mirror the invoice and transaction records in your WHMCS 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.
-==Additional Requirement==
+== Additional Requirements ==
-==Installation==
+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.
-Installation can be completed in 4 simple steps:
+== Installation ==
-#Begin by downloading the latest version from https://marketplace.whmcs.com/product/2546
+To install this addon:
-==Configuration==
+# Download the latest version from <tt>https://marketplace.whmcs.com/product/2546</tt>.
 [[File:kashflow2.png|thumb|Kashflow API Settings]] [[File:kashflow3.png|thumb|Kashflow IP Authorisation]] [[File:kashflow4.png|thumb|Kashflow Module Configuration]]
-==The Syncing Process==
+To configure this addon:
-*The sync process will run as part of the daily cron whilever the Enable box is checked - to disable again simply untick the box
+== Common Problems ==
-==Multi-Currency==
+=== KashFlow: Error Inserting Transaction xx ===
-*WHMCS connects to KashFlow and obtains the currencies configured within the users account.
+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.
-==Common Problems==
+=== Error Inserting Customer x: Customer Code is not unique ===
-===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.

@@ Line 13: / Line 13: @@
 #Now unzip the files to a folder on your computer
 #Next upload the "kashflow" folder from the zip file to the '''/modules/addons/''' directory of WHMCS on your server
-#To complete the process, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''' within the WHMCS Admin Area. Click '''Activate''' next to the new KashFlow module
+#To complete the process, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''' within the WHMCS Admin Area. Click '''Activate''' next to the new KashFlow module
 ==Configuration==

@@ Line 13: / Line 13: @@
 #Now unzip the files to a folder on your computer
 #Next upload the "kashflow" folder from the zip file to the '''/modules/addons/''' directory of WHMCS on your server
-#To complete the process, navigate to '''Setup > Addon Modules''' within the WHMCS Admin Area and then click the Activate link next to the new KashFlow module
+#To complete the process, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''' within the WHMCS Admin Area. Click '''Activate''' next to the new KashFlow module
 ==Configuration==
@@ Line 26: / Line 26: @@
 #Return to the previous screen and enter an API password. You will enter this into WHMCS shortly.
 #Now, login to your WHMCS Administration Area
-#To configure the module, begin by going to '''Setup > Addon Modules''' and Activate
+#To configure the module, begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''' and Activate
 #Here you will first be asked to enter your KashFlow Username & API Password configured in step 4. Once you have done this click '''Save Changes'''
 #The API login will then be tested and if there's a problem with the username and/or password you entered an error will be displayed on screen.
@@ Line 45: / Line 45: @@
 *WHMCS connects to KashFlow and obtains the currencies configured within the users account.
 *WHMCS then matches the currency code configured in Kashflow with that configured in WHMCS and then when creating the client account in KashFlow sends the appropriate currency ID.
-*The currency code must match in order to work. Therefore you should configure all the same currencies in KashFlow that you have configured in WHMCS under Setup > Payments > Currencies.
+*The currency code must match in order to work. Therefore you should configure all the same currencies in KashFlow that you have configured in WHMCS under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''.
 ==Common Problems==
 ===KashFlow: Error Inserting Transaction xx===
-Seeing this error in the Activity Log when the Kashflow synchronisation runs means that the transaction data being sent does not meet Kashflow's requirements. Review the Billing > Transactions List and Billing > Invoices pages to ensure all transactions and invoices have a payment Gateway assigned and that Transactions have a Transaction ID entered.
+Seeing this error in the Activity Log when the Kashflow synchronisation runs means that the transaction data being sent does not meet Kashflow's requirements. Review the '''Billing > Transactions List''' and '''Billing > Invoices''' pages to ensure all transactions and invoices have a payment Gateway assigned and that Transactions have a Transaction ID entered.
 ===Error Inserting Customer x: Customer Code is not unique===
 Seeing this error in the Activity Log when the Kashflow synchronisation runs means the client's email address has been changed and no longer matches the email address stored in Kashflow. To resolve this, update the client's email address in Kashflow to match WHMCS.

@@ Line 36: / Line 36: @@
 *The sync process will run as part of the daily cron whilever the Enable box is checked - to disable again simply untick the box
-* The KashFlow Accounting module will process a maximum of 200 invoices for each time the sync runs
+* The module will process a maximum of 200 invoices for each time the sync runs
 *Should any errors occur when sending data to KashFlow, they will be recorded in the Activity Log under the Utilities menu so you should review it periodically to check for any errors
 *The first few runs will attempt to sync all existing customers & paid invoices and so may take longer than normal

← Older revision		Revision as of 14:16, 1 April 2015
Line 45:		Line 45:
	*WHMCS then matches the currency code configured in Kashflow with that configured in WHMCS and then when creating the client account in KashFlow sends the appropriate currency ID.		*WHMCS then matches the currency code configured in Kashflow with that configured in WHMCS and then when creating the client account in KashFlow sends the appropriate currency ID.
	*The currency code must match in order to work. Therefore you should configure all the same currencies in KashFlow that you have configured in WHMCS under Setup > Payments > Currencies.		*The currency code must match in order to work. Therefore you should configure all the same currencies in KashFlow that you have configured in WHMCS under Setup > Payments > Currencies.
		+
		+	==Common Problems==
		+	===KashFlow: Error Inserting Transaction xx===
		+	Seeing this error in the Activity Log when the Kashflow synchronisation runs means that the transaction data being sent does not meet Kashflow's requirements. Review the Billing > Transactions List and Billing > Invoices pages to ensure all transactions and invoices have a payment Gateway assigned and that Transactions have a Transaction ID entered.
		+
		+	===Error Inserting Customer x: Customer Code is not unique===
		+	Seeing this error in the Activity Log when the Kashflow synchronisation runs means the client's email address has been changed and no longer matches the email address stored in Kashflow. To resolve this, update the client's email address in Kashflow to match WHMCS.