Skip to content

Accounts

Accounts are used for describing separate billing account of some Contractor. Contractor could have more than one Account.

It is necessary to configure Contractor before creating Account. Initial balance for newly created account is always zero. Balance can be changed as result of calls billing or new Payments.

For each call: account balance will be decreased on call cost if it uses account for origination (customer) and increased if it uses account for termination (vendor).

Properties

Id
Auto-generated unique account id.
UUID
Auto-generated unique account UUID. UUID used as identifier for Customer API
EXTERNAL
external_id account attribute value. external_id stores ID from external system when data provisioned via Admin API
Name
Unique account name.
Contractor
Contractor that is related to this Account.
Balance
Current account balance.
Min balance
If account balance become less than this limit, then traffic for this account will be blocked.
Max balance
If account balance become greater than this limit, then routes, which are belongs to this account, will not be used for calls termination.
VAT
Account VAT value. Affects calculation of customer_price in CDR.
Destination rate limit
Maximum per-minute price allowed
Max call duration
Maximum calls duration originated by account or terminated to account in seconds
Origination capacity
Maximum capacity which can be originated for this account. If incoming calls number exceed origination capacity, then traffic will be blocked.
Termination capacity
Maximum capacity which can be terminated for this account. If outgoing calls number exceed origination capacity, then routes, which are belongs to this account, will not be used for new calls.
Total capacity
Shared capacity either for incoming or outgoing calls, i.e. summarized traffic in both directions (but not in particular one) is limited by this number (see the picture below).

Invoice period
Automatic invoices generation period.
Invoice template
Template for generation of PDF invoice documents. Templates can be configured at Billing->Invoice templates
Send invoices to
List of Contacts where to send invoices
Invoice Ref template
Invoice reference generation template. Use $id as unique value per account.
Timezone
Timezone which will be used for invoices generation for this account.

Balance notification settings

Balance low threshold
If account balance become less than this limit, notification will be send by email.
Balance high threshold
If account balance become greater than this limit, notification will be send by email.
Send balance notifications to
List of Contacts where to send balance notification emails

Quick Filters

Account page (Billing->Accounts menu) provides few quick filters:

Vendors Accounts
Displays only accounts linked to contractors with flag Vendor enabled
Customers Accounts
Displays only accounts linked to contractors with flag Customer enabled
Insufficient Balance
Displays accounts where balance<min_balance OR balance>max_balance
Low Balance Threshold
Displays accounts where low threshold configured in Balance notification settings and balance<low_threshold
High Balance Threshold
Displays accounts where high threshold configured in Balance notification settings and balance>high_threshold