Kolmisoft Wiki - User contributions [en]

MOR - Blocked IPs

2017-08-29T12:45:33Z

Aurelija:

Go to '''ADDONS -> Monitorings -> Blocked IPs''' to manage blocked IPs. An IP can be blocked by entering valid input values and by clicking the '''Block''' icon. The to-be-blocked IP '''must not''' be local or a current server IP. By clicking on the '''Unblock''' icon an IP is unblocked. All the blocking/unblocking changes will be active in '''one minute after they have been applied'''.
 
[[File:Mor blocked ips list.png]]
 
When IP is blocked manually reason says: MOR-BLOCKED-IP-FROM-GUI. When IP is blocked automatically by MOR reason says: fail2ban-AST_CLI_Attack. Below you see example how it looks in GUI:
 
[[File:Blocekd_IPs_example.png]]
 
Explanation of the values given in the '''Reason''' column can be found [[How_to_be_secure_using_MOR#Additional_software_to_increase_MOR_system_security|here]]. Reason "INPUT" means that IP was blocked manually by using these instructions: [[How to block someone%27s IP]]
 
=See Also=

* [[How to block someone's IP]]
* [[How to block country IP]]
* [[How to add Fail2ban exception for my IP]]

File:Blocekd IPs example.png

2017-08-29T12:39:21Z

Aurelija: uploaded a new version of "File:Blocekd IPs example.png"

File:Blocekd IPs example.png

2017-08-29T12:38:44Z

Aurelija: uploaded a new version of "File:Blocekd IPs example.png"

File:Blocekd IPs example.png

2017-08-29T12:33:30Z

Aurelija:

Invoices

2017-08-01T13:48:09Z

Aurelija: /* XLSX Invoices */

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoice types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number and TAX Registration Number are included in the output CSV file) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:Invoice list small.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
Example of XLSX Invoice can be downloaded [http://wiki.kolmisoft.com/images/9/93/Invoice_example_for_wiki.xls here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file use as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.
 
[[File:Setttings xlsx.png]]
 
For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.

Example of PDF invoice can be downloaded by clicking [http://wiki.kolmisoft.com/images/a/a0/Example-Invoice-for-wiki.pdf here] and for detailed invoice click [http://wiki.kolmisoft.com/images/e/e1/Example-Detailed-Invoice-for-wiki.pdf here].
 

=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 

= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:Pay_unpaid_invocies.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Delete all Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Delete all invoices''' will appear.
 
[[File:Delete_all_invoices.png]]
 
Click '''Delete all invoices''' and '''all listed Invoices in all pages''' will be deleted (with respect to search filter).
 
'''Note:''' Invoices, which were already sent, are possible to delete only with option enabled in: Invoices->Functionality-> Invoice allow recalculate after send.
 

= Send invoices by email (manual) =

Click '''Send Invoices over Email to Users''' to send invoices to their Users in this period:
 
[[Image:Invoce email.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 

= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

= Export all to XLSX =

In Invoices list you can click on '''Export all to XLSX''' link to download all Invoices' XLSX files in a single ZIP. It includes all Invoices matching your search.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

Invoices

2017-08-01T13:44:03Z

Aurelija: /* XLSX Invoices */

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoice types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number and TAX Registration Number are included in the output CSV file) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:Invoice list small.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
Example of XLSX Invoice can be downloaded [http://wiki.kolmisoft.com/images/9/93/Invoice_example_for_wiki.xls here] and for detailed invoice click [http://wiki.kolmisoft.com/images/e/e3/Invoice_detailed_example_for_wiki.xls here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file use as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.
 
[[File:Setttings xlsx.png]]
 
For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.

Example of PDF invoice can be downloaded by clicking [http://wiki.kolmisoft.com/images/a/a0/Example-Invoice-for-wiki.pdf here] and for detailed invoice click [http://wiki.kolmisoft.com/images/e/e1/Example-Detailed-Invoice-for-wiki.pdf here].
 

=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 

= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:Pay_unpaid_invocies.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Delete all Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Delete all invoices''' will appear.
 
[[File:Delete_all_invoices.png]]
 
Click '''Delete all invoices''' and '''all listed Invoices in all pages''' will be deleted (with respect to search filter).
 
'''Note:''' Invoices, which were already sent, are possible to delete only with option enabled in: Invoices->Functionality-> Invoice allow recalculate after send.
 

= Send invoices by email (manual) =

Click '''Send Invoices over Email to Users''' to send invoices to their Users in this period:
 
[[Image:Invoce email.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 

= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

= Export all to XLSX =

In Invoices list you can click on '''Export all to XLSX''' link to download all Invoices' XLSX files in a single ZIP. It includes all Invoices matching your search.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

Invoices

2017-08-01T13:40:02Z

Aurelija: /* XLSX Invoices */

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoice types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number and TAX Registration Number are included in the output CSV file) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:Invoice list small.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
Example of XLSX Invoice can be downloaded [http://wiki.kolmisoft.com/images/9/93/Invoice_example_for_wiki.xls here] and of detailed invoice click [http://wiki.kolmisoft.com/images/e/e3/Invoice_detailed_example_for_wiki.xls here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file use as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.
 
[[File:Setttings xlsx.png]]
 
For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.

Example of PDF invoice can be downloaded by clicking [http://wiki.kolmisoft.com/images/a/a0/Example-Invoice-for-wiki.pdf here] and for detailed invoice click [http://wiki.kolmisoft.com/images/e/e1/Example-Detailed-Invoice-for-wiki.pdf here].
 

=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 

= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:Pay_unpaid_invocies.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Delete all Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Delete all invoices''' will appear.
 
[[File:Delete_all_invoices.png]]
 
Click '''Delete all invoices''' and '''all listed Invoices in all pages''' will be deleted (with respect to search filter).
 
'''Note:''' Invoices, which were already sent, are possible to delete only with option enabled in: Invoices->Functionality-> Invoice allow recalculate after send.
 

= Send invoices by email (manual) =

Click '''Send Invoices over Email to Users''' to send invoices to their Users in this period:
 
[[Image:Invoce email.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 

= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

= Export all to XLSX =

In Invoices list you can click on '''Export all to XLSX''' link to download all Invoices' XLSX files in a single ZIP. It includes all Invoices matching your search.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

File:Invoice detailed example for wiki.xls

2017-08-01T13:36:14Z

Aurelija:

Invoices

2017-08-01T13:35:21Z

Aurelija: /* PDF invoices */

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoice types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number and TAX Registration Number are included in the output CSV file) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:Invoice list small.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
Example of XLSX Invoice can be downloaded [http://wiki.kolmisoft.com/images/9/93/Invoice_example_for_wiki.xls here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file us as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.
 
[[File:Setttings xlsx.png]]
 
For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.

Example of PDF invoice can be downloaded by clicking [http://wiki.kolmisoft.com/images/a/a0/Example-Invoice-for-wiki.pdf here] and for detailed invoice click [http://wiki.kolmisoft.com/images/e/e1/Example-Detailed-Invoice-for-wiki.pdf here].
 

=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 

= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:Pay_unpaid_invocies.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Delete all Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Delete all invoices''' will appear.
 
[[File:Delete_all_invoices.png]]
 
Click '''Delete all invoices''' and '''all listed Invoices in all pages''' will be deleted (with respect to search filter).
 
'''Note:''' Invoices, which were already sent, are possible to delete only with option enabled in: Invoices->Functionality-> Invoice allow recalculate after send.
 

= Send invoices by email (manual) =

Click '''Send Invoices over Email to Users''' to send invoices to their Users in this period:
 
[[Image:Invoce email.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 

= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

= Export all to XLSX =

In Invoices list you can click on '''Export all to XLSX''' link to download all Invoices' XLSX files in a single ZIP. It includes all Invoices matching your search.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

File:Example-Detailed-Invoice-for-wiki.pdf

2017-08-01T13:30:29Z

Aurelija:

File:Example-Invoice-for-wiki.pdf

2017-08-01T13:29:12Z

Aurelija:

File:Invoice example for wiki.xls

2017-08-01T13:26:48Z

Aurelija: uploaded a new version of "File:Invoice example for wiki.xls"

Invoices

2017-08-01T13:25:08Z

Aurelija: /* XLSX Invoices */

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoice types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number and TAX Registration Number are included in the output CSV file) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:Invoice list small.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Invoice detailed''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
Example of XLSX Invoice can be downloaded [http://wiki.kolmisoft.com/images/9/93/Invoice_example_for_wiki.xls here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file us as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.
 
[[File:Setttings xlsx.png]]
 
For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.
 
=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 

= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:Pay_unpaid_invocies.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Delete all Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Delete all invoices''' will appear.
 
[[File:Delete_all_invoices.png]]
 
Click '''Delete all invoices''' and '''all listed Invoices in all pages''' will be deleted (with respect to search filter).
 
'''Note:''' Invoices, which were already sent, are possible to delete only with option enabled in: Invoices->Functionality-> Invoice allow recalculate after send.
 

= Send invoices by email (manual) =

Click '''Send Invoices over Email to Users''' to send invoices to their Users in this period:
 
[[Image:Invoce email.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 

= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

= Export all to XLSX =

In Invoices list you can click on '''Export all to XLSX''' link to download all Invoices' XLSX files in a single ZIP. It includes all Invoices matching your search.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

File:Invoice example for wiki.xls

2017-08-01T13:16:32Z

Aurelija:

Call routing per destination basis

2017-06-22T14:32:54Z

Aurelija:

SETTINGS > Billing > LCR and then click on icon in "By destinations" column.

Some destinations need fine tuning to better tell which providers should be used to reach that destination and in which order.

Each user has an assigned LCR. For some destinations, it is possible to set a different LCR.

[[File:Routing_by_destination_new.png]]

Different LCR can be set on '''Prefix''', '''Destination Name''' or '''Destination Group'''. 
Destination Names support wildcard characters: 
* % matches any number of characters, even zero characters. 
* _ matches exactly one character. 
== Example ==

We take [http://en.wikipedia.org/wiki/Paraguay Paraguay] as example, because this country has a small number of destinations.
 
[[Image:crpdb1.png]]
 
Let's say we have three providers (in LCR: Primary), and we use them all together for all our destinations. The route is picked by the least cost route, that is, the LCR order is by '''Price''':
 
[[Image:crpdb2.png]]
 
Then we have the situation that calls to Paraguay (except those to Mobiles) do not go through the provider Eutelia.

To handle this situation we create a new LCR: Secondary, in which the order is '''Priority'''. It excludes Eutalia and has only two providers:
 
[[Image:crpdb3.png]]
 
Now we need to configure Routing per destination.

Click on the '''By destinations''' icon for Primary LCR (because Primary LCR is used by the user who dials):
 
[[Image:crpdb4.png]]
 
We create the following configuration:
 
[[Image:crpdb5.png]]
 
== Explanation ==

Now when the user dials any Paraguay FIX number, the call will be routed using LCR: Secondary with order: priority:
 
[[Image:crpdb6.png]]
 
We can click on '''Active destinations''' and will see for which prefixes such an LCR applies:
 
[[Image:crpdb7.png]]
 
As we know that Eutalia can route calls to Mobile networks of Paraguay, so MOB destinations will be handled by old LCR:
 
[[Image:crpdb8.png]]
 
We can click on '''Active destinations''' and will see for which prefixes such an LCR applies:
 
[[Image:crpdb9.png]]
 
=See also=

* [[LCR]]
* [[Call Routing by price]]
* [[Call Routing by priority (Manual LCR) | Call Routing by priority ]]
* [[Routing by Percent | Call Routing by percent]] or Weight-based routing
* [[How to add Provider to LCR]]

M4 Rates

2017-05-25T13:42:34Z

Aurelija:

=Usage=

Go to '''Billing > Tariffs''' and here you will see all tariffs list grouped by Buy and Sell Tariffs.
 
[[File:tariffs_list.png|1000px]]
 

Click '''RATES''' to reach list of Rates. 
Click '''[[M2_Rates#Import_Rates_from_CSV | IMPORT FROM CSV]]''' to import Rates from CSV. 
Click '''[[M2_Rates#Update_Rates | UPDATE RATES]]''' to update Rates. 
Click '''DELETE ALL RATES''' to delete all Rates. 
Click '''[[M2_Rates#Rate_Check | RATE CHECK]]''' to compare Rates of all Tariffs.
 
''Note that you can use alphanumeric prefixes in M2.''
 
==Rate Check==

Click '''RATE CHECK''' button and you will reach page:
 
[[File:rate_check.png]]
 
Here you can see comparison of all Rates of particular Destinations. The lowest Rate in line is marked with green and the highest - with red color. Only effective rates are displayed.
 

==Update Rates==

Click '''UPDATE RATES''' and you will reach page:
 
[[File:update_rates.png|1000px]]
 
Here you can change Rates for All selected Destinations at once. Need to write all name of Destination to change Rates for that Destination. Also you can write first few letters of Destination and % sign to update Rates for group of Destinations.
 

==Import Rates from CSV==

You are able to import tariff rates from a CSV file by opening '''Billing -> Tariffs''' and clicking on the 'IMPORT FROM CSV' link on any given tariff in the list.

* Step 1.1 '''File uploading''':
After clicking the link you're prompted to select and upload the CSV file you want to import.
* Step 1.2 '''Separator selection''':
Once the file is uploaded, you'll be shown a minor part of it's content.
This step allows you to change the system suggested ''Column Separator'' and the ''Decimal Separator'' if you think that either one of them is not valid.
* Step 2 '''Import settings and column selection'''
In this step, you're able to change various settings that will effect your import.

'''''Rate Day Type'', ''From-Till''''': Determines which rate types the new rate values will effect, allowing you to import new rates for ''Work Days'' or ''Free Days'' rates.
 
'''''Use Destination Names from file'''''- When this option is selected destination name is updated from CSV file during rate import.
 
'''''Delete Rates for Prefixes which are not present in imported file''''': This option allows you to delete existing rates, which will not be updated.(The prefixes that belong to these rates are not a part of the file being imported).
 
'''Column Selection'''
 
Here we must assign columns from the CSV file. Prefix and Rate are mandatory fields. All other fields can be empty. Effective from date, Connection Fee, Increment and Min. Time have their defaults.
If you wish, you can enter values manually for them. Manually entered values have the highest priority. If you omit them, then MOR inserts values from the CSV file. If there is no assigned column for these fields, then default values will be added to database (DB).
* Step 3 '''Column Confirmation'''
This step allows you to review the settings you've set, and the columns you've assigned, in order to prevent any unintentional user errors.
* Step 4 '''Analysis'''
During this step, the application analizes the CSV file and determines the order of steps that should be taken.
Information to be found in the analysis step:
'''DB Analysis'''
''Directions in DB''
''Destinations in DB''
''Tariff Rates''
'''CSV file analysis'''
''File size''
''Total file lines''
''Destinations in CSV file''
''Existing destinations in CSV file''
''New destinations in CSV file''
''bad destinations''
'''To do'''(Steps to be taken)
''Destinations to create''
''Rates to update''
''New rates to create''

* Step 5 '''Updating rates'''

Here M2 updates rates with the values from CSV files. These rates already exist in DB. Just click Proceed.

* Step 6 '''Creating new rates'''

During this step M2 creates new rates for the tariff, which haven't existed in the DB so far.

* Step 7 '''Deleting rates '''

This is the final step. M2 deletes the rates which were not a part of the file being imported. You're all done!
 

==Rates Refine Results ==
Click '''REFINE RESULTS''' button in rates list and you will see page:
 
[[File:Rates_search.png|1000px]]
 
Here you can write prefix and find Rates with this prefix from Rates List.

 

==User Rates==

Users can also view rates in Connection Points by pressing on Tariff's name
 
[[File:M2_user_connection_points.png]]
 
After click User will be redirected into Rates list
 
[[File:M2_user_rates_list.png]]

=See also=

[[M2_Rate_Details | Rate Details]]

M4 Tariffs

2017-05-25T13:35:59Z

Aurelija: /* Usage */

=Description=

Tariffs are sets of Rates (prices) to different Destinations. There is supported just one type off Tariffs and it is '''Wholesale'''. In Wholesale Tariffs, Rates can be set to every Destination possible.
 
=Usage=

Go to '''Billing > Tariffs''' and here you will see all tariffs list grouped by Buy and Sell Tariffs.
 
[[File:tariffs_list.png|1000px]]
 
In this list you can find such information as Tariff name, its Currency, how many Rates does Tariff has. Also you can check usage, how many [[M2 Termination Points | Termination Points]]/[[M2_Origination_Points|Origination Points]] are using particular Tariff. 
You can make a lot actions like manage [[M2 Rates | Rates]], make new Tariff from current Tariff, export PDF/CSV files. Also there is ability to create new Tariff without Rates or Generate new Tariff from old ones already with Rates, change Tariff for Users and Export Destinations to CSV.
 
==Tariff Generator==

This is an functionality to generate a new Tariff by combining existing ones.

Just go to '''BILLING > Tariffs''' find button '''Generate Tariff''' and press it.
 
[[File:tariff_generator.png]]
 
Here you can enter name of new Tariff, its Currency, Profit Margin percent and select from which Tariffs new one should be generated. Tariffs you can choose by Tariff names and by [[M2 Dial Peers|Dial Peers]] (all [[M2 Termination Points|Termination Point]] tariffs will be used)

All selected Tariffs will be merged into one new Tariff. If two or more Tariffs have Rates for the same Destination, then selected n-th cheast Rate (valued by system Currency) for that Destination will be chosen. If Profit Margin on selected cheapest n-th Rate is lower than Profit Margin on the cheapest Rate (for the same prefix in all selected Tariffs) then cheapest Rate with Profit Margin will be used instead on n-th cheapest Rate. All Rates will be converted to selected Currency.
 
===Exampe===

Current Rates of selected Tariffs:
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
! Destination (Prefix)
! Tariff A
! Tariff B
|-
| 370
| 0.1
| 0.05
|-
| 3705
| 0.1
| -
|-
| 3706
| 0.2
| 0.3
|-
| 888
| -
|0.8
|}
 
If in selected Tariffs there will be Destinations without Rates, Rates from Destinations with shorter Prefix will be taken. If there is no Destination with shorter Prefix, it will stay without Rate.
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
! Destination (Prefix)
! Tariff A
! Tariff B
|-
| 370
| 0.1
| 0.05
|-
| 3705
| 0.1
| '''0.05'''
|-
| 3706
| 0.2
| 0.3
|-
| 888
| -
|0.8
|}
'''NOTE''' Rate 0.05 will be treated as Rate of Prefix 3705 in Tariff B, because Prefix 370 has this Rate. Prefix 888 in Tariff A will be treated as without Rate, because there are no Prefixes in that Tariff which starts with 8.
 
If Profit Margin is 10% on 1st cheapest Rate new Tariff will have Rates as Tariff C:
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
! Destination (Prefix)
! Tariff A
! Tariff B
! Tariff C
|-
| 370
| 0.1
| 0.05
| 0.055
|-
| 3705
| 0.1
| 0.05
| 0.055
|-
| 3706
| 0.2
| 0.3
| 0.22
|-
| 888
| -
|0.8
|0.88
|}

 
If two or more rates have different minimal time, increment or connection fee value, '''max''' value will be chosen for newly created rates.

 

= Create new tariff from highest Rate, not lowest =

If you know you have 3 tariffs from which you want to create new tariff, then select to add something to the 3rd tariff, that would be the same as adding something to the highest rate.

Example:

You have 3 tariffs: A with price 3, B with price 5, C with price 1

Let's add 100% to the 3rd "CHEAPEST" rate, that would be tariff B with price 5 (ordered in increasing order: 1 3 5)

Result would be 5 + 100% = 10

This is the same as creating new tariff from the highest rate.

No data in Statistics pages

2017-04-27T13:06:46Z

Aurelija:

This applies since MOR X7.

Run following commands to fix it:

service elasticsearch restart
elasticsearch resync

 
ES (ElasticSearch) is a tool that we use to show statistics in MOR. 
ES Sync Status shows how accurate is ES data compared to MySQL data. 
ES periodically fetches data from MySQL. 
Since this action is not in real time, some miss match is possible when you have active calls. 
This miss match should be only noticeable when checking newest calls. 
Eventually all calls should be synchronized between ES and MySQL. Small percentage miss match is normal.

No data in Calls by Clients

2017-04-27T13:02:06Z

Aurelija: moved No data in Calls by Clients to No data in Statistics pages

#REDIRECT [[No data in Statistics pages]]

No data in Statistics pages

2017-04-27T13:02:06Z

Aurelija: moved No data in Calls by Clients to No data in Statistics pages

This applies since MOR X7.

Run following commands to fix it:

service elasticsearch restart
elasticsearch resync

Recordings Addon

2017-04-27T07:00:51Z

Aurelija: /* How to use this functionality */

=Description=

Recordings functionality can be used to record selected users' calls for Monitoring purpose.
 
== Functionality ==

Recording Addon provides this functionality:

* Record User Calls.
* Send a Recording to email.
* Limit space Users' space for Recordings.
* Record Calls without User knowledge.
* Let Users manage their Recordings (send to email/listen/download/delete).
* Convert recordings from WAV to MP3 format and store them on an external server, to ease the load on the main server.

NOTE: Resellers is able to have the same functions as an administrator if '''Allow to use recording functionality''' option is checked by Admin in resellers settings. In order for the calls to be recorded for resellers users the "Record calls for this Device:" option (located in the device edit window, "Recordings" block) has to be enabled by the reseller for the devices for which the calls should be recorded.
 
=== Limitations ===

* Recordings will not be saved on the server if there will be left less then 10% of free space. Such recordings will be sent directly to the Email (if email is specified in GUI Interface) and will be completely removed from the server.

* Currently it is not possible to record Calls that are made between local extensions, but it is possible to record calls if a local device has a DID assigned to it and the call is made dialing the DID number, so the call would go like this: local extension > DID > local extension.

*Calling Cards calls cannot be recorded.
 

=== Sound file format ===

Recordings are saved into mp3 format. 1mb can save around 4min of recordings.
 

=Configuration=

In order to use Recording, you have to set up which Users' Calls you want to record.

Go to '''ADDONS –> Recordings –> Users''' and you will see this window:
 
[[Image:recordings1.png]]
 

Here you can check the '''Forced record calls for this User''' field for the Users you want to record. By checking '''Allow to use recording functionality''' option you can authorize the User to use the Recordings Addon functionality. Click '''Update''' at the bottom for the changes to take effect.
To allow particular Reseller to use Recordings functionality, "Allow to use recording functionality" option must be checked in his details.

If you leave '''Server space (Mb)''' 0 - there will be no limitations in data usage (HDD will fill up after some time).

'''NOTE''' Recordings are NOT available in Calls between 2 SIP Devices in MOR.
 
'''SETTINGS –> Users –> Edit (on selected user)'''

The Recordings section has the following options:

* Allow to use recording functionality - can this user use the Recording addon functionality?

* Forced record calls for this User - record calls for this user (all devices) without user knowledge. This option has the highest priority.
when enabled - records for all User devices will be recorded regardless of other options (value in Device settings: Record calls for this Device: - will be ignored, Server space - dedicated for User will be ignored ant etc )

* Server space - how much HDD space to reserve for recordings of this user. Takes effect only if Admin has not enabled recordings for User himself. Such options should be set on appropriate User/Device by Admin in order to enable this function for User:
User settings
Forced record calls for this User: NO
Device settings:
Record calls for this Device : NO
Keep Recordings on Server after sent to Email: NO

* Send deleted recordings to this email. If HDD space is used, the recording will be deleted and sent to this email. If this email is empty, the recording will be sent to the default user email. Recordings will be kept in server if email sending fails.
 
'''Device –> Edit window'''

The following options are available for Device:

* '''Record calls for this Device''' - record calls for this Device (without user knowledge). If this option is enabled, recordings must be deleted manually. If this option is set to YES, then server space - dedicated for User will be ignored and records will be placed on server regardless of this value
* '''Show Recordings to the User for this Device''' - allows User to see such recordings
* '''Send Recording to Email''' - when recording is completed, send to it email. Recordings will be kept in server if email sending fails.
* '''Recordings Email''' - send to this email address.
* '''Keep Recordings on Server after sent to Email''' - should the recording be left on the server after being sent to email? If this option is set to YES, then server space - dedicated for User will be ignored and records will be placed on server regardless of this value
 
[[File:device_recordings_settings.png]]
 
== Setup User so he could see his recorded Calls ==

1. As admin, go to '''User Edit''' settings [[Image:icon_edit.png]] and check '''Allow to use recording functionality'''. User will be able to use Recording addon functionality.

2. Log in as this User and in '''PERSONAL MENU –> Details –> Devices''', click [[Image:icon_edit.png]] for Device and in the Recordings section check '''Record calls for this Device: YES.'''

3. Now the user will be able to see his calls in '''PERSONAL MENU –> Call –> Recordings'''.
 
=== User settings ===

The Administrator must authorize the User to use the Recording Addon functionality before User can use its functions. This can be done by checking '''Allow to use recording functionality''' in the User Edit window.
 
'''PERSONAL MENU –> Details'''

* Server space - shows used/reserved HDD space for recordings.
* Email for deleted Recordings - to which email recordings should be sent if there is not enough space for them.
 
'''PERSONAL MENU –> Details –> Devices –> Edit'''

* Record calls for this Device - user can set to record calls for this device or not.
* Send Recording to Email - should recording be sent to email? Recordings will be kept in server if email sending fails.
* Recordings Email - the email address email to which recordings should be sent.
* Keep Recordings on Server after sent to Email - should recordings be left on the server after being sent to email?
 
'''PERSONAL MENU –> Calls –> Recordings'''

On this page, the User can manage his recordings.
 
User Owner can decide:

* Whether or not the user can use Recording Addon functionality (set to record calls, send recordings to email, etc).
* Which user calls should always be recorded (without User knowledge).
 

== Record not answered calls ==

In order to enable this functionality few changes a needed: 

1) Edit /etc/asterisk/mor.conf 

vi /etc/asterisk/mor.conf

and set '''record_not_answered_calls =''' '''1''' 

This option record_not_answered_calls - save audio to the file while the channel is not answered (not bridged), default 0 (by default records only answered calls).
 

2) Option Show Recordings with zero billsec should be enabled in GUI. 

To enable it go to '''SETTINGS –> Setup –> Visual''' and check option '''Show recordings with zero billsec'''. 
 
[[Image:recordingams.png]]
 
Now system records not answered calls for all users which are using recording functionality. 

Recordings are located in '''ADDONS –> Recordings.''' 

In recording list you will be able to see recordings without duration. 

Such calls were not answered but recorded.
 
[[Image:recordingams2.png]]
 
== Delete recordings after sending it via e-mail ==

1. As admin, go to '''User Edit''' settings [[Image:icon_edit.png]] and check '''Allow to use recording functionality'''. User will be able to use Recording addon functionality. Do not check '''Forced record calls for this User''' because it this way recordings will '''NOT''' be deleted.

2. Log in as this User and in '''PERSONAL MENU –> Personal Details –> Devices''', click [[Image:icon_edit.png]] for Device and in the Recordings section check '''Keep Recordings on Server after sent to Email: NO.'''

3. Now recordings will be deleted immediately after they will be sent via e-mail.
 
==Recordings on external server==

Manage settings for recordings upload to external server go to '''ADDONS –> Recordings –> Settings'''
 
[[File:recordings_settings_path.png]]
 
you will reach settings page
 
[[File:recordings_addon_settings.png]]
 
* Use external Server - should system send recordings to [[External Recordings Server]]?
* Recordings server - details such as IP/Port/Login where port is SSH default port 22 and Login is default root.
* By default recording files in remote server will be placed at /tmp directory

'''P.S. SSH keys must be configured without password in order scp command could transfer the recordings to other server. If this functionality is not enabled - the recordings are stored in local server'''
 

==Recordings on additional HDD==

If you want to save recordings on additional HDD, please follow this instrucction
[[Recordings on additional HDD]].

=Usage=

To view/listen/download/delete recorded Calls go to '''ADDONS –> Recordings'''. You will see something like this:
 
[[Image:recordings2.png]]
 
Here Admin/Reseller can see all recordings, search Recordings by:

* Period.
* Source (CallerID).
* Destination (Dialed number).
* User.
* Device.

With each recording, it is possible to:

* Check its details.
* Check Call details.
* Add comment to it (note that User and Admin have different comment fields)
* Listen to it.
* Download it.
* Delete it.
 
'''NOTE:''' When listening to a recording its row will turn green as an indicator that the recording was listened.
 
[[Image:Recordig_listened_indicator.png]]
 

= Recordings bulk management =

This feature allows an administrator to quickly delete Recordings for selected period or selected Device
 
=== Who can use this functionality? ===

* This feature is only available for MOR administrator
 
=== How to use this functionality ===

To delete by device: 
Go to '''ADDONS –> Recordings'''
 
[[File:Recordings_menu_path.png]]
 
Click on [[image:icon_edit.png]] '''Bulk management''' link.
 
[[File:Recordings_bulk_management.png]]
 
Here you can check an option to delete by device, select device and click '''Delete'''.
 
[[File:Recordings_bulk_management_confirm.png]]
 
Confirm that you really want to delete recordings of selected device.
 
To delete by date: 
Go to '''ADDONS –> Recordings'''
 
[[File:Recordings_menu_path.png]]
 
Click on [[image:icon_edit.png]] '''Bulk management''' link.
 
[[File:Date bulkmanagement.png]]
 
Here you can check an option to delete by date, select date and click '''Delete'''.
 
[[File:Date recorddelete.png]]
 
Confirm that you really want to delete recordings of selected period.

=See also=

* [[MOR Addons]]

File:Date recorddelete.png

2017-04-27T06:49:06Z

Aurelija:

File:Date bulkmanagement.png

2017-04-27T06:48:27Z

Aurelija:

Recordings Addon

2017-04-27T06:45:02Z

Aurelija: /* How to use this functionality */

=Description=

Recordings functionality can be used to record selected users' calls for Monitoring purpose.
 
== Functionality ==

Recording Addon provides this functionality:

* Record User Calls.
* Send a Recording to email.
* Limit space Users' space for Recordings.
* Record Calls without User knowledge.
* Let Users manage their Recordings (send to email/listen/download/delete).
* Convert recordings from WAV to MP3 format and store them on an external server, to ease the load on the main server.

NOTE: Resellers is able to have the same functions as an administrator if '''Allow to use recording functionality''' option is checked by Admin in resellers settings. In order for the calls to be recorded for resellers users the "Record calls for this Device:" option (located in the device edit window, "Recordings" block) has to be enabled by the reseller for the devices for which the calls should be recorded.
 
=== Limitations ===

* Recordings will not be saved on the server if there will be left less then 10% of free space. Such recordings will be sent directly to the Email (if email is specified in GUI Interface) and will be completely removed from the server.

* Currently it is not possible to record Calls that are made between local extensions, but it is possible to record calls if a local device has a DID assigned to it and the call is made dialing the DID number, so the call would go like this: local extension > DID > local extension.

*Calling Cards calls cannot be recorded.
 

=== Sound file format ===

Recordings are saved into mp3 format. 1mb can save around 4min of recordings.
 

=Configuration=

In order to use Recording, you have to set up which Users' Calls you want to record.

Go to '''ADDONS –> Recordings –> Users''' and you will see this window:
 
[[Image:recordings1.png]]
 

Here you can check the '''Forced record calls for this User''' field for the Users you want to record. By checking '''Allow to use recording functionality''' option you can authorize the User to use the Recordings Addon functionality. Click '''Update''' at the bottom for the changes to take effect.
To allow particular Reseller to use Recordings functionality, "Allow to use recording functionality" option must be checked in his details.

If you leave '''Server space (Mb)''' 0 - there will be no limitations in data usage (HDD will fill up after some time).

'''NOTE''' Recordings are NOT available in Calls between 2 SIP Devices in MOR.
 
'''SETTINGS –> Users –> Edit (on selected user)'''

The Recordings section has the following options:

* Allow to use recording functionality - can this user use the Recording addon functionality?

* Forced record calls for this User - record calls for this user (all devices) without user knowledge. This option has the highest priority.
when enabled - records for all User devices will be recorded regardless of other options (value in Device settings: Record calls for this Device: - will be ignored, Server space - dedicated for User will be ignored ant etc )

* Server space - how much HDD space to reserve for recordings of this user. Takes effect only if Admin has not enabled recordings for User himself. Such options should be set on appropriate User/Device by Admin in order to enable this function for User:
User settings
Forced record calls for this User: NO
Device settings:
Record calls for this Device : NO
Keep Recordings on Server after sent to Email: NO

* Send deleted recordings to this email. If HDD space is used, the recording will be deleted and sent to this email. If this email is empty, the recording will be sent to the default user email. Recordings will be kept in server if email sending fails.
 
'''Device –> Edit window'''

The following options are available for Device:

* '''Record calls for this Device''' - record calls for this Device (without user knowledge). If this option is enabled, recordings must be deleted manually. If this option is set to YES, then server space - dedicated for User will be ignored and records will be placed on server regardless of this value
* '''Show Recordings to the User for this Device''' - allows User to see such recordings
* '''Send Recording to Email''' - when recording is completed, send to it email. Recordings will be kept in server if email sending fails.
* '''Recordings Email''' - send to this email address.
* '''Keep Recordings on Server after sent to Email''' - should the recording be left on the server after being sent to email? If this option is set to YES, then server space - dedicated for User will be ignored and records will be placed on server regardless of this value
 
[[File:device_recordings_settings.png]]
 
== Setup User so he could see his recorded Calls ==

1. As admin, go to '''User Edit''' settings [[Image:icon_edit.png]] and check '''Allow to use recording functionality'''. User will be able to use Recording addon functionality.

2. Log in as this User and in '''PERSONAL MENU –> Details –> Devices''', click [[Image:icon_edit.png]] for Device and in the Recordings section check '''Record calls for this Device: YES.'''

3. Now the user will be able to see his calls in '''PERSONAL MENU –> Call –> Recordings'''.
 
=== User settings ===

The Administrator must authorize the User to use the Recording Addon functionality before User can use its functions. This can be done by checking '''Allow to use recording functionality''' in the User Edit window.
 
'''PERSONAL MENU –> Details'''

* Server space - shows used/reserved HDD space for recordings.
* Email for deleted Recordings - to which email recordings should be sent if there is not enough space for them.
 
'''PERSONAL MENU –> Details –> Devices –> Edit'''

* Record calls for this Device - user can set to record calls for this device or not.
* Send Recording to Email - should recording be sent to email? Recordings will be kept in server if email sending fails.
* Recordings Email - the email address email to which recordings should be sent.
* Keep Recordings on Server after sent to Email - should recordings be left on the server after being sent to email?
 
'''PERSONAL MENU –> Calls –> Recordings'''

On this page, the User can manage his recordings.
 
User Owner can decide:

* Whether or not the user can use Recording Addon functionality (set to record calls, send recordings to email, etc).
* Which user calls should always be recorded (without User knowledge).
 

== Record not answered calls ==

In order to enable this functionality few changes a needed: 

1) Edit /etc/asterisk/mor.conf 

vi /etc/asterisk/mor.conf

and set '''record_not_answered_calls =''' '''1''' 

This option record_not_answered_calls - save audio to the file while the channel is not answered (not bridged), default 0 (by default records only answered calls).
 

2) Option Show Recordings with zero billsec should be enabled in GUI. 

To enable it go to '''SETTINGS –> Setup –> Visual''' and check option '''Show recordings with zero billsec'''. 
 
[[Image:recordingams.png]]
 
Now system records not answered calls for all users which are using recording functionality. 

Recordings are located in '''ADDONS –> Recordings.''' 

In recording list you will be able to see recordings without duration. 

Such calls were not answered but recorded.
 
[[Image:recordingams2.png]]
 
== Delete recordings after sending it via e-mail ==

1. As admin, go to '''User Edit''' settings [[Image:icon_edit.png]] and check '''Allow to use recording functionality'''. User will be able to use Recording addon functionality. Do not check '''Forced record calls for this User''' because it this way recordings will '''NOT''' be deleted.

2. Log in as this User and in '''PERSONAL MENU –> Personal Details –> Devices''', click [[Image:icon_edit.png]] for Device and in the Recordings section check '''Keep Recordings on Server after sent to Email: NO.'''

3. Now recordings will be deleted immediately after they will be sent via e-mail.
 
==Recordings on external server==

Manage settings for recordings upload to external server go to '''ADDONS –> Recordings –> Settings'''
 
[[File:recordings_settings_path.png]]
 
you will reach settings page
 
[[File:recordings_addon_settings.png]]
 
* Use external Server - should system send recordings to [[External Recordings Server]]?
* Recordings server - details such as IP/Port/Login where port is SSH default port 22 and Login is default root.
* By default recording files in remote server will be placed at /tmp directory

'''P.S. SSH keys must be configured without password in order scp command could transfer the recordings to other server. If this functionality is not enabled - the recordings are stored in local server'''
 

==Recordings on additional HDD==

If you want to save recordings on additional HDD, please follow this instrucction
[[Recordings on additional HDD]].

=Usage=

To view/listen/download/delete recorded Calls go to '''ADDONS –> Recordings'''. You will see something like this:
 
[[Image:recordings2.png]]
 
Here Admin/Reseller can see all recordings, search Recordings by:

* Period.
* Source (CallerID).
* Destination (Dialed number).
* User.
* Device.

With each recording, it is possible to:

* Check its details.
* Check Call details.
* Add comment to it (note that User and Admin have different comment fields)
* Listen to it.
* Download it.
* Delete it.
 
'''NOTE:''' When listening to a recording its row will turn green as an indicator that the recording was listened.
 
[[Image:Recordig_listened_indicator.png]]
 

= Recordings bulk management =

This feature allows an administrator to quickly delete Recordings for selected period or selected Device
 
=== Who can use this functionality? ===

* This feature is only available for MOR administrator
 
=== How to use this functionality ===

Go to '''ADDONS –> Recordings'''
 
[[File:Recordings_menu_path.png]]
 
Click on [[image:icon_edit.png]] '''Bulk management''' link.
 
[[File:Recordings_bulk_management.png]]
 
Here you can check an option to delete by device, select device and click '''Delete'''.
 
[[File:Recordings_bulk_management_confirm.png]]
 
Confirm that you really want to delete recordings of selected device.
 

=See also=

* [[MOR Addons]]