Clients (account/subaccount)

Clients (account)

Result: list of elements

In the platform web interface: section Clients in the left menu of the platform.

Clients

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique client identifier.
`name`	String	no	Client name.
`project`	Positive integer	no	Provider available to the client.
`balance`	String	no	Client account balance.
`status`	String (list)	no	Client properties.

Client registration

Function: register

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → click Add.

For more information, see the article Integration with website.

To register a client in BILLmanager, the user is redirected from the website to the registration form:

Registration in BILLmanager

https://IP-address:port/billmgr?func=register

More details

To register a client on the website without redirecting to BILLmanager, the register function is used, a remote call of which will register the client in the billing platform. The function has the following parameters:

Parameter	Type	Required	Value
`sok`	String	yes	Value `ok` confirms operation execution. Without this parameter, changes will not be applied.
`email`	String	yes	Login and Email of the new client.
`passwd`	String	yes	Password of the new client.
`realname`	String	no	Full name of the client.
`phone`	String	no	Phone number.
`conditions_agree`	Flag	no	Set the value `on` if acceptance of terms of use is required for registration.
`offer_xxx`	Flag	no	Set the value `on` if acceptance of an offer contract is used during registration, where `xxx` is the offer id.
`country`	String	no	Country code according to the BILLmanager directory.
`state`	String	no	Region or area code according to the BILLmanager directory.
`project`	Positive integer	no	Provider id.
`recovery`	Flag	no	Set the value `on` if a password reset link needs to be sent to the client in the registration email.
`_ga`	String	no	Google Analytics binding code.
`partner`	String	no	When using a referral program, the website must remember 'PARTNER_ID' (partner code) if the client arrived via a referral link. Usually this parameter is saved in cookies.
`sesid`	String	no	If a referral program is used. Click identifier.
`tzoffset`	String	no	Client timezone offset relative to GMT, set in BILLmanager via JavaScript.

Send a ticket to the client

Function: ticket.write.account

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Ticket.

Access level: admin

Payments (account.payment)

Function: account.payment

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Payments.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique payment identifier.
`number`	String	no	Payment number.
`create_date`	Date and time	no	Payment creation date.
`pay_date`	Date and time	no	Payment date.
`sender_name`	String	no	Payer.
`recipient_name`	String	no	Recipient.
`project`	Positive integer	no	Provider.
`account_name`	String	no	Client.
`paymethod_name`	String	no	Payment method.
`subaccountamount_iso`	String	no	Amount.
`paymethodamount_iso`	String	no	Amount in payment currency.
`status`	String (list)	no	Payment status flags.

Payment properties

Function: payment.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → select the payment → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.payment).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.payment);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`number`	String	no	Invoice number for payment.
`createdate`	Date and time	no	Date and time of invoice creation for payment.
`paydate`	Date and time	no	Date of invoice payment or payment crediting.
`documentnumber`	String	no	Payment document number.
`documentdate`	Date and time	no	Payment document date.
`description`	String	no	Payment purpose.
`sender`	Positive integer	no	Client payer on whose behalf the payment was made.
`subaccountamount`	String	no	Payment amount credited to the client account.
`usedamount`	String	no	Amount of spent funds.
`paymethodamount`	String	no	Amount in payment system currency.
`commissionamount`	String	no	Commission added to the payment amount upon payment.
`taxamount_readonly`	String	no	Tax amount.
`status`	String (enumeration)	no	Payment status.
`paymethod`	Positive integer	no	Payment method.
`restrictrefund`	Flag	no	Prohibit refund of funds from this payment. To enable this option, use the value `on`.
`info`	String	no	Payment information. Additional information about the payment received from the payment system.
`note`	String	no	Employee comment.

Credit payment to client account

Function: payment.setpaid

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → select the payment → click Credit.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.payment.

Example API call for crediting a payment to the client account:

Example API call

https://IP-address:port/billmgr?authinfo=username:password&elid=3&func=payment.setpaid&out=xml

More details

Send invoice via email

Function: payment.send

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → select the payment → Send invoice.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.payment.

Filter installation

Function: account.payment.filter

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → Filter menu.

Cancel payment

Function: payment.refund

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → select the payment → click Cancel.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.payment).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.payment);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`amount`	String	yes	Refund amount. Amount in payment method currency that will be returned to the client.
`description`	String	no	Reason for refund to be transmitted to the payment system.

Payment change history by number

Function: payment.history

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Payments → click History.

Access level: admin

Parameter	Type	Required	Value
`changedate`	Date and time	no	Change date.
`desc`	String	no	Change.
`user`	String	no	User.
`ip`	String	no	IP address.
`action`	String	no	Function.

Display payment information in a print-friendly format

Function: payment.print

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → click Print.

Access level: admin

Download document in PDF format

Function: payment.print.pdf

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → click Download.

Access level: admin

Expense amount distribution across payments

Function: payment.expense

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Payments → click Expenses.

Access level: admin

Parameter	Type	Required	Value
`expense`	Positive integer	no	Expense code.
`expense_locale_name`	String	no	Expense.
`amount_iso`	String	no	Amount.
`invoice`	Positive integer	no	Act code.
`invoice_number`	String	no	Act.

Editing distribution

Function: payment.expense.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → click Expenses → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account.payment);
- elid — unique identifier (element expense from the function payment.expense).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account.payment);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account.payment);
- elid — unique identifier (element expense from the function payment.expense);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`expense`	Positive integer	no	Expense code.
`amount`	String	no	Amount that will be debited from the payment.

Delete

Function: payment.expense.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → select the payment → click Expenses → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element expense from the function payment.expense.

Delete selected payments. Available only for unpaid payments

Function: payment.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → select the client → click Payments → select the payment → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.payment.

Create

Function: payment.add

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → click Add.

Access level: admin, user

Invoice content

Function: payment.orderinfo

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Payments → select the payment → click Details.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique invoice item identifier.
`info`	String	no	Invoice subject.
`cost`	String	no	Cost.

Editing invoice content

Function: payment.orderinfo.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → click Payments → tab Details → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account.payment);
- elid — unique identifier (element id from the function payment.orderinfo).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account.payment);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account.payment);
- elid — unique identifier (element id from the function payment.orderinfo);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`name`	String	no	Description of the invoice item.

Send a request to the client

Function: ticket.write.payment

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Payments → click Ticket.

Access level: admin

Client groups

Function: account.group

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Groups.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique group identifier.
`name`	String	no	Name.
`status`	String (list)	no	Status.

Enable

Function: account.group.resume

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Groups → select the group → click Enable.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.group.

Disable

Function: account.group.suspend

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Groups → select the group → click Disable.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.group.

Editing group

Function: account.group.edit

Result: successful operation execution or error message

Access level: admin

Delete group

Function: account.group.delete

Result: successful operation execution or error message

Access level: admin

Accounts

Function: subaccount

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Accounts.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique account identifier.
`project`	Positive integer	no	Provider.
`balance`	String	no	Client account balance.
`creditlimit`	String	no	Credit limit.
`status`	String (list)	no	Status.

Editing account

Function: subaccount.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → click Accounts → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function subaccount).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function subaccount);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`subaccount_project`	Positive integer	no	Provider of the created account.
`subaccount_currency`	String	no	Currency of the created account.
`allowpostpaid`	Flag	no	The option enables the client to pay for services on credit from this account. To enable this option, use the value `on`.
`creditlimit`	String	no	Credit limit. Allows the client to go into debt within the specified amount.
`referer`	Positive integer	no	Attracted by the client via a referral program. Specify the client code of the client who referred the client via the referral program.
`active`	Flag	no	Client account is active. A client can have only one active account per provider. To enable this option, use the value `on`.
`incident_limit`	Positive integer	no	Maximum use of support requests by the client for all time.

Disable

Function: subaccount.suspend

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Accounts → click Disable.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function subaccount.

Refund to account

Function: subaccount.refund

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Accounts → click Refund.

Access level: admin

Enable

Function: subaccount.resume

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Accounts → click Enable

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function subaccount.

Discounts

Function: account.discount

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Discounts.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique discount identifier.
`name`	String	no	Name.
`actiontype`	String (enumeration)	no	Services to which the discount applies
`project`	Positive integer	no	Provider.
`discount_type`	String (enumeration)	no	Discount type.
`period`	String (enumeration)	no	Validity period.

Create discount

Function: account.discount.add

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Discounts → click Add.

Access level: admin

Delete discount

Function: account.discount.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Discounts → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma.

Editing discount

Function: account.discount.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Discounts → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element idname from the function account.discount).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element idname from the function account.discount);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`fromdate`	Date and time	no	From date. First day of discount validity.
`todate`	Date and time	no	To date. Last day of discount validity.
`type`	String (enumeration)	no	Discount type. Method of providing the discount.
`percentage`	String	no	Discount in % on service or product cost.
`priority`	Positive integer	no	Discount priority. By default, discounts assigned to the client personally have higher priority than discounts specified in promotions. If a negative priority is assigned to the discount, it will be applied only if there are no suitable discounts from promotions.
`actiontype`	String (enumeration)	no	Select what the discount applies to. Note that a renewal discount will not apply to tariffs with daily billing.
`period`	String (enumeration)	no	Order period to which the discount applies.
`note`	String	no	Comment to the discount.

Discount change history

Function: account.discount.history

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Discounts → click History.

Access level: admin

Sending SMS message

Function: account.sms

Result: successful operation execution or error message

For the option to work, an SMS gateway must be configured.

In the platform web interface: section Clients → Clients → select the client → click SMS.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object.

Viewing object parameters:

Parameters:
- elid — unique identifier (element id from the function account).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`type`	Positive integer	no	Selection of phone number to which the message will be sent.
`phone`	String	yes	Phone number to which the message will be sent.
`message`	String	yes	Message.

Set filter by client

Function: account.setfilter

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Filter by client.

Access level: admin

Filter installation

Function: account.filter

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → Filter menu.

Currency rate

Function: account.currencyrate

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Currency rate.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique rate identifier.
`currency_base`	String	no	Currency.
`rate`	String	no	Rate.
`ratedate`	Date and time	no	Rate date.

Currency rate

Function: account.currencyrate.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Currency rate → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.currencyrate).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.currencyrate);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`currency_base`	String	no	Base currency to which conversion is performed.
`currency_relate`	String	no	Convertible currency. Currency that is converted to the base currency.
`rate`	String	no	Currency rate value for the specified date for the specified number of units.
`amount`	String	no	Number of base currency units for which the conversion rate is specified.
`ratedate`	Date and time	no	Date from which the rate is effective.

Delete

Function: account.currencyrate.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Currency rate → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.currencyrate.

Expenses

Function: subaccount.expense

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Expenses.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique expense identifier.
`locale_name`	String	no	Name.
`realdate`	Date and time	no	Debit date.
`cdate`	Date and time	no	Service provision date.
`amount`	String	no	Amount.
`notpayd`	Flag	no	Unpaid.
`discountamount`	String	no	Discount amount.
`payments`	String (list)	no	Paid by payments.
`discount`	Positive integer	no	Discount code.
`taxamount`	String	no	Tax.

Filter installation

Function: subaccount.expense.filter

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Expenses → Filter menu.

Editing expense

Function: subaccount.expense.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Expenses → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function subaccount.expense).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function subaccount.expense);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`subaccount`	Positive integer	no	Provider / account id (payer id).
`item`	Positive integer	no	Service id. Select the service for which the expense will be created.
`operation`	String (enumeration)	no	Operation on the basis of which the expense will be created. For example: `prolong`, `billdaily`, `changeaddon`.
`amount`	String	no	Expense amount.
`taxrate`	String	no	Tax rate. Tax percentage. Tax amount is included in the expense amount and calculated by the formula: AMOUNT — (AMOUNT / ((100 + RATE) / 100))
`postpaid`	Flag	no	If the option is set, then if there are insufficient funds in the account, the expense will be created on credit. To enable this option, use the value `on`.
`name`	String	no	Name. You can specify your own name. If you do not specify a name, it will be generated automatically based on the operation.
`realdate`	Date and time	no	Actual debit date.
`cdate`	Date and time	no	Service provision start date.
`plid`	Positive integer	no	Client id.

Example request

https://<billing_address>/billmgr?func=subaccount.expense.edit&authinfo=xxx:xxx&amount=<amount>&item=<service_id>&name=<Name>&name_ru=<name_ru>&operation=<operation_type>&plid=<client_id>&postpaid=<on>&sok=ok&subaccount=<account_id>

Parameters

Delete

Function: subaccount.expense.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Expenses → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function subaccount.expense.

Tax rates

Function: account.taxrule

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Tax.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique rule identifier.
`type`	String (enumeration)	no	Type.
`project`	Positive integer	no	Provider.
`company`	Positive integer	no	Company.
`country`	Positive integer	no	Payer country.
`taxrate`	String	no	Tax rate.
`itemtype`	String (enumeration)	no	Product type.

Delete rule

Function: account.taxrule.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Tax → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.taxrule.

Special rule

Function: account.taxrule.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Tax → click Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object. Viewing object parameters:

Parameters:
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.taxrule).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique identifier of the parent list (element id from the function account);
- elid — unique identifier (element id from the function account.taxrule);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`project`	Positive integer	no	Provider name.
`taxrate`	String	no	Tax rate. Specify the tax rate for the selected country.
`specialitemtype`	Flag	no	Option "Only for specific product types". If enabled, not all product types are subject to taxation. To enable this option, use the value `on`.
`itemtype`	String (list)	no	Product types. Specify which product types are subject to taxation.

Editing client information

Function: account.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → clicks Add or Edit.

Access level: admin

Used for viewing object parameters, modifying an object, and creating a new object.

Viewing object parameters:

Parameters:
- elid — unique identifier (element id from the function account).
Result: list of object parameters.

Creating an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- additional request parameters.
Result: successful operation execution or error message.

Modifying an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (element id from the function account);
- additional request parameters.
Result: successful operation execution or error message.

List of object parameters or additional request parameters:

Parameter	Type	Required	Value
`email`	String	no	Client email, also will be used as login for authorization in BILLmanager.
`verify_email`	Flag	no	Email verification. To enable this option, use the value `on`.
`project`	Positive integer	no	Provider to which the client will be linked.
`country`	Positive integer	no	Client country.
`state`	Positive integer	no	Region.
`realname`	String	no	Contact person. Full name of the client or contact person of the organization for which the account is being created.
`name`	String	no	Client name.
`settingurl`	String	no	Settings URL. URL for obtaining settings by ispmanager panels.
`valid_phone`	String	no	Verified client phone number.
`try_phone`	String	no	Client phone number.
`label`	String	no	Label. Service information available in the filter.
`selfview`	String	no	Own namespace. Allows replacing the name servers specified in the panel settings.
`passwd`	String	no	Password for access to the client area.
`confirm`	String	no	Confirmation.
`products_page`	Positive integer	no	Page.
`registration_date`	Date and time	no	Registration date.
`registration_ip`	String	no	IP address from which the client registration was performed.
`attitude`	Positive integer	no	Client characteristic.
`employee`	Positive integer	no	Employee who registered the client.
`nocalcstat`	Flag	no	Client services will not be displayed in statistics. To enable this option, use the value `on`.
`note`	String	no	Comment to the client.
`notify`	Flag	no	Send the client a notification about registration in BILLmanager. To enable this option, use the value `on`.
`recovery`	Flag	no	Add password reset data to the notification. To enable this option, use the value `on`.

Log in to the panel with user rights

Function: account.su

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Log in.

Access level: admin

Delete

Function: account.delete

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Delete.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.

Providers available to the client

Function: account.project

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Providers.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique provider identifier.
`name`	String	no	Name.
`status`	String (list)	no	Status.

Enable

Function: account.project.resume

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Providers → select the provider → click Enable.

Access level: admin

Parameters:

plid — unique identifier of the parent list (element id from the function account);
elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.project.

Disable

Function: account.project.suspend

Result: successful operation execution or error message

In the platform web interface: section Clients → Clients → select the client → click Providers → select the provider → click Disable.

Access level: admin

Parameters:

elid — one or several unique object identifiers, separated by a comma. Unique identifier is the element id from the function account.project.

Client parameter change history

Function: account.history

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click History.

Access level: admin

Client verification information

Function: account.validate

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Verification.

Access level: admin

Client orders

Function: account.orders

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Orders.

Access level: admin

Client currencies

Function: account.currency

Result: list of elements

In the platform web interface: section Clients → Clients → select the client → click Currency rate.

Access level: admin

Client merging

Function: account.join

Result: successful operation execution or error message

In the platform web interface: section Tools → Client merging.

Access level: admin

Client groups (accountgroup)

Function: accountgroup

Result: list of elements

In the platform web interface: section Clients → Client groups.

Access level: admin

Editing group

Function: accountgroup.edit

Result: successful operation execution or error message

In the platform web interface: section Clients → Client groups → click Add or Edit.

Access level: admin

Auto-inclusion conditions for group

Function: accountgroup.condition

Result: list of elements

In the platform web interface: section Clients → Client groups → click Conditions of automatic assignment.

Access level: admin