Docs for all releases
View User Guide 3.26 or visit our current documentation home page.
Section overview
This section allows generating the profit report, which analyses profitability data and defines profits between Reseller parties (companies and managers) and Clients belonging to the respective Reseller/Manager.
For example, when Manager_1 executes profitability report, it allows to see his origination customers sending traffic to Manager_2, who owns actual terminator vendors. In this case, Reseller's permissions apply to every query, which guarantees that Manager_1 will not be able to see any actual name of a client belonging to another manager, or another party that restricts such access.
Screenshot: Profit Report query form
Creating Profit Report
To generate a profit report, you need to fill in the required parameters in the form and press Query button. To get information sorted, use the Group by option and choose respective values from the drop-down list.
The list of query fields is as follows:
Information block | Field Description | |
---|---|---|
qFilters | On the Filters menu, select required parameters for the report. To cancel any filter, click the delete sign next to the filter. | |
Period (1) | Specify the time interval for the report and a timezone. Please note that the Period field is mandatory. | |
Period 2 | Accessible when you enable the Compare Period option by clicking on the plus sign next to the Period. Specify the second interval for the report.
Tip When you select one of Time parameters for Group By, the end date of the Period 2 will be set automatically to make equal intervals of Period 1 and Period 2. | |
Reseller | Specify the name of target Reseller. | |
Mode | Choose the mode of the report:
By default, field value is set to All visible | |
Group By | Select a grouping option, here you can choose and swap columns, as well as change its order. There are following accessible options to group data in reports:
Attention Please note, the Group By field is mandatory, it couldn't be left empty in order to generate the report. | |
Additional Filters | ||
There are following accessible filters:
| ||
Income Client | Specify an origination client(s) for the report | |
Income Client's Tag | Specify tag(s) assigned to orignation clients | |
Income Account | Determine origination client's account(s) | |
Income Account's Tag | Indicate origination account's tags | |
Income Code | Define an incoming code | |
Income Code Name | Specify an incoming code name | |
Income Serial | Indicate a serial number of originator's call card | |
Income Reseller | Specify target reseller(s) for the report | |
Outcome Client | Define a termination client(s) | |
Outcome Client's Tag | Define termination client's tag(s) | |
Outcome Account | Indcate account(s) of termination client(s) for the report | |
Outcome Account's Tag | Specify termination account's tags if any | |
Outcome Code | Specify a termination code of the client | |
Outcome Code Name | Indicate termination code name | |
Package | Determine a name of the used package | |
Output | This form contains settings of the output data of the report. Click plus sign next to Columns and select required columns in order to add them to Output information block. Also, you can cancel any chosen item. | |
Accessible columns in the report | ||
Additional columns of the report are: Columns for main period: Volume Total, Income Cost, Income Avg Rate, Income Billed Time, Outcome Cost, Outcome Avg Rate, Outcome Billed Time, Profit, Profit (%). Columns for comparative period: Total time, min; Income Rate, Outcome Rate, Income Cost, Income Avg Rate, Income Billed Time, Outcome Cost, Outcome Avg Rate, Outcome Billed Time, Profit, Profit (%), Profit Difference. | ||
Volume Total | Total time of calls in minutes | |
Rate | The call rate
| |
Profit | The revenue
| |
Time | The billed time
| |
Cost | The call cost
| |
Other output settings | ||
Order By | Select parameters to sort already grouped data in columns. There are following accessible options to order the data: by Time, Clients, Extras. Here you can sort data from highest to lowest values (or vice versa) and select different values. | |
Type | Choose a format of the report from a drop-down list: Web / CSV / Excel XLS / Excel XLSx Also select next to the Type field a table view:
Attention Please note that Grouped type of table view is available only for Excel XLSx and Web formats, it doesn't work with CSV. | |
Limit | Determine the number of rows that will be visible in the report. It is useful for displaying some top positions by chosen parameter. It is available only for plain type of the report. | |
Send to | You can send generated reports via email. Also, it is possible to specify several emails. Attention This feature is available only for CSV, Excel XLS, Excel XLSx formats of the report, it doesn't work with Web. | |
Currency | Specify a currency for the report. And all values will be automatically converted in the report to the specified currency. | |
Code Deck | Using a drop-down list select a respective code deck. All codes names will be rewritten and presented according to the specified code deck. If there is no value specified, code deck assigned to the Client or Rate Table will be in usage. |
A generated profit report is demonstrated on a screenshot below:
Screenshot: Profit report section
If the data is grouped in the report, it will be shown initially collapsed. To expand or collapse data in your report, click the plus or minus signs.
Warning
Please note, the system shows rounded values in the reports. But while calculating the system takes an exact value. Hence, the procedure of the rounding is following:
- system rounds currency values according to the settings of a respective currency;
- other parameters are rounded to the nearest ten thousandth. For example: 3.879256 to 3.8793.
Creating Query Template
User can create a template for profit reports and save specified parameters by clicking Save Query button. A pop-up window with settings will appear and you need to fill out the following form:
Screenshot: New Template form
Section | Description | |
---|---|---|
Profit report | Here you can specify parameters for the template that will be used while running reports | |
Title | Specify a name of the template | |
Reseller | Indicate a Reseller of the report template | |
Visibility | It allows controlling visibility of respective reports templates. Whether you want to keep templates private or leave them visible for users under specified Reseller. To enable this option, select one parameter from the drop-down list:
| |
Watch | This tool allows to automatically generate reports at the appropriate time and send the results to the list of e-mails Attention Please note, this tool is not available for Web output type, only for CSV / Excel XLS / Excel XLSx. | |
Recipients | Specify recipients: it can be your own email, other users of the system or even 3rd parties | |
Run Time | Define an appropriate time to automatically generate a report. It could be several times, for example: 10:00, 12:00, 18:00 | |
Days of Week | Indicate days of the week to automatically generate a report. For example, you can run a report only on Monday or each day of week | |
Report Query | Here you need to specify filters that will be used for generating a correct report and choose the output type to view the report. |
To preview or load already existing templates while generating statistic reports, click Load Query button and click on a template name or icon, respectively.
Export Generated Report
You can export data to XLSx or CSV file, which contains currently presented data by pressing Export to XLSx or Export to CSV button respectively. Please note that Export to CSV is available only when the Type of the output is Plain.
Attention
You can check an actual date interval of the report by clicking on Info icon, and it could be different from the Interval specified above if there is no date for the period.
Side-by-side report
This tool allows building a report with side-by-side sub-reports. Use it to run a comparative analysis on the same page. It's helpful for reviewing multiple parameters, totals and compare results at different time intervals. The Compare Period option is designed to create a report that shows two sub-reports side-by-side.
To enable this option, click on the plus sign next to the Period field and specify both intervals (Period 1 / Period 2) for the report.
Screenshot: Profit Report query form
Then, choose columns for main and comparative period in the report Output form. When all required parameters are specified, click the Query button.
To remove this filter, please click the delete icon.
You can modify a comparative mode by changing periods and columns. For example, to compare how different the profit of the two periods is , choose the Profit value from the Columns. Therefore, the final report splits the Profit into separate columns (see screenshot below).
Screenshot: Profit Report query form