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:
- Parameters:
- elid — unique identifier (id element of itemtype function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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