Difference between revisions of "Reports"
(→Access Control) |
|||
(14 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
WHMCS includes a wide range of reports to give you in-depth reporting and analytics on the performance of your business. Many reports also include graphs and charts to help you interpret the data. | WHMCS includes a wide range of reports to give you in-depth reporting and analytics on the performance of your business. Many reports also include graphs and charts to help you interpret the data. | ||
− | Reports | + | You can access this feature at '''Reports > Reports'''. |
+ | |||
+ | <div class="docs-alert-success"> | ||
+ | You can customize the reports that display in this interface or create new ones. For more information, see [[Customizing Reports]]. | ||
+ | </div> | ||
+ | |||
+ | <div class="docs-alert-warning"> | ||
+ | By default, an admin role group can access all reports in the system if their permissions include '''View Reports'''. However, you can configure admin roles to only view selected reports at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Roles'''. | ||
+ | </div> | ||
==Reports== | ==Reports== | ||
− | To | + | Reports display in several primary categories: '''General''', '''Billing''', '''Income''', '''Clients''', and '''Support'''. |
+ | |||
+ | You can export reports in CSV format or view them in a printer friendly format and print them. To do this, click on a report, click '''Tools''' in the upper-right corner, and then choose your desired option. | ||
+ | |||
+ | ===Affiliates Overview=== | ||
− | |||
An overview of affiliates for the current year: Visitors referred, Pending Commissions, Available to Withdraw balance, Withdrawn Amount and Total Commissions Paid. | An overview of affiliates for the current year: Visitors referred, Pending Commissions, Available to Withdraw balance, Withdrawn Amount and Total Commissions Paid. | ||
− | + | ===Aging Invoices=== | |
+ | |||
A summary of outstanding invoices by the period by which they are overdue. | A summary of outstanding invoices by the period by which they are overdue. | ||
− | + | ===Annual Income Report=== | |
+ | |||
A report of the received income for the year by month, which the system converts to the base currency using rates at the time of the transaction. It includes your recorded transactions. The graph shows the previous year's income for easy comparison. | A report of the received income for the year by month, which the system converts to the base currency using rates at the time of the transaction. It includes your recorded transactions. The graph shows the previous year's income for easy comparison. | ||
− | + | ===Client Sources=== | |
+ | |||
A summary of the answers clients have given to the 'How Did You Find Us?' or 'Where did you hear about us?' custom field signup question between a specified date range. | A summary of the answers clients have given to the 'How Did You Find Us?' or 'Where did you hear about us?' custom field signup question between a specified date range. | ||
− | + | ===Client Statement=== | |
+ | |||
A statement of account for individual client accounts between a date range. Displays Type (add funds, transaction, invoice), date, description, credits, debits and a running balance. | A statement of account for individual client accounts between a date range. Displays Type (add funds, transaction, invoice), date, description, credits, debits and a running balance. | ||
− | + | ===Client=== | |
+ | |||
A report that allows you to generate a JSON export of data relating to a given client. We added this in version 7.5. You can choose the data points to include in the export from the following options: | A report that allows you to generate a JSON export of data relating to a given client. We added this in version 7.5. You can choose the data points to include in the export from the following options: | ||
+ | |||
* Profile Data | * Profile Data | ||
* Contacts | * Contacts | ||
Line 34: | Line 51: | ||
* Notes | * Notes | ||
* Activity Log | * Activity Log | ||
− | |||
− | '''Clients''' | + | You can also access this report via the ''Export Client Data'' link on a client's '''[[Clients:Summary Tab|Summary]]''' tab. |
+ | |||
+ | ===Clients=== | ||
+ | |||
A custom export of client information by applying up to five filters. CSV Export is available in the ''Tools'' menu in the top-right corner of the page. | A custom export of client information by applying up to five filters. CSV Export is available in the ''Tools'' menu in the top-right corner of the page. | ||
− | + | ===Clients by Country=== | |
+ | |||
The total number of active services per country in map format, as well as total active unique clients per country in a table beneath the map. | The total number of active services per country in map format, as well as total active unique clients per country in a table beneath the map. | ||
− | + | ===Credits Reviewer=== | |
+ | |||
All the credits that you issued to clients between two dates you specify. | All the credits that you issued to clients between two dates you specify. | ||
− | + | ===Customer Retention Time=== | |
+ | |||
The average lifetime of products, services, addons and domains. (This is the number of days between the registration date and the termination date.) Averages display by product and the associated billing cycle, and include both as a number of days value and a years and months value. | The average lifetime of products, services, addons and domains. (This is the number of days between the registration date and the termination date.) Averages display by product and the associated billing cycle, and include both as a number of days value and a years and months value. | ||
− | + | ===Daily Performance=== | |
+ | |||
A daily activity summary for a given month. Data in this report includes Completed Orders, New Invoices, Paid Invoices, Opened Tickets, Ticket Replies and Cancellation Requests. | A daily activity summary for a given month. Data in this report includes Completed Orders, New Invoices, Paid Invoices, Opened Tickets, Ticket Replies and Cancellation Requests. | ||
− | + | ===Direct Debit Processing=== | |
− | All | + | |
+ | All unpaid invoices using the [[Direct_Debit|Direct Debit]] payment method, and their owners' associated bank account, ready for manual processing. | ||
+ | |||
+ | ===Disk Usage Summary=== | ||
+ | |||
+ | When the '''[[Automation_Settings#Update_Usage_Statistics|Update Usage Statistics]]''' option is enabled, the system generates a report of the disk space and bandwidth usage statistics for hosting accounts on active servers. This report excludes disabled servers and hosting accounts without a matching record in WHMCS. | ||
− | + | The cron job updates this once per day, or you can click '''Update Now''' to get current usage statistics. | |
− | |||
− | + | ===Domains=== | |
− | Generate a custom export of domain name information by applying up to five filters. CSV | + | |
+ | Generate a custom export of domain name information by applying up to five filters. CSV export is available in the ''Tools'' menu in the top-right corner of the page. | ||
+ | |||
+ | ===Domain Renewal Reminder Emails=== | ||
− | |||
Part of a dedicated logging system for domain renewal notices. This keeps a log of all sent renewal notices, along with the date and recipients, and provides an easy way to view and export that information for ICANN compliance. | Part of a dedicated logging system for domain renewal notices. This keeps a log of all sent renewal notices, along with the date and recipients, and provides an easy way to view and export that information for ICANN compliance. | ||
− | + | ===Income by Product=== | |
+ | |||
A breakdown per product or service of invoices that clients paid in a given month. This excludes overpayments and other payments to deposit funds (credit), and includes invoices paid from credit added in previous months. Because of this, it may not match the income total for the month. | A breakdown per product or service of invoices that clients paid in a given month. This excludes overpayments and other payments to deposit funds (credit), and includes invoices paid from credit added in previous months. Because of this, it may not match the income total for the month. | ||
− | + | ===Income Forecast=== | |
+ | |||
The projected income for each month of the year. Assumes all active services and domains renew on their next due date. This splits products with longer billing cycles (Quarterly, Semi-Annually, Annually, Biennially) evenly across the year. This doesn't include Addons and Billable Items. | The projected income for each month of the year. Assumes all active services and domains renew on their next due date. This splits products with longer billing cycles (Quarterly, Semi-Annually, Annually, Biennially) evenly across the year. This doesn't include Addons and Billable Items. | ||
− | + | ===Invoices=== | |
− | |||
− | + | A custom export of invoice information, applying up to five filters. CSV export is available via the download link at the bottom of the page. | |
− | A | ||
− | + | ===Monthly Orders=== | |
− | |||
− | + | A breakdown of the number of units sold of each product per month per currency. This allows you to see your most profitable products. | |
− | |||
− | |||
− | |||
− | |||
− | + | ===Monthly Transactions=== | |
− | |||
− | ''' | + | Provides a summary of daily payments activity for a given month per currency. The system generates this using transaction data. The '''Amount Out''' figure includes both expenditure transactions and refunds. |
− | |||
− | + | ===New Customers=== | |
− | |||
− | + | The total number of new customers, orders, and complete orders for the current year and compares each of these to the previous year on the graph. | |
− | |||
− | + | ===PDF Batch=== | |
− | |||
− | + | A single PDF document containing multiple individual invoices (one per page). You can filter this by date range, payment methods, and status. This is useful for printing invoices for record-keeping or mailing to clients. | |
− | A | ||
− | + | ===Product Suspensions=== | |
− | |||
− | + | All services that are currently suspended and the reasons for their suspensions. | |
− | |||
− | + | ===Promotions Usage=== | |
− | |||
− | ''' | + | Usage statistics for each promotional code to see how often clients have used each promo code. Click the '''Drill Down''' link to see exactly which orders used the code. |
− | |||
− | + | ===Sales Tax Liability=== | |
− | |||
− | + | Sales tax liability for the selected period (invoice sub-total before tax, tax amount, and total after tax). This does not include partial refunds that may have included sales tax refunds. | |
− | |||
− | + | ===Server Revenue Forecasts=== | |
− | |||
− | + | Income, by billing cycle, for each of your servers in the base currency. It then uses the monthly cost for each server to estimate the annual gross profit for each server. | |
− | + | ===Services=== | |
− | + | A custom export of service information (for example, domain, username, or server ID) by applying up to five filters. CCSV export is available in the '''Tools''' menu in the top-right corner of the page. | |
− | + | === Smarty Compatibility === | |
+ | |||
+ | In WHMCS 8.7 and later, this report lists information about legacy Smarty tags that the system has detected in your custom theme and template files. | ||
+ | |||
+ | <div class="docs-alert-info"> | ||
+ | Smarty 3 removed Smarty's <tt>{php}</tt>, <tt>{include_php}</tt>, and <tt>{insert}</tt> tag functionality. We deprecated these tags in WHMCS 6.0 and will remove support entirely in WHMCS 9.0. You '''must''' remove these tags from your custom themes and templates. For more information, see [[Eliminating Legacy Smarty Tags]]. | ||
+ | </div> | ||
+ | |||
+ | The system scans for <tt>{php}</tt>, <tt>{include_php}</tt>, and <tt>{insert}</tt> tags in all of the following files within your WHMCS installation's root directory: | ||
+ | |||
+ | * All files in the following directories: | ||
+ | ** <tt>/includes/hooks</tt> | ||
+ | ** <tt>/modules</tt> | ||
+ | ** <tt>/templates</tt> | ||
+ | ** <tt>/admin/templates</tt> | ||
+ | * All email template files. | ||
+ | * All trusted directories in the installation's [[Smarty_Security_Policy#.7Binclude_php.7D_Tag_Use|custom Smarty security policy]]. | ||
+ | |||
+ | Click '''Rescan Now''' to re-scan your WHMCS installation for <tt>{php}</tt>, <tt>{include_php}</tt>, and <tt>{insert}</tt> tags. Clicking '''Rescan Now''' erases the previous scan's data. | ||
+ | |||
+ | Within the report, files appear in two sections: | ||
+ | |||
+ | * '''Template Files''' lists each tag's file path, filename, and line number. The system sorts this list by the file path. | ||
+ | * '''Email Templates''' lists each tag's file path, filename, line number, and email template type. The system sorts this list by template type. | ||
− | + | ===Support Ticket Replies=== | |
− | |||
− | |||
− | |||
− | |||
− | + | A breakdown of the support tickets that each admin handled for a given month. The '''Ticket''' value is the number of unique tickets that they replied to and '''Replies''' is the total number of replies across all tickets. | |
− | == | + | ===Ticket Feedback Comments=== |
− | You can | + | A report that displays general feedback comments from customers when the '''[[Support_Tab#Ticket_Closure_Feedback_Request|Ticket Closure Feedback]]''' option is enabled. You can filter this by date range and staff member. |
− | + | ===Ticket Feedback Scores=== | |
− | + | A report that displays the ratings, on a scale of 1-10, that clients have given to individual admins when the '''[[Support_Tab#Ticket_Closure_Feedback_Request|Ticket Closure Feedback]]''' option is enabled. You can filter this by date range. Click the admin's name to see comments that clients left specifically about that member of staff. | |
− | + | ===Ticket Ratings Reviewer=== | |
− | + | A report that displays the score, on a scale of 1-10, that clients have given to individual support ticket replies when the '''[[Support_Tab#Support_Ticket_Rating|Support Ticket Rating]]''' option is enabled. You can filter this by date range and score. | |
− | + | ===Ticket Tags=== | |
− | + | An overview of assigned ticket tags for a given [[Date_Range_Picker|date range]], by ticket opening date. You can add tags to tickets via the '''Tag Cloud''' field when viewing a support ticket. | |
− | + | ===Top 10 Clients By Income=== | |
− | The | + | The 10 clients with the highest net income, according to the transactions in WHMCS. If the client does not use your default currency, the system will convert their income for ease of comparison. |
− | + | ===Transactions=== | |
− | |||
− | + | A custom export of transaction information by applying up to five filters. CSV export is available in the '''Tools''' menu in the top-right corner of the page. | |
− | |||
− | + | ===VAT MOSS=== | |
− | |||
− | + | This report provides the information EU businesses need to be able to complete the VATMOSS return in whatever specific format(s) your local VAT tax authority will accept. | |
− | |||
− | + | <div class="docs-alert-info"> | |
− | + | ''' Report Name:''' VAT MOSS Settlement Data Report for WHMCS<br /> | |
+ | ''' Version:''' 1.0<br /> | ||
+ | ''' Release Date:''' 1st April 2015<br /> | ||
+ | ''' Supported WHMCS Versions:''' 5.3+ | ||
+ | </div> | ||
− | + | On January 1st, 2015, new rules came into effect for handling VAT for the sale of digital products and services within the EU. The rules created a system called the Mini One-Stop Shop (MOSS) for the declaration of VAT collected on these digital supplies. For more information, see [http://blog.whmcs.com/?t=96594 New EU VAT rules from 1st January 2015]. | |
− | |||
− | |||
− | |||
− | |||
− | + | While the submission requirements and file formats vary by MOSS country of registration, the required information is the same. | |
− | |||
− | </ | + | * For more information, see [http://blog.whmcs.com/?t=99502 our blog post]. |
+ | * To download the report, [http://www.whmcs.com/download/702/whmcs-vat-moss-report click here]. | ||
+ | * To install a report in WHMCS, unzip the download file and upload the <tt>vat_moss.php</tt> file to the <tt>/modules/reports/</tt> directory. | ||
− | + | Make sure to confirm the procedure for uploading your settlement data with your tax authority. Contact your MOSS registration country if you have any further questions in relation to the MOSS return. |
Latest revision as of 14:09, 16 May 2023
WHMCS includes a wide range of reports to give you in-depth reporting and analytics on the performance of your business. Many reports also include graphs and charts to help you interpret the data.
You can access this feature at Reports > Reports.
You can customize the reports that display in this interface or create new ones. For more information, see Customizing Reports.
By default, an admin role group can access all reports in the system if their permissions include View Reports. However, you can configure admin roles to only view selected reports at Configuration () > System Settings > Administrator Roles or, prior to WHMCS 8.0, Setup > Staff Management > Administrator Roles.
Contents
- 1 Reports
- 1.1 Affiliates Overview
- 1.2 Aging Invoices
- 1.3 Annual Income Report
- 1.4 Client Sources
- 1.5 Client Statement
- 1.6 Client
- 1.7 Clients
- 1.8 Clients by Country
- 1.9 Credits Reviewer
- 1.10 Customer Retention Time
- 1.11 Daily Performance
- 1.12 Direct Debit Processing
- 1.13 Disk Usage Summary
- 1.14 Domains
- 1.15 Domain Renewal Reminder Emails
- 1.16 Income by Product
- 1.17 Income Forecast
- 1.18 Invoices
- 1.19 Monthly Orders
- 1.20 Monthly Transactions
- 1.21 New Customers
- 1.22 PDF Batch
- 1.23 Product Suspensions
- 1.24 Promotions Usage
- 1.25 Sales Tax Liability
- 1.26 Server Revenue Forecasts
- 1.27 Services
- 1.28 Smarty Compatibility
- 1.29 Support Ticket Replies
- 1.30 Ticket Feedback Comments
- 1.31 Ticket Feedback Scores
- 1.32 Ticket Ratings Reviewer
- 1.33 Ticket Tags
- 1.34 Top 10 Clients By Income
- 1.35 Transactions
- 1.36 VAT MOSS
Reports
Reports display in several primary categories: General, Billing, Income, Clients, and Support.
You can export reports in CSV format or view them in a printer friendly format and print them. To do this, click on a report, click Tools in the upper-right corner, and then choose your desired option.
Affiliates Overview
An overview of affiliates for the current year: Visitors referred, Pending Commissions, Available to Withdraw balance, Withdrawn Amount and Total Commissions Paid.
Aging Invoices
A summary of outstanding invoices by the period by which they are overdue.
Annual Income Report
A report of the received income for the year by month, which the system converts to the base currency using rates at the time of the transaction. It includes your recorded transactions. The graph shows the previous year's income for easy comparison.
Client Sources
A summary of the answers clients have given to the 'How Did You Find Us?' or 'Where did you hear about us?' custom field signup question between a specified date range.
Client Statement
A statement of account for individual client accounts between a date range. Displays Type (add funds, transaction, invoice), date, description, credits, debits and a running balance.
Client
A report that allows you to generate a JSON export of data relating to a given client. We added this in version 7.5. You can choose the data points to include in the export from the following options:
- Profile Data
- Contacts
- Products/Services
- Domains
- Billable Items
- Invoices Quotes
- Transactions
- Tickets Emails
- Notes
- Activity Log
You can also access this report via the Export Client Data link on a client's Summary tab.
Clients
A custom export of client information by applying up to five filters. CSV Export is available in the Tools menu in the top-right corner of the page.
Clients by Country
The total number of active services per country in map format, as well as total active unique clients per country in a table beneath the map.
Credits Reviewer
All the credits that you issued to clients between two dates you specify.
Customer Retention Time
The average lifetime of products, services, addons and domains. (This is the number of days between the registration date and the termination date.) Averages display by product and the associated billing cycle, and include both as a number of days value and a years and months value.
Daily Performance
A daily activity summary for a given month. Data in this report includes Completed Orders, New Invoices, Paid Invoices, Opened Tickets, Ticket Replies and Cancellation Requests.
Direct Debit Processing
All unpaid invoices using the Direct Debit payment method, and their owners' associated bank account, ready for manual processing.
Disk Usage Summary
When the Update Usage Statistics option is enabled, the system generates a report of the disk space and bandwidth usage statistics for hosting accounts on active servers. This report excludes disabled servers and hosting accounts without a matching record in WHMCS.
The cron job updates this once per day, or you can click Update Now to get current usage statistics.
Domains
Generate a custom export of domain name information by applying up to five filters. CSV export is available in the Tools menu in the top-right corner of the page.
Domain Renewal Reminder Emails
Part of a dedicated logging system for domain renewal notices. This keeps a log of all sent renewal notices, along with the date and recipients, and provides an easy way to view and export that information for ICANN compliance.
Income by Product
A breakdown per product or service of invoices that clients paid in a given month. This excludes overpayments and other payments to deposit funds (credit), and includes invoices paid from credit added in previous months. Because of this, it may not match the income total for the month.
Income Forecast
The projected income for each month of the year. Assumes all active services and domains renew on their next due date. This splits products with longer billing cycles (Quarterly, Semi-Annually, Annually, Biennially) evenly across the year. This doesn't include Addons and Billable Items.
Invoices
A custom export of invoice information, applying up to five filters. CSV export is available via the download link at the bottom of the page.
Monthly Orders
A breakdown of the number of units sold of each product per month per currency. This allows you to see your most profitable products.
Monthly Transactions
Provides a summary of daily payments activity for a given month per currency. The system generates this using transaction data. The Amount Out figure includes both expenditure transactions and refunds.
New Customers
The total number of new customers, orders, and complete orders for the current year and compares each of these to the previous year on the graph.
PDF Batch
A single PDF document containing multiple individual invoices (one per page). You can filter this by date range, payment methods, and status. This is useful for printing invoices for record-keeping or mailing to clients.
Product Suspensions
All services that are currently suspended and the reasons for their suspensions.
Promotions Usage
Usage statistics for each promotional code to see how often clients have used each promo code. Click the Drill Down link to see exactly which orders used the code.
Sales Tax Liability
Sales tax liability for the selected period (invoice sub-total before tax, tax amount, and total after tax). This does not include partial refunds that may have included sales tax refunds.
Server Revenue Forecasts
Income, by billing cycle, for each of your servers in the base currency. It then uses the monthly cost for each server to estimate the annual gross profit for each server.
Services
A custom export of service information (for example, domain, username, or server ID) by applying up to five filters. CCSV export is available in the Tools menu in the top-right corner of the page.
Smarty Compatibility
In WHMCS 8.7 and later, this report lists information about legacy Smarty tags that the system has detected in your custom theme and template files.
Smarty 3 removed Smarty's {php}, {include_php}, and {insert} tag functionality. We deprecated these tags in WHMCS 6.0 and will remove support entirely in WHMCS 9.0. You must remove these tags from your custom themes and templates. For more information, see Eliminating Legacy Smarty Tags.
The system scans for {php}, {include_php}, and {insert} tags in all of the following files within your WHMCS installation's root directory:
- All files in the following directories:
- /includes/hooks
- /modules
- /templates
- /admin/templates
- All email template files.
- All trusted directories in the installation's custom Smarty security policy.
Click Rescan Now to re-scan your WHMCS installation for {php}, {include_php}, and {insert} tags. Clicking Rescan Now erases the previous scan's data.
Within the report, files appear in two sections:
- Template Files lists each tag's file path, filename, and line number. The system sorts this list by the file path.
- Email Templates lists each tag's file path, filename, line number, and email template type. The system sorts this list by template type.
Support Ticket Replies
A breakdown of the support tickets that each admin handled for a given month. The Ticket value is the number of unique tickets that they replied to and Replies is the total number of replies across all tickets.
Ticket Feedback Comments
A report that displays general feedback comments from customers when the Ticket Closure Feedback option is enabled. You can filter this by date range and staff member.
Ticket Feedback Scores
A report that displays the ratings, on a scale of 1-10, that clients have given to individual admins when the Ticket Closure Feedback option is enabled. You can filter this by date range. Click the admin's name to see comments that clients left specifically about that member of staff.
Ticket Ratings Reviewer
A report that displays the score, on a scale of 1-10, that clients have given to individual support ticket replies when the Support Ticket Rating option is enabled. You can filter this by date range and score.
Ticket Tags
An overview of assigned ticket tags for a given date range, by ticket opening date. You can add tags to tickets via the Tag Cloud field when viewing a support ticket.
Top 10 Clients By Income
The 10 clients with the highest net income, according to the transactions in WHMCS. If the client does not use your default currency, the system will convert their income for ease of comparison.
Transactions
A custom export of transaction information by applying up to five filters. CSV export is available in the Tools menu in the top-right corner of the page.
VAT MOSS
This report provides the information EU businesses need to be able to complete the VATMOSS return in whatever specific format(s) your local VAT tax authority will accept.
Report Name: VAT MOSS Settlement Data Report for WHMCS
Version: 1.0
Release Date: 1st April 2015
Supported WHMCS Versions: 5.3+
On January 1st, 2015, new rules came into effect for handling VAT for the sale of digital products and services within the EU. The rules created a system called the Mini One-Stop Shop (MOSS) for the declaration of VAT collected on these digital supplies. For more information, see New EU VAT rules from 1st January 2015.
While the submission requirements and file formats vary by MOSS country of registration, the required information is the same.
- For more information, see our blog post.
- To download the report, click here.
- To install a report in WHMCS, unzip the download file and upload the vat_moss.php file to the /modules/reports/ directory.
Make sure to confirm the procedure for uploading your settlement data with your tax authority. Contact your MOSS registration country if you have any further questions in relation to the MOSS return.