Clients (account/subaccount)

Function: account

Result: the list of elements

Clients

Access level: admin

• elid — Id

• name — Name

• project — Provider

• balance — Account balance

• account_status — Client status

• tz_registration_date — Registration date

• status — Properties

Client registration

Read more in the article Integration with website

The system redirects a new client from your website to the registration form:

https://DOMAIN/billmgr?func=register

To register a user on the website without redirecting to BILLmanager, use the register function. A remote call of this function will register a new client in the billing platform. The function has the following parameters:

• sok = ok — save data
• email — login and email of a new client
• passwd — password of a new client 
• realname — client name
• phone — phone number
• conditions_agree set to on, if a client has to agree to a service agreement at the registration process
• offer_xxx set to on, if a client has to agree to a formal offer at the registration process
• country — country id according to BILLmanager directory, optional
• state — country id according to BILLmanager directory, optional
• project — provider id.  In the version"BILLmanager" it equals 1;
• recovery set to on, if you want to send a password reset notification in the registration email
• _ga — Google Analytics id, optional
• partner — if you use the affiliate program, the website should remember 'PARTNER_ID' in case a client was referred by the referral link. Usually, this parameter is kept in cookies.
• sesid — only if you use the affiliate program. This is the click identifier.
• tzoffset — time zone offset off GMT, optional. in BILLmanager it can be set via JavaScirpt.

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
An example of API request to credit payment to the client's account:

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

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 ", ".

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:

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

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

• plid — unique identifier of the parent list (the id element from the user function).
• 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