Kolmisoft Wiki - User contributions [en]

Invoices

2015-03-25T13:52:21Z

Tester2: /* Invoices list */

= 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:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.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 file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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 for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx 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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

=== 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]]
 
= Send invoices by email (manual) =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.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.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

Invoices

2015-03-25T13:48:01Z

Tester2: /* Invoices list */

= 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:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.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 rate will be set from the day when invoice was generated (0.25). 
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 file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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 for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx 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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

=== 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]]
 
= Send invoices by email (manual) =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.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.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

Invoices

2015-03-25T13:47:24Z

Tester2: /* Invoices list */

= 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:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.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 exchange rate will be set from the day when invoice was generated (0.25). 
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 file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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 for [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx 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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

=== 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]]
 
= Send invoices by email (manual) =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.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.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

Tariffs

2015-03-17T15:01:09Z

Tester2: /* Usage */

=Description=

Tariffs are sets of rates (prices) to different destinations. There are three types of tariffs: providers wholesale (inbound), users wholesale (outbound) and users retail (outbound).
 
===Tariff types===

There are two types of tariffs – '''Wholesale''' and '''Retail'''. Note that Tariffs for [[Providers]] type are also Wholesale. The difference between '''wholesale''' and '''retail''' tariffs is in the way rates are set for destinations.

In wholesale tariffs, rates can be set to every destination possible. In retail tariffs, destinations are grouped, which makes it possible to have lower rates. Wholesale and retail tariffs are used in different situations, and each type has its advantages and disadvantages.

The advantage for wholesale providers is the possibility of entering different rates for different destinations. It is useful to set this tariff when you resell services to other providers.

If your clients are retail end-users, it is better to use the retail tariff. They are easier to manage and understand for the final user.
 
=Usage=

Go to '''SETTINGS –> Billing –> Tariffs'''.
 
[[File:tariffs_path.png]]
 
You will see full list of all types of tariff:
 
[[File:tariffs.png]]
 
* Click on [[Image:icon_add.png]]'''New tariff''' to create new tariff. 
* [[Image:excel.png]]'''Destinations CSV''' exports all destinations list. 
* Click on [[image:icon_edit.png]]'''Change Tariff for Users''' to [[Bulk change Tariffs for Users]].
* Search applied for searching tariffs where chosen prefix has rate.
* You can see two numbers in Rates count, for example 251/251. First number shows active rates number, the second number shows total rates number.
 
===Wholesale tariff===

As you can see in picture above there are ability to manage [[Image:coins.png]] '''[[Entering Rates for Wholesale Tariff | Rates ()]]''' manually, [[Image:excel.png]][[Rate import from CSV|Import from CSV]], delete all rates form tariff. Also you can [[Make Retail Tariff from Wholesale Tariff explained | Make user retail tariff]] from wholesale tariff or make new wholesale tariff from old one. When Tariff has [[Rate Effective From | Effective From]] Rates then Active Rates will be taken. Check your tariff rates by exporting CSV files. Click on [[Image:Details-icon.png]] icon to see list of places, where this tariff is assigned.
 
'''Effective from for Provider tariff''' 

Provider's tariff list has column named [[Rate Effective From | Effective from]] which shows the date when the rate specified becomes active. This date cannot be changed or created in GUI, it can be added to GUI through [[Rate import from CSV |Tariff import]]
 

===Retail tariff===

As you can see in picture above there is an ability to manage [[Image:coins.png]] '''[[Entering Rates for Retail Tariff | Rates]]''' manually and to delete all rates from tariff. Check your tariff rates by exporting CSV files. Click on [[Image:Details-icon.png]] icon to see list of places, where this tariff is assigned.

=From Accountant=

Accountant must have [[Accountant permissions]] to manage Admins Tariffs.
 
=From Reseller/Reseller PRO=

Resellers have their own tariffs list and they are able to manage them independent from Admin.
 

=See also=

* [[Entering Rates for Wholesale Tariff]]
* [[Entering Rates for Retail Tariff]]
* [[Advanced Rates]]
* [[Rate import from CSV]]
* [[Importing Tariffs from CSV with wrong Regional Settings]]
* [[Make Retail Tariff from Wholesale Tariff explained]]
* [[Bulk change Tariffs for Users]]
* [[Day setup]]
* [[LCR/Tariff change based on call prefix]]
* [[Change Tariff for Connection Points]]

Invoices

2015-02-24T18:32:36Z

Tester2: /* Invoice generation */

= 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:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.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. In different currency you are able to check just total value of all selected Invoices.
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
==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 file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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.
 
'''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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

=== 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 for which users to recalculate invoices.
 
=== 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]]
 
= Send invoices by email =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.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.
 
=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

CDR Rerating

2015-02-03T14:53:47Z

Tester2: /* Usage */

= Description =

This function is used when you change Tariff for some customer and you want to recalculate Price for his Calls in the past. You need to select User, Period and system recalculates all Prices for all Calls in selected period for selected User. It affects balance of User and statistics will show information with new Prices.
 
=Usage=

Go to '''SETTINGS –> Billing –> CDR –> Rerating''':
 
[[Image:cdrrerating_image1.png]]
 
Select date interval and User whose Calls you want to rerate. You can select All Users and include calls of Reseller Users.



Also you are able su set '''Ghost Time''' percent, this value will increase user_billsec and/or reseller_billsec and price which depends on changed user_billsec and/or reseller_billsec. Ghost Time will be calculated just from initial billsec, and if you will rerate two timesr with same percentage value, on second time nothing will change. 0 leaves or returns initial user_billsec and/or reseller price.
 
Table below will show which data of Calls will be affected according each selection scenario.
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
!
! One of Admin Users
! One of Admin Resellers
!                 All Users                
! One of particular Reseller Users
! All Users (Reseller Users Included)
|-
| user_billsec,
user_rate,
user_price
|                 +
|                 -
|                 +
   (just for Admin Users Calls)
|                 +
|                 +
|-
| reseller_billsec,
reseller_rate,
reseller_price
|                 -
|                 +
 (for Calls of All Reseller Users)
|                 +
|                 -
|                 +
       (just for Reseller User Calls)
|}
'''NOTE''' If in Call of Reseller User will be used one of [[Common Use Providers]] Tariff to rerate Reseller Price will be taken form ADDONS -> Resellers -> Common use Providers. If in Call of Reseller User will be used one of Provider which belongs just to Reseller, Provider Price will be rerated by that Provider tariff.
 
* Press '''Rerate in Background(FAST)''' if you want to send Rerating task to [[Background Tasks]]. This way rerating of huge amount of Calls goes faster than SLOW method and also you do not need to wait in current page till rerating will be finished. '''Also Provider Billing details will be rerated'''

* Press '''Rerate in GUI(SLOW)'''. The rating mechanism is the same as in MOR application but here rating is done by GUI. '''Be patient – if there are many calls – it can take some time to rerate all of them'''. '''Provider Billing details will NOT be rerated.''' If you choose this way for Rerating you will be redirected to second step:
 
[[Image:cdrrerating2.png]]
 
Here you see call stats for selected date interval. When you are sure everything is correct – press '''Rerate''':
 
[[Image:cdrrerating3.png]]
 
Here you will see the Difference after Rerating.
 
== Rerate all users ==


Select 'All Users' from User selection to rerate all Users at once in selected period.
 
== Testing mode ==

Select '''Tariff for User''' below '''TESTING MODE''' header:
 
[[Image:cdrtestrerating.png]]
 
...and press '''Test with selected Tariff (SLOW)''' to check differences of Rates for selected User. This way Rerating will not save changes to Calls/Users.

Testing mode is useful for testing "What if User had this Tariff" scenarios.
 
'''Selected Tariff is used just in [[Image:icon_test.png]]Testing mode.''' Rerating functionality rerates old Calls by Tariff set in User Settings, if you did not change Tariff for User, after rerating Calls Prices will be same as were before.
 
== Tariff from Localization ==

If call's prefix is in Localization Rule which has some Tariff, this Tariff is used to count call's price instead of User's Tariff.
 

=Other notes=

* Re-rate does not take into account Flat Rates and User will be charged for such Calls. Do not do rerating for such User.

* Re-rate does not work when call's DID, LCR or Owner Device is changed by Localization rules.

* Re-rate will take Active Rate when Rates with [[Rate Effective From | Effective From]] are re-rated.

CDR Rerating

2015-02-03T14:53:15Z

Tester2: /* Usage */

= Description =

This function is used when you change Tariff for some customer and you want to recalculate Price for his Calls in the past. You need to select User, Period and system recalculates all Prices for all Calls in selected period for selected User. It affects balance of User and statistics will show information with new Prices.
 
=Usage=

Go to '''SETTINGS –> Billing –> CDR –> Rerating''':
 
[[Image:cdrrerating_image1.png]]
 
Select date interval and User whose Calls you want to rerate. You can select All Users and include calls of Reseller Users.



Also you are able su set '''Ghost Time''' percent, this value will increase user_billsec and/or reseller_billsec and price which depends on changed user_billsec and/or reseller_billsec. Ghost Time will be calculated just from initial billsec, and if you will rerate two timesr with same percentage value, on second time nothing will change. 0 leaves or returns initial user_billsec and/or reseller price.
 
Table below will show which data of Calls will be affected according each selection scenario.
 
{| class="wikitable" border="1" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #C0C0C0; padding: 0"
|-
!
! One of Admin Users
! One of Admin Resellers
!                 All Users                
! One of particular Reseller Users
! All Users (Reseller Users Included)
|-
| user_billsec,
user_rate,
user_price
|                 +
|                 -
|                 +
   (just for Admin Users Calls)
|                 +
|                 +
|-
| reseller_billsec,
reseller_rate,
reseller_price
|                 -
|                 +
 (for Calls of All Reseller Users)
|                 +
|                 -
|                 +
       (just for Reseller User Calls)
|}
'''NOTE''' If in Call of Reseller User will be used one of [[Common Use Providers]] Tariff to rerate Reseller Price will be taken form ADDONS -> Resellers -> Common use Providers. If in Call of Reseller User will be used one of Provider which belongs just to Reseller, Provider Price will be rerated by that Provider tariff.
 
* Press '''Rerate in Background(FAST)''' if you want to send Rerating task to [[Background Tasks]]. This way rerating of huge amount of Calls goes faster than SLOW method and also you do not need to wait in current page till rerating will be finished. '''Also Provider Billing details will be rerated'''

* Press '''Rerate in GUI(SLOW)'''. The rating mechanism is the same as in MOR application but here rating is done by GUI. '''Be patient – if there are many calls – it can take some time to rerate all of them'''. '''Provider Billing details will NOT be rerated.''' If you choose this way for Rerating you will be redirected to second step:
 
[[Image:cdrrerating2.png]]
 
Here you see call stats for selected date interval. When you are sure everything is correct – press '''Rerate''':
 
[[Image:cdrrerating3.png]]
 
Here you will see the Difference after Rerating.
 
== Rerate all users ==


Select 'All Users' from User selection to rerate all Users at once in selected period.
 
== Testing mode ==

Select '''Tariff for User''' below '''TESTING MODE''' header:
 
[[Image:cdrtestrerating.png]]
 
...and press '''Test with selected Tariff (SLOW)''' to check differences of Rates for selected User. This way Rerating will not save changes to Calls/Users.

Testing mode is useful for testing "What if User had this Tariff" scenarios.
 
'''Selected Tariff is used just in [[Image:icon_test.png]]Testing mode.''' Rerating functionality rerates old Calls by Tariff set in User Settings, if you did not change Tariff for User, after rerating Calls Prices will be same as were before.
 
== Tariff from Localization ==

If call's prefix is in Localization Rule which has some Tariff, this Tariff is used to count call's price instead of User's Tariff.
 

=Other notes=

* Re-rate does not take into account Flat Rates and User will be charged for such Calls. Do not do rerating for such User.

* Re-rate does not work when call's DID, LCR or Owner Device is changed by Localization rules.

* Re-rate will take Active Rate when Rates with [[Rate Effective From | Effective From]] are re-rated.

Multi-Level Resellers Addon

2015-02-03T14:46:31Z

Tester2: /* Description */

=Description=


Multi-Level Resellers functionality are integrated into MOR from X6 version. --->
In Multi-level structure – resellers are divided on 2 levels and have different rights. This functionality allows you to sell traffic and services to smaller companies that do not have their own switches or billing platforms yet but they want do VoIP business. These smaller companies in our product are defined as Partner Type Users who are able to create and configure their own Resellers (sub-resellers).

Partners are able to set for created Resellers their own Tariffs, Prepaid or Postpaid user type, credit limits and so on, also add Payments, generate and send Invoices, follow Calls and their Financial Statistics.
 
===Billing hierarchy===

Simple User Pays for Reseller => Reseller Pays for Partner => Partner Pays for Admin => Admin Pays for Provider
 

=Configuration=

Go to '''SETTINGS –> Users''', click [[Image:icon_add.png]]'''Add new''' and you will reach User create form. There you have to choose "partner" User Type:
 
[[File:partner_create.png]]
 
And fill all other parameters which are needed.

After pressing '''Create''' you will have Partner Type User.
 
=Useful Notes=

* Partners' Resellers will use admins' '''[[Reseller_Permissions|Resellers' Permissions Groups]]''', so be sure that you have them, otherwise Partner will be not able to create Reseller.
* For Partners' Resellers' Users '''Calls''' will be used Admins' [[LCR]] with all his [[Providers]], which have to be assigned in Partners' create or edit form.

Calls per Hour

2015-01-21T11:16:16Z

Tester2: Created page with '= Description = This page shows statistics of calls grouped first by days, then users, then hours and then by prefixes. == Who can access the page? == Admin and Accountant. …'

= Description =

This page shows statistics of calls grouped first by days, then users, then hours and then by prefixes.

== Who can access the page? ==

Admin and Accountant.

= Usage =

Go to '''STATISTICS –> Calls –> Calls per Hour''' 
 
[[File:Calls_per_hour_1.png]]
 
Besides Calls date, number of Attempted Calls, Answered Calls, Duration of calls made during the specific day/user/hour/prefix, Average Retries, you can also check and [http://wiki.kolmisoft.com/index.php/ASR/ACD ASR/ACD] information.
 
[[File:Calls_per_hour_2.png]]
 
You will not see days here that has no calls.

File:Calls per hour 2.png

2015-01-21T11:06:30Z

Tester2:

File:Calls per hour 1.png

2015-01-21T10:59:23Z

Tester2:

Invoices

2015-01-12T13:50:25Z

Tester2: /* Configuration */

= 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:Invoices_types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number is included in the output data) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:invoices_list_x6.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. In different currency you are able to check just total value of all selected Invoices.
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
==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 file shows information which are set by you. Check [[Invoices_(MOR_X6)#XLSX_Invoices | XLSX Invoice]]
*'''Invoice detailed''' PDF shows same information like simple invoice and includes calls list.
*'''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.
 
'''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'''
 
[[Image:invoice_xlsx_settings_x6.png]]
 
'''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.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 
=== 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.

'''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.
 
= 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 for which users to recalculate invoices.
 
=== 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]]
 
= Send invoices by email =

Click [[Image:icon_email_send.png]] to open more options to enter the period in which you want to send invoices. Click '''Send''' to send invoices to their Users in this period:
 
[[Image:invoices_send_x6.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.
 
=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]

File:Invoices types.png

2015-01-12T13:49:52Z

Tester2:

File:Invoices send x6.png

2014-11-13T10:20:39Z

Tester2: uploaded a new version of "File:Invoices send x6.png"

File:Invoices send x6.png

2014-11-13T10:20:12Z

Tester2: uploaded a new version of "File:Invoices send x6.png"

File:Invoices send x6.png

2014-11-13T10:16:00Z

Tester2:

File:Recaptcha3.png

2014-11-12T13:41:31Z

Tester2: uploaded a new version of "File:Recaptcha3.png"

File:Recaptcha2.png

2014-11-12T13:41:12Z

Tester2: uploaded a new version of "File:Recaptcha2.png"

File:Recaptcha1.png

2014-11-12T13:41:01Z

Tester2: uploaded a new version of "File:Recaptcha1.png"

File:Recaptcha3.png

2014-11-12T13:38:07Z

Tester2: uploaded a new version of "File:Recaptcha3.png"

File:Recaptcha2.png

2014-11-12T13:37:56Z

Tester2: uploaded a new version of "File:Recaptcha2.png"

File:Recaptcha1.png

2014-11-12T13:37:39Z

Tester2: uploaded a new version of "File:Recaptcha1.png"

ReCAPTCHA

2014-11-12T13:19:21Z

Tester2:

= Description =

A [http://recaptcha.net/ CAPTCHA] is a program that can tell whether its user is a human or a computer. You've probably seen them — colorful images with distorted text at the bottom of Web registration forms. CAPTCHAs are used by many websites to prevent abuse from "bots," or automated programs usually written to generate spam. No computer program can read distorted text as well as humans can, so bots cannot navigate sites protected by CAPTCHAs.

[http://recaptcha.net/ More info]

'''Tip: When generating CAPTCHA keys - please enable "global key" option, this way you will not have problems when you change your domain.'''

= Implementation in MOR =

reCAPTCHA is disabled by default in MOR.

To enable it, go to '''SETTINGS –> Setup –> Settings –> Registration'''.

Here mark '''reCAPTCHA enable''' and press on [https://admin.recaptcha.net/accounts/signup/?next= Get reCAPTCHA keys]

and follow pictures how to register and get keys:

[[Image:recaptcha1.png]]

Here enter your domain name, or your IP if you do not have a domain - for example: http://22.33.44.55 (put your IP here! Do not leave support.kolmisoft.com or 22.33.44.55 <- these are just examples!)

[[Image:recaptcha2.png]]

Copy-paste these keys into MOR configuration:

[[Image:recaptcha3.png]]

Now, on the registration page, the user should enter valid words to complete registration.

And in the registration page, the user will see captcha:

[[Image:recaptcha6.png]]

 
----
See also:
* [[Configuration from GUI#Registration | Registration configuration]]

ReCAPTCHA

2014-11-12T13:14:17Z

Tester2:

[[Image:recaptcha.gif|right]]
= Description =

A [http://recaptcha.net/ CAPTCHA] is a program that can tell whether its user is a human or a computer. You've probably seen them — colorful images with distorted text at the bottom of Web registration forms. CAPTCHAs are used by many websites to prevent abuse from "bots," or automated programs usually written to generate spam. No computer program can read distorted text as well as humans can, so bots cannot navigate sites protected by CAPTCHAs.

[http://recaptcha.net/ More info]

'''Tip: When generating CAPTCHA keys - please enable "global key" option, this way you will not have problems when you change your domain.'''

= Implementation in MOR =

reCAPTCHA is disabled by default in MOR.

To enable it, go to '''SETTINGS –> Setup –> Settings –> Registration'''.

Here mark '''reCAPTCHA enable''' and press on [https://admin.recaptcha.net/accounts/signup/?next= Get reCAPTCHA keys]

and follow pictures how to register and get keys:

[[Image:recaptcha1.png]]

Here enter your domain name, or your IP if you do not have a domain - for example: http://22.33.44.55 (put your IP here! Do not leave support.kolmisoft.com or 22.33.44.55 <- these are just examples!)

[[Image:recaptcha2.png]]

Copy-paste these keys into MOR configuration:

[[Image:recaptcha3.png]]

Now, on the registration page, the user should enter valid words to complete registration.

And in the registration page, the user will see captcha:

[[Image:recaptcha6.png]]

 
----
See also:
* [[Configuration from GUI#Registration | Registration configuration]]

Hangupcause Codes

2014-11-12T11:51:42Z

Tester2:

MOR application saves hangupcause codes (HGC in MOR terminology) to the database, so it is easy to check what the error was and why the call failed.

These codes can be seen in the Calls window (Hangup Cause column) when selected to show 'All', 'Busy', 'No Answer', 'Failed' or 'Missed' calls.

* Standard hangup codes can be found [http://www.voip-info.org/wiki/index.php?page=Asterisk+variable+hangupcause here].
* [http://networking.ringofsaturn.com/RemoteAccess/isdncausecodes.php ITU-T Q.850 Codes ]
* [http://en.wikipedia.org/wiki/List_of_SIP_response_codes SIP Response Codes]

 
= Standard codes =

<table>
<tr>
<td> Code </td>
<td> Cause </td>
</tr>
<tr>
<td> 34 </td>
<td> [[34 no circuit/channel available | no circuit/channel available]]</td>
</tr>
</table>
 

= MOR specific codes =

<table>
<tr>
<td> Code </td>
<td> Cause </td>
</tr>
<tr>
<td> 200 </td>
<td> [[200 MOR can't determine who is calling | MOR can't determine who is calling]]</td>
</tr>
<tr>
<td> 201 </td>
<td> [[201 User is blocked | User is blocked]]</td>
</tr>
<tr>
<td> 202 </td>
<td> [[202 Reseller is blocked | Reseller is blocked]]</td>
</tr>
<tr>
<td> 203 </td>
<td> [[203 No rates for user|No rates for User]] </td>
</tr>
<tr>
<td> 204 </td>
<td> [[204 No suitable providers found | No suitable providers found]] </td>
</tr>
<tr>
<td> 205 </td>
<td> [[205 MOR PRO not authorized to work on this computer | MOR PRO not authorized to work on this computer]]</td>
</tr>
<tr>
<td> 206 </td>
<td> [[206 server_id is not set in mor.conf file | server_id is not set in mor.conf file]] - ''this error code is not used anymore''</td>
</tr>
<tr>
<td> 207 </td>
<td> [[207 Not clear who should receive call | Not clear who should receive call]]</td>
</tr>
<tr>
<td> 208 </td>
<td> [[208 MOR can not make more calls | MOR can not make more calls]] </td>
</tr>
<tr>
<td> 209 </td>
<td> [[209 Test time exceeded | Test time exceeded]] </td>
</tr>
<tr>
<td> 210 </td>
<td> [[210 Balance more then 0, but not enough to make call 1s in length | Balance more than 0, but not enough to make call 1s in length]] </td>
</tr>
<tr>
<td> 211 </td>
<td> [[211 Low balance for user | Low balance for user]]</td>
</tr>
<tr>
<td> 212 </td>
<td> [[mor_authorize: Too low balance for more simultaneus calls!!!| Balance too low for more simultaneous calls]] </td>
</tr>
<tr>
<td> 213 </td>
<td> [[213 Low balance for DID owner | Low balance for DID owner]]</td>
</tr>
<tr>
<td> 214 </td>
<td> [[214 Too low balance for DID owner for more simultaneous calls | DID owner's balance is too low to make more simultaneous calls]]</td>
</tr>
<tr>
<td> 215 </td>
<td> [[215 Low balance for reseller | Low balance for reseller]]</td>
</tr>
<tr>
<td> 216 </td>
<td> [[216 Too low balance for reseller for more simultaneous calls | Reseller's balance is too low to make more simultaneous calls]]</td>
</tr>

<tr>
<td> 217 </td>
<td> [[217 Callback not initiated because device not found by ANI | Callback not initiated because device not found by ANI]]</td>
</tr>
<tr>
<td> 218 </td>
<td> [[218 Reseller does now allow loss calls | Reseller does not allow loss calls]]</td>
</tr>
<tr>
<td> 219 </td>
<td> [[219 DID has reached call limit. No more calls allowed to this DID | DID has reached call limit. No more calls allowed to this DID]]</td>
</tr>
<tr>
<td> 220 </td>
<td> [[220 User call limit reached | User call limit reached]]</td>
</tr>
<tr>
<td> 221 </td>
<td> [[221 Device call limit reached | Device call limit reached]]</td>
</tr>
<tr>
<td> 222 </td>
<td> [[222 Resellers call limit reached | Resellers call limit reached]]</td>
</tr>
<tr>
<td> 223 </td>
<td> [[223 Providers call limit reached | Providers call limit reached]] </td>
</tr>
<tr>
<td> 224 </td>
<td> [[224 Provider skipped because his rate is higher then users rate | Provider skipped because his rate is higher than user's rate]] </td>
</tr>
<tr>
<td> 225 </td>
<td> [[225 CallerID is banned | CallerID is banned]] </td>
</tr>
<tr>
<td> 226 </td>
<td> [[226 DID is free | DID is free]] </td>
</tr>
<tr>
<td> 227 </td>
<td> [[227 Calling Card PIN is not entered | Calling Card PIN is not entered]] </td>
</tr>
<tr>
<td> 228 </td>
<td> [[228 Calling Card Destination is not entered | Calling Card Destination is not entered]] </td>
</tr>
<tr>
<td> 229 </td>
<td> [[229 DID is reserved | DID is reserved]] </td>
</tr>
<tr>
<td> 230 </td>
<td> [[230 Connection returned error code 0 instead of real code | Connection returned error code 0 instead of real code]]</td>
</tr>
<tr>
<td> 231 </td>
<td> [[231 Provider unreachable | Provider unreachable]] - ''this error code is not used anymore'' </td>
</tr>
<tr>
<td> 232 </td>
<td> [[232 Callback DID not available | Callback DID not available]] </td>
</tr>
<tr>
<td> 233 </td>
<td> [[233 Skype Addon Disabled | Skype Addon Disabled]] </td>
</tr>
<tr>
<td> 234 </td>
<td> [[234 Internal Loop | Internal Loop]] </td>
</tr>
<tr>
<td> 235 </td>
<td> [[235 Providers rate higher by percent | Providers rate higher by percent]] </td>
</tr>
<tr>
<td> 236 </td>
<td> [[236 Callback initiation too early| Callback initiation too early]] </td>
</tr>
<tr>
<td> 237 </td>
<td> [[237 DID User is blocked| DID User is blocked]] </td>
</tr>
<tr>
<td> 238 </td>
<td> [[238 Provider used its daily call time limit| Provider used its daily call time limit]] </td>
</tr>
<tr>
<td> 239 </td>
<td> [[239 Device used its daily call time limit| Device used its daily call time limit]] </td>
</tr>
<tr>
<td> 240 </td>
<td> [[240 Provider belongs to the User which makes call| Provider belongs to the User which makes call (loop)]] </td>
</tr>
<tr>
<td> 241 </td>
<td> [[241 Local Caller canceled the call before call was answered|Local Caller canceled the call before call was answered]] </td>
</tr>
<tr>
<td> 242 </td>
<td> [[242 No Rates for Reseller|No Rates for Reseller]] </td>
</tr>
<tr>
<td> 243 </td>
<td> [[243 Provider skipped because of CPS limitation|Provider skipped because of CPS limitation]] </td>
</tr>
<tr>
<td> 244 </td>
<td> [[244 Device call aborted because of CPS limitation|Device call aborted because of CPS limitation]] </td>
</tr>
<tr>
<td> 245 </td>
<td> [[245 Provider skipped because of balance limitation|Provider skipped because of balance limitation]] </td>
</tr>
<tr>
<td> 246 </td>
<td> [[246 Duplicate call hangup|Duplicate call hangup]] </td>
</tr>
<tr>
<td> 247 </td>
<td> [[247 Dead Provider skipped|Dead Provider skipped]] </td>
</tr>
<tr>
<td> 248 </td>
<td> [[248 Call was terminated because FAS(False Answer Supervision) control detected an issue. | Call was terminated because FAS(False Answer Supervision) control detected an issue ]] </td>
</tr>
<tr>
<td> 249 </td>
<td> [[249 Partners call limit reached | Partners call limit reached ]] </td>
</tr>
</table>

 

= Relation between MOR hangupcause codes and Standard codes =

This table describes which standard ISDN code is MOR giving when one or another hangupcause is given.

{| border="1" cellpadding="5" cellspacing="0"
| '''MOR code''' || '''ISDN code''' || '''SIP code'''

|-
| [[208 MOR can not make more calls | 208]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[210_Balance_more_then_0,_but_not_enough_to_make_call_1s_in_length | 210]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[211_Low_balance_for_user | 211]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[Mor_authorize:_Too_low_balance_for_more_simultaneus_calls!!! | 212]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[213_Low_balance_for_DID_owner | 213]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[214 Too low balance for DID owner for more simultaneous calls | 214]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[215_Low_balance_for_reseller | 215]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[216 Too low balance for reseller for more simultaneous calls | 216]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[219 DID has reached call limit. No more calls allowed to this DID | 219]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[220 User call limit reached | 220]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[221 Device call limit reached | 221]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[222 Resellers call limit reached | 222]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[223 Providers call limit reached | 223]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[226 DID is free | 226]] || 1 || 404 Not found
|-
| [[229 DID is reserved | 229]] || 1 || 404 Not found
|-
| [[233 Skype Addon Disabled | 233]] || 66 || 500 Internal server error
|-
| All others not listed above and greater than 199 ( >=200 ) || 21 || 403 Forbidden
|}
 
Starting from [[MOR 12]], it is possible to change relation between MOR code and ISDN code. Relation can be defined in [[Mor.conf|mor.conf]].
 

= See also =
* [[Hangupcause Sounds]]
* [[H323 hangupcause codes]]
* [[SIP Error Codes]]
* [[M2 Hangupcause Codes]]

MOR API user register

2014-10-29T13:23:17Z

Tester2: /* Parameters */

=Description=


[[MOR API]] Create new user from params.
 
=Usage=

* Call: /api/user_register
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

Parameters which are '''included''' into hash:

* '''email''' - New user email. '''Required'''.
* '''id''' - User UNIQUEHASH in MOR database. '''Required'''. If uniquehash is not used, user will end up at admin account.
Uniquehash can be found in SETTINGS –> Setup –> Settings –> API tab (last setting) or after log out of MOR in the address field of the browser, for example:
http://SERVERIP/billing/callc/login/kljsdfg54kl where kljsdfg54kl is the uniquehash.
* '''device_type''' - Device type [SIP, IAX2]. '''Required'''.
* '''username''' - New user username. '''Required'''.
* '''first_name''' - New user first name. '''Required'''.
* '''last_name''' - New user last name. '''Required'''.

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''password''' - New user password. '''Required'''.
* '''password2''' - New user password confirmation. '''Required'''.
* '''country_id''' - New user country (please check table below). '''Required'''.
* '''mob_phone''' - Mobile phone number.
* '''phone - Phone number.
* '''fax''' - Fax.
* '''caller_id''' - CallerID for Device (It can include letters, numbers and signs. If empty value is passed CallerID will be used the same as in Default User settings. If empty in Default User settings and in request - it will not be used).
* '''client_id''' - Company/Personal ID.
* '''vat_number''' - TAX Registration Number.
* '''state'''
* '''county'''
* '''city'''
* '''postcode''' - Postcode/ZIP.
* '''address'''
* '''device_location_id'''
* '''lcr_id'''
* '''usertype'''
* '''permissions_group''' - Reseller or Accountant Permission Group (depending what usertype is sended)
* '''accounting_number''' - Accounting Number
* '''call_limit''' - Call limit (how many simultaneous Calls the new User can make by default?)
* '''credit_limit''' - Credit limit
 

===Request===

HTML POST: http://<SERVER_IP>/billing/api/user_register?id=kljsdfg54kl&username=username&password=pass&password2=pass&first_name=first
&last_name=last&country_id=10&email=email@email.com&device_type=SIP&hash=sd5g16sd1g6s
 

===Returns===

'''Success'''

<page>
<status>
<success>Registration successful</success>
</status>
<user_device_settings>
<email>Registration email</email> - If email sending enabled.
<user_id> user id</user_id> 
<device_type> device type [SIP|IAX2]</device_type>
<device_id> device id </device_id> 
<username> device username </username>
<password> device password </password>
<pin> device pin </pin>
<server_ip> Asterisk Server IP </server_ip>
<registration_notice> Registration notice which is set in Settings </registration_notice>
</user_device_settings>
</page>
 
----
'''Errors'''

* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.
* <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
* <error>Please enter username</error> - Params username is not send. Enter correct username.
* <error>Enter device type</error> - device_type is not send. Enter correct device_type.
* <error>Such username is already taken</error> - Duplicate of username. Change username.
* <error>Passwords do not match</error> - Enter correct passwords.
* <error>Password must be longer than (...) characters</error> - Enter correct password.
* <error>Please enter first name</error> - Enter first_name.
* <error>Please enter last name</error> - Enter last_name.
* <error>Please select country</error> - Enter country_id.
* <error>Please enter email</error> - Email address is not valid or not send. Enter correct email.
* <error>This email address is already in use</error> - Change email address.
* <error>User with mobile phone already exists</error> - Change mobile phone.
* <error>User with phone already exists</error> - Change phone.
* <error>User with fax already exists</error> - Change fax.
* <error>Default user is not present</error> - [[Default_user | Default User's]] settings are not saved in database.
* <error>LCR was not found</error> - LCR id incorrect or does not exist
* <error>Location was not found</error> - Location id incorrect or does not exist
 

=== List of Country IDs ===

1 - Afghanistan

2 - Albania

3 - Algeria

4 - American Samoa

5 - Andorra

6 - Angola

7 - Anguilla

8 - Antarctica

9 - Antigua And Barbuda

10 - Argentina

11 - Armenia

12 - Aruba

13 - Australia

14 - Austria

15 - Azerbaijan

16 - Bahamas

17 - Bahrain

18 - Bangladesh

19 - Barbados

20 - Belarus

21 - Belgium

22 - Belize

23 - Benin

24 - Bermuda

25 - Bhutan

26 - Bolivia

27 - Bosnia And Herzegovina

28 - Botswana

30 - Brazil

32 - Brunei Darussalam

33 - Bulgaria

34 - Burkina Faso

35 - Burundi

36 - Cambodia

37 - Cameroon

38 - Canada

39 - Cape Verde

40 - Cayman Islands

41 - Central African Republic

42 - Chad

43 - Chile

44 - China

45 - Christmas Island

46 - Cocos (Keeling) Islands

47 - Colombia

48 - Comoros

49 - Congo

50 - Congo, The Democratic Republic Of The

51 - Cook Islands

52 - Costa Rica

53 - Ivory Cost

54 - Croatia

55 - Cuba

56 - Cyprus

57 - Czech Republic

58 - Denmark

59 - Djibouti

60 - Dominica

61 - Dominican Republic

62 - Ecuador

63 - Egypt

64 - El Salvador

65 - Equatorial Guinea

66 - Eritrea

67 - Estonia

68 - Ethiopia

69 - Falkland Islands (Malvinas)

70 - Faroe Islands

71 - Fiji

72 - Finland

73 - France

74 - French Guiana

75 - French Polynesia

77 - Gabon

78 - Gambia

79 - Georgia

80 - Germany

81 - Ghana

82 - Gibraltar

83 - Greece

84 - Greenland

85 - Grenada

86 - Guadeloupe

87 - Guam

88 - Guatemala

89 - Guinea

90 - Guinea-Bissau

91 - Guyana

92 - Haiti

94 - Vatican City

95 - Honduras

96 - Hong Kong

97 - Hungary

98 - Iceland

99 - India

100 - Indonesia

101 - Iran

102 - Iraq

103 - Ireland

104 - Israel

105 - Italy

106 - Jamaica

107 - Japan

108 - Jordan

109 - Kazakhstan

110 - Kenya

111 - Kiribati

112 - Korea, Democratic People's Republic Of

113 - Korea, Republic of

114 - Kuwait

115 - Kyrgyzstan

116 - Laos

117 - Latvia

118 - Lebanon

119 - Lesotho

120 - Liberia

121 - Libyan Arab Jamahiriya

122 - Liechtenstein

123 - Lithuania

124 - Luxembourg

125 - Macao

126 - Macedonia

127 - Madagascar

128 - Malawi

129 - Malaysia

130 - Maldives

131 - Mali

132 - Malta

133 - Marshall islands

134 - Martinique

135 - Mauritania

136 - Mauritius

137 - Mayotte

138 - Mexico

139 - Micronesia

140 - Moldova

141 - Monaco

142 - Mongolia

143 - Montserrat

144 - Morocco

145 - Mozambique

146 - Myanmar

147 - Namibia

148 - Nauru

149 - Nepal

150 - Netherlands

151 - Netherlands Antilles

152 - New Caledonia

153 - New Zealand

154 - Nicaragua

155 - Niger

156 - Nigeria

157 - Niue

158 - Norfolk Island

159 - Northern Mariana Islands

160 - Norway

161 - Oman

162 - Pakistan

163 - Palau

164 - Palestine

165 - Panama

166 - Papua New Guinea

167 - Paraguay

168 - Peru

169 - Philippines

171 - Poland

172 - Portugal

173 - Puerto Rico

174 - Qatar

175 - Reunion

176 - Romania

177 - Russian Federation

178 - Rwanda

179 - Saint Helena

180 - Saint Kitts And Nevis

181 - Saint Lucia

182 - Saint Pierre And Miquelon

183 - Saint Vincent And The Grenadines

184 - Samoa

185 - San Marino

186 - Sao Tome And Principe

187 - Saudi Arabia

188 - Senegal

189 - Seychelles

190 - Sierra Leone

191 - Singapore

192 - Slovakia

193 - Slovenia

194 - Solomon Islands

195 - Somalia

196 - South Africa

198 - Spain

199 - Sri Lanka

200 - Sudan

201 - Suriname

203 - Swaziland

204 - Sweden

205 - Switzerland

206 - Syrian Arab Republic

207 - Taiwan

208 - Tajikistan

209 - Tanzania

210 - Thailand

212 - Togo

213 - Tokelau

214 - Tonga

215 - Trinidad And Tobago

216 - Tunisia

217 - Turkey

218 - Turkmenistan

219 - Turks And Caicos Islands

220 - Tuvalu

221 - Uganda

222 - Ukraine

223 - United Arab Emirates

224 - United Kingdom

225 - United States

227 - Uruguay

228 - Uzbekistan

229 - Vanuatu

230 - Venezuela

231 - Vietnam

232 - Virgin Islands, British

233 - Virgin Islands, U.S.

234 - Wallis And Futuna

236 - Yemen

238 - Zambia

239 - Zimbabwe

240 - Ascension Island

241 - Diego Garcia

242 - Inmarsat

243 - East Timor

246 - Iridium

247 - Serbia and Montenegro

250 - Emsat

251 - Ellipso-3

252 - Globalstar

253 - Montenegro

254 - Kosovo
 
=See also=

* [[MOR API]]

MOR API Subscriptions get

2014-10-29T13:20:18Z

Tester2: /* See also */

= NOTE: Available from MOR X5 =

=Description=
[[MOR API]] Subscriptions get
 
=Usage=

* From '''MOR X5''' Call: '''/api/subscriptions_get'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

* u - username for authentication. '''Required'''.
* service_id - Subscription's Service id.
* subscription_activation_start - Subscription's Activation Start timestamp in System Time Zone (if not defined - current day).
* subscription_activation_end - Subscription's Activation End timestamp in System Time Zone (if not defined - current day).
* subscription_memo - Subscription's memo.
* subscription_until_canceled - defines if Subscription can be Until canceled - can not to have Activation End (0 - off, 1 - on, default - off).
* user_id - Subscription's User id
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
 
===Request===

We have: API Secret Key = secret

We send:
HTML POST: http://<SERVER_IP>/billing/api/subscriptions_get?&u=admin&service_id=2&subscription_activation_start=1307167264&subscription_activation_end=1307167265
&subscription_memo=Subscriptions memo&subscription_until_canceled=1&user_id=2
'''NOTE that username is not included in hash'''
 

'''Success'''

<page>
<status>
<subscriptions>
<subscription>
<user>Test User #1</user>
<device></device>
<service>Service Name</service>
<from>2011-06-04 06:01:04 +0200</from>
<till></till>
<time_left></time_left>
<memo>Subscriptions memo</memo>
</subscription>
</subscriptions>
</status>
</page>
 
----

'''Errors'''
* <error>No Subscriptions found</error> - Subscription was not found using specified params. Use correct params.
* <error>You are not authorized to manage Subscriptions</error> - Such username does not exist in the database or User does not have rights to manage Subscriptions.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key while concatenating hash_string.
 

=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API subscription create]]
* [[MOR API subscription update]]

MOR API subscription delete

2014-10-29T13:19:45Z

Tester2: /* See also */

=Deescription=

[[MOR API]] Delete subscription
 
=Usage=

* Call: /api/subscription_delete
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* subscription_id - ID of Subscription you want to delete. '''Required'''.
* subscription_delete_action - number of action that you wish to choose. Numbers meaning: 1 - Delete without money return, 2 - Disable Subscriptions, 3 - Delete with whole money return. '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
 

===Request===

We have subscription_id = 123, API Secret Key = 456789 and we want to Subscription to be deleted with whole money return.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_delete?u=username&subscription_id=123&subscription_delete_action=3&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription deleted and money returned</success>
</status>
</page>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription disabled</success>
</status>
</page>

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription deleted</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - Person trying to delete Subscription does not exist or his user type is User.

* <error>You are not authorised to use this functionality</error> - Person trying to delete subscription does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Subscription disabled</error> - Subscription was successfully disabled.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
* <error>Subscription delete action was not found</error> - Specified subscription_delete_action was not found should be in (1,2,3).
 
=See also=

* [[MOR API]]
* [[MOR API Subscriptions get]]
* [[MOR API subscription create]]
* [[MOR API subscription update]]

MOR API subscription create

2014-10-29T13:19:32Z

Tester2: /* See also */

=Deescription=

[[MOR API]] Create subscription
 
=Usage=

* Call: /api/subscription_create
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* service_id - Service ID. '''Required'''.
* user_id - User ID . '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start.
* subscription_activation_end - timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''.
 

===Request===

We have service_id = 10, user_id = 2, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_create?u=username&service_id=10&user_id=2&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully created</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
* <error>Service was not found</error> - Service with specified service_id was not found.
 
=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API Subscriptions get]]
* [[MOR API subscription update]]

MOR API subscription update

2014-10-29T13:19:22Z

Tester2: /* See also */

=Deescription=

[[MOR API]] Update subscription
 
=Usage=

* Call: /api/subscription_update
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* subscription_id - Subscription ID. '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start.
* subscription_activation_end - timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''.
 

===Request===

We have subscription_id = 10, subscription_activation_start = 1255132800, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_update?u=username&subscription_id=10&subscription_activation_start=1255132800&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username is not included in hash'''
 

===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully updated</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Subscription activation end date must be valid timestamp</error> - self explanatory.
* <error>Subscription activation start date must be valid timestamp</error> - self explanatory.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
* <error>Activation start date must be earlier than end date</error> - self explanatory.
* <error>Service is not flat rate</error> - you are using subscription_no_expiration_at_the_end_of_a_month parameter with service which is not Flat-Rate type.
 

=See also=

* [[MOR API]]
* [[MOR API subscription delete]]
* [[MOR API Subscriptions get]]
* [[MOR API subscription create]]

MOR API subscription update

2014-10-29T13:19:06Z

Tester2: /* See also */

MOR API subscription update

2014-10-29T13:03:52Z

Tester2: /* Request */

MOR API subscription update

2014-10-29T13:03:42Z

Tester2: /* Returns */

=Deescription=

[[MOR API]] Update subscription
 
=Usage=

* Call: /api/subscription_update
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* subscription_id - Subscription ID. '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start.
* subscription_activation_end - timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''.
 

===Request===

We have subscription_id = 10, subscription_activation_start = 1255132800, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_update?u=username&subscription_id=10&subscription_activation_start=1255132800&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully updated</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Subscription activation end date must be valid timestamp</error> - self explanatory.
* <error>Subscription activation start date must be valid timestamp</error> - self explanatory.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
* <error>Activation start date must be earlier than end date</error> - self explanatory.
* <error>Service is not flat rate</error> - you are using subscription_no_expiration_at_the_end_of_a_month parameter with service which is not Flat-Rate type.
 

=See also=

* [[MOR API]]

MOR API subscription create

2014-10-29T13:02:16Z

Tester2:

MOR API subscription update

2014-10-29T13:02:12Z

Tester2: Created page with '=Deescription=  MOR API Update subscription =Usage= * Call: /api/subscription_update * Methods: POST, GET(if all…'

=Deescription=

[[MOR API]] Update subscription
 
=Usage=

* Call: /api/subscription_update
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* subscription_id - Subscription ID. '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start.
* subscription_activation_end - timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''.
 

===Request===

We have subscription_id = 10, subscription_activation_start = 1255132800, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_update?u=username&subscription_id=10&subscription_activation_start=1255132800&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully updated</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - user does not exist or cannot use this functionality.
* <error>You are not authorised to use this functionality</error> - accountant does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Subscription activation end date must be valid timestamp</error> - self explanatory.
* <error>Subscription activation start date must be valid timestamp</error> - self explanatory.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
* <error>Activation start date must be earlier than end date</error> - self explanatory.
 
=See also=

* [[MOR API]]

MOR API subscription create

2014-10-29T12:53:13Z

Tester2:

=Deescription=

[[MOR API]] Create subscription
 
=Usage=

* Call: /api/subscription_create
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* service_id - Service ID. '''Required'''.
* user_id - User ID . '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start.
* subscription_activation_end - timestamp of Subscription activation end.
* subscription_memo - memo of Subscription.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off).
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''.
 

===Request===

We have service_id = 10, user_id = 2, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_create?u=username&service_id=10&user_id=2&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully created</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - Person trying to create Subscription does not exist or his user type is User.
* <error>You are not authorised to use this functionality</error> - Person trying to create subscription does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
 
=See also=

* [[MOR API]]

MOR API subscription delete

2014-10-29T12:52:39Z

Tester2:

MOR API subscription create

2014-10-29T12:49:38Z

Tester2:

=Deescription=

[[MOR API]] Create subscription
 
=Usage=

* Call: /api/subscription_create
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* service_id - Service ID. '''Required'''.
* user_id - User ID . '''Required'''.

Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
* subscription_activation_start - timestamp of Subscription activation start. '''Optional'''.
* subscription_activation_end - timestamp of Subscription activation end. '''Optional'''.
* subscription_memo - memo of Subscription. '''Optional'''.
* subscription_until_canceled - subscription is until cancel (0 - off, 1 - on, default - off). '''Optional'''.
* subscription_no_expiration_at_the_end_of_a_month - subscription has no expiration at the end of month. (0 - off, 1 - on, default - off). '''Only for Flat Rate'''. '''Optional'''.
 

===Request===

We have service_id = 10, user_id = 2, subscription_memo = acc_one, API Secret Key = 456789.

We send:

HTML POST: http://<SERVER_IP>/billing/api/subscription_create?u=username&service_id=10&user_id=2&subscription_memo=acc_one&hash=e0f93111f867ca5d424c0f0ebb6b678159086d00

'''* Note that username are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Subscription was successfully created</success>
</status>
</page>

 
----
'''Errors'''
* <error>Access Denied</error> - Person trying to create Subscription does not exist or his user type is User.
* <error>You are not authorised to use this functionality</error> - Person trying to create subscription does not have Manage Subscription permission.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>User has insufficient balance</error> - Subscription price is bigger than Subscription User balance.
* <error>Subscription was not found</error> - Subscription with specified subscription_id was not found.
 
=See also=

* [[MOR API]]

MOR API

2014-10-29T12:48:17Z

Tester2: /* Subscriptions */

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key

 
=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.

 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Services get| services_get]] – get Services.
* [[MOR API Service update| service_update]] – update Service.

 

==SMS Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==Subscriptions==
* [[MOR API subscription delete|subscription_delete]] - Subscription delete.
* [[MOR API Subscriptions get|subscriptions_get]] - Subscriptions get.
* [[MOR API subscription create|subscription_create]] - Subscription create.
* [[MOR API subscription update|subscription_update]] - Subscription delete.
 

==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API Service create

2014-09-30T13:47:02Z

Tester2: Undo revision 18419 by Aisteb (Talk)

=Description=
[[MOR API]] Create Service
 
=Usage=

* Call: /api/service_create
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* new_service_name - name of the Service '''Required'''.
* new_service_type - periodic_fee, one_time_fee or flat_rate. '''Required'''.
* service_sell_price - price of the Service. '''Required'''.
* service_self_cost - self cost of the Service. '''Required'''.

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* service_period - month or day. For Periodic fee service type only.
* service_minutes_per_month - for Flat-Rate service type only.
 
===Request===

We have u = admin, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/service_create?u=admin&new_service_type=flat_rate&service_minutes_per_month=5&new_service_name=name&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

*Now we can find this Service in GUI Services list.

'''* Note that username and password are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Service successfully created</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - user was not authorized or is simple user. Only admin, reseller or accounant can use this API method.
* <error>Incorrect hash</error> - hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Service must have service type</error> - type must be one of periodic_fee, one_time_fee or flat_rate.
* <error>Flat Rate Service must have quantity</error> - Flat-Rate Service must have Minutes/month provided.
* <error>Quantity must be numeric</error> - Minutes/month must be a number.
* <error>Quantity must be greater than zero</error>
* <error>Service Price must be numeric</error>
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Services.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Quantity must be numeric</error>
</status>
</page>
 

=See also=

* [[MOR API]]
* [[MOR_API_Service_delete | Services delete]]
* [[MOR_API_Service_update | Service update]]

MOR API

2014-09-30T13:46:03Z

Tester2: /* Services */

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key

 
=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.

 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Service update| service_update]] – update Service.
* [[MOR API Services get| services_get]] – get Service information.

 

==SMS Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API

2014-09-30T13:45:50Z

Tester2: /* Services */

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key

 
=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.

 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service create| service_create]] – create Service.
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Service update| service_update]] – update Service.
* [[MOR API Service get| service_get]] – get Service information.

 

==SMS Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

MOR API Service update

2014-09-24T07:17:52Z

Tester2: /* See also */

= NOTE: Available from MOR X5 =

=Description=
[[MOR API]] Update Service
 
=Usage=

* From '''MOR X5''' Call: '''/api/service_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:
* service_id - Service ID, which we want to delete. '''Required'''.
* u - username for authentication. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
 
Parameters which are '''not included''' into hash:
* service_name - name of Service.
* service_type - type of Service (periodic_fee, one_time_fee, flat-rate).
* service_sell_price - sell price of Service.
* service_self_cost - cost of Service.
* service_period - period of Service (month, day, by default month only for Periodic Fee type).
* service_minutes_per_month - how many minutes User is allowed to use Service (only for Flat Rate type).

===Request===

We have Service ID = 19, API Secret Key = secret 
We send:
HTML POST: http://<SERVER_IP>/billing/api/service_update?u=admin&service_id=19&service_name=ddddddd&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4
'''NOTE that username is not included in hash'''
 

'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Service successfully updated</success>
</status>
</page>

 
----

'''Errors'''
* <error>Service Type is invalid</error> - Service type is unknown. It should be periodic_fee or one_time_fee or flat-rate.
* <error>Quantity must be numeric</error> - Quantity was not numeric.
* <error>Quantity must be greater than zero</error> - Quantity is less than zero.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Services.
* <error>Access Denied</error> - User can not Manage Services and can not get permissions to use it.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

=See also=

* [[MOR API]]
* [[MOR_API_Service_delete | Services delete]]
* [[MOR_API_Service_create | Service create]]

MOR API Service update

2014-09-24T07:17:15Z

Tester2: /* Request */

MOR API Service create

2014-09-24T07:14:35Z

Tester2: /* Returns */

MOR API Service update

2014-09-24T07:12:53Z

Tester2: /* Parametres */

= NOTE: Available from MOR X5 =

=Description=
[[MOR API]] Update Service
 
=Usage=

* From '''MOR X5''' Call: '''/api/service_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:
* service_id - Service ID, which we want to delete. '''Required'''.
* u - username for authentication. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
 
Parameters which are '''not included''' into hash:
* service_name - name of Service.
* service_type - type of Service (periodic_fee, one_time_fee, flat-rate).
* service_sell_price - sell price of Service.
* service_self_cost - cost of Service.
* service_period - period of Service (month, day, by default month only for Periodic Fee type).
* service_minutes_per_month - how many minutes User is allowed to use Service (only for Flat Rate type).

===Request===

We have Service ID = 19, API Secret Key = secret
We send:
HTML POST: http://<SERVER_IP>/billing/api/service_update?u=admin&service_id=19&service_name=ddddddd&test=1
'''NOTE that username is not included in hash'''
 

'''Success'''

<page>
<status>
<success>Service successfully updated</success>
</status>
</page>

 
----

'''Errors'''
* <error>Service Type is invalid</error> - Service type is unknown. It should be periodic_fee or one_time_fee or flat-rate.
* <error>Quantity must be numeric</error> - Quantity was not numeric.
* <error>Quantity must be greater than zero</error> - Quantity is less than zero.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Services.
* <error>Access Denied</error> - User can not Manage Services and can not get permissions to use it.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
 

=See also=

* [[MOR API]]

MOR API Service create

2014-09-24T07:10:52Z

Tester2: /* See also */

=Description=
[[MOR API]] Create Service
 
=Usage=

* Call: /api/service_create
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* new_service_name - name of the Service '''Required'''.
* new_service_type - periodic_fee, one_time_fee or flat_rate. '''Required'''.
* service_sell_price - price of the Service. '''Required'''.
* service_self_cost - self cost of the Service. '''Required'''.

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* service_period - month or day. For Periodic fee service type only.
* service_minutes_per_month - for Flat-Rate service type only.
 
===Request===

We have u = admin, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/service_create?u=admin&new_service_type=flat_rate&service_minutes_per_month=5&new_service_name=name&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

*Now we can find this Service in GUI Services list.

'''* Note that username and password are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Service successfully created</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - user was not authorized or is simple user. Only admin, reseller or accounant can use this API method.
* <error>Incorrect hash</error> - hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Service must have service type</error> - type must be one of periodic_fee, one_time_fee or flat_rate.
* <error>Flat Rate Service must have quantity</error> - Flat-Rate Service must have Minutes/month provided.
* <error>Quantity must be numeric</error> - Minutes/month must be a number.
* <error>Quantity must be greater than zero</error>
* <error>Service Price must be numeric</error>

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Quantity must be numeric</error>
</status>
</page>
 

=See also=

* [[MOR API]]
* [[MOR_API_Service_delete | Services delete]]
* [[MOR_API_Service_update | Service update]]

MOR API Service create

2014-09-24T07:09:02Z

Tester2: Created page with '=Description= MOR API Create Service =Usage= * Call: /api/service_create * Methods: POST, GET(if allowed, not recomended) ===Parametres=== Parameters whi…'

=Description=
[[MOR API]] Create Service
 
=Usage=

* Call: /api/service_create
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

Parameters which are '''included''' into hash:

* new_service_name - name of the Service '''Required'''.
* new_service_type - periodic_fee, one_time_fee or flat_rate. '''Required'''.
* service_sell_price - price of the Service. '''Required'''.
* service_self_cost - self cost of the Service. '''Required'''.

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* service_period - month or day. For Periodic fee service type only.
* service_minutes_per_month - for Flat-Rate service type only.
 
===Request===

We have u = admin, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/service_create?u=admin&new_service_type=flat_rate&service_minutes_per_month=5&new_service_name=name&hash=38282ca5e65e63746498ef5b39a2fe71c6448df4

*Now we can find this Service in GUI Services list.

'''* Note that username and password are not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Service successfully created</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - user was not authorized or is simple user. Only admin, reseller or accounant can use this API method.
* <error>Incorrect hash</error> - hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Service must have service type</error> - type must be one of periodic_fee, one_time_fee or flat_rate.
* <error>Flat Rate Service must have quantity</error> - Flat-Rate Service must have Minutes/month provided.
* <error>Quantity must be numeric</error> - Minutes/month must be a number.
* <error>Quantity must be greater than zero</error>
* <error>Service Price must be numeric</error>

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Quantity must be numeric</error>
</status>
</page>
 

=See also=

* [[MOR API]]
* [[Services get]]
* [[Service delete]]

MOR API

2014-09-24T06:33:08Z

Tester2: /* Services */

[[File:warning.png|100px]]<big><big><big>IMPORTANT!!! API methods described here are for MOR X5. For previous versions please check appropriate [http://wiki.kolmisoft.com/index.php/MOR_Manual#Old_Manuals manual].</big></big></big>

 
=About=
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.

MOR accepts requests by HTML POST and returns results in XML.

 
=MOR users that are allowed to use MOR API=
* Admin
* Reseller
* Accountant - only by using Admin Hash and Secret key

 
=Functions=

== API Related ==
* [[API Configuration]] – configuration options for API.
* [[MOR API hash construction|Hash construction]] – how to construct hash to authenticate data over API.

 
==Balance==
* [[MOR API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance.
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance
* [[MOR API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance
* [[MOR API user balance get by psw | user_balance_get_by_psw]] – gets User's Balance by his owned Device's Password
* [[MOR API User Balance get by Username | user_balance_get_by_username]] – gets User's Balance by his owned Device's Username

 

==Callback==
* [[MOR API callback init|callback_init]] (callback) – initiates callback.

 
==Calling Cards==
* [[MOR API card_by_cli_update| card_by_cli_update]] (cc_by_cli) – creates and updates calling cards, including adding and transferring funds, by being identified according the Caller_ID.
* [[MOR API card_from_group_sell| card_from_group_sell]] (buy_card_from_callingroup) – sells cards from calling card group.
* [[MOR API card_group_get| card_group_get]] (show_calling_card_group) – show calling group info.
* [[MOR API card_balance_get| card_balance_get]] (card_balance_get) – show card's balance.
* [[MOR API card_payment_add| card_payment_add]] – add payment to the calling card.

 

==Calls==
* [[MOR API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device.

 

==Conflines==
* [[MOR API conflines update|conflines_update]] – changes settings for API, Default User or Default Device.

 
==Credit notes==
* [[MOR API credit_notes_get| credit_notes_get]] (credit_notes) – credit notes list.
* [[MOR API credit_note_update| credit_note_update]] – credit note update.
* [[MOR API credit_notes_create| credit_note_create]] – credit note create.
* [[MOR API credit_notes_delete| credit_note_delete]] – credit note delete.

 
==Device==
* [[MOR API device create| device_create]] – create device
* [[MOR API device delete| device_delete]] (delete_device) – delete device
* [[MOR API devices get | devices_get]] (device_list) – users device list
* [[MOR API device callflow get| device_callflow_get]] - returns information about specified device callflow state.
* [[MOR API device callflow update | device_callflow_update]] – updates information of specified device callflow state.
* [[MOR API CLI info get | cli_info_get]] (cli_get_info) – shows id of device where CLI belongs.
* [[MOR API CLI delete | cli_delete]] – deletes specified CLI.
* [[MOR API CLI add | cli_add]] – creates CLI and assigns it to the specified device.
* [[MOR API device details get | device_details_get]] – shows all information about specified device.
* [[MOR_API_device_update | device_update]] – updates location_id of selected Device.

 

==DID==

* [[MOR API dids get| dids_get]] – get list of particular DIDs
* [[MOR API did_create| did_create]] – DID create
* [[MOR_API_did_device_assign| did_device_assign]] (did_assign_device) – Assign Device to DID
* [[MOR_API_did_device_unassign| did_device_unassign]] (did_unassign_device) – Unassign Device from DID

 

==Email==
* [[MOR API email send| email_send]] (send_email) – send Email.

 
==Financial statements==
* [[MOR API financial_statements_get| financial_statements_get]] (financial_statements) – financial statements list.

 
==Invoices==
* [[MOR API invoices_get|invoices_get]] (invoices) – retrieves a list of invoices in a selected time period.

 
==Login==
* [[MOR API user_login|user_login]] (login) – logs user in to MOR.
* [[MOR API user_logout|user_logout]] (logout) – logs user out from MOR.

 
==Monitorings==
* [[MOR API ma_activate_api| ma_activate]] – turn on monitorings addon

 
==Payments==
* [[MOR API payment_create| payment_create]] (create_payment) – create payment.
* [[MOR API payments_get| payments_get]] (payments_list) – payments list.

 
==Phonebooks==
* [[MOR API phonebooks_get| phonebooks_get]] (phonebooks_api ) – phonebooks list.
* [[MOR API phonebook_edit| phonebook_edit]] (phonebook_edit_api) – edit phonebook.
* [[MOR API phonebook_record_create| phonebook_record_create]] – create phonebook.

 
==Quickforwards==
* [[MOR API Quickforwards get| quickforwards_dids_get]] (quickforwards_dids_get) – get Quickforwards.
* [[MOR API Quickforwards update| quickforwards_did_update]] (quickforwards_did_update) – update Quickforwards.
* [[MOR API Quickforwards delete| quickforwards_did_delete]] (quickforwards_did_delete) – delete Quickforwards.

 
==Rates==
* [[MOR API rate get|rate_get]] (rate) – check user rate by prefix
* [[MOR API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates
* [[MOR API tariff_retail_import | tariff_retail_import ]] (import_relail_tariff) – import xml retail tariff
* [[MOR API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff

 
==Services==
* [[MOR API Service delete| service_delete]] – delete Service.
* [[MOR API Service create| service_create]] – create Service.

 

==SMS Send==
* [[MOR API sms send| sms_send]] (send_sms) – send SMS.

 
==User==

* [[MOR API user_register| user_register]] – create new user from params.
* [[MOR API user_details_get | user_details_get]] (user_details) – gets user details.
* [[MOR_API_user_details_update| user_details_update]] (user_update_api) – update user from params.
 

== Resellers ==
* [[MOR API reseller group create]] - create new Reseller Group

 
==Version==
* [[MOR API system version get| system_version_get]] (get_version) – get MOR version number.

 
= Examples =
* [[MOR API PHP Examples]]

 
=HTML POST=
All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username

* username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.
 
=Useful to know=

* All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:
** Value of money will be returned in Default System [[Currencies|Currency]].
** Date will not be affected of [[Configuration_from_GUI#Visual| Default date format]] setting.
** Value of money will not be affected of [[Configuration_from_GUI#Visual|Number digits]] setting.

 
=See also =
* [[API Configuration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]

Common Use Providers

2014-09-24T06:18:53Z

Tester2: /* Usage from Reseller PRO */

=Description=

Common Use Providers are [[Providers]] whose belongs to admin and can be used by [[Reseller_Pro_Addon |Resellers PRO]]. Reseller will be billed using Provider assigned to him as common use.

'''NOTE''' that if provider is marked as common use and is used in one of reseller's LCR or is in Terminators list - admin is not allowed to delete this provider or remove Common Use option.
 
=Configuration=

Go to '''SETTINGS –> Billing –> Providers'''.
 
[[File:providers_path.png]]
 
Here you can see a list of all Providers:
 
[[File:providers_list.png]]
 
Click on [[image:icon_edit.png]] icon and in Provider configuration page, [[Providers#Advanced | Advanced settings block]] set Yes on '''Common Use''' option.

When you have at least one Common Use Provider and at least one Reseller PRO go to '''ADDONS –> Resellers –> Common Use Providers'''
 
[[File:common_use_providers_path.png]]
 
Here you can see a list of Common Use Providers already assigned to Resellers PRO:
 
[[File:common_use_providers.png]]
 
* In this page, you can let use all Common Use Providers for all Resellers PRO with Tariffs which is assigned to them in [[User_Details | user configuration page]], just press '''Let resellers use all common use providers''' button.

* Also you can Add one by one Provider to each Reseller PRO, just under the table select Reseller name, Provider name and Tariff which you want to set him.
 
=Usage from Reseller PRO=

This kind of Provider Reseller PRO able to find in '''MAIN MENU –> Routing –> Providers''' list as System Providers.
 
[[File:common_use_providers_in_rspro_prov_list.png]]
 
Resellers are not allowed to make some configurations on Common User Providers and only see their names as Provider + ID. Resellers are able to use them in [[LCR]].

Reseller able to enter List of Rates added to him on particular Provider with click on its Tariff name. Rates will be shown as [[Advanced Rates for Users ]] without ability to edit them, for Reseller PRO no need to check additional options, he will reach these rates as long as he will have Common Use Providers.

=See also=

* [[Providers]]
* [[Reseller Pro Addon]]
* [[User Details]]