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:
- Parameters:
- elid — unique identifier (id element of project 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 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:
- Parameters:
- elid — unique identifier (id element of project 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 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