BILLmanager API

From ISPWiki
Jump to: navigation, search

On this page you can see automatically generated description of panel’s functions and their parameters.

For more information on how to work with API and call its functions, please refer to the article Working_with_ISPsystem's_API.

This page is generated automatically, that’s why the information it contains may vary depending on configuration. You can find a certain function or parameter name in the control panel’s configuration file by executing the function in the web-interface.

Function name and its parameters will be shown in the log.== Affiliate program ==

Function: affiliate.client

Access level: user

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

  • affiliate - Affiliate program. Select an affiliate program you want to join
  • url - Referral link . This is your referral link
  • promocode - Promo code. Clients who enter this promo code will be your referrals

Contents

Enumerations

Function: enumeration

Result: the list of elements

Enumerations

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name

Delete

Function: enumeration.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of enumeration function.

Result: successful operation or error message

Enumeration

Function: enumeration.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of enumeration function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • intname - Internal name. Enter an internal name

Name

Function: enumerationitem

Result: the list of elements

Enumeration items

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name

Delete

Function: enumerationitem.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of enumerationitem function.

Result: successful operation or error message

Enumeration

Function: enumerationitem.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of enumeration function).
    • elid - unique identifier (id element of enumerationitem function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of enumeration function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of enumeration function).
    • elid - unique identifier (id element of enumerationitem function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • intname - Internal name. Enter an internal name

Staff

Function: employee

Result: the list of elements

Staff

Access level: root admin

  • id - Id
  • name - Login
  • realname - Full name
  • email - Email
  • department - Departments
  • status - Parameters

Deny access to the billing for the selected administrator

Function: employee.suspend

Deny access to the billing for the selected administrator

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of employee function.

Result: successful operation or error message

Department

Function: employee.department

Result: the list of elements

Departments to which this staff member is assigned

Access level: root admin

  • id - Id
  • name - Department
  • status - Status

Unassign this staff member from the department

Function: employee.department.suspend

Unassign this staff member from the department

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of employee.department function.

Result: successful operation or error message

Assign this staff member into the selected department

Function: employee.department.resume

Assign this staff member into the selected department

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of employee.department function.

Result: successful operation or error message

Go to the panel with privileges of the selected staff member

Function: employee.su

Go to the panel with privileges of the selected staff member

Access level: root admin

Delete

Function: employee.delete

Delete

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of employee function.

Result: successful operation or error message

Name

Function: rights2.user

Result: the list of elements

User rights

Access level: root admin

  • caption - Name
  • access - Access

Resume

Function: rights2.user.resume

Resume

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of rights2.user function.

Result: successful operation or error message

Suspend

Function: rights2.user.suspend

Suspend

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of rights2.user function.

Result: successful operation or error message

Set filter.

rights2.user.filter

Partial access is given to the list elements. Set the list filter. Excluded records will be unavailable

Function: rights2.user.hardfilter

Partial access is given to the list elements. Set the list filter. Excluded records will be unavailable

Access level: root admin

Support center settings

Function: employee.support_tool_settings

Support center settings

Access level: admin

Set filter.

employee.filter

Allow access to the billing

Function: employee.resume

Allow access to the billing

Access level: root admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of employee function.

Result: successful operation or error message

Send SMS

Function: employee.sms

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of employee function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Choose a phone number. Select a type of the phone number to send an sms
  • phone - Phone number. A phone number to which this SMS will be sent
  • message - Message. Message that you want to send

Edit the staff profile

Function: employee.edit

Access level: admin root

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of employee function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Login. Enter a login
  • realname - Full name. Enter the first and the last name
  • position - Job title . Job title. It is shown in tickets in BILLmanager 6., eg. Technical support specialist
  • passwd - Password. Enter a password
  • confirm - Re-enter password. Re-type the password to ensure it is correct
  • department - Departments. Select departments to which you want to assign this staff member.
  • email - Email. Email address of the staff member
  • phone - Phone number. Enter a phone number that can be used for sms notifications
  • default_access_allow - . (Optional parameter. To enable the option click "on".) Allow full access to all features for this staff member

Schedule

Function: ticket_schedule

Result: the list of elements

Schedule

Access level: admin

  • id - Id
  • locale_name - Name
  • project - Provider
  • schedule - Schedule
  • attitude - Client characteristics
  • priority - Ticket priority
  • user_department - Department
  • account_group - Client group

Delete

Function: ticket_schedule.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket_schedule function.

Result: successful operation or error message

Set filter.

ticket_schedule.filter

Schedule settings

Function: ticket_schedule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of ticket_schedule function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Rule. Schedule rules. You cannot change them after creation
  • comparison - Comparison. Comparison conditions
  • value - Value. Parameter value
  • amount - Amount. Amount
  • project - Provider. Select a provider this schedule is associated with. You cannot change it after creation
  • pricelist - Tariff plan. Service tariff plan
  • pricelist_addon - Add-on. Tariff plan add-ons
  • enumerationitem - Parameter value. Ordered value for the enumeration
  • account_client - Client. The schedule will be applied to the selected client
  • account_group - Client group. A group of clients for which you are creating the schedule
  • attitude - Client characteristics. Characteristics of the client who submitted the trouble ticket
  • priority - Ticket priority. Enter the ticket priority
  • user_department - Department. Department that this ticket is assigned to
  • time_schedule - Response time. Ticket response time
  • highpriority - . (Optional parameter. To enable the option click "on".) Put this ticket at the beginning of the queue

Blocked emails

Function: gateway_blacklist

Result: the list of elements

Blocked email addresses

Access level: admin

  • id - Id
  • name - Email address

Delete

Function: gateway_blacklist.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gateway_blacklist function.

Result: successful operation or error message

Set filter.

gateway_blacklist.filter

Site builder

Function: sitebuilder

Result: the list of elements

Site builder

Access level: admin user

  • domain - Domain name
  • ip - IP address
  • username - Username
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg -
  • item_status -
  • cost - Price

Hard reboot of server in the control panel

Function: service.hardreboot

Hard reboot of server in the control panel

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Drill down to User panel

Function: sitebuilder.su

Drill down to User panel

Access level: admin

Resume

Function: sitebuilder.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Service usage statistics

Function: service.stat

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Submit a subject related to this service

Function: service.ask

Submit a subject related to this service

Access level: user

The service will be suspended, and will be charged as suspended services. You can later start the service

Function: service.stop

The service will be suspended, and will be charged as suspended services. You can later start the service

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Domain name

Function: sitebuilder.domain

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • freedomain_name - Free domain name.
  • additional_domain - Additional domain name.
  • owndomain - Domain name.
  • ordereddomain - Domain name.

Reboot the server in the control panel

Function: service.reboot

Reboot the server in the control panel

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Name

Function: service.detail

Result: the list of elements

Service configuration

Access level: admin+

  • id - Id
  • name - Name
  • addonlimit - Tariff plan includes
  • value - Add-ons
  • props - Price

Delete the selected entries

Function: service.detail.delete

Delete the selected entries

Access level: admin+

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the idkey element of service.detail function.

Result: successful operation or error message

Edit the selected resource

Function: service.detail.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (idkey element of service.detail function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (idkey element of service.detail function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name to display in the interface and documents
  • pricelist_measure - Unit of measure. Select a unit of measure for add-on
  • manualvalue - Quantity. Quantity of allocated resource
  • intvalue - Add-ons. Additional order. Values from to
  • boolvalue - . (Optional parameter. To enable the option click "on".) Resource value
  • enumerationitem - Value. Select a resource value
  • no_check_addon - . (Optional parameter. To enable the option click "on".) The add-on's value was changed without verification
  • addonlimit - Tariff plan includes. Tariff plan includes
  • addonbool - . (Optional parameter. To enable the option click "on".) Value of the tariff plan's resource
  • addonenumerationitem - Tariff plan includes.
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes

Order a new service

Function: sitebuilder.order

Order a new service

Access level: user

IP address

Function: service.ip

Result: the list of elements

IP addresses

Access level: admin user

  • id - Id
  • name - IP address
  • mask - Mask
  • gateway - Gateway
  • domain - Domain
  • type - Type
  • ip_status - Status
  • ip_clientstatus - Status

Move IP address

Function: service.ip.move

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (id element of service.ip function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (id element of service.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • item - Service. Enter the service ID. This IP address will be moved to the selected service.
  • noexpense - . (Optional parameter. To enable the option click "on".) A client won't be charged for a new IP address
  • postpaid - . (Optional parameter. To enable the option click "on".) Select the check box to provide services on credit in case of insufficient funds on client's account

IP addresses

Function: service.ip.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (id element of service.ip function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (id element of service.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Type of IP address. Type of IP address
  • pools - IP pool. Enter the pool that contains this IP address
  • domain - Domain. Reverse PTR for IP address
  • ippool - IP pool . Please specify the pool from which this IP is allocated
  • name - IP address. IP address
  • mask - Subnet mask . Enter a subnet mask. It will be used for network configuration by other products
  • gateway - Gateway . Enter a gateway address. Usually, this is the same address as the primary IP.
  • addinpanel - . (Optional parameter. To enable the option click "on".) Clear the check box if you don't want to add IP into the control panel
  • addinipmgr - . (Optional parameter. To enable the option click "on".) Clear the check box if you don't want this IP to be reserved in IPmanager
  • count - Number. Number of IP addresses you want to add . Values from 1 to 1000
  • noexpense - . (Optional parameter. To enable the option click "on".) A client won't be charged for a new IP address
  • postpaid - . (Optional parameter. To enable the option click "on".) Select the check box to provide services on credit in case of insufficient funds on client's account
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes

Deleting IP-address

Function: service.ip.del.admin

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (id element of service.ip function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of sitebuilder function).
    • elid - unique identifier (id element of service.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • noexpense - . (Optional parameter. To enable the option click "on".) IP-address will be deleted without making refund to a client
  • manual - . (Optional parameter. To enable the option click "on".) IP-address will be deleted from billing only. Address availability in control panel or in IPmanager won't be checked
  • ipcount - Amount of addresses . Total amount of IP-addresses being deleted
  • cost - Refund amount. Total amount to be added to a client's account after deleting IP-addresses

Delete

Function: service.ip.delete

Delete

Access level: user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of service.ip function.

Result: successful operation or error message

Name

Function: service.ip.history

Result: the list of elements

IP address change history

Access level: admin user

  • changedate - Change date
  • desc - Description
  • user - Username
  • ip - IP address
  • action - Function

Edit properties of the selected service

Function: sitebuilder.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Suspend

Function: sitebuilder.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Set a filter by the selected client

Function: sitebuilder.setfilter

Set a filter by the selected client

Access level: admin

Send a ticket to the selected client

Function: ticket.write.service

Send a ticket to the selected client

Access level: admin

Change password

Function: service.changepassword

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • passwd - . Enter a new password for the service
  • confirm - Re-enter password.

Setup and usage guide

Function: service.instruction.html

Setup and usage guide

Access level: admin user

Renew the selected service

Function: service.prolong

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • period - Period. Select a renewal period for this service

Delete the selected services

Function: sitebuilder.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

The service will get activated, and the client will be charged as if he uses the active service

Function: service.start

The service will get activated, and the client will be charged as if he uses the active service

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Service activation

Function: sitebuilder.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Set filter.

sitebuilder.filter

Change the selected tariff plan

Function: service.changepricelist

Change the selected tariff plan

Access level: admin

Name

Function: service.history

Result: the list of elements

Service history

Access level: admin user

  • changedate - Change date
  • desc - Change
  • user - Username
  • ip - IP address
  • action - Function

Reports

Function: reportlist

Result: the list of elements

Reports

Access level: admin

  • report - Report name

Generate report

Function: report.open

Generate report

Access level: admin

Virtual private servers

Function: vds

Result: the list of elements

Virtual private servers

Access level: admin user

  • domain - Domain name
  • ip - IP address
  • ostempl - OS template
  • processingnode - Cluster node
  • serverid - Name
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg -
  • item_status -
  • cost - Price

Delete the selected services

Function: vds.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vds function.

Result: successful operation or error message

Drill down to User panel

Function: vds.su

Drill down to User panel

Access level: admin

Set filter.

vds.filter

Suspend

Function: vds.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vds function.

Result: successful operation or error message

Resume

Function: vds.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vds function.

Result: successful operation or error message

Create a ticket to import a Virtual server to Virtual data-center

Function: vds.movetovdc

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vds function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • vdc - Virtual data-center . Select a virtual data-center to import your virtual servers

Order a new service

Function: vds.order

Order a new service

Access level: user

Set a filter by the selected client

Function: vds.setfilter

Set a filter by the selected client

Access level: admin

Edit properties of the selected service

Function: vds.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vds function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • change_disc_size - . (Optional parameter. To enable the option click "on".) Select the check box to confirm that all the operations (such as activation/suspension of a virtual server, change of its disk size) were performed
  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Service activation

Function: vds.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vds function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Scheduler

Function: scheduler

Result: the list of elements

Scheduler

Access level: root

  • command - Command
  • interval - Period
  • schedule_type - Scheduler
  • state - Status
  • description - Description

Inventory module settings

Function: scheduler.prop

Access level: root

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (key element of scheduler function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • mailto - Email. Enter the email address that will be used for notifications about your cronjobs.
  • path - Path. Enter one or more paths (space separated) that will be used to search for executables.

Run the selected cron job

Function: run

Run the selected cron job

Access level: root

Delete

Function: scheduler.delete

Delete

Access level: root

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.

Result: successful operation or error message

Crob job

Function: scheduler.edit

Access level: root

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (key element of scheduler function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • mailto - Email. You can enter an e-mail address using the global setting button of the cronjob module. Afterwards you can receive information by e-mail about a cronjob.
  • command - Command:. Enter the path to the script that you want to be executed by the cronjob.
  • description - Description:. This field can be used for additional information about this cron job
  • active - . (Optional parameter. To enable the option click "on".) Check the box to activate this cron job.
  • schedule_type - Scheduler. You can configure the settings of a cronjob in basic or in expert mode. The expert mode has more options but you need to have more knowledge about cronjobs to be able to use the expert mode.


  • run_every - Run. Select the main time frame this cron job will be executed.
  • time_hour - Time. Enter the hour this cron job will be executed (value 0 -23).
  • time_min - . Enter the minute this cron job will be executed (value 0 - 59).
  • wday1 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Monday
  • wday2 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Tuesday
  • wday3 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Wednesday
  • wday4 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Thursday
  • wday5 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Friday
  • wday6 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Saturday
  • wday0 - . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Sunday
  • month - Month. Select a month to start cron job
  • month_day - Day of month. Select day of month to run the cron job
  • input_min - Minutes. Enter the minutes this cronjob needs to be executed. Format: * - for all minutes
  • input_hour - Hours. Enter the hours this cronjob needs to be executed. Format: * - all hours
  • input_dmonth - Days of month. Enter the days this cronjob needs to be executed. Format: * - all days of month
  • input_month - Months. Enter the days this cronjob needs to be executed. Format: * - all months
  • input_dweek - Days of week. Enter the days of a week this cronjob needs to be executed.Format: * - all days of week
  • hideout - . (Optional parameter. To enable the option click "on".) Check the box if you do not want to receive the output of this cron job by email.

Suspend

Function: scheduler.suspend

Suspend

Access level: root

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.

Result: successful operation or error message

Resume

Function: scheduler.resume

Resume

Access level: root

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.

Result: successful operation or error message

Support tickets

Function: clientticket

Result: the list of elements

Support tickets

Access level: user

  • id - Id
  • name - Subject
  • last_message - Last updated
  • wait_time - Delay
  • create_user - Author
  • tstatus - Status

Set filter.

clientticket.filter

Buy support incidents to contact technical support

Function: incident

Buy support incidents to contact technical support

Access level: user

Support ticket

Function: clientticket.edit

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of clientticket function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Subject. The ticket subject contains a brief description of the support ticket
  • ticket_item - Service. Select a service related to your question
  • ticket_project_select - Provider. Select a provider associated with the ticket
  • client_department - Department. Select the provider's department to assign the ticket
  • item - Service. Select a service related to your question
  • client_priority - Priority. Ticket priority
  • priority - Priority. Ticket priority
  • message - Text. Enter the text of the message you want to send
  • show_optional - . (Optional parameter. To enable the option click "on".) Show additional configuration options for this ticket
  • note_message - .
  • ticket_expense - Support fee . Amount that will be charged from the client's account
  • high_priority - . (Optional parameter. To enable the option click "on".) Place the ticket to the to of the queue
  • low_priority - . (Optional parameter. To enable the option click "on".) Raised priority will be reset for this ticket
  • incident_count - .
  • show_abuse - . (Optional parameter. To enable the option click "on".) Show abuse registration parameters
  • score - Number of scores . Number of abuse scores
  • action - Function.
  • deadline_date - .
  • deadline_time - .
  • score_note - Comment. Enter additional information

Move to archive

Function: clientticket.archive

Move to archive

Access level: user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of clientticket function.

Result: successful operation or error message

Support tickets

Function: ticket

Result: the list of elements

Support tickets

Access level: admin

  • id - Id
  • ticket - Ticket
  • name - Subject
  • client - Client
  • delay - Delay
  • date_start - Date submitted
  • deadline - Remaining time
  • responsible - Responsible
  • project - Provider
  • queue - Queue
  • location - Location
  • props - Properties

Unblock this ticket

Function: ticket.unblock

Unblock this ticket

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket function.

Result: successful operation or error message

Name

Function: ticket.message

Result: the list of elements

List of ticket messages

Access level: admin

  • id - Id
  • message - Message
  • date_post - Expense date
  • message_user - User

Edit the selected message

Function: ticket.message.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of ticket function).
    • elid - unique identifier (id element of ticket.message function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of ticket function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of ticket function).
    • elid - unique identifier (id element of ticket.message function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • message - Message. Message body

Split this ticket into two tickets starting from the selected message

Function: ticket.split

Split this ticket into two tickets starting from the selected message

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket.message function.

Result: successful operation or error message

Hide the message from the client

Function: ticket.message.delete

Hide the message from the client

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket.message function.

Result: successful operation or error message

Set filter.

ticket.filter

Add this ticket to Favorites and keep track of its history

Function: ticket.favorite

Add this ticket to Favorites and keep track of its history

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket function.

Result: successful operation or error message

Drill down to User panel

Function: ticket.su

Drill down to User panel

Access level: admin

Ticket

Function: ticket.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of ticket function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Subject. The ticket subject contains a brief description of the support ticket
  • ticket_item - Service. Select a service related to your question
  • ticket_project_select - Provider. Select a provider associated with the ticket
  • client_department - Department. Select the provider's department to assign the ticket
  • item - Service. Select a service related to your question
  • client_priority - Priority. Ticket priority
  • priority - Priority. Ticket priority
  • message - .
  • show_optional - . (Optional parameter. To enable the option click "on".) Show additional configuration options for this ticket
  • note_message - .
  • ticket_expense - Support fee . Amount that will be charged from the client's account
  • high_priority - . (Optional parameter. To enable the option click "on".) Place the ticket to the to of the queue
  • low_priority - . (Optional parameter. To enable the option click "on".) Raised priority will be reset for this ticket
  • incident_count - Support incidents . Number of incidents deducted from the client's account for this ticket. Enlarging this number will deduct additional incidents, decreasing the number will return incidents to the client's account
  • show_abuse - . (Optional parameter. To enable the option click "on".) Show abuse registration parameters
  • score - Number of scores . Number of abuse scores
  • action - Function.
  • deadline_date - .
  • deadline_time - .
  • score_note - Comment. Enter additional information

Close ticket (delete from the queue)

Function: ticket.delete

Close ticket (delete from the queue)

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket function.

Result: successful operation or error message

Set a filter by the selected client

Function: ticket.setfilter

Set a filter by the selected client

Access level: admin

Pre-defined replies

Function: anstempl

Result: the list of elements

Pre-defined replies

Access level: admin

  • id - Id
  • name - Name
  • project - Provider
  • template_type - Template type
  • department - Department
  • orderpriority - Priority order
  • props - Properties

Move one line up

Function: anstempl.up

Move one line up

Access level: admin

Set filter.

anstempl.filter

Delete

Function: anstempl.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of anstempl function.

Result: successful operation or error message

Answer template

Function: anstempl.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of anstempl function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • message - Text. Enter a predefined reply. You can use the following macros:
    %PROJECT% - provider name
    %SUPPORTUSER% - full name of a staff member answering in the ticket
    %USER% - full name of the client's user
    %SERVICE%" - service name
  • orderpriority - Priority . Set the order to sort templates
  • project - Provider. This template will be available to the selected provider
  • shared_for_all - . (Optional parameter. To enable the option click "on".) Allow all members, or only members of the department selected below, to use this template
  • user_department - Department. This template will be available to members of the selected department

Move one line down

Function: anstempl.down

Move one line down

Access level: admin

Quality control

Function: selecttickets

Result: the list of elements

Quality control

Access level: admin

  • id - Id
  • name - Name

Name

Function: selecttickets.rate.category

Result: the list of elements

Rate categories

Access level: admin

  • id - Id
  • name - Name

Edit rate categories

Function: selecttickets.rate.category.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of selecttickets function).
    • elid - unique identifier (id element of selecttickets.rate.category function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of selecttickets function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of selecttickets function).
    • elid - unique identifier (id element of selecttickets.rate.category function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method

Delete

Function: selecttickets.rate.category.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selecttickets.rate.category function.

Result: successful operation or error message

Show selected items

Function: selecttickets.selection

Show selected items

Access level: admin

Selection of tickets

Function: selecttickets.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of selecttickets function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • type - Type . Chat or tickets will be selected
  • email_list - Email list. The list of email addresses that can be selected when sending tickets with customer satisfaction rating

Name

Function: selecttickets.rule

Result: the list of elements

Rules to select tickets

Access level: admin

  • id - Id
  • rule - Rule
  • rulegroup - Group of rules

Delete

Function: selecttickets.rule.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selecttickets.rule function.

Result: successful operation or error message

Edit the selected rule

Function: selecttickets.rule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of selecttickets function).
    • elid - unique identifier (id element of selecttickets.rule function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of selecttickets function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of selecttickets function).
    • elid - unique identifier (id element of selecttickets.rule function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Type.
  • group - Group of conditions. Conditions in this group will be combined by the OR operator. Groups are combined by the AND operator. For example: A, B, and C operators can be combined into one group. D and E operators are combined into the second group. The result will be as follows: (A OR B OR С) AND (D OR E)
  • groupname - Group name. Enter the name of the conditions group

Select tickets according to the rules specified

Function: selecttickets.runselection

Select tickets according to the rules specified

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selecttickets function.

Result: successful operation or error message

Delete

Function: selecttickets.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selecttickets function.

Result: successful operation or error message

Per-incident support

Function: paidsupport

Result: the list of elements

Per-incident support

Access level: admin

  • ticket_usage - Usage
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Order a new service

Function: paidsupport.order

Order a new service

Access level: user

Delete the selected services

Function: paidsupport.delete

Delete the selected services

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paidsupport function.

Result: successful operation or error message

Purchase support incidents

Function: paidsupport.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paidsupport function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Set filter.

paidsupport.filter

Service activation

Function: paidsupport.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paidsupport function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Resume

Function: paidsupport.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paidsupport function.

Result: successful operation or error message

Suspend

Function: paidsupport.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paidsupport function.

Result: successful operation or error message

Set a filter by the selected client

Function: paidsupport.setfilter

Set a filter by the selected client

Access level: admin

Drill down to User panel

Function: paidsupport.su

Drill down to User panel

Access level: admin

Global settings

Function: settings

Access level: admin

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

  • DeleteManualSuspend - . (Optional parameter. To enable the option click "on".) Services suspended by administrator will be deleted according to schedule. By default, the billing system deletes only expired services, or services that were suspended due to insufficient funds for renewal. Period can be specified either in the tariff plan edit form, or in the product type edit form
  • AllowDeleteNotification - . (Optional parameter. To enable the option click "on".) Allow clients to delete notifications in the corresponding module
  • NoProjectSelect - . (Optional parameter. To enable the option click "on".) This option will forbid a client to switch between service providers after login to Client area
  • HideClosedItem - . (Optional parameter. To enable the option click "on".) "Deleted" services won't be displayed in all lists where services are displayed


  • DeleteInactiveAccount - . (Optional parameter. To enable the option click "on".) This option enables an automatic deleting of customers without any activity within the specified period and having no active services, payments and expenses. The following factors will be analyzed: created payments, ordered services, technical support requests, new customers attracted under the referral program.
  • DeleteInactiveAccountPeriod - Delete account if it is not active for more than . Period when the client remains idle
  • DeleteInactiveAccountNotify - . (Optional parameter. To enable the option click "on".) Select this check box to send the Account deletion notification
  • NearDeleteInactiveAccountNotify - . (Optional parameter. To enable the option click "on".) Select the check box to enable preliminary notifications about near deletion of user account
  • NearDeleteInactiveAccountPeriod - Date of sending preliminary notification . Number of days left until the deletion date, separated by spaces
  • ignore_accounts - Exclude clients from reports . Enter clients' ids comma separated. They will be ignored in reports. In reports that collects statistics every day, a newly added client will be excluded the next day
  • HideDiscount - . (Optional parameter. To enable the option click "on".) Select the check box to hide a discount during service order
  • PostPaidPaymentExpenseDate - Invoice for due expenses . Due expenses will be included into a monthly invoice
  • ProRataCreateDate - Service provisioning (calendar billing) . Select how to generate a service provisioning date in case of calendar billing
  • PaymentWizardOrder - Payment Wizard . Order of steps for invoice generation
  • AllowAnyCountryForProfile - . (Optional parameter. To enable the option click "on".) Allow a client to create payers from countries that differ from the one he selected during registration. We do not recommend that you do so if you set tax rates. For more information, please read the corresponding article
  • ProhibitDifferentProfileTypes - . (Optional parameter. To enable the option click "on".) Forbid clients to create payers with different statuses, The client cannot have a status of both company or individual
  • AutoPayment - . (Optional parameter. To enable the option click "on".) Select this check box to enable automatic invoicing in case of low account balance
  • CountProfileType_1 - Number of individuals . Enter the maximum number of "Individual" payers per client. Leave the field blank to set an unlimited value
  • CountProfileType_2 - Number of legal entities . Enter the maximum number of "Legal entity (Company)" payers per client. Leave the field blank to set an unlimited value
  • CountProfileType_3 - Number of sole proprietors . Enter the maximum number of "Sole proprietor" payers per client. Leave the field blank to set an unlimited value
  • ProfileValidationPolicy - Data change policy . Set policy rules for verified payers
  • DefaultInvoiceType - Invoice generation type . Type of generation of invoices created for payers by default
  • InvoiceCurrencyDate - . (Optional parameter. To enable the option click "on".) When you generate an invoice based on due expenses, and if the invoice currency differs from the currency set for client's account, by default the system will use rate for the current date. Select this check box to use currency rate for the date when the invoice was created.
  • ProfileCreateNotification - . (Optional parameter. To enable the option click "on".) If this option is enabled, the payer will receive the information notification to his/her email. Only for individuals and sole proprietor.
  • StatNotificationType - Send notification . Select when you want to send notifications if you charge a client for resource overages
  • StatExpensePolicy - In case of insufficient funds on client's account . Choose an action that will be performed to charge a client, if there are insufficient funds on his account
  • StatNotificationLimit - Send notifications when a client reaches its limits . Enter a percentage of resource usage at which the threshold notification will be sent
  • SupportToCc - . (Optional parameter. To enable the option click "on".) Select this check bot to send notifications to multiple recipients, specified in the client's email
  • SupportUsePriority - . (Optional parameter. To enable the option click "on".) Allow your clients to set priority for support tickets, and allow administrators to change priority if needed
  • SupportFileSize - Maximum file size . Enter the maximum file size that clients may attach to tickets
  • SupportMessageSize - Maximum message size . Enter the maximum message size per ticket post
  • SupportHightPrioritySchedule - Increase ticket priority when response time is less than . This option enables to change ticket priority if remaining resonse time is less than the value specified
  • AbuseRateStat - . (Optional parameter. To enable the option click "on".) Select the check box to sum up abuse scores and apply fines when the limit is reached
  • AbuseBlockItemRate - Block services when reaching the limit . Client's services will be blocked and the client won't be able to order new services
  • ArchiveTicket - . (Optional parameter. To enable the option click "on".) Select the check box to move tickets to the Archive automatically after a certain time of inactivity
  • ArchiveTicketDays - If new posts are not added for more than . Enter a period in days. Support tickets will be automatically closed after a certain time of inactivity has passed
  • ValidateOrder - Verification order . Set the data checking order
  • FraudValidateType - Phone number confirmation . A client is asked to enter his phone number and pass the verification procedure. The phone number will be marked verified and can be used for service deletion confirmation
  • fraud_phone_trycount - Number of attempts to receive a code . Set the number of attempts to enter a phone confirmation code a client can make to pass the verification process
  • fraud_code_trycount - Number of attempts to enter code . Enter the number of attempts to enter the confirmation code a client can make before he will be required to obtain a new code
  • EmailValidateType - Confirmation by email . Confirmation of email address specified during registration
  • WaitTimeSend - Email sending period . Time is seconds that will pass before the next attempt to send an account activation email will be made. The default value is 300 seconds
  • ManualValidateType - Manual confirmation . Manual confirmation of client's account
  • ManualValidateDepartment - Department . Select a department that will receive tasks for manual confirmation of client accounts
  • AllowRecoveryBySms - . (Optional parameter. To enable the option click "on".) Enables to send a verification code for password recovery to a verified phone number. If the phone number is not verified, a client will be emailed the password reset instructions
  • PhoneRestoreMaxSendTime - Attempts to send a code . Enter the maximum number of attempts to receive a code by the phone
  • PhoneRestoreSendTimeOut - Code receiving timeout . Enter the minimal time in seconds that will pass before a client will be able to receive a new recovery code
  • AllowRecoveryByEmail - . (Optional parameter. To enable the option click "on".) A client can choose how he wants to receive a password
  • ProfilePhoneValidateType - Phone number confirmation . Payer's phone number confirmation
  • ProfilePhoneTryCount - Attempts to get a code . Enter the maximum number of attempts for phone number confirmation that a client can make during the verification process
  • ProfilePhoneCodeTryCount - Password entry attempts. The maximum number of attempts to enter a code. Once exceeded, you will need to get a new code
  • ProfileEmailValidateType - Email confirmation . Email confirmation of payer's address
  • ProfileEmailWaitTimeSend - Email sending period . Time is seconds that will pass before the second confirmation email will be sent. The default value is 300 sec
  • ProfileManualValidateType - Manual confirmation . Manual verification of payers' data
  • ProfileManualValidateDepartment - Department . Select a department that will received tasks for manual confirmation of payer's data
  • RequireEmailValidation - . (Optional parameter. To enable the option click "on".) Notifications cannot be sent to non-verified email addresses. After registration, a client will be asked to pass the email verification process. You can send a verification email from the user settings form. Mass mailing won't be sent to non-verified email addresses
  • ParseMailSystemAutoreplay - . (Optional parameter. To enable the option click "on".) Select the check box to process automatic notifications from mail systems informing that email cannot be delivered. You can select this option, if you configure a gateway to pass incoming emails for a mailbox from which emails will be sent
  • BuymoreMaxCount - Offers. Enter the maximum number of related products in the Cart
  • RegFormType - Registration form. Registration form type
  • RegistrationPhone - . (Optional parameter. To enable the option click "on".) Select the check box to allow customers to specify phone number during registration
  • RecaptchaType - reCAPTCHA type on the login form . Enable reCAPTCHA on a client registration form. Do not forget about these settings if you integrate registration form with your website
  • RecaptchaPublicKey - Key . reCAPTCHA public key
  • RecaptchaPrivateKey - Secret key . reCAPTCHA secret key
  • RecaptchaAuthType - reCAPTCHA type on the login form. Select the check box to enable reCAPTCHA on the client login form
  • RecaptchaAuthPublicKey - Key. reCAPTCHA public key
  • RecaptchaAuthPrivateKey - Secret key

. reCAPTCHA secret key

  • ShowroomBehavior - Behavior . Select an action that will be performed when a non-registered user opens BILLmanager
  • ShowroomLinkType - Link type . Select a type of the link that will be shown on the login form
  • OneDedicatedIp - . (Optional parameter. To enable the option click "on".) Only one IP address will be allocated, even if the tariff plan includes multiple IP addresses that can be allocated, but a client didn't order additional IPs. The client can order additional IP addresses in the "IP address" module
  • CheckIpInUse - . (Optional parameter. To enable the option click "on".) Only for "Dedicated servers": the system will check IP address accessibility before deletion; If IP address is active, it won't be deleted

IPmanager

Function: processing.ipmgr

Result: the list of elements

Integration with IP manager

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Delete

Function: processing.ipmgr.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing.ipmgr function.

Result: successful operation or error message

Open the control panel

Function: processing.ipmgr.gotoserver

Open the control panel

Access level: admin

Integration with IPmanager

Function: processing.ipmgr.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of processing.ipmgr function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of processing.ipmgr function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name
  • url - URL. IPmanager URL
  • login - Username. Username
  • password - Password

. Enter a password to access the control panel

  • adminlogin - Administrator login. Administrator login in IPmanager
  • adminpassword - Administrator password. Administrator password in IPmanager
  • hiddentypes - Ignore IP types. Enter types of IP addresse, space separated, that should not be checked against the billing database

Virtual DC

Function: vdc

Result: the list of elements

Virtual data-center

Access level: admin user

  • vdcname - Name
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg -
  • item_status -
  • cost - Price

Networks

Function: vdc.network

Result: the list of elements

Networks

Access level: admin user

  • id - Id
  • name - Name
  • vm_group -
  • router - Router
  • gateway - Gateway
  • mask - Network mask
  • network_subnets - Subnet addresses
  • network_pools - IP pool
  • status - Status

Name

Function: vdc.network.subnet

Result: the list of elements

Subnets

Access level: admin user

  • id - Id
  • name - Name
  • cidr - Subnet address
  • gateway - Gateway
  • status - Status
  • status - Status
Delete

Function: vdc.network.subnet.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.network.subnet function.

Result: successful operation or error message

Edit subnet

Function: vdc.network.subnet.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.network function).
    • elid - unique identifier (id element of vdc.network.subnet function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.network function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.network function).
    • elid - unique identifier (id element of vdc.network.subnet function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • subnet_type - Select the address network interface . Select the address network interface
  • pool - Pool . Select the network address from the pool
  • mask - Subnet mask. Subnet mask
  • cidr - Subnet address . Subnet address
  • use_gateway - . (Optional parameter. To enable the option click "on".) Use gateway for this subnet. One of the subnet addresses will be used by the gateway
  • gateway - Gateway address. Gateway address which is used for subnet. Leave the field blank if you wan to allocate IP automatically
  • use_dhcp - . (Optional parameter. To enable the option click "on".) Use DHCP for this subnet. One of the subnet address will be used by DHCP

Delete

Function: vdc.network.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.network function.

Result: successful operation or error message

Edit network

Function: vdc.network.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.network function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.network function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • vdc_vm_group - Group of virtual servers . Allows to create the network which would be available inside the group of virtual servers only
  • create_subnet - . (Optional parameter. To enable the option click "on".) Enables to create subnet during network creation
  • subnet_name - Subnet name . Subnet name
  • subnet_type - Select the network address . Select the network address
  • subnet_pool - Pool . Select the network address from the pool
  • subnet_mask - Subnet mask. Subnet mask
  • subnet_cidr - Subnet address . Subnet address in the form 'network_address/network_mask'. For example: 192.168.0.0/24
  • subnet_use_gateway - . (Optional parameter. To enable the option click "on".) Use gateway for this subnet. One of the subnet addresses will be used by the gateway
  • subnet_gateway - Gateway address. Gateway address which is used in subnet. Leave the field blank to allocate IP automatically
  • subnet_use_dhcp - . (Optional parameter. To enable the option click "on".) Use DHCP for this subnet. One of the subnet address will be used by DHCP
  • gateway - Gateway . Gateway
  • mask - Network mask . Network mask
  • dns1 - Primary DNS . Primary DNS server which is used in network
  • dns2 - Secondary DNS . Secondary DNS server which is used in network
  • dns_suffix - DNS suffix . DNS suffix which is used in network
  • subnet_vdc_router - .
  • vdc_router - Connect to the router. The newly created network will be connected to the selected router of the virtual data-center
  • vdc_network - Connect to VDC network . Network will be connceted to the selected network of virtual Data Center
  • network_pools - .
  • network_dhcp - .

Suspend

Function: vdc.network.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.network function.

Result: successful operation or error message

Resume

Function: vdc.network.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.network function.

Result: successful operation or error message

Virtual machines

Function: vdc.vm

Result: the list of elements

List of virtual servers

Access level: admin user

  • id - Id
  • name - Name
  • vm_group - Group
  • vmtempl - Virtual server template
  • ostempl_name - OS template
  • external_ip - External IP
  • internal_ip - Internal IP
  • ncpu_m - CPU
  • mem_m - RAM, MiB
  • disc_total_m - Disk, GiB
  • status - Status
  • status - Status

Navigate to the web-console of the virtual machine

Function: vdc.vm.webconsole

Navigate to the web-console of the virtual machine

Access level: admin user

Editing virtual server

Function: vdc.vm.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.vm function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.vm function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Name of virtual server
  • vmtempl - Parameters. Virtual server template
  • source - Base object. Select the base object that will be used to create a new virtual server
  • ostempl - Operating system. OS template used to create a new virtual server
  • vdc_volume - Disk. You can only select a bootable disk that is not used by any virtual server
  • vdc_volume_snapshot - Disk snapshot. New disk for the virtual server will be created based on the snapshot
  • vdc_vm_snapshot - Snapshot of virtual server. New virtual server will be created on the basis of snapshot
  • vdc_vm_group - Group for location. Group for virtual server
  • vm_group_name - Group name. Name of virtual server group
  • vdc_network - Network. Virtual data center network which the new virtual server will be connected to
  • create_volume - . (Optional parameter. To enable the option click "on".) Disk of the specified volume will be created for virtual server
  • disc - Disk. Disk volume of virtua server
  • ncpu - CPU. CPU number of virtual server
  • mem - RAM. RAM given to virtual server
  • password - Password

. Virtual server password

  • confirm - Re-enter password.

Disk name

Function: vdc.vm.volume

Result: the list of elements

Disks connected to virtual server

Access level: admin user

  • id - Id
  • name - Disk name
  • size - Disk size, GB
Connect disk to virtual server

Function: vdc.vm.volume.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.vm function).
    • elid - unique identifier (id element of vdc.vm.volume function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.vm function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.vm function).
    • elid - unique identifier (id element of vdc.vm.volume function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • volumelist - Disk name . Name of the disk you want to connect to virtual server
Disconnect disk from virtual server

Function: vdc.vm.volume.delete

Disconnect disk from virtual server

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm.volume function.

Result: successful operation or error message

Set filter.

vdc.vm.filter

==== Reboot virtual server

====

Function: vdc.vm.reboot

Reboot virtual server


Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm function.

Result: successful operation or error message

Stop virtual server

Function: vdc.vm.suspend

Stop virtual server

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm function.

Result: successful operation or error message

Run the forced reboot of the selected VPS

Function: vdc.vm.hardreboot

Run the forced reboot of the selected VPS

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm function.

Result: successful operation or error message

Delete virtual server

Function: vdc.vm.delete

Delete virtual server

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm function.

Result: successful operation or error message

Name

Function: vdc.vm.network

Result: the list of elements

Connection to VDC networks

Access level: admin user

  • id - Id
  • network_name - Network name
  • ip_address - IP address
  • network_subnet - Subnet
  • mac - MAC-address
Disconnect virtual server from network

Function: vdc.vm.network.delete

Disconnect virtual server from network

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm.network function.

Result: successful operation or error message

Add new connection

Function: vdc.vm.network.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.vm function).
    • elid - unique identifier (id element of vdc.vm.network function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.vm function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.vm function).
    • elid - unique identifier (id element of vdc.vm.network function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • network - Network. Enter the VDC network the virtual server will be connected to

Name

Function: vdc.vm.ip

Result: the list of elements

External IP addresses connected to virtual server

Access level: admin user

  • id - Id
  • ip - IP address
  • status - Status
Connect IP address to virtual server

Function: vdc.vm.ip.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.vm function).
    • elid - unique identifier (id element of vdc.vm.ip function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.vm function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.vm function).
    • elid - unique identifier (id element of vdc.vm.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • iplist - IP address . Enter the IP address you want to connected to the virtual server
  • port - Connection port . Enter the port of the server that the external IP address will be connected to
Delete IP from virtual server

Function: vdc.vm.ip.delete

Delete IP from virtual server

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm.ip function.

Result: successful operation or error message

Run virtual server

Function: vdc.vm.resume

Run virtual server

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.vm function.

Result: successful operation or error message

Disk name

Function: vdc.volume

Result: the list of elements

Disk storage

Access level: admin user

  • id - Id
  • name - Disk name
  • size - Disk size, GiB
  • externalid - Disk ID
  • vdc_vm_name - VPS
  • type - Type
  • bootable - Boot disk
  • ss - Snapshots
  • status - Status

Name

Function: vdc.volume.snapshot

Result: the list of elements

Disk snapshots

Access level: admin user

  • id - Id
  • name - Name
  • externalid - Snapshot ID
  • vdc_volume - Disk
  • status - Status
Delete

Function: vdc.volume.snapshot.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.volume.snapshot function.

Result: successful operation or error message

Snapshot

Function: vdc.volume.snapshot.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.volume function).
    • elid - unique identifier (id element of vdc.volume.snapshot function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.volume function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.volume function).
    • elid - unique identifier (id element of vdc.volume.snapshot function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method

Edit disk

Function: vdc.volume.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.volume function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.volume function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Disk name . Disk name
  • type - Type. Disk type
  • source_type - Source. Disk creation source
  • ostempl - Image . Select the image that will be used for disk creation
  • snapshot - Snapshot . Select the snapshot that will be used for disk creation
  • size - Disk size . Disk size in GB
  • bootable - . (Optional parameter. To enable the option click "on".) Boot disk

Delete

Function: vdc.volume.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.volume function.

Result: successful operation or error message

Suspend

Function: vdc.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc function.

Result: successful operation or error message

Resume

Function: vdc.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc function.

Result: successful operation or error message

Set filter.

vdc.filter

Virtual data-center

Function: vdc.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vdc function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Delete the selected services

Function: vdc.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc function.

Result: successful operation or error message

Order a virtual data-center

Function: vdc.order.pricelist

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vdc function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • datacenter - Select a data center. Select a data center where the service will be located

Set a filter by the selected client

Function: vdc.setfilter

Set a filter by the selected client

Access level: admin

Name

Function: vdc.loadbalancer

Result: the list of elements

Lits of balancers

Access level: admin user

  • id - Id
  • name - Name
  • externalid - Balancer ID
  • vm - VPS
  • protocol - Protocol
  • port - Port
  • method - Method
  • monitortype - Monitoring protocol
  • delay - Interval, sec
  • retries - Attempts
  • timeout - Timeout, sec
  • status - Status

Edit balancer

Function: vdc.loadbalancer.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.loadbalancer function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.loadbalancer function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • subnet - Subnets . Select a subnet
  • protocol - Protocol . Select protocol
  • port - Port. Select a port. Possible values 1 to 65535
  • method - Method. Method of traffic distribution between pool members
  • vm - VPS. Virtual servers from the pool
  • monitortype - Monitoring protocol . Monitoring protocol type
  • delay - Interval, sec. Query interval, in seconds
  • retries - Attempts. The number of successful check attempts before the status of the pool member will be changed. Possible values: 1 to 10.
  • timeout - Timeout, sec . The maximum waiting time for connection, in seconds

Name

Function: vdc.loadbalancer.vm

Result: the list of elements

Virtual server connected to balancer

Access level: admin user

  • id - Id
  • vm -
  • subnet - Subnet
Connect virtual server to balancer

Function: vdc.loadbalancer.vm.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.loadbalancer function).
    • elid - unique identifier (id element of vdc.loadbalancer.vm function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.loadbalancer function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.loadbalancer function).
    • elid - unique identifier (id element of vdc.loadbalancer.vm function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • vm - VPS. Virtual server that will be connected to balancer
Delete

Function: vdc.loadbalancer.vm.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.loadbalancer.vm function.

Result: successful operation or error message

Name

Function: vdc.loadbalancer.ip

Result: the list of elements

IP addresses connected to balancer

Access level: admin user

  • id - Id
  • ip - IP address
  • status - Status
Connect IP to balancer

Function: vdc.loadbalancer.ip.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.loadbalancer function).
    • elid - unique identifier (id element of vdc.loadbalancer.ip function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.loadbalancer function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.loadbalancer function).
    • elid - unique identifier (id element of vdc.loadbalancer.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • iplist - IP address. IP address that you want to connect to balancer
Disconnect IP from balancer

Function: vdc.loadbalancer.ip.delete

Disconnect IP from balancer

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.loadbalancer.ip function.

Result: successful operation or error message

Delete balancer

Function: vdc.loadbalancer.delete

Delete balancer

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.loadbalancer function.

Result: successful operation or error message

Routers

Function: vdc.router

Result: the list of elements

List of VDC router

Access level: admin user

  • id - Id
  • externalid - Router identifier
  • name - Name
  • routertempl_name - Configuration
  • network - External network
  • external_ip - IP addresses
  • status - Status
  • status - Status

Suspend

Function: vdc.router.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router function.

Result: successful operation or error message

Name

Function: vdc.router.lbp

Result: the list of elements

List of pools

Access level: admin user

  • id - Id
  • name - Name
  • description - Description
  • members - Pool members
  • service - Services
  • port - Ports
  • monitor_port - Monitoring port
  • method - Method
  • interval - Interval
  • timeout - Timeout
  • status - Status
Delete pool

Function: vdc.router.lbp.delete

Delete pool

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.lbp function.

Result: successful operation or error message

Pool parameters

Function: vdc.router.lbp.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.lbp function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.lbp function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name . Name of the load balancer pool. It can contain only the Latin alphabet letters, digits, a dash, underscore, and must start with a letter
  • description - Description . Enter any information related to this pool
  • uri - Accessibility check URI . URI for HTTP availability check

Tunnel name

Function: vdc.router.vpn

Result: the list of elements

IPSec VPN tunnel management

Access level: admin user

  • id - Id
  • name - Tunnel name
  • connection_type - Connection type
  • local_ip_address - Local IP address
  • peer_ip_address - External IP address
  • network_local - Local networks
  • network_peer - External networks
  • encryption_protocol - Encryption protocol
  • status - Status
  • status - Status
IPSec VPN tunnel parameters

Function: vdc.router.vpn.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.vpn function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.vpn function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • description - Description.
  • connection_type - Connection type . Select a connection method of the IPSec VPN tunnel
  • vdc_router_peer - Router . Select a router of the virtual data-center that the IPSec VPN tunnel will be configured
  • vdc_network_local - Local networks . Local networks connected to the router
  • vdc_network_peer - External networks . External networks connected to the router of the virtual data-center
  • peer_cidr - External networks . External networks that the IPSec VPN tunnel is configured for. Supported format: address_network/mask, space separated. For example: 192.168.0.0/24 192.168.1.0/24
  • local_endpoint - Local connection point . Router interface that will be used for VPN connection. Select the "Public IP address" check box if you want to use public IP address for connection
  • local_endpoint_use_public_ip - . (Optional parameter. To enable the option click "on".)
  • peer_endpoint - External connection point . Router interface that will be used for VPN connection. Select the "Public IP address" check box if you want to use public IP address for connection
  • peer_endpoint_use_public_ip - . (Optional parameter. To enable the option click "on".)
  • local_id - Local ID. Local ID IPSec VPN tunnel
  • peer_id - External ID. External ID IPSec VPN tunnel
  • peer_ip_address - External IP address . Address of the external connection point
  • encryption_protocol - Encryption protocol . Connection encryption protocol
  • shared_key - Encryption key . Encryption key. You can use the Latin alphabet letters and digits. The key length must be from 32 to 128 characters long
  • mtu - MTU . Enter the maximum package size that will pass through the IPSec VPN tunnel
Delete

Function: vdc.router.vpn.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.vpn function.

Result: successful operation or error message

Suspend

Function: vdc.router.vpn.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.vpn function.

Result: successful operation or error message

Resume

Function: vdc.router.vpn.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.vpn function.

Result: successful operation or error message

Name

Function: vdc.router.lbs

Result: the list of elements

List of servers

Access level: admin user

  • id - Id
  • name - Name
  • description - Description
  • ip - IP address
  • vdc_loadbalancer_pool_name - Pool
  • service_name - Service name
  • service_port - Service port
  • service_persistence - Method
  • status - Status
  • status - Status
Suspend

Function: vdc.router.lbs.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.lbs function.

Result: successful operation or error message

Delete server

Function: vdc.router.lbs.delete

Delete server

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.lbs function.

Result: successful operation or error message

Server parameters

Function: vdc.router.lbs.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.lbs function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.lbs function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name . Enter the name of the load balancer server. It can contain the Latin alphabet letters, digits, a dash, underscore, and must start with a letter
  • description - Description . Enter any information related to this server
  • vdc_network - Network . Select the router network the load balancer will be activated for
  • ip - IP address . IP address of the load balancer server
  • pool - Pool . Pool of the load balancer parameters
  • use_log - . (Optional parameter. To enable the option click "on".) Activate logging of the traffic going through the load balancer server
Resume

Function: vdc.router.lbs.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.lbs function.

Result: successful operation or error message

Name

Function: vdc.router.firewall

Result: the list of elements

Delete router Firewall

Access level: admin user

  • id - Id
  • name - Name
  • source_desc - Source
  • destination_desc - Destination IP
  • protocol - Protocol
  • policy - Policy
  • status - Status
  • status - Status
Delete

Function: vdc.router.firewall.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.firewall function.

Result: successful operation or error message

Suspend

Function: vdc.router.firewall.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.firewall function.

Result: successful operation or error message

Edit Firewall rule

Function: vdc.router.firewall.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.firewall function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.firewall function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name . Rule name
  • protocol - Protocol . Select a protocol the rule will be applied to
  • source - Source . Traffic source. Possible values: IP address, CIDR, range of IP addresses, "any","internal" and "external". You can enter a specific value or select it from the list
  • source_port - Source port . Source port. You can enter a specific value or select it from the list
  • destination - Destination IP. Traffic destination IP. Possible values: IP address, CIDR, a range of IP addresses, "any","internal" and "external". You can enter a specific value or select it from the list
  • destination_port - Destination IP port . Destination IP port. You can enter a specific value or select it from the list
  • policy - Policy. Set traffic policy
  • use_log - . (Optional parameter. To enable the option click "on".) Select the check box to log traffic associated with the rule
Resume

Function: vdc.router.firewall.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.firewall function.

Result: successful operation or error message

Name

Function: vdc.router.interface

Result: the list of elements

Router interfaces

Access level: admin user

  • id - Id
  • externalid - Router interface identifier
  • network - Network
  • subnet - Subnet
  • fixedips - IP address
  • type - Interface type


  • status - Status
Inventory module settings

Function: vdc.router.interface.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.interface function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.interface function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • subnet - Subnet . Subnet that the router will be associated with

Function: vdc.router.interface.param


Access level: admin user

Delete the selected interfaces

Function: vdc.router.interface.delete

Delete the selected interfaces

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.interface function.

Result: successful operation or error message

Resume

Function: vdc.router.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router function.

Result: successful operation or error message

Name

Function: vdc.router.dhcp

Result: the list of elements

Delete DHCP router

Access level: admin user

  • id - Id
  • network - Data-center network
  • ip_range - IP range
  • default_lease_time - Default lease time
  • max_lease_time - Max lease time
  • status - Status
Suspend

Function: vdc.router.dhcp.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.dhcp function.

Result: successful operation or error message

Resume

Function: vdc.router.dhcp.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.dhcp function.

Result: successful operation or error message

Delete

Function: vdc.router.dhcp.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.dhcp function.

Result: successful operation or error message

Edit IP range

Function: vdc.router.dhcp.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.dhcp function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.dhcp function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • vdc_network - Data-center network . Select a data-center the DHCP range is activated for
  • ip_range - IP range . Select a range that IP addresses will be allocated from
  • default_lease_time - Default lease time . Enter the default time for IP address lease
  • max_lease_time - Max lease time . Enter the maximum lease time for the IP address

Edit router

Function: vdc.router.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.router function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc function).
    • elid - unique identifier (id element of vdc.router function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name . Enter a name for this payment method
  • routertempl - Configuration . Router configuration
  • external_network - External network . External network that the router will be connected to
  • use_dhcp - . (Optional parameter. To enable the option click "on".) Enable DHCP for router
  • use_firewall - . (Optional parameter. To enable the option click "on".) Enable Firewall for router
  • firewall_policy - Default policy . Default policy for packages
  • use_vpn - . (Optional parameter. To enable the option click "on".) Enable VPN for router

Delete the selected routers

Function: vdc.router.delete

Delete the selected routers

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router function.

Result: successful operation or error message

Name

Function: vdc.router.nat

Result: the list of elements

NAT router management

Access level: admin user

  • id - Id
  • network - Data-center network
  • rule_type - Rule type
  • original_ip_range - Source IP/range
  • original_port_desc - Source port
  • translated_ip_range - Translated IP/range
  • translated_port_desc - Translated port
  • protocol - Protocol
  • status - Status
Suspend

Function: vdc.router.nat.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.nat function.

Result: successful operation or error message

Delete

Function: vdc.router.nat.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.nat function.

Result: successful operation or error message

Edit NAT rule

Function: vdc.router.nat.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.nat function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of vdc.router function).
    • elid - unique identifier (id element of vdc.router.nat function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • vdc_network - Data-center network . Select data-center network the NAT rule will be applied to
  • rule_type - Rule type . Address translation type. SNAT - translates outgoing requests going from the internal network, DNAT - translates incoming requests going to the internal network
  • description - Description . Enter any information related to this rule
  • protocol - Protocol . Select the protocol the NAT rule will be applied to
  • original_ip_range - Source IP/range . For the SNAT rule enter an internal IP-address or IP range, for DNAT - an external IP-address or IP range. You can enter a specific value or select it from the list
  • original_port - Source port . Source port. You can enter a specific value or select it from the list
  • translated_ip_range - Translated IP/range . For the SNAT rule enter an external IP-address or IP range, for DNAT - an internal IP-address or IP range. You can enter a specific value or select it from the list
  • translated_port - Translated port . The translated port. You can enter a certain value or select it from the list
Resume

Function: vdc.router.nat.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc.router.nat function.

Result: successful operation or error message

Synchronization of service with VDC objects

Function: vdc.sync

Synchronization of service with VDC objects

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vdc function.

Result: successful operation or error message

Drill down to User panel

Function: vdc.su

Drill down to User panel

Access level: admin

Affiliate programs

Function: affiliate

Result: the list of elements

Affiliate programs

Access level: admin

  • id - Id
  • locale_name - Name
  • reward - Reward, %
  • period - Referral period, month
  • locale_url - Site URL
  • project_name - Provider

Delete

Function: affiliate.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of affiliate function.

Result: successful operation or error message

Edit properties of the selected affiliate program

Function: affiliate.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of affiliate function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • project - Provider. Select a provider who offers this affiliate program
  • name - Name. Enter the name for the affiliate program that will be displayed to your client
  • promocode - Promo code template. Enter a promo code template. Use @ID@ where you want to insert the affiliate's Id. If a referral enters the promo code corresponding to this template, the system will consider the affiliate to refer the client
  • reward - Reward. Enter the percentage of the referral expenses, which you wish to pay to an affiliate as referral bonus at the beginning of the next month
  • period - Referral period . Period in months during which a client will receive percentage of all referral's expenses
  • url - Web-site URL. URL to the provider's site. Each affiliate will have a unique link. A client's id will be added to the end of the URL
  • account_group - Client group. Select a client group that will join the affiliate program
  • account_group_restrict - Forbid for group members. Clients of the selected group won't be rewarded

Name

Function: affiliate.reward

Result: the list of elements

Affiliate program expenses

Access level: admin

  • cdate - Date
  • amount - Amount

Client

Function: affiliate.reward.partner

Result: the list of elements

Affiliate program expenses

Access level: admin

  • id - Id
  • name - Client
  • amount - Amount
Drill down to User panel

Function: affiliate.reward.partner.su

Drill down to User panel

Access level: admin

Name

Function: affiliate.itemtype

Result: the list of elements

Special rules for affiliate rewards

Access level: admin

  • id - Id
  • locale_name - Product type
  • pricelist_locale_name - Tariff


  • reward - Reward, %

Edit the selected rule

Function: affiliate.itemtype.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of affiliate function).
    • elid - unique identifier (id element of affiliate.itemtype function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of affiliate function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of affiliate function).
    • elid - unique identifier (id element of affiliate.itemtype function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • reward - Reward. Percentage of referral expenses for the services of the selected type

Delete

Function: affiliate.itemtype.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of affiliate.itemtype function.

Result: successful operation or error message

ISPsystem licenses

Function: soft

Result: the list of elements

ISPsystem licenses

Access level: admin user

  • id - Id
  • licname - License name
  • ip - IP address
  • period - Period
  • update_expiredate - Updates expiration date
  • real_ipchange - IP address date
  • real_keychange - Key date
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

License

Function: soft.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of soft function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • remoteip - Server IP address. Enter a license IP address. Leave the field blank if it matches the IP to which the license will be assigned
  • update_expiredate - Updates expiration date. Updates for the control panel will be provided until the specified date
  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Order a new service

Function: soft.order

Order a new service

Access level: user

Resume

Function: soft.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of soft function.

Result: successful operation or error message

Delete the selected services

Function: soft.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of soft function.

Result: successful operation or error message

Suspend

Function: soft.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of soft function.

Result: successful operation or error message

Set a filter by the selected client

Function: soft.setfilter

Set a filter by the selected client

Access level: admin

Drill down to User panel

Function: soft.su

Drill down to User panel

Access level: admin

Set filter.

soft.filter

Service activation

Function: soft.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of soft function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

CRM-contacts

Function: crm

Result: the list of elements

CRM-contacts

Access level: admin

  • id - Id
  • cdate - Date
  • description - Description
  • employee - Staff member
  • account - Client
  • type - Type
  • channel - Channel
  • project - Provider
  • info - Comment
  • status - Status

Copy CRM contact

Function: crm.clone

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of crm function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • description - Contact description . Additional description of this contact
  • employee - Staff member . Select a staff member who created this contact
  • account - Client . Client associated with this contact
  • project - Provider . Provider associated with this CRM-contact
  • type - Contact type . Contact type
  • channel - Channel . Channel that the client was referred through
  • contactperson - Contact person . Contact person
  • email - Email

. Contact email

  • phone - Phone number. Contact phone number
  • attitude - Client status. Select characteristics of a client that can help you work with him
  • info - Comment .

Set filter by client (including this list)

Function: crm.setfilterall

Set filter by client (including this list)

Access level: admin

Set filter.

crm.filter

Open the ticket associated with this contact

Function: crm.ticket

Open the ticket associated with this contact

Access level: admin

Delete

Function: crm.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm function.

Result: successful operation or error message

Name

Function: crm.remind

Result: the list of elements

CRM-contact reminders

Access level: admin

  • id - Id
  • remind_date - Date
  • comment - Comment
  • status - Status

Change the status into "Completed"

Function: crm.remind.resume

Change the status into "Completed"

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm.remind function.

Result: successful operation or error message

Change the status into "Not completed"

Function: crm.remind.suspend

Change the status into "Not completed"

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm.remind function.

Result: successful operation or error message

Delete the selected reminder from the list

Function: crm.remind.delete

Delete the selected reminder from the list

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm.remind function.

Result: successful operation or error message

Edit properties of the selected reminder

Function: crm.remind.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of crm function).
    • elid - unique identifier (id element of crm.remind function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of crm function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of crm function).
    • elid - unique identifier (id element of crm.remind function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • remind_date - Date. Reminder date
  • comment - Comment. Add any information

Close the CRM-contact

Function: crm.suspend

Close the CRM-contact

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm function.

Result: successful operation or error message

CRM-contact

Function: crm.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of crm function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • description - Contact description . Additional description of this contact
  • employee - Staff member . Select a staff member who created this contact
  • account - Client . Client associated with this contact
  • project - Provider . Provider associated with this CRM-contact
  • type - Contact type . Contact type
  • channel - Channel . Channel that the client was referred through
  • contactperson - Contact person . Contact person
  • email - Email

. Contact email

  • phone - Phone number. Contact phone number
  • attitude - Client status. Select characteristics of a client that can help you work with him
  • info - Comment .

Service

Function: crm.item

Result: the list of elements

CRM-contact services

Access level: admin

  • id - Id
  • name - Service
  • opendate - Activation date
  • status - Service status
  • project - Provider
  • itemtype - Product type
  • pricelist - Tariff plan
  • contact - CRM contacts
  • relationstatus - Status

Suspend

Function: crm.item.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm.item function.

Result: successful operation or error message

Edit

Function: crm.item.edit

Edit

Access level: admin

Resume

Function: crm.item.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm.item function.

Result: successful operation or error message

Set filter.

crm.item.filter

Open a CRM-contact

Function: crm.resume

Open a CRM-contact

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of crm function.

Result: successful operation or error message

Set a filter by the selected client

Function: crm.setfilter

Set a filter by the selected client

Access level: admin

Edit properties of the selected user

Function: user.edit

Access level: user

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

  • email - Email. Enter an email for this user. It will be used as his username. The username cannot be modified
  • verify_email - . (Optional parameter. To enable the option click "on".) A user won't receive news letters and other notifications in the Client area unless he has his email verified
  • name - Login. Enter a login
  • realname - Full name. Enter the first and the last name
  • phone - Phone number. Enter a contact phone number to receive sms
  • passwd - Password. Enter a password
  • confirm - Re-enter password.
  • default_access_allow - . (Optional parameter. To enable the option click "on".) Grant full access to this user

Domains

Function: domain

Result: the list of elements

Domains

Access level: admin user

  • id - Id
  • domain - Domain name
  • account - Client
  • pricelist - Tariff plan
  • project - Provider
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • status_msg -
  • item_status -
  • cost - Price

Domain information

Function: domain.whois

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of domain function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • whois_data - Domain information. WHOIS information

Register new domain/domains

Function: domain.order.register

Register new domain/domains

Access level: user

Resume

Function: domain.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain function.

Result: successful operation or error message

Service activation

Function: domain.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of domain function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Name servers

Function: domain.ns

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of domain function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • ns0 - NS. Use the following record format: "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2"
  • ns1 - NS. Use the following record format: "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2"
  • ns2 - NS. Use the following record format: "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2"
  • ns3 - NS. Use the following record format: "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2"
  • ns_additional - Additional NS. Use the following record format: "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2". Each additional domain is added with a new line
  • provider - .

Set a filter by the selected client

Function: domain.setfilter

Set a filter by the selected client

Access level: admin

File name

Function: domain.doc

Result: the list of elements

Documents

Access level: admin user

  • id - Id
  • profile - Domain contact
  • doctype - Document type
  • name - File name
  • size - Size
  • props - Properties

Document type

Function: domain.doc.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of domain function).
    • elid - unique identifier (id element of domain.doc function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of domain function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of domain function).
    • elid - unique identifier (id element of domain.doc function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • doctype - Document type. Document type

Add new document

Function: domain.doc.upload

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of domain function).
    • elid - unique identifier (id element of domain.doc function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of domain function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of domain function).
    • elid - unique identifier (id element of domain.doc function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • doctype - Document type. Document type

Delete document

Function: domain.doc.delete

Delete document

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain.doc function.

Result: successful operation or error message

View the selected file

Function: domain.doc.file

View the selected file

Access level: admin user

Send files to verify domain contact details

Function: domain.doc.verify

Send files to verify domain contact details

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain.doc function.

Result: successful operation or error message

Set the "Verified" status for the selected document

Function: domain.doc.verified

Set the "Verified" status for the selected document

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain.doc function.

Result: successful operation or error message

Download document

Function: domain.doc.download

Download document

Access level: admin user

Drill down to User panel

Function: domain.su

Drill down to User panel

Access level: admin

Transfer the domain/domains from another registrar

Function: domain.order.transfer

Transfer the domain/domains from another registrar

Access level: user

Edit properties of the selected service

Function: domain.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of domain function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Delete the selected services

Function: domain.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain function.

Result: successful operation or error message

Request domain status and data from the registrar

Function: domain.sync

Request domain status and data from the registrar

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain function.

Result: successful operation or error message

Set filter.

domain.filter

Localizations

Function: locale

Result: the list of elements

Localizations

Access level: admin

  • id - Id
  • name - Name
  • langcode - Code
  • status - Status

Delete

Function: locale.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of locale function.

Result: successful operation or error message

Resume

Function: locale.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of locale function.

Result: successful operation or error message

Set the default localization

Function: locale.setdefault

Set the default localization

Access level: admin

Edit the selected localization

Function: locale.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of locale function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the localization name (for example: French)
  • langcode - Language code. Enter the language code that will be used for identifying localized messages

Suspend

Function: locale.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of locale function.

Result: successful operation or error message

Server care

Function: servicemonitor

Result: the list of elements

Server care

Access level: admin user

  • url - URL
  • monserver - Server
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Service activation

Function: servicemonitor.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of servicemonitor function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Edit properties of the selected service

Function: servicemonitor.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of servicemonitor function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Set filter.

servicemonitor.filter

Drill down to User panel

Function: servicemonitor.su

Drill down to User panel

Access level: admin

Delete the selected services

Function: servicemonitor.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of servicemonitor function.

Result: successful operation or error message

Order a new service

Function: servicemonitor.order

Order a new service

Access level: user

Resume

Function: servicemonitor.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of servicemonitor function.

Result: successful operation or error message

Suspend

Function: servicemonitor.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of servicemonitor function.

Result: successful operation or error message

Set a filter by the selected client

Function: servicemonitor.setfilter

Set a filter by the selected client

Access level: admin

Message templates

Function: notifytype

Result: the list of elements

Types of message templates

Access level: admin

  • type - Type

Name

Function: notifytype.template

Result: the list of elements

Message templates - Email notifications - Emails in the Notifications module

Access level: admin

  • id - Id
  • name - Name
  • notice - Message type
  • project - Provider
  • intname - Internal name
  • changetemplate - Change date
  • status - Status

Suspend

Function: notifytype.template.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notifytype.template function.

Result: successful operation or error message

Delete

Function: notifytype.template.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notifytype.template function.

Result: successful operation or error message

Edit the message template

Function: notifytype.template.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of notifytype function).
    • elid - unique identifier (id element of notifytype.template function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of notifytype function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of notifytype function).
    • elid - unique identifier (id element of notifytype.template function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • project - Provider. A newly created template will be available for the selected provider
  • notice - Notification type. Select a notification type that will define when to send this notification
  • subject - Message heading. Enter a heading
  • allowcopy - . (Optional parameter. To enable the option click "on".) This letter will be put into the Notifications module
  • allowunverifiedemail - . (Optional parameter. To enable the option click "on".) Select the check box to allow sending notifications based on templates
  • blindcopy - . (Optional parameter. To enable the option click "on".) Hidden copy
  • blindcarboncopy - Email. Enter email address for hidden copy
  • content - Message template. Message template in the xslt or ejs formats

Name

Function: notifytypecontent.history

Result: the list of elements

Template history

Access level: admin

  • changedate - Change date
  • desc - Description
  • user - User
  • ip - IP address
  • action - Function
Back to the previous list

Function: notify.template

Back to the previous list

Access level: admin

Resume

Function: notifytype.template.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notifytype.template function.

Result: successful operation or error message

Reset the template

Function: notifytype.template.restoredefault

Reset the template

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notifytype.template function.

Result: successful operation or error message

Test the selected template

Function: notifytype.template.try

Test the selected template

Access level: admin

Invoices

Function: invoice

Result: the list of elements

Invoices

Access level: admin user

  • id - Id
  • number - Number
  • cdate - Date
  • company - Company
  • customer - Payer
  • amount_iso - Amount
  • invoice_status - Status
  • warning_message - Bug report
  • sdate - Sent

Generate invoices

Function: invoice.generate

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of invoice function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • invoice_status - Status . Invoice status
  • company - Company. Select a company to generate invoices
  • gentype - Payers. Select a company to generete invoices
  • profiletype - Payer type. Select payer types to generate invoices
  • customer - Payer. Select a payer to generate the invoice
  • cdate - Invoice date. Enter the invoice generation date
  • fromdate - Expenses, start date. Enter a start date to generate invoices
  • todate - Expenses, end date. Enter the end date

Set the "Signed" status for invoice

Function: invoice.status.4

Set the "Signed" status for invoice

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of invoice function.

Result: successful operation or error message

Download this documetn in PDF

Function: invoice.print.pdf

Download this documetn in PDF

Access level: admin user

Send a ticket to the selected client

Function: ticket.write.invoice

Send a ticket to the selected client

Access level: admin

Edit the selected invoice

Function: invoice.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of invoice function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • number - Number. Number of the invoice
  • cdate - Date. Date when the document was generated
  • invoice_status - Status. The invoice status is set manually

Request invoice original

Function: invoice.request

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of invoice function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Name

Function: invoice.history

Result: the list of elements

Invoice history

Access level: admin user

  • changedate - Change date
  • desc - Description
  • user - User
  • ip - IP address
  • action - Function

Print the selected invoice

Function: invoice.print

Print the selected invoice

Access level: admin user

Description

Function: invoice.item

Result: the list of elements

Services provided

Access level: admin user

  • id - Id
  • name - Description
  • amount - Amount
  • payments - Payment numbers

Invoice item

Function: invoice.item.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of invoice function).
    • elid - unique identifier (id element of invoice.item function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of invoice function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of invoice function).
    • elid - unique identifier (id element of invoice.item function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Description. Description of the service provided

Set filter.

invoice.item.filter

Drill down to User panel

Function: invoice.su

Drill down to User panel

Access level: admin

Print an envelop to send this invoice

Function: invoice.envelope

Print an envelop to send this invoice

Access level: admin

Delete

Function: invoice.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of invoice function.

Result: successful operation or error message

Cancel invoice

Function: invoice.revocation

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of invoice function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • revocation_comment - Comment. Enter any information related to this operation

Set a filter by the selected client

Function: invoice.setfilter

Set a filter by the selected client

Access level: admin

Send invoices

Function: invoice.send

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of invoice function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • method - Send invoices . Select how you want to send invoices to clients
  • sdate - Sent. Select a date when the invoice will be sent
  • currency - Currency. Currency
  • cost - Cost of sending . Enter an amount, if you want to charge your client for invoices sent by post. An "Operational expenses" expense will be generated. Client's balance of account will become negative in case of insufficient funds
  • freepostsum - Amount of invoices for free delivery . You can enter an amount of expenses. Once it is reached, you can send invoices to this client free of charge

Regenerate invoice

Function: invoice.regenerate

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of invoice function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • invoice_status - Status . Invoice status
  • cdate - Invoice date. Enter the invoice generation date
  • fromdate - Expenses, start date. Enter a start date to generate invoices
  • todate - Expenses, end date. Enter the end date

Set the "Created" status for invoice

Function: invoice.status.1

Set the "Created" status for invoice

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of invoice function.

Result: successful operation or error message

Set filter.

invoice.filter

Units of measure

Function: measure

Result: the list of elements

Units of measure

Access level: admin

  • id - Id
  • name - Name

Delete

Function: measure.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of measure function.

Result: successful operation or error message

Unit of measure

Function: measure.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of measure function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • intname - Internal name. Enter the internal name that is used in the system
  • lessmeasure - Ratio to. Select unit of measure to set the ratio
  • relation - Ratio. Set the ratio to the selected unit of measure

Abuse list

Function: abuse_task

Result: the list of elements

Abuse list

Access level: admin

  • id - Id
  • ticket - Request
  • subject - Subject
  • opendate - Creation date
  • deadline - Deadline
  • account - Client
  • author - initiator
  • score - Number of scores
  • status - Status
  • action - Function

Close abuse

Function: abuse_task.finish

Close abuse

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of abuse_task function.

Result: successful operation or error message

Drill down to User panel

Function: abuse_task.su

Drill down to User panel

Access level: admin

Set a filter by the selected client

Function: abuse_task.setfilter

Set a filter by the selected client

Access level: admin

Abuse

Function: abuse_task.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of abuse_task function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • subject - Subject. Subject
  • account - Client . This abuse issue is associated with the selected client
  • score - Number of scores . Number of abuse scores
  • action - Action. Select the action that should be taken if there is no response from client
  • abuse_item - Service. Select a service related to this abuse. This service will be selected for a new ticket
  • user_responsible - Department. The ticket will be assigned to this department
  • user_deadline_responsible - Department. Select a department to redirect a ticket if a client doesn't send any response
  • deadline_date - Correction date. The issue must be resolved by this date
  • deadline_time - Correction time. The issue should be resolved by this time
  • message - Message. Email that will be sent to the client. This email will be the first in the tickets
  • score_note - Comment. Enter additional information

Set filter.

abuse_task.filter

Delete

Function: abuse_task.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of abuse_task function.

Result: successful operation or error message

Product types

Function: itemtype

Result: the list of elements

Product types

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name
  • orderpriority - Sort

Edit properties of the selected product type

Function: itemtype.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of itemtype function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a product type name
  • intname - Internal name. Internal name is used for identification. Processing modules are selected based on this internal name
  • itemname - Service name template. Service and expense names will be based on this XSLT template. Leave the field blank if you want to use a default template for this service type
  • trialtype - Trial version. Select how you want to allow trial versions
  • splitexpense - . (Optional parameter. To enable the option click "on".) Select the check box to distribute expenses. E.g. when a client pays for one year, the billing system will generate 12 or 13 expenses per each month during which client's service remains active.
  • nostopholidays - . (Optional parameter. To enable the option click "on".) Select the check box not to suspend clientsэ services on weekends (Saturdays and Sundays)
  • open_duration_limit - Processing time limit . The service should be processed during this period. Format: hh:mm
  • suspendperiod - Auto deletion period. Period in days that will pass before a suspended unpaid service will be deleted
  • closetype - Service deletion rules. Service deletion policy for clients
  • closesubtype - When a client deletes . Service deletion rules (if service is deleted by client)
  • trial - . (Optional parameter. To enable the option click "on".) Trial periods can be activated for this product
  • day - . (Optional parameter. To enable the option click "on".) This product can be ordered for one day
  • monthly - . (Optional parameter. To enable the option click "on".) This product can be ordered for one month
  • quarterly - . (Optional parameter. To enable the option click "on".) This product can be ordered for three years
  • semiannual - . (Optional parameter. To enable the option click "on".) This product can be ordered for half a year
  • annually - . (Optional parameter. To enable the option click "on".) This product can be ordered for one year
  • biennial - . (Optional parameter. To enable the option click "on".) This product can be ordered for two years
  • triennial - . (Optional parameter. To enable the option click "on".) Three years
  • quadrennial - . (Optional parameter. To enable the option click "on".) This period can be ordered for four years
  • quinquennial - . (Optional parameter. To enable the option click "on".) This product can be ordered for five years
  • decennial - . (Optional parameter. To enable the option click "on".) Enable the selected period of 10 years
  • lifetime - . (Optional parameter. To enable the option click "on".) One-time fee
  • transfer - . (Optional parameter. To enable the option click "on".) Enable transfer
  • orderview - How to display tariff plans . You can change the way how tariff plans are located in a service order form. You can modify tariff description in its edit form
  • show_addon_image - . (Optional parameter. To enable the option click "on".) This option enables to configure and display resources' icons during service order and modification

Name

Function: itemtype.detail

Result: the list of elements

Contents of the product type

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name
  • orderpriority - Sort

Move one line up

Function: itemtype.detail.up

Move one line up

Access level: admin

Delete

Function: itemtype.detail.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.detail function.

Result: successful operation or error message

Product type add-on

Function: itemtype.detail.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of itemtype function).
    • elid - unique identifier (id element of itemtype.detail function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype function).
    • elid - unique identifier (id element of itemtype.detail function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a product type name
  • intname - Internal name. Enter the internal name of the product type add-on
  • description - Description. Addon brief description in BILLmanager 6
  • orderpriority - Sorting (count forward). Add-on's sorting order
  • showoninfo - . (Optional parameter. To enable the option click "on".) Used for service detalization. Available only in BILLmanager 6 user interface.
  • select_paramgroup - Group . Inhering to a group. Used for service detalization. Available only for BILLmanager 6 user interface.

Move one line down

Function: itemtype.detail.down

Move one line down

Access level: admin

Name

Function: itemtype.param

Result: the list of elements

Service parameters

Access level: admin

  • id - Id
  • locale_name - Name
  • intname - Internal name
  • orderpriority - Sort

Move the selected service parameter one line up

Function: itemtype.param.up

Move the selected service parameter one line up

Access level: admin

Edit parameter

Function: itemtype.param.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of itemtype function).
    • elid - unique identifier (id element of itemtype.param function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype function).
    • elid - unique identifier (id element of itemtype.param function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • tune_pricelists - . (Optional parameter. To enable the option click "on".) If this option is not selected, the parameter is connected to all tariff plans. Check the box if you want to allow for manual configuration
  • intname - Internal name. Enter an internal name that will be used in service processing modules
  • ordervisible - . (Optional parameter. To enable the option click "on".) If you select this check box, a client will be asked to enter this parameters when making a new order
  • openvisible - . (Optional parameter. To enable the option click "on".) A client will be asked to enter this parameter when setting up a service. This field is filled out by a processing module automatically , or manually
  • listvisible - . (Optional parameter. To enable the option click "on".) Select the check box to display this parameter in the list of services
  • editreadlevel - Read permissions. This parameter will be displayed to users with the selected user role
  • editwritelevel - Edit permissions. Selected user role will be able to edit this parameter
  • needsetparam - . (Optional parameter. To enable the option click "on".) When a parameter is changed, the corresponding processing module with the setparam command will be called
  • crypted - . (Optional parameter. To enable the option click "on".) Select the check box if you want to save this parameter in the encrypted way
  • hint - Hint. A hint will be shown when moving a mouse cursor over the ? icon
  • description - Description. Parameter brief description in BILLmanager 6
  • orderpriority - Sort. Order of parameters on the service order/edit form
  • select_paramgroup - Group . Inhering to a group. Used for service detalization. Available only for BILLmanager 6 user interface.
  • selecttype - Display type . It is used only in BILLmanager6 user interface.
  • inputtype - Input field type. Select types of data that can be entered into the field
  • zoom - . (Optional parameter. To enable the option click "on".) Selecting this check box will enable you to enter multiple values space separated. The selected validator will be applied to each value
  • inputrows - Number of input strings. Enter the number of input strings in the text field
  • required - . (Optional parameter. To enable the option click "on".) Empty values for this parameter are forbidden
  • validator - Check function. This fucntion will prevent users from entering invalid data
  • select_ip - IP type . Type of IP address
  • num_range - . (Optional parameter. To enable the option click "on".) Range of values
  • r_start_int - Start of the range. Start value of the range
  • r_end_int - End of the range. End of the range
  • r_start_float - Start of the range. Start value of the range
  • r_end_float - End of the range. End of the range

Move the selected service parameters one line down

Function: itemtype.param.down

Move the selected service parameters one line down

Access level: admin

Tariff plan

Function: itemtype.param.pricelist

Result: the list of elements

Tariff plans

Access level: admin

  • id - Id
  • name - Tariff plan
  • status - Status
Activate parameter for this tariff plan

Function: itemtype.param.pricelist.resume

Activate parameter for this tariff plan

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.pricelist function.

Result: successful operation or error message

Disable parameter for this tariff plan

Function: itemtype.param.pricelist.suspend

Disable parameter for this tariff plan

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.pricelist function.

Result: successful operation or error message

Delete

Function: itemtype.param.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param function.

Result: successful operation or error message

Name

Function: itemtype.param.value

Result: the list of elements

Values for Operating system

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name
  • tags - Tags
  • orderpriority - Sort
  • status - Status
Enable the value of this parameter for all tariff plans

Function: itemtype.param.value.resume

Enable the value of this parameter for all tariff plans

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value function.

Result: successful operation or error message

Edit values

Function: itemtype.param.value.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of itemtype.param function).
    • elid - unique identifier (id element of itemtype.param.value function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype.param function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype.param function).
    • elid - unique identifier (id element of itemtype.param.value function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • intname - Internal name. Enter an internal name that is normally used by processing modules
  • tags - Tags. List of tags separated by the "," character
  • disablepricelists - . (Optional parameter. To enable the option click "on".) When you activate this option, the parameter's value won't be automatically assigned to tariff plans, even when creating a new tariff plan
  • info - Brief information. Brief information related to this value. A client will see this information in the order form
  • orderpriority - Sort. Set priority to show this parameter in the drop down menu on the service edit form
  • valuegroup - Group of parameters. Allows to specify a group for displaying parameter at a service order and editing form. Available only in BILLmanager 6 user interface
Disable the value of this parameter for all tariff plans

Function: itemtype.param.value.suspend

Disable the value of this parameter for all tariff plans

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value function.

Result: successful operation or error message

Move service value one line item below in the list

Function: itemtype.param.value.down

Move service value one line item below in the list

Access level: admin

Set filter.

itemtype.param.value.filter

Move service value one line item above in the list

Function: itemtype.param.value.up

Move service value one line item above in the list

Access level: admin

Processing module

Function: itemtype.param.value.processing

Result: the list of elements

Processing modules

Access level: admin

  • id - Id
  • name - Processing module
  • status - Status
Suspend

Function: itemtype.param.value.processing.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value.processing function.

Result: successful operation or error message

Resume

Function: itemtype.param.value.processing.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value.processing function.

Result: successful operation or error message

Tariff plan

Function: itemtype.param.value.pricelist

Result: the list of elements

Tariff plans

Access level: admin

  • id - Id
  • name - Tariff plan
  • status - Status
Resume

Function: itemtype.param.value.pricelist.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value.pricelist function.

Result: successful operation or error message

Suspend

Function: itemtype.param.value.pricelist.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value.pricelist function.

Result: successful operation or error message

Delete

Function: itemtype.param.value.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.param.value function.

Result: successful operation or error message

Delete

Function: itemtype.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype function.

Result: successful operation or error message

Name

Function: itemtype.orderpage

Result: the list of elements

Order page

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name
  • orderpriority - Sort
  • status - Status

Delete

Function: itemtype.orderpage.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.orderpage function.

Result: successful operation or error message

Shift this page one position up

Function: itemtype.orderpage.up

Shift this page one position up

Access level: admin

Edit order page

Function: itemtype.orderpage.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of itemtype function).
    • elid - unique identifier (id element of itemtype.orderpage function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of itemtype function).
    • elid - unique identifier (id element of itemtype.orderpage function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Page name
  • intname - Internal name. Internal name of the page that is used for its identification
  • orderpriority - Sort. Set the priority
  • defaultpage - . (Optional parameter. To enable the option click "on".) Default page for tariff plan

Shift this page one position down

Function: itemtype.orderpage.down

Shift this page one position down

Access level: admin

Move the selected product type one line down

Function: itemtype.down

Move the selected product type one line down

Access level: admin

Move the selected product type one line up

Function: itemtype.up

Move the selected product type one line up

Access level: admin

Notifications

Function: notification

Result: the list of elements

Notifications

Access level: admin user

  • id - Id
  • subject - Heading
  • cdate - Date

Delete

Function: notification.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notification function.

Result: successful operation or error message

View the notification

Function: notification.view

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of notification function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

DNS hosting

Function: dnshost

Result: the list of elements

DNS hosting

Access level: admin user

  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Set filter.

dnshost.filter

Order a new service

Function: dnshost.order

Order a new service

Access level: user

Service activation

Function: dnshost.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of dnshost function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Delete the selected services

Function: dnshost.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dnshost function.

Result: successful operation or error message

Drill down to User panel

Function: dnshost.su

Drill down to User panel

Access level: admin

Suspend

Function: dnshost.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dnshost function.

Result: successful operation or error message

Set a filter by the selected client

Function: dnshost.setfilter

Set a filter by the selected client

Access level: admin

Resume

Function: dnshost.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dnshost function.

Result: successful operation or error message

Edit properties of the selected service

Function: dnshost.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of dnshost function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Game hosting

Function: gamehost

Result: the list of elements

Game hosting

Access level: admin user

  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Order a new service

Function: gamehost.order

Order a new service

Access level: user

Suspend

Function: gamehost.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gamehost function.

Result: successful operation or error message

Drill down to User panel

Function: gamehost.su

Drill down to User panel

Access level: admin

Set a filter by the selected client

Function: gamehost.setfilter

Set a filter by the selected client

Access level: admin

Set filter.

gamehost.filter

Resume

Function: gamehost.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gamehost function.

Result: successful operation or error message

Edit properties of the selected service

Function: gamehost.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of gamehost function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Delete the selected services

Function: gamehost.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gamehost function.

Result: successful operation or error message

Service activation

Function: gamehost.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of gamehost function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Name servers

Function: processing.nameserver

Result: the list of elements

Name servers

Access level: admin

  • id - Id
  • name - Name
  • module - Control panel
  • status - Status

Open the control panel

Function: processing.nameserver.gotoserver

Open the control panel

Access level: admin

Add

Function: processing.nameserver.add

Add

Access level: admin

Delete

Function: processing.nameserver.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing.nameserver function.

Result: successful operation or error message

Edit name servers

Function: processing.nameserver.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of processing.nameserver function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of processing.nameserver function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • project - Provider. Provider who owns the name server
  • module - Control panel. Select a control panel
  • name - Name. Enter the name of the name server
  • url - URL. Enter the URL to the control panel
  • login - Username. Enter a username to access the control panel (User role in DNSmanager is reseller and user
  • password - Password

. Enter a password to access the control panel

  • freedomain - . (Optional parameter. To enable the option click "on".) Server can be used for creating free domain names
  • dnsprovider - . (Optional parameter. To enable the option click "on".) Server can be used for creating provider's domain names
  • dnsprovidercount - Number of domains. Maximum number of domain names per account
  • dnsprivate - . (Optional parameter. To enable the option click "on".) Server can be used for creating private domain names
  • dnsprivatecount - Number of domains. Maximum domain names per account

Action log

Function: journal

Result: the list of elements

Action log

Access level: user

  • time - Time
  • user - User
  • ip - Remote IP address
  • funcname - Function

Set filter.

journal.filter

Action log

Function: journal.edit

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of journal function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • time - Time. Time of execution of the action in the control panel
  • user - User. The user who has performed the action in the control panel
  • ip - Remote IP address . The IP-address from which the user has performed the operation in the control panel
  • funcname - Function. The name of the control panel's function
  • params - Paramaters. The list of the parameters transferred to the control panel's function

Name

Function: journal.stat

Result: report

Function usage over period

Access level: admin+

Processing modules

Function: processing

Result: the list of elements

Processing modules

Access level: admin

  • id - Id
  • name - Name
  • module - Processing module
  • datacenter_name - Datacenter
  • pusage - Usage
  • balance_info - Processing module balance
  • orderpriority - Sort
  • status - Status

Name

Function: processing.customparam

Result: the list of elements

Processing module parameters

Access level: admin

  • id - Id
  • param - Parameter
  • value - Value

You can specify selection criteria for this list. They will be applied every time the list is displayed until the filter is removed or modified

Function: processing.customparam.filter

You can specify selection criteria for this list. They will be applied every time the list is displayed until the filter is removed or modified

Access level: admin

Edit parameter

Function: processing.customparam.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of processing function).
    • elid - unique identifier (id element of processing.customparam function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing function).
    • elid - unique identifier (id element of processing.customparam function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • param - Parameter. Select a parameter type
  • value - Value . Parameter value

Delete the selected parameters

Function: processing.customparam.delete

Delete the selected parameters

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing.customparam function.

Result: successful operation or error message

Update configuration of the processing module

Function: processing.updateconfig

Update configuration of the processing module

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing function.

Result: successful operation or error message

Add

Function: processing.add

Add

Access level: admin

Set filter.

processing.filter

Move the processing module up one line

Function: processing.up

Move the processing module up one line

Access level: admin

Name

Function: processing.pricelist

Result: the list of elements

Tariff plans that are processed by this module

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: processing.pricelist.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing.pricelist function.

Result: successful operation or error message

Suspend

Function: processing.pricelist.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing.pricelist function.

Result: successful operation or error message

Move the processing module down one line

Function: processing.down

Move the processing module down one line

Access level: admin

Delete

Function: processing.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing function.

Result: successful operation or error message

Name

Function: processing.import

Result: the list of elements

Import services

Access level: admin

  • id - Id
  • item_name - Name
  • expiredate - End date
  • account - Client
  • status - Status

Purge the list of services

Function: processing.import.clear

Purge the list of services

Access level: admin

Name

Function: processing.import.service_profile

Result: the list of elements

Uploaded service profiles

Access level: admin

  • id - Id
  • name - Name
  • item_count - Number of services
Contact parameters

Function: service_profile.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of processing.import function).
    • elid - unique identifier (id element of processing.import.service_profile function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing.import function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing.import function).
    • elid - unique identifier (id element of processing.import.service_profile function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Profile name. The profile name is used to facilitate its identification in the list of service profiles
  • profiletype - Contact type. Select a legal status of the contact

Delete the selected services

Function: processing.import.delete

Delete the selected services

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing.import function.

Result: successful operation or error message

Get the list of services

Function: processing.import.load

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of processing function).
    • elid - unique identifier (id element of processing.import function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing function).
    • elid - unique identifier (id element of processing.import function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • itemtype - Service type. Get information for the selected service type
  • search - Search options. Service selection criteria. Leave the field blank if you want to import all services. If you want to import a certain service, enter its full name.

Import service to the client

Function: processing.import.assign

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of processing function).
    • elid - unique identifier (id element of processing.import function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of processing function).
    • elid - unique identifier (id element of processing.import function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • account - Client . Select a client this service will be imported to

Resume

Function: processing.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing function.

Result: successful operation or error message

Edit properties of the selected processing module

Function: processing.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of processing function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • datacenter - Data center . Data center
  • name - Name. Name of the processing module that will be shown in the interface
  • department - Department. Select a department that will be in charge of the tasks
  • orderpriority - Sort. Module priority
  • threshold - Processing module minimal balance . Enter the minimal balance of the processing module for service renewal

Open the control panel

Function: gotomoduleserver

Open the control panel

Access level: admin

Suspend

Function: processing.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of processing function.

Result: successful operation or error message

Document templates

Function: doctmpl

Result: the list of elements

Document templates

Access level: admin

  • id - Id
  • name - Name
  • doctype - Type
  • templatetype - Layout
  • locale - Document language

Reset to default template settings

Function: doctmpl.restoredefault

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of doctmpl function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • doctmpl - Template. A template can be used as pre-constructed document when creating various documents in the billing panel


Edit the selected document template

Function: doctmpl.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of doctmpl function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a template name
  • doctype - Document type. A document type will be used to filter a list of documents when selecting a print template
  • language - Language. Language of the document text
  • doctmpl - Template . A template can be used as pre-constructed document when creating various documents in the billing panel


  • content - Text. Type in the text of the document template in XSLT or EJS format

Delete

Function: doctmpl.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of doctmpl function.

Result: successful operation or error message

Shared hosting

Function: vhost

Result: the list of elements

Shared hosting

Access level: admin user

  • domain - Domain name
  • ip - IP address
  • processingnode - Cluster node
  • username - Username
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Edit properties of the selected service

Function: vhost.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vhost function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Delete the selected services

Function: vhost.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vhost function.

Result: successful operation or error message

Resume

Function: vhost.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vhost function.

Result: successful operation or error message

Service activation

Function: vhost.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of vhost function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Order a new service

Function: vhost.order

Order a new service

Access level: user

Drill down to User panel

Function: vhost.su

Drill down to User panel

Access level: admin

Suspend

Function: vhost.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vhost function.

Result: successful operation or error message

Set filter.

vhost.filter

Set a filter by the selected client

Function: vhost.setfilter

Set a filter by the selected client

Access level: admin

Tariff plans

Function: pricelist

Result: the list of elements

Tariff plans

Access level: admin

  • id - Id
  • name - Name
  • itemtype_name - Type
  • project - Provider
  • processingmodules - Processing modules
  • pricelist_cost - Cost
  • orderpriority - Sort
  • status - Status

Name

Function: pricelist.history

Result: the list of elements

Tariff plan change history

Access level: admin

  • changedate - Change date
  • desc - Tariff description
  • user - User
  • ip - IP address
  • action - Function

Name

Function: itemtype.orderreference

Result: the list of elements

Tariff order rules

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: itemtype.orderreference.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.orderreference function.

Result: successful operation or error message

Name

Function: pricelist.orderreference

Result: the list of elements

Tariff order rules

Access level: admin

  • id - Id
  • name - Name
  • status - Status
Resume

Function: pricelist.orderreference.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.orderreference function.

Result: successful operation or error message

Suspend

Function: pricelist.orderreference.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.orderreference function.

Result: successful operation or error message

Suspend

Function: itemtype.orderreference.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of itemtype.orderreference function.

Result: successful operation or error message

Name

Function: pricelist.detail

Result: the list of elements

Tariff plan configuration

Access level: admin

  • id - Id
  • name - Name
  • price - Prices
  • orderpriority - Sort
  • status - Status

Name

Function: pricelist.detail.integer

Result: the list of elements

Quantity based pricing

Access level: admin

  • id - Id
  • value - Quantity
  • price - Prices
Delete

Function: pricelist.detail.integer.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.detail.integer function.

Result: successful operation or error message

Special price

Function: pricelist.detail.integer.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of pricelist.detail function).
    • elid - unique identifier (id element of pricelist.detail.integer function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist.detail function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist.detail function).
    • elid - unique identifier (id element of pricelist.detail.integer function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • value - Number. When the amount of resources reaches the specified value (greater than or equals), the special price will be applied. Values from to

Resume

Function: pricelist.detail.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.detail function.

Result: successful operation or error message

Name

Function: pricelist.detail.enum

Result: the list of elements

Prices

Access level: admin

  • id - Id
  • name - Name
  • price - Price
  • orderpriority - Sort
  • status - Status
Resume

Function: pricelist.detail.enum.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.detail.enum function.

Result: successful operation or error message

Suspend

Function: pricelist.detail.enum.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.detail.enum function.

Result: successful operation or error message

Move one line up

Function: pricelist.detail.enum.up

Move one line up

Access level: admin

Prices

Function: pricelist.detail.enum.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of pricelist.detail function).
    • elid - unique identifier (id element of pricelist.detail.enum function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist.detail function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist.detail function).
    • elid - unique identifier (id element of pricelist.detail.enum function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • orderpriority - Sort. Sorting order for enumeration element in the list
Move one line down

Function: pricelist.detail.enum.down

Move one line down

Access level: admin

Move the selected add-on one line up

Function: pricelist.detail.up

Move the selected add-on one line up

Access level: admin

Edit the selected resource

Function: pricelist.detail.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of pricelist function).
    • elid - unique identifier (id element of pricelist.detail function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist function).
    • elid - unique identifier (id element of pricelist.detail function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • billtype - Billing type. Choose how you want to charge customers for this add-on
  • chargestoped - . (Optional parameter. To enable the option click "on".) If you clear this check box, the client will be compensated for his service downtime
  • itemtype - Type. Select an add-on type
  • addontype - Value type. Select how you want to provide add-ons for this tariff plan
  • selecttype - Display type . It is used only in BILLmanager6 user interface.
  • scaletype - Value scale type . This parameter is used to calculate add-on price
  • restrictclientchange - Edit resource after order. Resources modification policy
  • minperiodtype - Minimum order period. Select a minimum period that will pass before a client will be able to downgrade his add-on
  • minperiodlen - Period. Enter the minimum order period for this add-on
  • manualprocessing - . (Optional parameter. To enable the option click "on".) The service will be set up manually. The corresponding task will be created for a technical support team
  • manualprocessing_skipdefault - . (Optional parameter. To enable the option click "on".) With this option enabled and the default value selected, this add-on will not be added to manual processing.
  • manualname - . (Optional parameter. To enable the option click "on".) Select the check box to use the value specified below for a new add-on
  • name - Name. Enter the tariff plan name
  • intname - Internal name. Enter the internal name, only if the it differs from the internal name of the add-on type, or if several parameters should be calculated
  • processing_feature - Check possibility. If you choose an addon with this feature, the handler will be selected that has this feature
  • roundtype - Rounding procedure. Select a rounding procedure
  • addonstattype - Bill resource overuse. Select a period to bill a client for resource overuse
  • addonstatcomparison - Several parameters. Select how you want to bill a client if there are several parameters of the same type. For example, traffic can be incoming and outgoing
  • addonstatcalculation - Price for. The price is specified for... If it is specified per item per month, the statistics will be calculated as follows: (overuse per day) * (price) / (number of days in a month)
  • addonstatchargestoped - . (Optional parameter. To enable the option click "on".) If this option is enabled, service will be charged even if it is suspended
  • allowpostpaid - . (Optional parameter. To enable the option click "on".) Select the check box to charge a client for resource overage without debiting his personal account
  • summarizeinvoice - . (Optional parameter. To enable the option click "on".) Sum up the values for the whole period
  • measure - Unit of measure. Select a unit of measure for this add-on. The value will be converted into a unit of measure used by the control panel
  • addonlimit - Tariff plan includes. Default value for add-on
  • addonstep - Step. Add-on order step
  • addonmin - Minimum value . Minimum order value. This value cannot be smaller than the value included into the tariff plan
  • addonmax - Maximum value. Enter the maximum order value
  • addonlimittrial - Include into tariff on trial period. The default value for the add-on on a trial period
  • addonmaxtrial - Maximum value on trial period . Maximum value that can be ordered on a trial period
  • enumeration - Enumeration. Values for add-on will be taken from this enumeration
  • enumerationitem - Default value. Enumeration element that this service includes by default
  • orderpolicy - Price after change . Here you can add rules how to calculate the price if you change service add-on
  • addonbool - . (Optional parameter. To enable the option click "on".) Default value for add-on
  • orderpriority - Sorting (count forward). Set priority for this add-on
  • description - Add-on description . Add-on description in HTML format. For line break use <br/>, to put in bold type or in italics <b></b> and <i></i>
  • description_markdown - Add-on description (markdown). Add-on description. Markdown formatting is used for descriotion

Delete

Function: pricelist.detail.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.detail function.

Result: successful operation or error message

Move the selected add-on one line down

Function: pricelist.detail.down

Move the selected add-on one line down

Access level: admin

Name

Function: pricelist.detail.compound

Result: the list of elements

Resource variants

Access level: admin

  • id - Id
  • name - Name
  • price - Prices
  • orderpriority - Sort
  • status - Status
Move the selected add-on one line up

Function: pricelist.detail.compound.up

Move the selected add-on one line up

Access level: admin

Suspend

Function: pricelist.detail.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.detail.compound function.

Result: successful operation or error message

Move the selected add-on one line down

Function: pricelist.detail.compound.down

Move the selected add-on one line down

Access level: admin

Import tariff plan from a remote server

Function: pricelist.import

Import tariff plan from a remote server

Access level: admin

Name

Function: pricelist.reference

Result: the list of elements

Add-on dependencies

Access level: admin

  • id - Id
  • referencedesc - Dependency
  • reference - Ratio

Edit dependency

Function: pricelist.reference.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of pricelist function).
    • elid - unique identifier (id element of pricelist.reference function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist function).
    • elid - unique identifier (id element of pricelist.reference function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • pricelist_base - Main add-on . Select a tariff add-on. Modifying this add-on will modify the value of the dependent add-on
  • base_value - Value. Select a value of the main add-on . Values from to
  • enumerationitem_base - Values. Select a value. Selecting the value will modify the dependent add-on
  • pricelist_reference - Dependent add-on . Select an add-on that will be changed when changing the main add-on
  • reference_value - Value. Select a value that will be set for the dependent add-on. Values from to
  • enumerationitem_reference - Values. Select values that will be available when changing the main add-on

Copy the selected dependency

Function: pricelist.reference.clone

Copy the selected dependency

Access level: admin

Delete

Function: pricelist.reference.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.reference function.

Result: successful operation or error message

Resume

Function: pricelist.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist function.

Result: successful operation or error message

Move the tariff plan one line up

Function: pricelist.up

Move the tariff plan one line up

Access level: admin

Suspend

Function: pricelist.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist function.

Result: successful operation or error message

Add

Function: pricelist.add

Add

Access level: admin

Edit properties of the selected tariff plan

Function: pricelist.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of pricelist function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the tariff plan name
  • processingmodule - Processing module . Select processing modules for the newly created tariff plan. Tariff plans won't be available for order, if they are not associated with a processing module
  • modulepreset - Configuration.
  • intname - Internal name. Enter an internal name that will be used for getting default parameters of newly created services from the processing module, or for identifying basic configuration in case of manual setup
  • billdaily - . (Optional parameter. To enable the option click "on".) Select the check box to charge clients on a daily basis. The amount will be calculated in proportin to daily price in the selected month. The tariff upgrade policy cannot be applied
  • billhourly - . (Optional parameter. To enable the option click "on".) Select the check box to allow clients to start/suspend services associated with this tariff plan. If the "Charge client after suspension" check box is selected, the client will be compensated for his service downtime. Funds are charged at the beginning of the day, and the client will be compensated the next day taking into account his service downtime
  • chargestoped - . (Optional parameter. To enable the option click "on".) If you clear the check box, the client will be compensated for his service downtime. This option is available for every service (it is enabled by default). Options in tariff configuration form and in additional resources are not interrelated
  • autocalcday - . (Optional parameter. To enable the option click "on".) Select the check box to calculate the month price divided by the number of days in the month
  • billprorata - . (Optional parameter. To enable the option click "on".) Selecting this check box will change the service validity period by a calendar month depending on a date selected in the "Pro-rata day" field. If a client orders the service before the specified date, its expiration date will be set before the end of the current month. If he makes an order at the specified date or later - until the end of the next month. Order/renewal price will be changed in proportion to changes of the service validity period
  • prorataday - Pro-rata day . Select a day for calendar-based charges
  • quickorder - . (Optional parameter. To enable the option click "on".) Enable quick order of services, a client won't need to enter any parameters during order
  • opennotify - Service activation notification template . Service activation notification template. It will be sent to a client's email upon service activation. You can also find the instruction in the service module by clicking the corresponding button on the toolbar.
  • license - Service agreement. Select a Service agreement template that clients will need to accept while ordering a service. You can add or edit a template in the "Document templates" module
  • pricelist_group - Tariff group. Select a tariff group in order to give global discounts, set trial policies, and group tariff plans in reports
  • create_addon - . (Optional parameter. To enable the option click "on".) All add-ons available for this tariff plan will be created while creating a tariff plan
  • show_on_dashboard - . (Optional parameter. To enable the option click "on".) Show tariff on the Dashboard in BILLmanager 6
  • orderpage - Page. Service order page that will display the tariff in BILLmanager 6
  • ostemplate - OS templates . OS templates that will be included into the tariff plan
  • access - Available for order . Select a group of users who can order or upgrade to this tariff plan
  • minperiodtype - Minimum order period. Select an order period. When this period is over, a client can cancel his service. In case of daily charges, this value may affect the amount of funds reserved for a service
  • minperiodlen - Minimum period length. Enter the minimum period in days or months
  • trial - Trial period. Enter a trial period in days. You can set trial policy in a product type edit form. Leave the field blank if this tariff plan doesn't have a trial period
  • trial_itemmax - Number of trials available for order . The maximum number of trials available for this tariff plan
  • itemmax - Number of services available for order. Enter the maximum number of services that a client can order. The client won't be able to order add-ons for this tariff plan once reaching this limit
  • suspendpenaltytype - Late renewal fee . A client will be charged this late renewal fee while renewing a service
  • suspendpenaltypercent - Price percent. Enter the price percent for overdue services
  • allownosuitable - . (Optional parameter. To enable the option click "on".) The service will be available for order even if there are no resources or dedicated servers available
  • suspendperiod - Auto-deletion period. Set a period in days that will pass before a suspended service will be deleted. Leave the field blank to apply the product type settings
  • nostopholidays - Suspend service on weekends. Select a service cancellation policy
  • changepolicy - Tariff change policy. Tariff plan change policy
  • changeprolongpolicy - Renew from. Tariff upgrade policy
  • orderpolicy - Additional resources order policy. Select how you want to calculate add-on prices
  • returnpolicy - Addon cancellation policy. Select how you want to calculate refunds if a client cancels add-ons
  • note - Notes. Enter any information related to this tariff plan that may be useful for staff
  • orderlink - Tariff plan order URL. You can use this link to make an order from your site
  • quickorderlinkbasket - .
  • quickorderlinkpayment - .
  • orderpriority - Sort. Set priority for this tariff plan (count forward)
  • show_addon_image - Show addon icons. This option enables to configure and display resources' icons during service order and modification
  • description - Tariff description.
  • description_markdown - Tariff description (markdown) .
  • siteinfo - Information for site. Enter any information that can be used for integration with your site
  • label - Labels. Tariff labels can be used to set filters on the order page. Enter labels with a fresh line

Name

Function: pricelist.processing

Result: the list of elements

Processing modules

Access level: admin

  • id - Id
  • name - Name
  • orderpriority - Priority
  • status - Status

Suspend

Function: pricelist.processing.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.processing function.

Result: successful operation or error message

Put the processing module one position up

Function: pricelist.processing.up

Put the processing module one position up

Access level: admin

Resume

Function: pricelist.processing.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.processing function.

Result: successful operation or error message

Put the processing module one position down

Function: pricelist.processing.down

Put the processing module one position down

Access level: admin

Move the tariff plan one line down

Function: pricelist.down

Move the tariff plan one line down

Access level: admin

Clone the selected tariff plan

Function: pricelist.clone

Clone the selected tariff plan

Access level: admin

Delete

Function: pricelist.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist function.

Result: successful operation or error message

Set filter.

pricelist.filter

Name

Function: pricelist.change

Result: the list of elements

Tariff change rules

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Name

Function: pricelist.change.rule

Result: the list of elements

Tariff change special rules

Access level: admin

  • id - Id
  • fromdate - Order start date
  • todate - Order end date
  • period - Order period
  • discount - Discount, %
Special rule for tariff change

Function: pricelist.change.rule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of pricelist.change function).
    • elid - unique identifier (id element of pricelist.change.rule function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist.change function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of pricelist.change function).
    • elid - unique identifier (id element of pricelist.change.rule function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • fromdate - Order start date. Start date. The rule will be applied only to services that were ordered after this date
  • todate - Order end date. End date. The rule will be applied only to services that were ordered before this date
  • period - Order period. You can create different rules depending on order period (lifetime, one month, etc.)
  • discount - Discount on a new tariff plan. Enter a discount in % that will be given on a new product
Delete

Function: pricelist.change.rule.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.change.rule function.

Result: successful operation or error message

Resume

Function: pricelist.change.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.change function.

Result: successful operation or error message

Suspend

Function: pricelist.change.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of pricelist.change function.

Result: successful operation or error message

Email notifications

Function: emailnotify

Access level: admin

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

  • servertype - Mail server type . Select a type of the mail server that will send email notifications
  • smtpserver - SMTP-server . Enter the SMTP server URL to send notifications
  • smtpuser - Login. Enter a username (login or full email address, such as example@mail.com)
  • smtppassword - Password. Enter a password
  • smtpport - SMTP-server port. Enter the SMTP-server port. Port 25 is used by default
  • sendername - Sender name . Enter the sender name that will be added to emails by default
  • servername_param - Server name. Enter the domain name of the server that will be used in the email
  • type_auth - . (Optional parameter. To enable the option click "on".) Select the check box to allow notifications about successful authentication in the panel
  • type_geoip - . (Optional parameter. To enable the option click "on".) Select the check box to enable notifications from the geolocation module. Disabling this option will disable the GeoIP module
  • type_recovery - . (Optional parameter. To enable the option click "on".) Enable password reset notifications. Disabling this option will also disable the module itself
  • type_dnssec - . (Optional parameter. To enable the option click "on".) Allows sending DNSSEC dns-server extension notifications

Incoming messages

Function: gateway_message

Result: the list of elements

Incoming emails

Access level: admin

  • id - Id
  • name - Subject
  • sender - Sender
  • date_post - Date received
  • reason_code - Message type
  • identifier - Gateway
  • project - Provider

Delete

Function: gateway_message.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gateway_message function.

Result: successful operation or error message

Incoming email

Function: gateway_message.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of gateway_message function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Subject. Enter the message subject
  • error_message - Bug report. This email was put in the list of incoming emails due to this error
  • message - .
  • action - Action. Select an action you want to perform
  • account - Client . Client who sent this email
  • project - Provider. Select a provider. If the client is not connected to a service provider, the billing system will connect it
  • department - Department. Select a department to assign the ticket

Delete the message and mark it as spam

Function: gateway_message.spam

Delete the message and mark it as spam

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gateway_message function.

Result: successful operation or error message

All tickets

Function: ticket_all

Result: the list of elements

All tickets

Access level: admin

  • id - Id
  • name - Subject
  • client - Client
  • date_start - Date submitted
  • last_message - Last reply
  • last_activity - Last response
  • responsible - Responsible
  • project_name - Provider
  • tstatus - Status
  • props - Properties

Drill down to User panel

Function: ticket_all.su

Drill down to User panel

Access level: admin

Set a filter by the selected client

Function: ticket_all.setfilter

Set a filter by the selected client

Access level: admin

Name

Function: ticket_all.message

Result: the list of elements

List of ticket messages

Access level: admin

  • id - Id
  • message - Message
  • date_post - Expense date
  • message_user - User

Ticket

Function: ticket_all.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of ticket_all function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • ticket_item - .
  • ticket_project_select - .
  • client_department - .
  • item - .
  • client_priority - .
  • priority - .
  • message - .
  • show_optional - . (Optional parameter. To enable the option click "on".)
  • note_message - .
  • ticket_expense - .
  • high_priority - . (Optional parameter. To enable the option click "on".)
  • low_priority - . (Optional parameter. To enable the option click "on".)
  • incident_count - Support incidents . Number of incidents deducted from the client's account for this ticket. Enlarging this number will deduct additional incidents, decreasing the number will return incidents to the client's account
  • show_abuse - . (Optional parameter. To enable the option click "on".)
  • score - .
  • action - Action. Select the action that should be taken, if the client fails to resolve the issue
  • deadline_date - Date when the issue should be resolved. Abuse issue should be resolved by this date
  • deadline_time - Time. Abuse issue should be resolved by this time
  • score_note - .

Add this ticket to Favorites and keep track of its history

Function: ticket_all.favorite

Add this ticket to Favorites and keep track of its history

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket_all function.

Result: successful operation or error message

Delete this ticket from the system

Function: ticket_all.delete

Delete this ticket from the system

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket_all function.

Result: successful operation or error message

Set filter.

ticket_all.filter

Modules

Function: plugin

Access level: root admin

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

Countries

Function: country

Result: the list of elements

Countries

Access level: admin

  • id - Id
  • locale_name - Name
  • iso2 - ISO2
  • phonecode - Phone code
  • status - Status

Country

Function: country.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of country function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a country name
  • iso2 - ISO2. Enter a two- or five-letter code for the country or region
  • phonecode - Phone code. Enter a country code
  • phoneformat - Phone number format . Phone number format is specified with a mask without phone code. '9' in the mask means a digit from the range 0-9. In square brackets you can specify the number of unnecessary characters. For example, mask 99-99-9[9] means that a phone number can contain 5 or 6 digits, code not included
  • doctype - Document types . Types of documents available to a company from this country

Name

Function: country.state

Result: the list of elements

States/Provinces

Access level: admin

  • id - Id
  • locale_name - Name
  • iso - ISO code

Delete

Function: country.state.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.state function.

Result: successful operation or error message

Edit state/province

Function: country.state.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of country function).
    • elid - unique identifier (id element of country.state function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of country function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of country function).
    • elid - unique identifier (id element of country.state function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. State/province name
  • iso - ISO code . Enter the ISO code of the region

Suspend

Function: country.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country function.

Result: successful operation or error message

Delete

Function: country.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country function.

Result: successful operation or error message

Name

Function: country.profileparam

Result: the list of elements

Payer and company information

Access level: admin

  • id - Id
  • locale_name - Name
  • profiletype - Payer status
  • page - Block
  • locale_hint - Description
  • orderpriority - Sorting (count forward)
  • props - Properties

Move one line up

Function: country.profileparam.up

Move one line up

Access level: admin

Resume

Function: country.profileparam.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.profileparam function.

Result: successful operation or error message

Move one line down

Function: country.profileparam.down

Move one line down

Access level: admin

Delete

Function: country.profileparam.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.profileparam function.

Result: successful operation or error message

Reset parameters of payers and companies

Function: country.profileparam.restoredefault

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of country function).
    • elid - unique identifier (id element of country.profileparam function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of country function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of country function).
    • elid - unique identifier (id element of country.profileparam function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Suspend

Function: country.profileparam.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country.profileparam function.

Result: successful operation or error message

Parameter

Function: country.profileparam.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of country function).
    • elid - unique identifier (id element of country.profileparam function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of country function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of country function).
    • elid - unique identifier (id element of country.profileparam function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Parameter name
  • hint - Hint .
  • intname - Internal name. Enter a unique eternal name for this parameter.
  • page - Block. Select a block to place this field
  • inputtype - Input field type. Select types of data that can be entered into the field
  • required - . (Optional parameter. To enable the option click "on".) Empty values for this parameter are forbidden
  • manual_validate_not_required - . (Optional parameter. To enable the option click "on".) Select the check box to cancel manual verification of payer profile
  • profiletype - Payer status . This parameters will be available for the selected types of payers
  • orderpriority - Sorting (count forward). You can set priority for this field
  • readonly_client - . (Optional parameter. To enable the option click "on".) Select the check box if you want to forbid your client to modify the value after he has made a payment
  • requiredonpay - During payment . Here you can choose how a field will be displayed on the Add payer form. If this policy is not set, the field will be displayed depending on BILLmanager settings
  • inputtype - Input field type. Select types of data that can be entered into the field
  • zoom - . (Optional parameter. To enable the option click "on".) Selecting this check box will enable you to enter multiple values space separated. The selected validator will be applied to each value
  • inputrows - Number of input strings. Enter the number of input strings in the text field
  • required - . (Optional parameter. To enable the option click "on".) Empty values for this parameter are forbidden
  • validator - Check function. This fucntion will prevent users from entering invalid data
  • select_ip - IP type . Type of IP address
  • num_range - . (Optional parameter. To enable the option click "on".) Range of values
  • r_start_int - Start of the range. Start value of the range
  • r_end_int - End of the range. End of the range
  • r_start_float - Start of the range. Start value of the range
  • r_end_float - End of the range. End of the range

Resume

Function: country.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of country function.

Result: successful operation or error message

Contracts

Function: contract

Result: the list of elements

Contracts

Access level: admin user

  • id - Id
  • number - Number
  • signdate - Date
  • senddate - Sent
  • end_date - Expiration date
  • client_name - Payer
  • company_name - Company
  • contract_name - Contract type
  • contracttype - Contract type
  • status - Status

Mark the selected contract "Sent" and set the sent date if it was not specified earlier

Function: contract.status.3

Mark the selected contract "Sent" and set the sent date if it was not specified earlier

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of contract function.

Result: successful operation or error message

Cancel the contract

Function: contract.status.5

Cancel the contract

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of contract function.

Result: successful operation or error message

Sign the selected contract

Function: contract.status.4

Sign the selected contract

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of contract function.

Result: successful operation or error message

Download this documetn in PDF

Function: contract.print.pdf

Download this documetn in PDF

Access level: admin user

Delete

Function: contract.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of contract function.

Result: successful operation or error message

Drill down to User panel

Function: contract.su

Drill down to User panel

Access level: admin

Set filter.

contract.filter

Set a filter by the selected client

Function: contract.setfilter

Set a filter by the selected client

Access level: admin

Print an envelop to send this contract

Function: contract.envelope

Print an envelop to send this contract

Access level: admin user

Request the original of this contract

Function: contract.request

Request the original of this contract

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of contract function.

Result: successful operation or error message

Contract

Function: contract.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of contract function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • number - Number. Contract number
  • signdate - Date when the contract was signed. Date when the contract was signed
  • senddate - Sent. Date when the contract was sent to client
  • companycontract - Contract type. Select a contract. You can add a new contract in "Companies" -- "Contracts"
  • status - Status. Select a contract status
  • profile - Payer. Enter a payer Id to generate a contract

Print the document

Function: contract.print

Print the document

Access level: admin user

Promotions

Function: promotion

Result: the list of elements

Promotions

Access level: admin

  • id - Id
  • name - Name
  • fromdate - Start date
  • todate - Expiry date
  • status - Status
  • project_name - Provider

Name

Function: promotion.archived

Result: the list of elements

Archive of promotion actions

Access level: admin

  • id - Id
  • name - Name
  • fromdate - Start date
  • todate - Expiry date
  • status - Status
  • project_name - Provider

Name

Function: promotion.discount

Result: the list of elements

Discounts

Access level: admin

  • id - Id
  • name - Name
  • actiontype - Discount type
Delete

Function: promotion.discount.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of promotion.discount function.

Result: successful operation or error message

Edit the selected discount

Function: promotion.discount.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of promotion.archived function).
    • elid - unique identifier (id element of promotion.discount function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of promotion.archived function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of promotion.archived function).
    • elid - unique identifier (id element of promotion.discount function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Discount type. Select a discount type
  • percentage - Discount. Discount in % on product/service
  • actiontype - Type. Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges
  • period - Order periods. This discount will be given on selected periods
  • validity - Validity period. Select a discount validity period
  • validitylength - Validity period, months. Select a discount validity period

Name

Function: promotion.condition

Result: the list of elements

Conditions

Access level: admin

  • id - Id
  • condition - Condition
  • cgroup - Group of conditions
Delete

Function: promotion.condition.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of promotion.condition function.

Result: successful operation or error message

Promotion conditions

Function: promotion.condition.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of promotion.archived function).
    • elid - unique identifier (id element of promotion.condition function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of promotion.archived function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of promotion.archived function).
    • elid - unique identifier (id element of promotion.condition function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • ctype - Condition. Promotion will be active, if the selected condition is met
  • comparison - Comparison . Comparison condition
  • period - Period. Order period
  • periodtype - Period type. Period type
  • periodlength - Period length. Period length
  • amount - Number. Number of services of the selected type or tariff plan
  • currency - Currency. Select currency
  • summa - Amount. Amount in the selected currency
  • affiliate - Affiliate program. Clients who were referred by the referral link will be able to participate in promotion
  • account_group - Client group. This promotion will be available to members of this group
  • group - Group of conditions. You can group conditions. The conditions will be grouped by the OR operator. The groups can be associated with each other by the AND operator. E.g. A, B, and C conditions are included into one group, and D and E conditions are included into another group. The result is (A OR B OR С) AND (D OR E)
  • groupname - Group name. Enter the name of the conditions group

Name

Function: promotion.promocode

Result: the list of elements

Promo codes

Access level: admin

  • id - Id
  • code - Promo code
  • uselimit - Usage limit
  • use_count - Usage
Delete

Function: promotion.promocode.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of promotion.promocode function.

Result: successful operation or error message

Name

Function: promocode.usage

Result: the list of elements

Promo code usage

Access level: admin

  • id - Service Id
  • account - Client
  • status - Status
  • expense - Expenses
Edit properties of the selected promo code

Function: promotion.promocode.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of promotion.archived function).
    • elid - unique identifier (id element of promotion.promocode function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of promotion.archived function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of promotion.archived function).
    • elid - unique identifier (id element of promotion.promocode function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • code - Promo code. Promo code template. The "?" signs will be changed into random values while generating a new promo code
  • count - Number of promo codes. Enter the number of promo codes you want to generate
  • uselimit - Usage limit. How many times this promo code can be used
  • account_uselimit - Usage limit per client . How many times a client can use this promo code
  • onlydigit - . (Optional parameter. To enable the option click "on".) Only digits will be used to generate a random number
  • active_time_type - Period when the promo code can be activated. Period when the promo code can be activated
  • fromdate - Start date. Enter the promo code start date
  • todate - End date. Promo code expiration date
  • expiretype - Promo code discount period . The promo code's discount can be used during the specified period
  • periodtype - Period type. Period type
  • periodlength - Period length. Period length

Name

Function: promotion.promocode.usage

Result: the list of elements

Promo code usage

Access level: admin

  • promocode - Promo code
  • id - Service Id
  • account - Client
  • status - Status
  • expense - Expenses

Name has been changed from "__old_value__" into "__new_value__"

Function: promotion.history

Result: the list of elements

Promo change history

Access level: admin

  • changedate - Change date
  • desc - Description
  • user - User
  • ip - IP address
  • action - Function

Delete

Function: promotion.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of promotion function.

Result: successful operation or error message

=== Add a new promotion

===

Function: promotion.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of promotion function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • project - Provider. Select a service provider
  • fromdate - Start date . Select a start date for this promo
  • todate - End date. Select an end date for this promo (chosen date is included)

Move the selected promo to archive

Function: promotion.archive

Move the selected promo to archive

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of promotion function.

Result: successful operation or error message

Set filter.

promotion.filter

Expenses

Function: expense

Result: the list of elements

Expenses

Access level: admin user

  • id - Id
  • locale_name - Name
  • account - Client
  • realdate - Date
  • cdate - Date
  • amount - Amount
  • notpayd - Not paid
  • discountamount - Discount amount
  • payments - Payments
  • discount - Discount id
  • taxamount - Tax

Set a filter by the selected client

Function: expense.setfilter

Set a filter by the selected client

Access level: admin

Set filter.

expense.filter

Drill down to User panel

Function: expense.su

Drill down to User panel

Access level: admin

Edit the selected expense

Function: expense.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of expense function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • subaccount - Provider . Choose a provider
  • item - Service. Select a service
  • operation - Operation. Expense will be generated based on the selected operation
  • amount - Amount. Expense amount
  • taxrate - Tax rate. Tax rate. Note: tax amount is included into expense. Tax amount will be calculated as follows: AMOUNT - (AMOUNT / (100 + RATE) / 100)
  • postpaid - . (Optional parameter. To enable the option click "on".) Select the check box to provide services on credit in case of insufficient funds on client's account
  • name - Name. Enter any name you want to use, otherwise the name will be generated automatically based on the operation selected above
  • realdate - Date. Date when the client was charged for the service
  • cdate - Service activation date. Service activation date

Delete

Function: expense.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of expense function.

Result: successful operation or error message

Name

Function: expense.payment

Result: the list of elements

Payments associated with the expense

Access level: admin user

  • payment - Payment id
  • payment_number - Payment
  • amount_iso - Amount
  • invoice - Invoice id
  • invoice_number - Invoice

Edit

Function: expense.payment.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of expense function).
    • elid - unique identifier (payment element of expense.payment function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of expense function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of expense function).
    • elid - unique identifier (payment element of expense.payment function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • payment - Payment . Select a payment for the expense
  • amount - Amount . Amount that will be deducted from the expense

Delete

Function: expense.payment.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the payment element of expense.payment function.

Result: successful operation or error message

Customers also buy

Function: buymore

Result: the list of elements

Customers also buy

Access level: admin

  • id - Id
  • name - Name
  • orderpriority - Sort
  • status - Status

Increase order priority

Function: buymore.up

Increase order priority

Access level: admin

Suspend

Function: buymore.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of buymore function.

Result: successful operation or error message

Resume

Function: buymore.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of buymore function.

Result: successful operation or error message

Name

Function: buymore.condition

Result: the list of elements

Conditions

Access level: admin

  • id - Id
  • condition - Condition
  • conditiongroup - Group

Delete

Function: buymore.condition.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of buymore.condition function.

Result: successful operation or error message

Edit the selected rule

Function: buymore.condition.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of buymore function).
    • elid - unique identifier (id element of buymore.condition function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of buymore function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of buymore function).
    • elid - unique identifier (id element of buymore.condition function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Type. Condition type
  • group - Group of conditions . Conditions in this group will be combined by the OR operator. Groups are combined by the AND operator. For example: A, B, and C operators can be combined into one group. D and E operators are combined into the second group. The result will be as follows: (A OR B OR С) AND (D OR E)
  • groupname - Group name . Enter the name of the conditions group

Lower order priority

Function: buymore.down

Lower order priority

Access level: admin

Delete

Function: buymore.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of buymore function.

Result: successful operation or error message

Edit associated products

Function: buymore.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of buymore function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • project - Provider. This application will be displayed only to clients of the selected provider
  • language - Language. This application will be displayed to clients using the selected language. If no languages are selected, the application will be shown to all clients
  • link - Function. Select a function to be called
  • description - Description. HTML description of the product
  • orderpriority - Sort. Specify the order in which your products display in the Cart

Fraud protection

Function: fraud_setting

Result: the list of elements

Fraud protection

Access level: admin

  • id - Id
  • name - Provider
  • status - Status

Provider

Function: fraud_setting.pricelist

Result: the list of elements

Fraud protection

Access level: admin

  • id - Id
  • name - Provider
  • status - Status

Select periods to run a check

Function: period

Select periods to run a check

Access level: admin

Resume

Function: fraud_setting.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of fraud_setting.pricelist function.

Result: successful operation or error message

Suspend

Function: fraud_setting.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of fraud_setting.pricelist function.

Result: successful operation or error message

Notifications queue

Function: notifytask

Result: the list of elements

Notifications queue

Access level: admin

  • id - Id
  • modulename - Module name
  • filename - File
  • createdate - Creation date
  • priority - Priority
  • status - Status

Notification information

Function: notifytask.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of notifytask function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • err_info - Error: . Error that occurred while sending the notification

Delete

Function: notifytask.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notifytask function.

Result: successful operation or error message

Set filter.

notifytask.filter

Registered licenses

Function: softregistration

Result: the list of elements

Registered licenses

Access level: admin user

  • id - Id
  • soft - License ID
  • pricelist - License type
  • ip - IP address
  • account - Client
  • owner_account - License owner

Set filter.

softregistration.filter

Set a filter by the selected client

Function: softregistration.setfilter

Set a filter by the selected client

Access level: admin

Drill down to User panel

Function: softregistration.su

Drill down to User panel

Access level: admin

License history

Function: softregistration.history

License history

Access level: admin

Send a ticket to the client

Function: ticket.write.softregistration

Send a ticket to the client

Access level: admin

Announcements

Function: infoboard

Result: the list of elements

Announcements

Access level: admin

  • id - Id
  • name - Name
  • schedule - Schedule
  • orderpriority - Sort
  • status - Status

Edit the selected announcement

Function: infoboard.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of infoboard function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • blocking - . (Optional parameter. To enable the option click "on".) This announcement will block access to the Support department. Clients won't be able to submit a new ticket or add new posts to existing tickets
  • orderpriority - Sort. Set priority to show announcements
  • timezone - Time zone. Select a time zone
  • start_date - Start date . Date in the format YYYY-MM-DD
  • start_time - Start time . Time in the format HH:MM
  • end_date - Estimated time of completion . Date in the format YYYY-MM-DD
  • end_time - Estimated time of completion . Time in the format HH:MM
  • subject - Heading. Notification heading that will be displayed in the banner
  • message - Message. Enter the text of the announcement that will be shown when clicking the "More info" button. You can use the macros:
    %USER% - User full name
    %SERVICE% - client's services space separated

Name

Function: infoboard.condition

Result: the list of elements

Rules

Access level: admin

  • id - Id
  • condition - Condition

Edit the selected rule

Function: infoboard.condition.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of infoboard function).
    • elid - unique identifier (id element of infoboard.condition function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of infoboard function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of infoboard function).
    • elid - unique identifier (id element of infoboard.condition function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Type. Condition type

Delete

Function: infoboard.condition.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of infoboard.condition function.

Result: successful operation or error message

Delete

Function: infoboard.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of infoboard function.

Result: successful operation or error message

Decrease the priority. Blocking announcements have higher priority than non-blocking ones

Function: infoboard.down

Decrease the priority. Blocking announcements have higher priority than non-blocking ones

Access level: admin

Increase the priority. Blocking announcements have higher priority than non-blocking

Function: infoboard.up

Increase the priority. Blocking announcements have higher priority than non-blocking

Access level: admin

Business hours

Function: working_plan

Result: the list of elements

Department business hours

Access level: admin

  • id - Id
  • name - Name

Delete

Function: working_plan.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of working_plan function.

Result: successful operation or error message

Business hours

Function: working_plan.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of working_plan function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name that will be displayed in the drop-down lists
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_0_allday - . (Optional parameter. To enable the option click "on".)
  • day_0_begin - .
  • day_0_end - .
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_1_allday - . (Optional parameter. To enable the option click "on".)
  • day_1_begin - .
  • day_1_end - .
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_2_allday - . (Optional parameter. To enable the option click "on".)
  • day_2_begin - .
  • day_2_end - .
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_3_allday - . (Optional parameter. To enable the option click "on".)
  • day_3_begin - .
  • day_3_end - .
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_4_allday - . (Optional parameter. To enable the option click "on".)
  • day_4_begin - .
  • day_4_end - .
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_5_allday - . (Optional parameter. To enable the option click "on".)
  • day_5_begin - .
  • day_5_end - .
  • day_active - . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
  • day_6_allday - . (Optional parameter. To enable the option click "on".)
  • day_6_begin - .
  • day_6_end - .

Name

Function: working_plan.day

Result: the list of elements

Days off and changes to business hours

Access level: admin

  • id - Id
  • affected_date - Date
  • description - Description

Edit properties of the selected exception

Function: working_plan.day.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of working_plan function).
    • elid - unique identifier (id element of working_plan.day function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of working_plan function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of working_plan function).
    • elid - unique identifier (id element of working_plan.day function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Type. Select an exception type
  • day_begin - Openning time. Enter the opening time
  • day_end - Closing time. Enter the closing time
  • note - Comment . Enter additional information related to the exception

Copy exceptions

Function: working_plan.day.copy

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of working_plan function).
    • elid - unique identifier (id element of working_plan.day function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of working_plan function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of working_plan function).
    • elid - unique identifier (id element of working_plan.day function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • plan - Copy from. Select the department's business hours from which you want to copy the exceptions
  • first_day - Start date. Exceptions will be copied from the selected date
  • last_day - End date. Select the end date of the range to copy the exceptions

Add

Function: working_plan.day.create

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of working_plan function).
    • elid - unique identifier (id element of working_plan.day function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of working_plan function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of working_plan function).
    • elid - unique identifier (id element of working_plan.day function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • affected_date - Date. Select date(s) for this exception. You can use the "-" character for providing a range of dates, e.g. '2001-01-01 - 2001-01-31'. Start a new line for each date
  • type - Type. Select an exception type
  • day_begin - Openning time. Enter the opening time
  • day_end - Closing time. Enter the closing time
  • note - Comment . Enter additional information related to the exception

Delete

Function: working_plan.day.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of working_plan.day function.

Result: successful operation or error message

Print the reconciliation report

Function: profile.reconciliation

Access level: user

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

  • company - Company. Select a company to print the reconciliation report
  • currency - Currency. Select currency for the reconciliation report
  • fromdate - Start date. Select a start date of the billing period
  • todate - End date. Select an end date of the billing period
  • prepair_invoice - . (Optional parameter. To enable the option click "on".) Add information about "Preliminary" invoices

Document flow

Function: docflow_connection

Result: the list of elements

Document flow

Access level: admin

  • id - Id
  • company - Company
  • module - Connection module

Delete

Function: docflow_connection.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection function.

Result: successful operation or error message

Send the documents from the queue and get statuses of already sent documents

Function: docflow_connection.doc_sync

Send the documents from the queue and get statuses of already sent documents

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection function.

Result: successful operation or error message

Payer

Function: docflow_connection.counteragent

Result: the list of elements

List of contracting parties

Access level: admin

  • id - Id
  • name - Payer
  • vatnum - INN
  • status - Status

Suspend

Function: docflow_connection.counteragent.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection.counteragent function.

Result: successful operation or error message

Resume

Function: docflow_connection.counteragent.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection.counteragent function.

Result: successful operation or error message

Function: docflow_connection.counteragent.docflow_box


Access level: admin

Uploading list of contracting parties

Function: docflow_connection.customer_search_all

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of docflow_connection function).
    • elid - unique identifier (id element of docflow_connection.counteragent function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of docflow_connection function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of docflow_connection function).
    • elid - unique identifier (id element of docflow_connection.counteragent function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Update the list

Function: docflow_connection.customer_sync_all

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of docflow_connection function).
    • elid - unique identifier (id element of docflow_connection.counteragent function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of docflow_connection function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of docflow_connection function).
    • elid - unique identifier (id element of docflow_connection.counteragent function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Name

Function: docflow_connection.docflow_box

Result: the list of elements

Boxes

Access level: admin

  • id - Id
  • name - Name
  • box_id - Box Id
  • status - Status

Resume

Function: docflow_connection.docflow_box.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of docflow_connection.docflow_box function.

Result: successful operation or error message

Edit the selected connection

Function: docflow_connection.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of docflow_connection function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of docflow_connection function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • profile - Company. Company connected to the electronic document management system
  • module - Connection module. You can use this module to connect the electronic document management system
  • document_type - Document type . Select what type of documents will be sent by default
  • group_items - . (Optional parameter. To enable the option click "on".) Positions will be grouped by tariff plan, payment period, and item amount.
  • autoassign - . (Optional parameter. To enable the option click "on".) Search for a payer in the electronic document system when assigning to the company

Add

Function: docflow_connection.add

Add

Access level: admin

Applications platform

Function: dockerapp

Result: the list of elements

Applications platform

Access level: admin user

  • domain - Domain name
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg -
  • item_status -
  • cost - Price

Order a new service

Function: dockerapp.order

Order a new service

Access level: user

Resume

Function: dockerapp.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dockerapp function.

Result: successful operation or error message

Service activation

Function: dockerapp.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of dockerapp function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Set a filter by the selected client

Function: dockerapp.setfilter

Set a filter by the selected client

Access level: admin

Open URL in a new tab

Function: dockerapp.gotoserver

Open URL in a new tab

Access level: admin user

Drill down to User panel

Function: dockerapp.su

Drill down to User panel

Access level: admin

Edit properties of the selected service

Function: dockerapp.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of dockerapp function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Suspend

Function: dockerapp.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dockerapp function.

Result: successful operation or error message

Set filter.

dockerapp.filter

Delete the selected services

Function: dockerapp.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dockerapp function.

Result: successful operation or error message

Mail gateways

Function: gateway

Result: the list of elements

Mail gateways

Access level: admin

  • id - Id
  • module - Gateway type
  • gateway_type - Action
  • identifier - Identifier
  • project - Provider
  • status - Status

Gateway parameters

Function: gateway.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of gateway function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • gateway_type - Use for. Select a gateway type
  • user - Department. Select a department. Tickets sent to this email address will be redirected to the selected department
  • abuse - . (Optional parameter. To enable the option click "on".) Select the check box to redirect the messages to the Abuse department
  • active - . (Optional parameter. To enable the option click "on".) Use gateway

Add a new gateway

Function: gateway.create

Add a new gateway

Access level: admin

Resume

Function: gateway.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gateway function.

Result: successful operation or error message

Suspend

Function: gateway.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gateway function.

Result: successful operation or error message

Delete the selected gateway

Function: gateway.delete

Delete the selected gateway

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of gateway function.

Result: successful operation or error message

Open tickets

Function: ticket_open

Result: the list of elements

Open tickets

Access level: admin

  • id - Id
  • name - Subject
  • client - Client
  • date_start - Date submitted

Close ticket (delete from the queue)

Function: ticket_open.delete

Close ticket (delete from the queue)

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ticket_open function.

Result: successful operation or error message

Ticket

Function: ticket_open.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of ticket_open function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Subject. The ticket subject contains a brief description of the support ticket
  • ticket_item - Service. Select a service related to your question
  • ticket_project_select - Provider. Select a provider associated with the ticket
  • client_department - Department. Select the provider's department to assign the ticket
  • item - Service. Select a service related to your question
  • client_priority - Priority. Ticket priority
  • priority - Priority. Ticket priority
  • message - .
  • show_optional - . (Optional parameter. To enable the option click "on".) Show additional configuration options for this ticket
  • note_message - .
  • ticket_expense - Support fee . Amount that will be charged from the client's account
  • high_priority - . (Optional parameter. To enable the option click "on".) Place the ticket to the to of the queue
  • low_priority - . (Optional parameter. To enable the option click "on".) Raised priority will be reset for this ticket
  • incident_count - .
  • show_abuse - . (Optional parameter. To enable the option click "on".) Show abuse registration parameters
  • score - Number of scores . Number of abuse scores
  • action - Function.
  • deadline_date - .
  • deadline_time - .
  • score_note - Comment. Enter additional information

SSL certificates

Function: certificate

Result: the list of elements

SSL certificates

Access level: admin user

  • id - Id
  • CN - Domain
  • account - Client
  • pricelist - Tariff plan
  • project - Provider
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • status_msg -
  • item_status -
  • cost - Price

Restart the certificate processing operation

Function: certificate.retry

Restart the certificate processing operation

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of certificate function.

Result: successful operation or error message

Reissue the selected certificate

Function: certificate.reissue

Reissue the selected certificate

Access level: admin user

Resume

Function: certificate.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of certificate function.

Result: successful operation or error message

Set a filter by the selected client

Function: certificate.setfilter

Set a filter by the selected client

Access level: admin

Order a new certificate

Function: certificate.order

Order a new certificate

Access level: user

Service activation

Function: certificate.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of certificate function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • crt - Certificate. DER certificate
  • processingmodule - Processing module. Processing module for this service

Drill down to User panel

Function: certificate.su

Drill down to User panel

Access level: admin

Request the certificate data and status from the CA

Function: certificate.sync

Request the certificate data and status from the CA

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of certificate function.

Result: successful operation or error message

Set filter.

certificate.filter

Delete the selected records

Function: certificate.delete

Delete the selected records

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of certificate function.

Result: successful operation or error message

Certificate

Function: certificate.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of certificate function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • service_status - .
  • custom_order_id - Identifier. Certificate identifier in the Certification authority
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed
  • crt_start_date - Start date . Certificate activation date
  • crt_end_date - End date . Certificate expiration date
  • CN - Domain. If you want to protect only one domain, enter www.example.com. If you want to protect domain and its subdomains, enter *.example.com. If you purchase multi-domain certificate, enter one domain www.example.com. Enter additional domains on the next order step
  • field_country - Country. Select a country from the list
  • ST - Region. Enter the region. You can only use the Latin alphabet letters
  • L - City. Enter the city that will be shown in the certificate. You can use the Latin alphabet letters
  • O - Organization . Enter the organization name, or a full name of the individual this certificate will be issued for. Organization's legal status should be provided, if you are ordering EV certificates.You can use only the Latin alphabet letters
  • OU - Department . Enter the organization unit. You can use only the Latin alphabet letters
  • emailAddress - Email. Enter the email if you want it to show in the certificated details

ISPsystem modules

Function: addition

Result: the list of elements

ISPsystem modules

Access level: admin user

  • item - License
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Order a new service

Function: addition.order

Order a new service

Access level: user

Service activation

Function: addition.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of addition function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Suspend

Function: addition.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of addition function.

Result: successful operation or error message

Delete the selected services

Function: addition.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of addition function.

Result: successful operation or error message

Set a filter by the selected client

Function: addition.setfilter

Set a filter by the selected client

Access level: admin

Edit properties of the selected service

Function: addition.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of addition function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Resume

Function: addition.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of addition function.

Result: successful operation or error message

Set filter.

addition.filter

Drill down to User panel

Function: addition.su

Drill down to User panel

Access level: admin

SSL-keys

Function: sslkey

Result: the list of elements

SSL-keys

Access level: user

  • server - Panel URL
  • user - User
  • cert - Certificate
  • start - Creation date
  • expire - Expiry date
  • props - Properties

You can download the key. This operation can be run only once. The key file will be deleted upon downlaod

Function: sslkey.download

You can download the key. This operation can be run only once. The key file will be deleted upon downlaod

Access level: user

New SSL key

Function: sslkey.edit

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (key element of sslkey function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • server - Panel URL. Different panel's addresses can use different SSL certificates for authentication. A new key will be valid only for the certificate used on this port
  • self - . (Optional parameter. To enable the option click "on".) You can create a key for the current user or for any of his users
  • username - Username. Enter the user for whom you want to generate a key. You must be the owner of that user
  • type - Action. You can generate a new key, use the existing one, use the current key (if you used the key that is not registered in the system) or get a signed certificate to generate the key manually
  • name - Key name. Enter a name for the certificate that will be shown in the system
  • period - Validity period (days). A new key will be valid during the specified period starting today
  • passwd - . Enter a password for the SSL key
  • confirm - Re-enter password.
  • subject - Key name. Enter the name of your key. Note: the key must be signed by the certificate specified in the HTTP server settings.
  • request - SSL certificate request. You will get a signed certificate. To generate a key, convert it into PKCS#12 format. For example, you can use the command: openssl pkcs12 -export -in my.crt -inkey my.key -certfile ca.crt -out my.p12 -passout pass:your password

Delete

Function: sslkey.delete

Delete

Access level: user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of sslkey function.

Result: successful operation or error message

Domain contacts

Function: service_profile

Result: the list of elements

Domain contacts

Access level: user

  • id - Id
  • name - Name
  • profiletype - Contact type
  • spusage - Usage
  • fullname - Name
  • domains -

Delete

Function: service_profile.delete

Delete

Access level: user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of service_profile function.

Result: successful operation or error message

Document copies

Function: service_profile.doc

Document copies

Access level: user

Data centers

Function: datacenter

Result: the list of elements

Data centers

Access level: admin

  • id - Id
  • locale_name - Name
  • orderpriority - Sort

Move one line down

Function: datacenter.down

Move one line down

Access level: admin

Data center

Function: datacenter.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of datacenter function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • orderpriority - Sorting order. Data-center sorting order

Move one line up

Function: datacenter.up

Move one line up

Access level: admin

Delete

Function: datacenter.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of datacenter function.

Result: successful operation or error message

Other software

Function: softexternal

Result: the list of elements

Other software

Access level: admin user

  • licname - License name
  • ip - IP address
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg -
  • item_status -
  • cost - Price

Drill down to User panel

Function: softexternal.su

Drill down to User panel

Access level: admin

Set a filter by the selected client

Function: softexternal.setfilter

Set a filter by the selected client

Access level: admin

Resume

Function: softexternal.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of softexternal function.

Result: successful operation or error message

Set filter.

softexternal.filter

Service activation

Function: softexternal.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of softexternal function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Edit properties of the selected service

Function: softexternal.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of softexternal function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Suspend

Function: softexternal.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of softexternal function.

Result: successful operation or error message

Delete the selected services

Function: softexternal.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of softexternal function.

Result: successful operation or error message

Order a new service

Function: softexternal.order

Order a new service

Access level: user

Companies

Function: company

Result: the list of elements

Companies

Access level: admin

  • id - Id
  • name - Name

Add

Function: company.add

Add

Access level: admin

Name

Function: company.project

Result: the list of elements

Providers associated with this company

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: company.project.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of company.project function.

Result: successful operation or error message

Suspend

Function: company.project.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of company.project function.

Result: successful operation or error message

Name

Function: company.contract

Result: the list of elements

Contracts

Access level: admin

  • id - Id
  • name - Name
  • contracttype - Contract type
  • doctmpl_name - Template

Name

Function: company.contract.appendix

Result: the list of elements

Examples of contract annexes

Access level: admin

  • id - Id
  • name - Name
  • doctmpl_name -
Edit the selected annex

Function: company.contract.appendix.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of company.contract function).
    • elid - unique identifier (id element of company.contract.appendix function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of company.contract function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of company.contract function).
    • elid - unique identifier (id element of company.contract.appendix function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name for the contract annex
  • project - Provider. This annex will be generated, if a client has services of the selected type
  • itemtype - Product type . This annex will be generated, if a client has services of the selected type
  • nocheck - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want the billing system to check that a client has this service before generating a contract appendix
  • doctmpl - Template. Appendix template. You can add and modify it in the "Document templates" module
Delete

Function: company.contract.appendix.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of company.contract.appendix function.

Result: successful operation or error message

Edit the selected contract

Function: company.contract.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of company function).
    • elid - unique identifier (id element of company.contract function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of company function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of company function).
    • elid - unique identifier (id element of company.contract function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Contract type . Name of the contract example
  • contracttype - Contract type . Select a contract type
  • accepttype - User accepts offer . Select how you want your clients to read and accepts the offer
  • itemtype - Product types. A client will be asked to sign a contract if he has the selected services
  • accountgroup - Client groups. This contract will be available for the selected client group
  • profiletype - Payer status. Select a payer status
  • doctmpl - Contract template. Contract template. You can create and edit it in the "Document templates" module
  • suffix - Contract number suffix . This suffix will be added to the contract number. The contract number is generated as follows: PAYER_ID + SUFFIX. E.g. payer id - 1, suffix - '/contract'. The contract number will look like '1/contract'
  • start_date - Start date. The contract won't be generated automatically after this date
  • end_date - Expiration date. After this date the contract won't be generated for clients

Delete

Function: company.contract.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of company.contract function.

Result: successful operation or error message

Delete

Function: company.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of company function.

Result: successful operation or error message

Edit company details

Function: company.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of company function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a company name
  • email - Email. Enter the company's email
  • www - Web-site URL. Enter the URL of the company's web-site. It can be used in print templates
  • fax - Fax. Enter the fax number
  • phone - Phone number. Enter the phone number
  • payment_description - Purpose of advance payment. Enter a purpose of advance payments
  • country_legal - Country. Select a contry where the company is registered
  • state_legal - Region . Region where the company is registered
  • postcode_legal - ZIP code. Enter the zip code of the company's registration address
  • city_legal - City. Enter the city where the company is registered
  • address_legal - Address. Enter address where the company is registered (including the street, building and office)
  • country_physical - Country. Select a country where the company is located
  • state_physical - Region . Region where the company is located
  • postcode_physical - ZIP code. Enter the zip code of the city where this company is located
  • city_physical - City. Enter the city where the company is located
  • address_physical - Address. Enter address where the company is located (including the street, building and office)
  • regdate - Foundation date. Enter the date when the company was founded
  • locale - Documents localization. Language that is used for documents
  • doctmpl_payment - Invoice template for payment. Template of the invoice that can be printed. It can be modified in the payment methods edit form
  • numtmpl_payment - Invoice number template. Template of the invoice number. You can use the following macros: {id} - payment id and {num} - invoice numerical number. If both macros are not present, {num} will be used
  • nextnum_payment - Next numerical number of the invoice. Enter the next numerical number of the payment. This value is taken into account only if you specified invoice number template and didn't specify a template in the payment method edit form
  • doctmpl_invoice - Invoice template. Select an invoice print template
  • numtmpl_invoice - Invoice number template. Invoice number template. You can use the macros {id} - invoice id, and {num} - invoice numerical order. If both macros are not present, the {num} macro will be used
  • nextnum_invoice - Next order number of the invoice. Enter the next order number of the invoice
  • doctmpl_envelope - Envelope template. Template of the envelope
  • doctmpl_reconciliation - Reconciliation report template. Select a reconciliation report template. You can add or edit it in the "Document templates" module. If you do not select a template, your users won't be able to create a reconciliation report
  • sendcostcurrency - Currency . Select currency of the cost of sending documents
  • sendcost - Cost of sending documents . The cost of sending documents by post. The billing system will add a corresponding expense

Registration blocking

Function: blacklist

Result: the list of elements

Registration blacklist

Access level: admin

  • id - Id
  • type - Block type
  • name - Filter

Delete

Function: blacklist.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of blacklist function.

Result: successful operation or error message

Edit a filter for registration blocking

Function: blacklist.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of blacklist function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Type.
  • ip - Network address . Enter a specific IP address or network address in the format x.x.x.x/x or ::/x. You can enter several values space separated
  • domain - Email address domain . Enter a domain name of the mail server with addresses unavailable for registration. You can enter several domain names space separated

Refund rules

Function: refundrule

Result: the list of elements

Refund policy

Access level: admin

  • id - Id
  • name - Name

Rule properties

Function: refundrule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of refundrule function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name for the rule
  • fixedsum - Fee amount. Enter the fixed amount. The amount is fixed in currency of the account from which funds will be withdrawn. The amount of fee when using a fixed amount and percentage will differ depending on the refund rules
  • percent - % from refund. Enter the percent of the refund amount that will be deducted from the client's account as a fee
  • calcorder - Calculate amount of refund. Commission can be calculated as follows: % + amount - percent of the amount will be calculated first and summed up with fixed amount; amount + % - fixed amount will be deducted from the total sum, and percent will be calculated from the remaining amount
  • expensename - Expense name. Enter the name of the expense that will be specified when deducting a fee

Delete

Function: refundrule.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of refundrule function.

Result: successful operation or error message

Mass mailing

Function: notificationlist

Result: the list of elements

Mass mailing

Access level: admin

  • id - Id
  • subject - Heading
  • type - Notification type
  • selectclients - Client segment
  • project - Provider
  • status - Status
  • progress - Progress

Enable automatic mass mailing

Function: notificationlist.resume

Enable automatic mass mailing

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notificationlist function.

Result: successful operation or error message

Move selected notification lists to archive

Function: notificationlist.archive

Move selected notification lists to archive

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notificationlist function.

Result: successful operation or error message

Name

Function: notificationlist.users

Result: the list of elements

Notifications received

Access level: admin

  • name - Name
  • senddate - Date

Add

Function: notificationlist.create

Add

Access level: admin

Name

Function: notificationlist.archived

Result: the list of elements

Archive of notifications

Access level: admin

  • id - Id
  • subject - Heading
  • type - Notification type
  • selectclients - Client segment
  • project - Provider

View archived emails

Function: notificationlist.archived.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of notificationlist function).
    • elid - unique identifier (id element of notificationlist.archived function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of notificationlist function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of notificationlist function).
    • elid - unique identifier (id element of notificationlist.archived function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • selectclients - Client segment. Choose what conditions are to be used to select notification recipients
  • template - Notification template. The email will be based on the selected template
  • lang - User language. Notification will be sent only to clients who set the selected language in their browser
  • subject - Heading. Notification heading
  • summary - Summary . Provide a summary that will be displayed in the list of notifications in BILLmanager 6.
  • message - Notification text. Type in the text to be sent to clients

Delete

Function: notificationlist.archived.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notificationlist.archived function.

Result: successful operation or error message

Edit mass mail

Function: notificationlist.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of notificationlist function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of notificationlist function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • selectclients - Client segment. Choose what conditions are to be used to select notification recipients
  • template - Notification template. The email will be based on the selected template
  • unsubscribed - . (Optional parameter. To enable the option click "on".) Send email to clients who have already unsubscribed from news notifications
  • lang - User language. Notification will be sent only to clients who set the selected language in their browser
  • email_from - Return address. Responses from clients will be sent to this email
  • repeat_period - Repeat delivery. Set period in days to send messages
  • send_now - . (Optional parameter. To enable the option click "on".) Notification will be immediately sent to recipients
  • active - . (Optional parameter. To enable the option click "on".) Select the check box to send notifications automatically
  • check - . (Optional parameter. To enable the option click "on".) Send the notification email to test email address
  • test_email - Test email. Enter the test email address which will be used for receiving the test email
  • subject - Heading. Notification heading
  • summary - Summary . Provide a summary that will be displayed in the list of notifications in BILLmanager 6.
  • message - Notification text. Type in the text to be sent to clients

Name

Function: notificationlist.check

Result: the list of elements

Send to

Access level: admin

  • id - Id
  • name - Name
  • account - Client

Send message

Function: notificationlist.send

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of notificationlist function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of notificationlist function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Disable automatic mass mailing

Function: notificationlist.suspend

Disable automatic mass mailing

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notificationlist function.

Result: successful operation or error message

Delete

Function: notificationlist.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of notificationlist function.

Result: successful operation or error message

Clients

Function: account

Result: the list of elements

Clients

Access level: admin

  • id - Id
  • name - Name
  • project - Provider
  • balance - Account balance
  • account_status - Client status
  • tz_registration_date - Registration date
  • status - Properties

Send a ticket to this client

Function: ticket.write.account

Send a ticket to this client

Access level: admin

Name

Function: account.payment

Result: the list of elements

Payments

Access level: admin

  • id - Id
  • number - Number
  • create_date - Date
  • pay_date - Date
  • sender_name - Payer
  • recipient_name - Recipient
  • project - Provider
  • account_name - Client
  • paymethod_name - Payment method
  • subaccountamount_iso - Amount
  • paymethodamount_iso - Amount in payment currency
  • status - Status

Payment properties

Function: payment.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.payment function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.payment function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • number - Invoice number. Invoice number
  • createdate - Creation date and time. Date and time when the invoice was generated
  • paydate - Payment date. Date when the payment was made or funds were added to the client's account
  • documentnumber - Number of the payment document. Number of the payment document
  • documentdate - Date. Date when the payment document was generated
  • description - Payment details. Enter a purpose of payment
  • sender - Payer. Payer who made the payment
  • subaccountamount - Payment amount. Payment amount added to client's account
  • usedamount - Funds used. The amount that was debited
  • paymethodamount - Amount in payment currency. Amount in the payment system's currency
  • commissionamount - Commission. Commission charged from the client's account while making a payment
  • taxamount_readonly - Tax

. Tax amount

  • status - Payment status. Payment status
  • paymethod - Payment method. Payment method
  • restrictrefund - . (Optional parameter. To enable the option click "on".) Refund of this payment is prohibited
  • info - Payment information. Additional information from the payment system
  • note - Comment. Here you can add information related to this payment

Add funds to the client's account

Function: payment.setpaid

Add funds to the client's account

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.payment function.

Result: successful operation or error message

Send invoice over email

Function: payment.send

Send invoice over email

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.payment function.

Result: successful operation or error message

Set filter.

account.payment.filter

Refund

Function: payment.refund

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.payment function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.payment function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • amount - Refund . Refund amount in payment's currency
  • description - Reason . Reason for refund. This information will be sent to the payment gateway

Name

Function: payment.history

Result: the list of elements

Payment history

Access level: admin

  • changedate - Change date
  • desc - Change
  • user - User
  • ip - IP address
  • action - Function

Show printable information about this payment

Function: payment.print

Show printable information about this payment

Access level: admin

Download this documetn in PDF

Function: payment.print.pdf

Download this documetn in PDF

Access level: admin

Name

Function: payment.expense

Result: the list of elements

Payments associated with the expense

Access level: admin

  • expense - Expense id
  • expense_locale_name - Expense
  • amount_iso - Amount
  • invoice - Invoice id
  • invoice_number - Invoice
Edit

Function: payment.expense.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account.payment function).
    • elid - unique identifier (expense element of payment.expense function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account.payment function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account.payment function).
    • elid - unique identifier (expense element of payment.expense function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • expense - .
  • amount - Amount . Amount that will be deducted from the expense
Delete

Function: payment.expense.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the expense element of payment.expense function.

Result: successful operation or error message

Delete the selected payments. Only "Unpaid" payments can be deleted

Function: payment.delete

Delete the selected payments. Only "Unpaid" payments can be deleted

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.payment function.

Result: successful operation or error message

Add

Function: payment.add

Add

Access level: admin user

Name

Function: payment.orderinfo

Result: the list of elements

Invoice details

Access level: admin

  • id - Id
  • info - Invoice details
  • cost - Price
Edit the invoice

Function: payment.orderinfo.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account.payment function).
    • elid - unique identifier (id element of payment.orderinfo function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account.payment function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account.payment function).
    • elid - unique identifier (id element of payment.orderinfo function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Description. Invoice item description

Send a ticket to the selected client

Function: ticket.write.payment

Send a ticket to the selected client

Access level: admin

Name

Function: account.group

Result: the list of elements

Client groups

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: account.group.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.group function.

Result: successful operation or error message

Suspend

Function: account.group.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.group function.

Result: successful operation or error message

Client accounts

Function: subaccount

Result: the list of elements

Client accounts

Access level: admin

  • id - Id
  • project - Provider
  • balance - Account balance
  • creditlimit - Credit limit
  • status - Status

Edit the selected account

Function: subaccount.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of subaccount function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of subaccount function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • subaccount_project - Provider. Provider associated with this account
  • subaccount_currency - Currency. Currency of this account
  • allowpostpaid - . (Optional parameter. To enable the option click "on".) Select the check box to allow post-paid services for the client
  • creditlimit - Credit limit. Credit limit allows a client to buy services on credit within the amount specified
  • referer - Referred by client. Enter the id of the client who referred this client
  • active - . (Optional parameter. To enable the option click "on".) This account is active. A client may have only one active account registered with a certain provider
  • incident_limit - Incident limit . Total number of support tickets used by the client over the whole period

Suspend

Function: subaccount.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of subaccount function.

Result: successful operation or error message

Issue a refund

Function: subaccount.refund

Issue a refund

Access level: admin

Resume

Function: subaccount.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of subaccount function.

Result: successful operation or error message

Name

Function: account.discount

Result: the list of elements

Discounts

Access level: admin

  • id - Id
  • name - Name
  • actiontype - Discount type
  • project - Provider
  • discount_type - Type
  • period - Period

Add

Function: account.discount.add

Add

Access level: admin

Delete

Function: account.discount.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the idname element of account.discount function.

Result: successful operation or error message

Edit the selected discount

Function: account.discount.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (idname element of account.discount function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (idname element of account.discount function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • fromdate - Start date. First date of the discount
  • todate - End date. Last day of the discount


  • type - Discount type. Select a discount type
  • percentage - Discount. Discount in % on product/service
  • priority - Discount priority. By default, personal discounts have a higher priority than promotion discounts. A negative discount priority will be applied only if no suitable promotion discounts
  • actiontype - Type. Select a discount type. Please note, that discount given on renewal cannot be given on tariff plans with daily charges
  • period - Order periods. This discount will be given on selected periods
  • note - Comment . Comment to discount

Send SMS

Function: account.sms

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of account function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Choose a phone number. Select a type of the phone number to send an sms
  • phone - Phone number. A phone number to which this SMS will be sent
  • message - Message. Message that you want to send

Set a filter by the selected client

Function: account.setfilter

Set a filter by the selected client

Access level: admin

Set filter.

account.filter

Name

Function: account.currencyrate

Result: the list of elements

Currency rate

Access level: admin

  • id - Id
  • currency_base - Currency
  • rate - Currency rate
  • ratedate - Rate date

Currency rate

Function: account.currencyrate.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.currencyrate function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.currencyrate function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • currency_base - Base currency. Select a base currency for conversion
  • currency_relate - Convertible currency. Currency that will be converted to a base currency
  • rate - Currency rate. Currency rate as of the selected date for the selected number of items
  • amount - Amount. Number of items of the base currenct that this currency rate is created for
  • ratedate - Date. Start date of the exchange rate

Delete

Function: account.currencyrate.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.currencyrate function.

Result: successful operation or error message

Name

Function: subaccount.expense

Result: the list of elements

Expenses

Access level: admin

  • id - Id
  • locale_name - Name
  • realdate - Date
  • cdate - Date
  • amount - Amount
  • notpayd - Not paid
  • discountamount - Discount amount
  • payments - Payments
  • discount - Discount id
  • taxamount - Tax

Set filter.

subaccount.expense.filter

Edit the selected expense

Function: subaccount.expense.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of subaccount.expense function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of subaccount.expense function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • subaccount - Provider . Choose a provider
  • item - Service. Select a service
  • operation - Operation. Expense will be generated based on the selected operation
  • amount - Amount. Expense amount
  • taxrate - Tax rate. Tax rate. Note: tax amount is included into expense. Tax amount will be calculated as follows: AMOUNT - (AMOUNT / (100 + RATE) / 100)
  • postpaid - . (Optional parameter. To enable the option click "on".) Select the check box to provide services on credit in case of insufficient funds on client's account
  • name - Name. Enter any name you want to use, otherwise the name will be generated automatically based on the operation selected above
  • realdate - Date. Date when the client was charged for the service
  • cdate - Service activation date. Service activation date

Delete

Function: subaccount.expense.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of subaccount.expense function.

Result: successful operation or error message

Name

Function: account.taxrule

Result: the list of elements

Tax rates

Access level: admin

  • id - Id
  • type - Type
  • project - Provider
  • company - Company
  • country - Payer country
  • taxrate - Tax rate
  • itemtype - Product type

Delete the selected rule

Function: account.taxrule.delete

Delete the selected rule

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.taxrule function.

Result: successful operation or error message

Special rule

Function: account.taxrule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.taxrule function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of account function).
    • elid - unique identifier (id element of account.taxrule function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • project - Provider. Provider name
  • taxrate - Tax rate. Enter a tax rate for the selected country
  • specialitemtype - . (Optional parameter. To enable the option click "on".) Taxes are imposed only on particular product types
  • itemtype - Product types. Select product types to impose a tax

Edit client information

Function: account.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of account function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • email - Email. Enter the email address that a client will use to login to BILLmanager
  • verify_email - . (Optional parameter. To enable the option click "on".)
  • project - Provider. Select a provider this client will be assigned to
  • country - Country. Client country
  • state - Region . Select a region
  • realname - Contact person. Enter a customer name, or company's contact person name
  • name - Name. Enter a client name
  • settingurl - Configuration URL . URL to ISPmanager settings
  • valid_phone - Verified phone number. Enter the verified phone number
  • try_phone - Phone number. Enter the client's phone number
  • label - Label. This information will be available only in filters
  • selfview - Custom namespace . You can change the name servers that are configured for the control panel
  • passwd - . Enter a password to access BILLmanager
  • confirm - Re-enter password.
  • products_page - Page . Page
  • registration_date - Registration date. Registration date
  • registration_ip - Registration IP address. The client was registered from this IP address
  • attitude - Client characteristics. Characteristics of a client. This will help you work with him
  • employee - Staff member. Select a staff member who registered this client
  • nocalcstat - . (Optional parameter. To enable the option click "on".) Client's services won't be shown in statistics
  • note - Comment. You can add any information related to this client
  • notify - . (Optional parameter. To enable the option click "on".) Send the Client registration notification
  • recovery - . (Optional parameter. To enable the option click "on".) Add password reset information into Notifications

Drill down to User panel

Function: account.su

Drill down to User panel

Access level: admin

Delete

Function: account.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account function.

Result: successful operation or error message

Name

Function: account.project

Result: the list of elements

Providers that this client can be assigned to - John Doe (client@example.com)

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: account.project.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.project function.

Result: successful operation or error message

Suspend

Function: account.project.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of account.project function.

Result: successful operation or error message

Client profile

Function: clientoption

Access level: user

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

Providers

Function: project

Result: the list of elements

Providers

Access level: admin

  • id - Id
  • name - Name
  • currency_str - Currency
  • site - Web-site URL
  • billurl - Billing URL

Inventory module settings

Function: project.support

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of project function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • support_require - . (Optional parameter. To enable the option click "on".) Includes usage of paid support tickets
  • new_account_count - For new clients. Number of support incidents that will be added to a newly created client registered with this provider
  • first_payment_count - Number for the first payment . Number of support incidents that will be added when a client makes the first payment
  • first_expense_count - Tickets for first expense . Number of support tickets that will be added after a client is charged for the first time
  • paid_amount_count - Add funds to account balance . Number of support incidents that will be added when making a new payment
  • paid_amount_amount - Amount . Amount
  • support_over_limit - . (Optional parameter. To enable the option click "on".) Select this check box to allow provider's staff to charge support incidents from a client's account on credit. Once exceeding the limit, the client won't be able to submit new tickets unless he pays for extra tickets

Delete

Function: project.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project function.

Result: successful operation or error message

Edit properties of the selected provider

Function: project.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of project function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a provider's name that will be used in notifications, and invoices for clients
  • notifyemail - Email for notifications. Enter the email address to send notifications
  • supportemail - Support email. It is used in notification about activation of user/payer account and password recovery
  • site - Web-site URL. Enter the URL to your web-site. It can be used in notifications for users
  • billurl - Billing URL. Enter the URL to BILLmanager. It can be used in notifications for users
  • clienthelp - Help URL . Enter a URL of the page that will open when a user clicks the "Help" menu. The {lang} macro allows to open different pages depending on user's localization
  • currency - Currencies. Select currency. If you change it, new invoices will be generated in this new currency
  • country_default - Default country . Default country. It will be selected if a country cannot be defined by the saved value or IP address
  • state_default - Default region . Default region. It will be selected if a region cannot be defined by the saved value
  • billmgr6 - . (Optional parameter. To enable the option click "on".) Activate user interface of BILLmanager 6
  • def_billmgr6 - . (Optional parameter. To enable the option click "on".) Set user interface of BILLmanager6 per default
  • disable_orion - . (Optional parameter. To enable the option click "on".) Forbid clients to use the old web-interface
  • disable_banner - . (Optional parameter. To enable the option click "on".) Do not show your customers BILLmanager 6 web-interface notification
  • supportphone - Support phone number . Phone number of technical support department that will be shown to your clients in BILLmanager 6
  • supportphonedesc - Phone number description . Provide description for the phone number in BILLmanager 6
  • head_bill6 - Heading. The code from this field will be added into the HEAD for the client in the new interface theme
  • body_bill6 - Body. The code from this field will be added into the BODY for the client in the new interface theme
  • licenseserverprovider - License server . Provide a license server for ordering control panels for services
  • autoassignitem - . (Optional parameter. To enable the option click "on".) Select the check box to add the selected service for free to a client's account when assigning him to this provider
  • autoassignpricelist - Tariff plan. Tariff associates with the service you want to set up
  • autoassignperiod - Period. Select a period for this service
  • closeaccounts - . (Optional parameter. To enable the option click "on".) Select the check box to close clients' invoices when the period specified above is over
  • period_lenght - Idle time. Set the period that will pass before clinets' invoices are closed
  • period_type - Period . Period
  • description - Expense description. Expense description
  • activeitem - . (Optional parameter. To enable the option click "on".) Select the check box to close clients' inovices even if he has active services
  • ga_counter - Tracking ID. Google Analytics Tracking ID
  • ga_userid - . (Optional parameter. To enable the option click "on".) Send a User ID to Google
  • ga_type - Export type. Export will be based on expenses or services. Based on expenses - information about all clients' expenses will be exported. Based on services - information will be exported per service only once, regardless its expenses
  • ga_trial - . (Optional parameter. To enable the option click "on".) Show information about trial licenses
  • recaptcha_type - reCAPTCHA on the login form . reCAPTCHA settings on the login form for provider
  • recaptcha_publickey - Key. reCAPTCHA public key
  • recaptcha_privatekey - Secret key . reCAPTCHA secret key
  • recaptcha_auth_type - reCAPTCHA on the login form . Configure reCAPTCHA on the login form for provider
  • recaptcha_auth_publickey - Key. reCAPTCHA public key
  • recaptcha_auth_privatekey - Secret key . reCAPTCHA secret key
  • ym_counter - Counter id. Id counter for Yandex.Metrics
  • support_require - . (Optional parameter. To enable the option click "on".) Includes usage of paid support tickets
  • new_account_count - For new clients. Number of support incidents that will be added to a newly created client registered with this provider
  • first_payment_count - Number for the first payment . Number of support incidents that will be added when a client makes the first payment
  • first_expense_count - Tickets for first expense . Number of support tickets that will be added after a client is charged for the first time
  • paid_amount_count - Add funds to account balance . Number of support incidents that will be added when making a new payment
  • paid_amount_amount - Amount . Amount
  • support_over_limit - . (Optional parameter. To enable the option click "on".) Select this check box to allow provider's staff to charge support incidents from a client's account on credit. Once exceeding the limit, the client won't be able to submit new tickets unless he pays for extra tickets

Resume

Function: project.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project function.

Result: successful operation or error message

Name

Function: project.currency

Result: the list of elements

Currencies available to provider

Access level: admin

  • id - Id
  • name - Name
  • iso - ISO
  • status - Status

Suspend

Function: project.currency.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.currency function.

Result: successful operation or error message

Resume

Function: project.currency.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.currency function.

Result: successful operation or error message

Change currency for new clients by default

Function: project.currency.projectdefault

Change currency for new clients by default

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.currency function.

Result: successful operation or error message

Taxes

Function: project.taxrule

Result: the list of elements

Tax rules

Access level: admin

  • id - Id
  • company - Company
  • country - Payer country
  • taxrate - Tax rate
  • itemtype - Product type

Delete the selected rule

Function: project.taxrule.delete

Delete the selected rule

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.taxrule function.

Result: successful operation or error message

Tax settings

Function: project.taxrule.settings

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.taxrule function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.taxrule function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • taxexclusive - . (Optional parameter. To enable the option click "on".) Select this check box to add a tax to product's price. Tax rates limited by company to which payments are made, cannot be used
  • taxcustompay - . (Optional parameter. To enable the option click "on".) Show the tax amount when a client adds funds to his account. This is an obligatory option only for specific countries. Learn tax regulations for your country

Edit the selected rule

Function: project.taxrule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.taxrule function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.taxrule function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • company - Company.
  • country - Payer country. Select a country. A newly created tax rule will be applied to payers from this country
  • state - State/province. If a two-layer tax system is used, you can add a federal (all) tax and state tax, which will be summed up
  • taxrate - Tax rate. Enter a tax rate for the selected country
  • specialitemtype - . (Optional parameter. To enable the option click "on".) Taxes are imposed only on particular product types
  • itemtype - Product types. Select product types to impose a tax

Suspend

Function: project.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project function.

Result: successful operation or error message

Group

Function: project.group

Result: the list of elements

Groups of providers

Access level: admin

  • id - Id
  • name - Group
  • status - Status

Group editing

Function: project.group.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.group function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.group function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • allow_same_phone - . (Optional parameter. To enable the option click "on".) Select this option to allow clients to specify the same phone number for verification on different accounts

Group deletion

Function: project.group.delete

Group deletion

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.group function.

Result: successful operation or error message

Suspend

Function: project.group.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.group function.

Result: successful operation or error message

Inventory module settings

Function: project.group.resume_ext

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.group function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.group function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Name

Function: project.company

Result: the list of elements

Processing companies

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: project.company.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.company function.

Result: successful operation or error message

Suspend

Function: project.company.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.company function.

Result: successful operation or error message

Provider and company configuration

Function: project.company.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.company function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.company function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • payment_description - Purpose of advance payment. Enter the purpose of default advance payment that will be displayed in the list of payments

Name servers

Function: project.nsprovider

Result: the list of elements

Name server provider

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Delete

Function: project.nsprovider.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.nsprovider function.

Result: successful operation or error message

Suspend

Function: project.nsprovider.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.nsprovider function.

Result: successful operation or error message

Edit the name server provider

Function: project.nsprovider.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.nsprovider function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of project function).
    • elid - unique identifier (id element of project.nsprovider function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Name of the name server provider

Resume

Function: project.nsprovider.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of project.nsprovider function.

Result: successful operation or error message

Name

Function: project.itemtype

Result: the list of elements

Product types

Access level: admin

  • name - Name
  • orderpriority - Priority

Move the selected product type one line up

Function: project.itemtype.up

Move the selected product type one line up

Access level: admin

Move the selected product type one line down

Function: project.itemtype.down

Move the selected product type one line down

Access level: admin

Client segments

Function: selectclients

Result: the list of elements

Client segments

Access level: admin

  • id - Id
  • name - Name
  • project - Provider

Name

Function: selectclients.try

Result: the list of elements

Check filter

Access level: admin

  • id - Id
  • name - Name

Name

Function: selectclients.archived

Result: the list of elements

Client segments archive

Access level: admin

  • id - Id
  • name - Name
  • project - Provider

Name

Function: selectclients.rule

Result: the list of elements

Rules

Access level: admin

  • id - Id
  • rule - Rule
  • rulegroup - Group
Add

Function: selectclients.rule.add

Add

Access level: admin

Delete

Function: selectclients.rule.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selectclients.rule function.

Result: successful operation or error message

Edit the selected rule

Function: selectclients.rule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of selectclients.archived function).
    • elid - unique identifier (id element of selectclients.rule function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of selectclients.archived function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of selectclients.archived function).
    • elid - unique identifier (id element of selectclients.rule function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Move the selected segments into Archive

Function: selectclients.archive

Move the selected segments into Archive

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selectclients function.

Result: successful operation or error message

Client segment

Function: selectclients.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of selectclients function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • project - Provider. Select a service provider

Delete

Function: selectclients.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of selectclients function.

Result: successful operation or error message

Set filter.

selectclients.filter

Notification settings

Function: mainsubscribe

Result: the list of elements

Notification settings

Access level: user

  • type - Type

Name

Function: subscribe

Result: the list of elements

Notification settings

Access level: user

  • notice - Type
  • status - Status

Suspend

Function: subscribe.suspend

Suspend

Access level: user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the notice_id element of subscribe function.

Result: successful operation or error message

Resume

Function: subscribe.resume

Resume

Access level: user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the notice_id element of subscribe function.

Result: successful operation or error message

Upload payments

Function: paymentupload

Result: the list of elements

Upload payments

Access level: admin

  • id - Id
  • ppid - Payment order number
  • ppdate - Payment order date
  • recipient - Recipient
  • sender - Payer
  • amount - Amount
  • payment - Payment
  • cnum - Invoice number
  • cstate - Status

Upload payments

Function: paymentupload.load

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paymentupload function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • ignoreinn - Ignore payments from payers with the following INN . Enter the INN of the payers you want to exclude

Delete

Function: paymentupload.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymentupload function.

Result: successful operation or error message

Drill down to User panel

Function: paymentupload.su

Drill down to User panel

Access level: admin

Payer

Function: paymentupload.profile

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paymentupload function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Credit the payment that was found by uploaded data

Function: paymentupload.setpaid

Credit the payment that was found by uploaded data

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymentupload function.

Result: successful operation or error message

Set filter by the client associated with this payment order

Function: paymentupload.setfilter

Set filter by the client associated with this payment order

Access level: admin

Inventory module settings

Function: paymentupload.payment

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paymentupload function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Payment order

Function: paymentupload.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paymentupload function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Set filter.

paymentupload.filter

IP addresses report

Function: report.mvd

Access level: admin

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

  • statdate - Date. Date
  • ip_or_domain - Data type. Search by IP address or Domain name
  • ip - IP address. Enter the IP address
  • domain - Domain. Enter a domain to search

Auto payment

Function: payment.recurring.settings

Access level: user

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

Currencies

Function: currency

Result: the list of elements

Currencies

Access level: admin

  • id - Id
  • name - Name
  • iso - ISO code
  • code - ISO number
  • status - Status

Name

Function: currency.relate

Result: the list of elements

Exchange rates

Access level: admin

  • relate - Name
  • iso - Code
  • ratedate - Last update
  • rate - Current rate
  • status - Upload currencies automatically

Name

Function: currencyrate

Result: the list of elements

Exchange rates

Access level: admin

  • id - Id
  • ratedate - Date
  • rate - Rate
Currency rate

Function: currencyrate.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of currency.relate function).
    • elid - unique identifier (id element of currencyrate function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of currency.relate function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of currency.relate function).
    • elid - unique identifier (id element of currencyrate function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • ratedate - Date. Start date of the exchange rate
  • amount - Number. Number of items of the base currency
  • rate - Rate. Set the exchange rate for the date and units provided above
Delete

Function: currencyrate.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currencyrate function.

Result: successful operation or error message

Upload exchange rate

Function: currencyrate.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of currency.relate function).
    • elid - unique identifier (id element of currencyrate function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of currency.relate function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of currency.relate function).
    • elid - unique identifier (id element of currencyrate function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • autoupload - . (Optional parameter. To enable the option click "on".) Exchange rate will be uploaded automatically
  • autotime - Upload time. Enter the upload time (hh:mm). A cron job will start every day at this time to update exchange rates
  • upload - . (Optional parameter. To enable the option click "on".) Update exchange rates with parameters specified below
  • multi - Correction factor . Multiply the uploaded currency rate by the value from this field
  • sum - Increase by. Increase the uploaded currency rate by the value from this field
  • fromdate - Start date. Upload data starting from the selected date. Otherwise data will be uploaded from the last update date
  • rewrite - . (Optional parameter. To enable the option click "on".) Select the check box to overwrite the data saved in the system if the same date is used

Resume

Function: currency.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currency function.

Result: successful operation or error message

Edit the selected currency

Function: currency.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of currency function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a currency name
  • iso - ISO code. ISO code
  • symbol - Symbol . UTF symbol of the currency
  • code - ISO number. ISO number

Suspend

Function: currency.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currency function.

Result: successful operation or error message

Update exchange rates

Function: currency.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of currency function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Delete

Function: currency.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of currency function.

Result: successful operation or error message

Paremeters group

Function: paramgroup

Result: the list of elements

Paremeters group

Access level: admin

  • id - Id
  • name - Name
  • intname - Internal name
  • orderpriority - Sort

Move the selected product type one position up

Function: paramgroup.up

Move the selected product type one position up

Access level: admin

Move the selected product type one position down

Function: paramgroup.down

Move the selected product type one position down

Access level: admin

Editing a group of parameters

Function: paramgroup.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paramgroup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Parameter group name
  • intname - Internal name . A group name (internal). Used for its identification
  • orderpriority - Sort. Set priority for this product type (count forward)

Delete

Function: paramgroup.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paramgroup function.

Result: successful operation or error message

FAQ

Function: faqgroup

Result: the list of elements

FAQ groups

Access level: admin

  • id - Id
  • name - Name

Name

Function: faq

Result: the list of elements

FAQ

Access level: admin

  • id - Id
  • subject - Heading
  • location - Location
  • project - Provider
  • orderpriority - Sort

Edit the question

Function: faq.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of faqgroup function).
    • elid - unique identifier (id element of faq function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of faqgroup function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of faqgroup function).
    • elid - unique identifier (id element of faq function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • creation - Create question .
  • copyfrom - Copy from.
  • project - Provider . Provider name
  • language - Language. FAQ will be displayed only to clients with the selected language in the session
  • location - Location. Location
  • orderpriority - Sort. Set the priority
  • subject - .
  • type - Response type . Enter response in the form of a text or link
  • text - Text.
  • link - Link. Link to response

Move one line up

Function: faq.up

Move one line up

Access level: admin

Delete

Function: faq.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of faq function.

Result: successful operation or error message

Move one line down

Function: faq.down

Move one line down

Access level: admin

Tickets archive

Function: clientticket_archive

Result: the list of elements

Tickets archive

Access level: user

  • id - Id
  • name - Subject
  • last_message - Last updated
  • create_user - Author
  • props - Properties

Ticket

Function: clientticket_archive.edit

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of clientticket_archive function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of clientticket_archive function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Subject. The ticket subject contains a brief description of the support ticket
  • ticket_item - Service. Select a service related to your question
  • ticket_project_select - Provider. Select a provider associated with the ticket
  • client_department - Department. Select the provider's department to assign the ticket
  • item - Service. Select a service related to your question
  • client_priority - Priority. Ticket priority
  • priority - Priority. Ticket priority
  • message - .
  • show_optional - . (Optional parameter. To enable the option click "on".) Show additional configuration options for this ticket
  • note_message - .
  • ticket_expense - Support fee . Amount that will be charged from the client's account
  • high_priority - . (Optional parameter. To enable the option click "on".) Place the ticket to the to of the queue
  • low_priority - . (Optional parameter. To enable the option click "on".) Raised priority will be reset for this ticket
  • incident_count - .
  • show_abuse - . (Optional parameter. To enable the option click "on".) Show abuse registration parameters
  • score - Number of scores . Number of abuse scores
  • action - Function.
  • deadline_date - .
  • deadline_time - .
  • score_note - Comment. Enter additional information

Set filter.

clientticket_archive.filter

Dedicated servers

Function: dedic

Result: the list of elements

Dedicated servers

Access level: admin user

  • domain - Domain name
  • ip - IP address
  • ostempl - OS template
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Drill down to User panel

Function: dedic.su

Drill down to User panel

Access level: admin

Set filter.

dedic.filter

Suspend

Function: dedic.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dedic function.

Result: successful operation or error message

Service activation

Function: dedic.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of dedic function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Order a new service

Function: dedic.order

Order a new service

Access level: user

Set a filter by the selected client

Function: dedic.setfilter

Set a filter by the selected client

Access level: admin

Resume

Function: dedic.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dedic function.

Result: successful operation or error message

Edit properties of the selected service

Function: dedic.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of dedic function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Delete the selected services

Function: dedic.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of dedic function.

Result: successful operation or error message

FTP storage

Function: storage

Result: the list of elements

External FTP-storage

Access level: admin user

  • addr - FTP-server
  • processingnode - Cluster node
  • user - User
  • quota - Disk (MiB)
  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg -
  • item_status -
  • cost - Price

Drill down to User panel

Function: storage.su

Drill down to User panel

Access level: admin

Delete the selected services

Function: storage.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of storage function.

Result: successful operation or error message

Service activation

Function: storage.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of storage function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module for this service

Order a new service

Function: storage.order

Order a new service

Access level: user

Resume

Function: storage.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of storage function.

Result: successful operation or error message

Set filter.

storage.filter

Edit properties of the selected service

Function: storage.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of storage function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".)
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Suspend

Function: storage.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of storage function.

Result: successful operation or error message

Set a filter by the selected client

Function: storage.setfilter

Set a filter by the selected client

Access level: admin

Client groups

Function: accountgroup

Result: the list of elements

Client groups

Access level: admin

  • id - Id
  • name - Name
  • props - Parameters

Delete

Function: accountgroup.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of accountgroup function.

Result: successful operation or error message

Client

Function: accountgroup.account

Result: the list of elements

Inventory module settings

Access level: admin

  • id - Id
  • name - Client
  • status - Status

Resume

Function: accountgroup.account.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of accountgroup.account function.

Result: successful operation or error message

Set filter.

accountgroup.account.filter

Suspend

Function: accountgroup.account.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of accountgroup.account function.

Result: successful operation or error message

Tariff plan

Function: accountgroup.pricelist

Result: the list of elements

Inventory module settings

Access level: admin

  • id - Id
  • name - Tariff plan
  • status - Status

Set filter.

accountgroup.pricelist.filter

Resume

Function: accountgroup.pricelist.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of accountgroup.pricelist function.

Result: successful operation or error message

Suspend

Function: accountgroup.pricelist.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of accountgroup.pricelist function.

Result: successful operation or error message

Inventory module settings

Function: accountgroup.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of accountgroup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name for the group
  • allowsuspenditem - . (Optional parameter. To enable the option click "on".) Select the check box to allow users of this group to suspend and activate their services
  • allowdeleteitem - . (Optional parameter. To enable the option click "on".) Select the check box to allow users of this group to delete their services
  • ignoreitemmax - . (Optional parameter. To enable the option click "on".) Select the check box to allow group members to order any number of services regardless their tariff plan settings
  • ignoreabuserate - . (Optional parameter. To enable the option click "on".) Select the check box to apply fines to members of this group

Username

Function: accountgroup.condition

Result: the list of elements

Conditions

Access level: admin

  • id - Id
  • condition - Condition
  • conditiongroup - Group

Condition to assign a client to group automatically

Function: accountgroup.condition.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of accountgroup function).
    • elid - unique identifier (id element of accountgroup.condition function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of accountgroup function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of accountgroup function).
    • elid - unique identifier (id element of accountgroup.condition function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • comparison - Comparison . Comparison condition
  • country_select - Countries . List of countries
  • country_geoip_select - Countries . List of countries
  • project_select - Provider . Provider that was connected during registration
  • social_network_select - Social network . The client got registered via this social network
  • param - Parameter name . Parameter name in the client's registration request
  • value - Value . Value for the above parameter
  • type - Type. Condition type
  • group - Group of conditions . Conditions in this group will be combined by the OR operator. Groups are combined by the AND operator. For example: A, B, and C operators can be combined into one group. D and E operators are combined into the second group. The result will be as follows: (A OR B OR С) AND (D OR E)
  • groupname - Group name . Enter the name of the conditions group

Delete

Function: accountgroup.condition.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of accountgroup.condition function.

Result: successful operation or error message

Departments

Function: department

Result: the list of elements

Departments

Access level: admin

  • id - Id
  • locale_name - Name
  • orderpriority - Sort
  • status - Status

Staff member

Function: department.employee

Result: the list of elements

Staff members

Access level: admin

  • id - Id
  • employee - Staff member
  • realname - Full name
  • status - Status

Unassign this staff member from the department

Function: department.employee.suspend

Unassign this staff member from the department

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of department.employee function.

Result: successful operation or error message

Assign this member into the selected department

Function: department.employee.resume

Assign this member into the selected department

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of department.employee function.

Result: successful operation or error message

Create a task

Function: task.simple.create

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of department function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • specification - Description. Describe this task

Name

Function: department.rights

Result: the list of elements

Rights

Access level: admin

  • access - Access
  • caption - Name
  • access - Access

Partial access is given to the list elements. Set the list filter. Excluded records will be unavailable

Function: department.rights.hardfilter

Partial access is given to the list elements. Set the list filter. Excluded records will be unavailable

Access level: admin

Set filter.

department.rights.filter

Resume

Function: department.rights.resume

Resume

Access level: admin

Suspend

Function: department.rights.suspend

Suspend

Access level: admin

Move the selected department one line up

Function: department.up

Move the selected department one line up

Access level: admin

Delete

Function: department.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of department function.

Result: successful operation or error message

Move the selected department one line down

Function: department.down

Move the selected department one line down

Access level: admin

Edit properties of the selected department

Function: department.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of department function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name for the department
  • working_plan - Business hours. Enter business hours. If not specified, the department works 24х7
  • support_department - . (Optional parameter. To enable the option click "on".) Clients can select this department when submitting a new support ticket
  • language - Task localization . Select localization that will be used for generating messages for members of this department
  • project - Available to clients of the selected provider. Clients of the selected provider can choose this department when submitting a trouble ticket
  • head - Head of department. Head of the technical support department
  • realname - Ticket category description. This name will be shown to clients when submitting a new ticket
  • orderpriority - Sort. Department priority in the ticket creation form
  • support_require - . (Optional parameter. To enable the option click "on".) This option enables automatic ticket charging from clients during sending the ticket to other department. If there are no tickets left and it's impossible to purchase them, department will not be shown in the list

Set filter.

department.filter

Discounts

Function: account.discountinfo

Result: the list of elements

Discount information

Access level: user

  • id - Id
  • name - Name
  • value - Discount amount / special price
  • actiontype - Discount type
  • discount_type - Type
  • period - Period

Running operations

Function: runningoperation

Result: the list of elements

Running operations

Access level: admin

  • id - Id
  • desc - Description
  • item - Product/service
  • itemtype - Product type
  • client - Client
  • cdate - Creation date
  • trycount - Attempts
  • processingmodule - Processing module
  • task - Task
  • status - Status

Create a task for the current operation

Function: runningoperation.taskcreate

Create a task for the current operation

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of runningoperation function.

Result: successful operation or error message

Name

Function: runningoperation.errorhistory

Result: the list of elements

Operation history

Access level: admin

  • id - Id
  • createdate - Date
  • item - Service
  • task - Task

View the error log

Function: errorhistory.showlog

View the error log

Access level: admin

Set filter.

runningoperation.filter

Running operations

Function: runningoperation.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of runningoperation function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of runningoperation function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • intname - Operation type. Operation type
  • item - Product/service. newmsg
  • trycount - Attempts. Number of attempts
  • cdate - Creation date. Operation creation time
  • manual - . (Optional parameter. To enable the option click "on".) Disable automatic restart of the scheduled task
  • comment - Comment. A staff member can leave his comment here

Delete

Function: runningoperation.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of runningoperation function.

Result: successful operation or error message

Terminate the operation

Function: runningoperation.stop

Terminate the operation

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of runningoperation function.

Result: successful operation or error message

Set a filter by the selected client

Function: runningoperation.setfilter

Set a filter by the selected client

Access level: admin

Run the selected operation

Function: runningoperation.start

Run the selected operation

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of runningoperation function.

Result: successful operation or error message

Open the control panel

Function: runningoperationgotoserver

Open the control panel

Access level: admin

Drill down to User panel

Function: runningoperation.su

Drill down to User panel

Access level: admin

Backup

Function: billmgr.backup

Result: the list of elements

Backup configuration

Access level: admin

  • id - Id
  • date - Date
  • size - Size, MiB

Start the backup process

Function: billmgr.backup.create

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Download the backup copy to your local machine

Function: backups.download

Download the backup copy to your local machine

Access level: admin

Restore

Function: backups.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • behavior - Behavior. Select how you want to restore data from the backup.
    • Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.

E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.


Add a storage and backup plan

Function: billmgr.backup.setup

Add a storage and backup plan

Access level: admin

Backup archives

Function: backupdata

Result: the list of elements

Saved data

Access level: admin

  • type - Data type

Data name

Function: backupdata.names

Result: the list of elements

Data included into backup copy

Access level: admin

  • name - Data name
  • owner - Owner
Restore

Function: backupdata.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of backupdata function).
    • elid - unique identifier (id element of backupdata.names function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of backupdata function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of backupdata function).
    • elid - unique identifier (id element of backupdata.names function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • version - Version. Select a backup date
  • behavior - Behavior. Select how you want to restore data from the backup.
    • Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.

E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.


Name

Function: backupdata.files

Result: the list of elements

Files

Access level: admin

  • dname - Name
Restore

Function: backupdata.files.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of backupdata.names function).
    • elid - unique identifier (name element of backupdata.files function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of backupdata.names function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of backupdata.names function).
    • elid - unique identifier (name element of backupdata.files function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • version - Version. Select a backup date

Upload the backup copy

Function: backups.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Upload type. Select the upload type you want to use. You can upload files from your local computer or from a remote server. The files will be stored into the current folder.
  • name - File name. Enter the name of the file you want to upload. If you leave this field blank, the file name will be extracted from the URL.
  • storage - Storage. Select a storage for the backup copy

Delete the backup copy

Function: backups.delete

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • clean_storages - . (Optional parameter. To enable the option click "on".) Select if you want to delete archives and listings from the storages

Inventory module settings

Function: billmgr.backup.settings

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of billmgr.backup function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • dropsettings - . (Optional parameter. To enable the option click "on".) Backup settings and information about backup copies will be deleted. Data from storages won't be deleted

Payers

Function: profile

Result: the list of elements

Payers

Access level: admin user

  • id - Id
  • name - Name
  • account - Client
  • profiletype - Payer status

Payer

Function: profile.docflow_counteragent

Result: the list of elements

Connecting to document flows

Access level: admin user

  • id - Id
  • company - Company
  • module - Document flow
  • status - Status

Resume

Function: profile.docflow_counteragent.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of profile.docflow_counteragent function.

Result: successful operation or error message

Suspend

Function: profile.docflow_counteragent.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of profile.docflow_counteragent function.

Result: successful operation or error message

Name

Function: profile.company

Result: the list of elements

Payer companies

Access level: admin user

  • id - Id
  • name - Name
  • status - Status

Resume

Function: profile.company.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of profile.company function.

Result: successful operation or error message

Suspend

Function: profile.company.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of profile.company function.

Result: successful operation or error message

Search a payer in the document management system and check if it is assigned to companies

Function: profile.docflow

Search a payer in the document management system and check if it is assigned to companies

Access level: admin+

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of profile function.

Result: successful operation or error message

Send a ticket to the selected client

Function: ticket.write.profile

Send a ticket to the selected client

Access level: admin

Add

Function: profile.add

Add

Access level: user

Print envelope

Function: envelope.print

Print envelope

Access level: admin user

Drill down to User panel

Function: profile.su

Drill down to User panel

Access level: admin

Set a filter by the selected client

Function: profile.setfilter

Set a filter by the selected client

Access level: admin

Edit properties of the selected payer

Function: profile.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of profile function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • profiletype - Payer status. Select a payer status
  • name - Name. Enter a company name
  • person - Contact person. Enter the name of the contact person
  • phone - Phone number. Enter the phone number
  • fax - Fax. Enter the fax number
  • email - Email. Enter the company's email
  • maildocs - Receive documents. Select how to obtain originals of financial documents
  • docflow_box - Box (__company__). Box for incoming documents (__company__)
  • docflow_department - Department (__company__). Select departments for incoming documents (__company__)
  • document_type - Document type . Select a type of documents that will be sent via the electronic document flow
  • id1c - Code in accounting system . Enter the id to integrate with the accounting system
  • invoicetype - Generation type. Select how the system will generate reconciliation reports
  • postcompany - Invoice company . Company that will be specified in the invoice
  • postcurrency - Invoice currency . Invoice currency. If a client has unpaid expenses for which the invoice has been already generated, an advance payment can be made only by the company associated with that invoice and only in the invoice currency
  • invoicedesc - Service description. Enter any information related to the sevices.
  • payment_description - Purpose of advance payment. Enter a purpose of advance payments
  • note - Comment. Comment to payer
  • wrongaddress - . (Optional parameter. To enable the option click "on".) This means that mail was returned to this payer. We do not recommend sending documents to such payers
  • returnreason - Reason . Enter a reason why mail was returned
  • country_legal - Country. Select a contry where the company is registered
  • state_legal - Region . Region where the company is registered
  • postcode_legal - ZIP code. Enter the zip code of the company's registration address
  • city_legal - City. Enter the city where the company is registered
  • address_legal - Address. Enter address where the company is registered (including the street, building and office)
  • legaleqphysical - . (Optional parameter. To enable the option click "on".) The option includes saving registred address in accordance with legal address
  • country_physical - Country. Select a country where the company is located
  • state_physical - Region . Region where the company is located
  • postcode_physical - ZIP code. Enter the zip code of the city where this company is located
  • city_physical - City. Enter the city where the company is located
  • address_physical - Address. Enter address where the company is located (including the street, building and office)

Delete

Function: profile.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of profile function.

Result: successful operation or error message

Name

Function: profile.history

Result: the list of elements

Payer parameters change history

Access level: admin user

  • changedate - Change date
  • desc - Description
  • user - User
  • ip - IP address
  • action - Function

Set filter.

profile.filter

Fixed prices

Function: tool.fixedprices

Result: the list of elements

Fixed prices

Access level: admin

  • id - Id
  • project - Provider
  • pricelist - Tariff plan
  • fixdate - Date
  • itemcount - Number of services

Delete

Function: tool.fixedprices.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of tool.fixedprices function.

Result: successful operation or error message

Name

Function: tool.fixedprices.detail

Result: the list of elements

Service prices

Access level: admin

  • id - Id
  • name - Name

Service price

Function: tool.fixedprices.detail.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of tool.fixedprices function).
    • elid - unique identifier (id element of tool.fixedprices.detail function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of tool.fixedprices function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of tool.fixedprices function).
    • elid - unique identifier (id element of tool.fixedprices.detail function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Create

Function: tool.fixedprices.add

Create

Access level: admin

Fixed price

Function: tool.fixedprices.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of tool.fixedprices function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of tool.fixedprices function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Name

Function: tool.fixedprices.item

Result: the list of elements

Fixed prices can be set for the following services

Access level: admin

  • id - Id
  • name - Name
  • itemtype - Product type
  • account_name - Owner

Set a filter by the selected client

Function: tool.fixedprices.item.setfilter

Set a filter by the selected client

Access level: admin

Drill down to User panel

Function: tool.fixedprices.item.su

Drill down to User panel

Access level: admin

Cancel fixed prices for the selected prices

Function: tool.fixedprices.item.delete

Cancel fixed prices for the selected prices

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of tool.fixedprices.item function.

Result: successful operation or error message

ISPsystem partners

Function: hostingpartner

Result: the list of elements

ISPsystem hosting-partners

Access level: admin

  • id - Id
  • name - Name
  • brand - Brand
  • level - Level

Edit the selected hosting-partner

Function: hostingpartner.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of hostingpartner function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • account - Client . ISPsystem client
  • level - Level. Select a level of hosting-partner
  • set_autogroup - . (Optional parameter. To enable the option click "on".) Schedule change of the level
  • autogroup - New level. New level that will be set on the selected day
  • autogroup_date - Date . Select a date when the level will be changed
  • minimal_paymentamount - Minimum payment . Minimum amount of expenses on partner licenses per month
  • creditlimit - Credit limit. Client's credit limit
  • licurl - Partner's site URL . Enter the web-site URL where your clients can order licenses
  • free_ipchange - . (Optional parameter. To enable the option click "on".) Allow free IP change
  • auto_purchase - . (Optional parameter. To enable the option click "on".) Allow auto purchases
  • incidentcount - Add support incidents. Number of technical support incidents you want to add
  • eur_rate - Special rate (EUR). EUR to RUB exchange rate
  • iprange - IP address range. Enter the range of IP addresses
  • brand - Brand. Enter a brand name
  • domainsource - Domains source. Domains source
  • billmgrurl - URL for plug-ins order. URL to BILLmanager 5 API to order plug-ins for licenses
  • islandingpage - . (Optional parameter. To enable the option click "on".) This URL is a landing page
  • sshkey - SSH key. SSH key

Delete

Function: hostingpartner.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of hostingpartner function.

Result: successful operation or error message

Drill down to User panel

Function: hostingpartner.su

Drill down to User panel

Access level: admin

Set a filter by the selected client

Function: hostingpartner.setfilter

Set a filter by the selected client

Access level: admin

You can specify selection criteria for this list. They will be applied every time the list is displayed until the filter is removed or modified

Function: hostingpartner.filter

You can specify selection criteria for this list. They will be applied every time the list is displayed until the filter is removed or modified

Access level: admin

Payment methods

Function: paymethod

Result: the list of elements

Payment methods

Access level: admin

  • id - Id
  • name - Name
  • module - Payment gateways
  • currency_name - Currency
  • projects - Providers
  • companies - Companies
  • note - Comment
  • orderpriority - Sorting (count forward)
  • status - Status

Set filter.

paymethod.filter

Move the selected payment order one line up

Function: paymethod.up

Move the selected payment order one line up

Access level: admin

Add

Function: paymethod.add

Add

Access level: admin

Move the selected payment order one line down

Function: paymethod.down

Move the selected payment order one line down

Access level: admin

Resume

Function: paymethod.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod function.

Result: successful operation or error message

Payment method settings

Function: paymethod.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of paymethod function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter the name for the payment method
  • minamount - Minimum payment amount. Enter the minimum payment amount for the selected payment method
  • maxamount - Maximum payment amount. Enter the maximum payment amount that can be made with this payment method
  • commissionamount - Fixed amount . This fixed amount will be debited from client's account after the payment is effected
  • commissionpercent - Commission % . Commission in % that will be debited from client's account after the payment is effected
  • doctmpl - Print template. Select a template for printing the document. If it is not specified, the one from the company edit form will be used
  • numtmpl_payment - Invoice number template. In the invoice template you can use the following macros: {id} - payment id and {num} - number of the payment generated with this payment method. If these macros are not present, the {num} macros will be added to the invoice template number
  • nextnum_payment - Next numerical number of the invoice. Next numerical order of the invoice that was created with this payment method. It is taken into account provided that invoice number template is specified
  • payment_description - Purpose of advance payment. Name of the advance payment in the Payments module
  • autoclearperiod - Period to delete due invoices. Period in days since the payment creation date, that will pass before a due payment will be deleted
  • orderpriority - Sorting (count forward). Set priority for the selected payment method
  • successpage - Successful payment return page. A payer will be redirected to this page if his payment is processed successfully
  • failpage - Failed payment return page . A payer will be redirected to this page if his payment fails
  • pendingpage - Pending payment return page. A payer will be redirected to this page if his automatic payment is pending.
  • note - Comment . Add your comment to the payment method
  • profiletype - Payer status. This payment method will be available to payers with the selected status
  • accountgroup - Client groups. Select the check box to allow users from the selected group to use this payment module
  • deny_accountgroup - Forbid for client groups . Enables to forbid clients from the selected groups to use this payment method
  • language - Client language. This payment method will be available if the interface language matches of the selected languages. If the language is not selected, this payment method will be available азк all languages
  • recurring - . (Optional parameter. To enable the option click "on".) Enable recurrent payments
  • successpage_recurring - Successful autopayment return page. A payer will be redirected to this page if his automatic payment is processed successfully
  • failpage_recurring - Failed automatic payment return page . A payer will be redirected to this page if his automatic payment fails
  • pendingpage_recurring - Pending automatic payment return page. A payer will be redirected to this page if his payment is pending.
  • successpage_subscription - .
  • failpage_subscription - .
  • pendingpage_subscription - .
  • allowrefund - . (Optional parameter. To enable the option click "on".) Allow full or partial refunds using the selected payment method
  • description_markdown - Payment method description (markdown).
  • description - Payment method description . Description of the service method will be available to clients on the first payment step. You can use HTML

Name

Function: paymethod.company

Result: the list of elements

Activate the payment method for companies

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: paymethod.company.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.company function.

Result: successful operation or error message

Suspend

Function: paymethod.company.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.company function.

Result: successful operation or error message

Delete

Function: paymethod.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod function.

Result: successful operation or error message

Name

Function: paymethod.project

Result: the list of elements

Activate this payment method for providers - wire transfer

Access level: admin

  • id - Id
  • name - Name
  • status - Status

Resume

Function: paymethod.project.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.project function.

Result: successful operation or error message

Suspend

Function: paymethod.project.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod.project function.

Result: successful operation or error message

Suspend

Function: paymethod.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of paymethod function.

Result: successful operation or error message

Notifications

Function: problems

Result: the list of elements

Notifications

Access level: user

Drill down to User panel

Function: problems.su

Drill down to User panel

Access level: user

Set a filter by the selected client

Function: problems.setfilter

Set a filter by the selected client

Access level: admin

Cart

Function: basket

Access level: 8 user

The function is simultaneously used to view and change form's data

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

Users

Function: user

Result: the list of elements

Users

Access level: admin user

  • id - Id
  • name - Username
  • realname - Full name
  • email - Email
  • account - Client
  • status - Status

Set filter.

user.filter

Send a ticket to the selected client

Function: ticket.write.user

Send a ticket to the selected client

Access level: admin

Set a filter by the selected client

Function: user.setfilter

Set a filter by the selected client

Access level: admin

The username has been changed from "__old_value__" into "__new_value__"

Function: user.history

Result: the list of elements

User parameters change history

Access level: admin user

  • changedate - Change date
  • desc - Description
  • user - User
  • ip - IP address
  • action - Function

Suspend

Function: user.suspend

Suspend

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of user function.

Result: successful operation or error message

Delete

Function: user.delete

Delete

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of user function.

Result: successful operation or error message

Send SMS

Function: user.sms

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of user function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • type - Choose a phone number. Select a type of the phone number to send an sms
  • phone - Phone number. A phone number to which this SMS will be sent
  • message - Message. Message that you want to send

Drill down to User panel

Function: user.su

Drill down to User panel

Access level: admin

Resume

Function: user.resume

Resume

Access level: admin user

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of user function.

Result: successful operation or error message

Function: advertisement

Result: the list of elements

Banner ads

Access level: admin

  • id - Id
  • name - Name
  • selectclients - Client segment
  • project - Provider
  • weight - Weight
  • state - Status

Edit properties of the selected ad

Function: advertisement.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of advertisement function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a name for this payment method
  • project - Provider. The ad will be displayed only to clients of the selected provider
  • language - Language. The ad will be displayed only to users with this interface language. If no languages are selected, the ad will be shown to all clients
  • weight - Weight. Weight determines how often this banner will be shown
  • url - Banner address . Enter the banner URL
  • selectclients - Client segment. Only selected clients will see this promotion

Delete

Function: advertisement.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of advertisement function.

Result: successful operation or error message

Suspend

Function: advertisement.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of advertisement function.

Result: successful operation or error message

Resume

Function: advertisement.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of advertisement function.

Result: successful operation or error message

Payments

Function: payment

Result: the list of elements

Payments

Access level: admin user

  • id - Id
  • number - Number
  • create_date - Date
  • pay_date - Date
  • sender_name - Payer
  • recipient_name - Recipient
  • project - Provider
  • account_name - Client
  • paymethod_name - Payment method
  • subaccountamount_iso - Amount
  • paymethodamount_iso - Amount in payment currency
  • status - Status

Set a filter by the selected client

Function: payment.setfilter

Set a filter by the selected client

Access level: admin

Set filter.

payment.filter

Payment

Function: payment.add.redirect

Access level: user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of payment function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • amount_currency - Payment amount. Total

Drill down to User panel

Function: payment.su

Drill down to User panel

Access level: admin user

Top-level domains

Function: tld

Result: the list of elements

Top-level domains

Access level: admin

  • id - Id
  • name - Name

Delete

Function: tld.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of tld function.

Result: successful operation or error message

Top-level domain

Function: tld.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of tld function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • name - Name. Enter a TLD name
  • whois_host - Whois host. Domain name of the service that enables to get the information about domains
  • whois_find_string - Whois string. The domain will be considered available for order if the string specified is found
  • whois_timeout - Request timeout . Here you can set the Whois server response timeout. Once exceeded, Whois data error message will be displayed. The default value is 5 seconds
  • idn_type - Supported characters. Characters supported by the domain zone. You can use the Latin alphabet characters a-z, figures 0-9 and the hyphen (-)
  • min_lenght - Minimum name length. Enter the maximum domain name length that can be registered
  • max_lenght - Maximum name length. The maximum length of the domain name in Punycode that can be registered

Name

Function: tld.idntable

Result: the list of elements

Symbol tables

Access level: admin

  • name - Name
  • status - Status

Suspend

Function: tld.idntable.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of tld.idntable function.

Result: successful operation or error message

Contents of the symbol table

Function: tld.idntable.view

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of tld function).
    • elid - unique identifier (key element of tld.idntable function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of tld function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of tld function).
    • elid - unique identifier (key element of tld.idntable function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

Resume

Function: tld.idntable.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of tld.idntable function.

Result: successful operation or error message

Colocation

Function: colocation

Result: the list of elements

Colocation

Access level: admin user

  • id - Id
  • pricelist - Tariff plan
  • account - Client
  • project - Provider
  • datacentername - Data center
  • processingmodule - Processing module
  • createdate - Creation date
  • expiredate - End date
  • autoprolong - Auto renewal
  • status_msg - Status
  • item_status - Status
  • cost - Price

Suspend

Function: colocation.suspend

Suspend

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation function.

Result: successful operation or error message

Edit properties of the selected service

Function: colocation.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • elid - unique identifier (id element of colocation function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule - Processing module. Processing module
  • autoprolong - Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate - Order date . Date when the service was ordered
  • opendate - Creation date. Activation date
  • expiredate - Expiration date. Validity period
  • scheduledclose - . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot - . (Optional parameter. To enable the option click "on".) Reboot server to apply changes
  • note - Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense - . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Set filter.

colocation.filter

Resume

Function: colocation.resume

Resume

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation function.

Result: successful operation or error message

Set a filter by the selected client

Function: colocation.setfilter

Set a filter by the selected client

Access level: admin

Name

Function: colocation.hardware

Result: the list of elements

Hardware

Access level: admin user

  • id - Id
  • hardware - Description
  • receivingdate - Date
  • returndate - Return date
  • status - Status

Return of equipment

Function: colocation.hardware.return

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of colocation function).
    • elid - unique identifier (id element of colocation.hardware function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of colocation function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of colocation function).
    • elid - unique identifier (id element of colocation.hardware function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • returnemployee - Delivered. Full name of a staff member who delivered equipment to client
  • returnuser - Accepted. Full name of a staff member who accepted equipment
  • returndate - Return date. Date when equipment was returned to client


Certificate that confirms return of equipment to client

Function: colocation.hardware.return_print

Certificate that confirms return of equipment to client

Access level: admin

Acceptance of equipment by provider

Function: colocation.hardware.receiving_print

Acceptance of equipment by provider

Access level: admin

Equipment parameters

Function: colocation.hardware.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of colocation function).
    • elid - unique identifier (id element of colocation.hardware function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of colocation function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (id element of colocation function).
    • elid - unique identifier (id element of colocation.hardware function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • unit - Colocation . Colocation (rack and unit number)
  • hardware - Description . Equipment description
  • note - Comment. Add your comment
  • receiveemployee - Accepted . Full name of a staff member who accepted equipment
  • receiveuser - Delivered . Full name of the client who delivered equipment
  • receivingdate - Date . Date when equipment was accepted by provider
  • returnemployee - Delivered . Full name of a staff member who delivered equipment
  • returnuser - Accepted . Full name of the client who accepted equipment
  • returndate - Return date . Date when equipment was returned to client


Delete

Function: colocation.hardware.delete

Delete

Access level: admin

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of colocation.hardware function.

Result: successful operation or error message

Drill down to User panel

Function: colocation.su

Drill down to User panel

Access level: admin

Service activation

Function: colocation.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (id element of colocation function)