Skip to content

Get Account Info API

This document describes the get_account_info API endpoint for retrieving an account record from the database.

Endpoint

POST /Account/get_account_info

Request

Request Body

Content-Type: application/json

Field Name Type Description
aux_field_names [string] The names of additional fields to fetch.
batch_name string The name of the batch to which the account belongs. Note: Use either i_account, id, or login to look for an account (only one is applicable); when using batch_name, control_number must also be specified.
control_number integer The sequential number of the account in the batch. Mandatory when using batch_name or i_batch.
detailed_info integer Indicates whether to fetch additional information (e.g., account_expired, account_inactive). Values: 0 (don't fetch), 1 (fetch and include in account_info).
expand_alias integer Indicates whether to retrieve information from the alias or the related master account. Values: 0 (don't fetch master account info), 1 (fetch master account info). Applicable to aliases only.
get_included_services integer Indicates whether to retrieve the list of services configured for the account. Values: 0 (do not retrieve), 1 (retrieve and include in account_info).
get_service_features [string] The list of service feature names to fetch configuration for.
i_account integer The unique ID of the account. Note: Read-only.
i_batch integer The batch ID. Note: Use either i_account, id, or login (only one is applicable); when using i_batch, control_number must also be specified.
i_subscriber integer The unique ID of the account's subscriber record. Refers to the Subscribers table. Note: Read-only; not used.
id string The ID (PIN) of the account, unique in an environment. Note: Use either i_account, id, or login (only one is applicable).
limit_alias_did_number_list integer Include the list of DID numbers assigned as aliases to the account. Specify the number of DID numbers to include (max 100). Default: 0 (not included).
login string The account login for the web self-care interface, unique in an environment. Note: Use either i_account, id, or login (only one is applicable).
with_call_processing_mode integer Indicates whether to fetch the account's call processing mode. Values: 0 (don't include), 1 (include in response).
with_customer_info integer Indicates whether to include the customer_info field in the response. Values: 0 (don't include), 1 (include).
with_reseller_info integer Indicates whether to include the reseller_info field in the response. Values: 0 (don't include), 1 (include).
without_service_features integer Indicates whether to fetch service feature configuration. Values: 0 (fetch, default), 1 (don't fetch).

Example Request

{
  "params": {
    "id": "33398700001",
    "without_service_features": 1
  }
}

Response (200 OK)

Response Body

Field Name Type Description
account_info object The information about an account.
account_expired integer Indicates whether the account has expired. Based on the expiration date.
account_inactive integer Indicates whether the account is inactive. Values: 0 (active), 1 (inactive).
activation_date date The date the account is activated or first used.
address_line_2 string The 2nd line of the account owner's address.
alias_did_number_list [object] List of the account's aliases' DID numbers. Included if limit_alias_did_number_list > 0.
did_number string The DID number (read-only, numbers only).
i_did_number integer The unique ID of the DID number record (read-only).
assigned_addons [object] List of account's add-on products with associated recurring costs.
addon_effective_from date-time Date when a product add-on is effective.
addon_effective_to date-time Date when a product add-on becomes ineffective.
addon_priority integer Priority of an add-on product (0: main, 10: low, 15: medium low, 20: medium, 25: medium high, 30: high).
allowed_products [integer] List of main products compatible with the add-on product.
allowed_with_any_product string Indicates if add-on can be assigned with any main product (admin-managed only).
breakage number Breakage summary for depleted accounts.
default_i_acl integer ACL for accounts with this product assigned.
description string Internal product description.
end_user_description string Product description visible to end users.
end_user_name string Product name visible to end users.
fraud_protection string Overdraft protection mode (None, All, Debit).
hidden string Indicates if the product is hidden (Y: hidden, N: not hidden, read-only).
i_account_role integer ID of the account role (e.g., 1: Universal, 2: Phone line, etc.).
i_customer integer ID of the reseller managing the product.
i_product integer Unique ID of the product record.
i_product_group integer ID of the product group for add-on products.
i_reseller_subscription integer ID of the Subscription Plan assigned to the reseller.
i_subscription integer ID of the subscription plan for recurring fees.
i_vd_plan integer ID of the assigned volume discount plan.
included_services [integer] List of service types included with the product.
info_url string URL to an external website describing product features.
is_used integer Indicates if the product is used (1: used, 0: not used, read-only).
is_used_by_resellers integer Indicates if the shared product is used by resellers (1: used, 0: not used).
iso_4217 string ISO 4217 currency code (e.g., EUR, USD, INR, read-only after creation).
managed_by_user string Indicates if the product can be managed by end users (Y: yes, N: no).
name string Descriptive product name for the UI.
notepad string Notes about the product.
product_group_name string Name of the product group (read-only).
product_subscription object Subscription plan information.
activation_fee number One-time fee applied on subscription activation (read-only).
activation_mode integer Date when subscription charges apply (1: start date, 2: first usage, read-only).
advance_periods integer Number of periods to charge in advance (read-only).
cancel_penalty number Fee for early cancellation (for fixed cancellation mode).
charge_model integer How subscription charges are applied (0: progressively, 1: end of period, 2: in advance, read-only).
description string Subscription plan description (max 255 characters).
effective_fee number Effective subscription fee for the current billing period.
generate_daily_charge string Generate daily charges or keep total charge (Y: daily, N: total).
i_product integer Unique ID of the product record.
i_product_subscription integer Unique ID of the product subscription record.
i_subscription integer ID of the subscription plan.
invoice_description string Subscription name visible on invoices and self-care interfaces.
iso_4217 string ISO 4217 currency code for the subscription plan (read-only).
minimum_period integer Minimum subscription period in months to avoid penalties.
multi_month_discount_list [object] List of multi-month discounts for subscriptions charged in advance.
discount_fee number Fee with applied discount for the number of months.
i_subscription integer Unique ID of the Subscription Plan record.
i_subscription_discount integer Unique ID of the Subscription Discount record.
number_of_months integer Number of months covered by the discount.
percent number Percentage discount amount (for percentage discount type).
rate number Fixed discount amount (for fixed amount discount type).
standard_fee number Standard fee for the number of months (read-only).
multiple integer Indicates if the subscription can be assigned multiple times (Y: yes, N: no, read-only).
name string Name of the subscription plan.
periodic_fees [object] List of periodic fees for the subscription plan.
fee number Amount of the fee for one billing period (read-only).
i_billing_period integer Billing period ID the fee applies to (read-only).
i_subscription integer Subscription identifier (updates all accounts with this product).
i_subscription_fee integer Internal identifier of the billing period subscription fee (read-only).
periods integer Number of billing periods the fee applies to (0: default, read-only).
rounding integer Number of decimal places for rounding charged amounts (1 to 5).
realm string Custom string for scope of uniqueness for account IDs (read-only).
service_features [object] Service feature configuration options within the product.
attributes [object] List of service feature attributes.
effective_values [string] List of service feature attribute values (read-only, inherited).
name string Service feature attribute internal name (read-only).
values [string] Values of the service attribute (single value checked for accounts).
defined integer Indicates if the service feature is defined at the object's level.
effective_flag_value string Actual service feature flag value (read-only, inherited).
flag_value string State of the service feature (not mandatory for some features).
locked integer Indicates if the feature is locked for editing.
locks [string] List of user types who cannot change service features.
name string Service feature name.
service_flag_locks string Specifies if service feature values can be changed by admin/end user.
shared string Indicates if the product can be shared with resellers (Y: yes, N: no).
subscription_discount_list [object] List of subscription discounts for multi-month prepaid plans.
discount_fee number Fixed sum for the prepaid plan discount.
i_subscription integer Unique ID of the subscription plan record.
i_subscription_discount integer Unique ID of the subscription discount record.
number_of_months integer Number of billing periods for the prepaid plan.
percent number Percentage of the discount (for percentage discount type).
rate number Amount of the discount (for fixed amount discount type).
standard_fee number Standard fee without discount (read-only).
topup_addon string Indicates if add-on product has a volume discount plan (Y: yes, N: no).
volume_discount_plan_name string Name of the associated volume discount plan (read-only).
aux_fields [object] Data for the account's additional fields.
name string Name of the additional data field.
value string Value of the additional data field.
baddr1 string 1st line of the account owner's address.
balance number Account's current balance (debit accounts or credit accounts with individual control).
batch_name string Batch name to which the account belongs.
bcc string BCC email address for blind carbon copy.
bill_status string Account status (O: open, I: inactive, C: terminated).
billing_model integer Account type (-1: debit, 0: recharge voucher, 1: credit, 2: alias, 4: beneficiary).
blocked string Indicates if calls and self-care access are blocked (Y: blocked, N: not blocked).
call_processing_mode_info object Information about the account's active call processing mode.
effective_from date-time Date and time the call processing mode became active (read-only).
effective_to date-time Date and time the call processing mode becomes inactive.
i_response_message integer ID of the voice response message.
name string Operation mode name (read-only).
response_message_name string Response message name (read-only).
short_code integer ID of the operation mode (used as DTMF code).
sticky string Indicates if mode is preserved on bulk mode switch (Y: preserved, N: not preserved).
city string City of the account owner's address.
companyname string Account owner's company name.
cont1 string Main contact person for the account.
cont2 string Alternative contact person for the account.
control_number integer Sequential number of the account in the batch (read-only).
country string Country code in ISO 3166-1 alpha-2 format (0 to 32 characters).
credit_exceed string Indicates if the account has exceeded its credit limit (credit accounts only).
credit_limit number Account's credit limit value (for credit accounts).
cust_bill_suspension_delayed integer Indicates if customer suspension is delayed (0: not delayed, 1: delayed).
customer_bill_status string Customer billing status (O: operational, L: limited, S: suspended, C: terminated, E: ported).
customer_bill_suspended integer Indicates if customer is suspended (1: suspended, 0: not suspended).
customer_blocked string Indicates if all customer accounts are blocked (Y: blocked, N: not blocked).
customer_credit_exceed string Indicates if customer's credit limit was exceeded (1: exceeded, 0: not exceeded).
customer_name string Name of the customer that owns the account.
customer_status string Status of the customer (e.g., credit_exceed).
did_number string Account's DID number (read-only).
dual_version_system string System to which the account belongs (normal, source, target, read-only).
ecommerce_enabled string Indicates if e-commerce is enabled for balance recharge (Y: enabled, N: disabled).
email string Email address associated with the account for password reset.
expiration_date date Date when the account becomes unusable.
extension_id string Account's extension number (read-only).
extension_name string Name of the account's extension (read-only).
faxnum string Account owner's fax number.
first_usage date Date of first account usage (read-only).
first_usage_time date-time Date and time of first account usage (read-only).
firstname string Account owner's first name.
h323_password string VoIP password for authenticating calls.
has_custom_fields integer Indicates if account has custom fields (read-only).
i_account integer Unique ID of the account (read-only).
i_account_balance_control_type integer ID of the account's balance control type (1: undefined, 2: individual credit limit, 3: subordinate).
i_account_role integer ID of the account role (e.g., 1: Universal, 2: Phone line, etc.).
i_acl integer ID for account's access level (deprecated, use i_role).
i_batch integer ID of the batch to which the account belongs.
i_credit_card integer ID of the account's credit card (read-only).
i_customer integer ID of the customer record (read-only).
i_customer_site integer ID of the customer site the account belongs to.
i_did_number integer ID of the assigned DID number (read-only).
i_distributor integer Unique ID of the distributor associated with the account (debit accounts only).
i_lang string Code for the account's web language (e.g., en, ru, es).
i_master_account integer ID of the beneficiary account for alias/sponsor (read-only).
i_parent integer ID of the reseller for sub-customers (read-only).
i_product integer ID for the account's product.
i_role integer ID of the account's access role.
i_subscriber integer Unique ID of the account's subscriber record (deprecated, read-only).
i_time_zone integer ID for the account's time zone.
i_vd_plan integer ID for the account's discount plan (obsolete).
id string Unique ID (PIN) of the account (max 64 characters).
idle_days integer Number of days the account has not been used (read-only).
in_date_format string Input date format for self-care interface.
in_time_format string Input time format for self-care interface.
inactivity_expire_time integer Period of account availability after last use (days).
included_services [object] List of services available for the account (read-only, inherited).
default string Indicates if service belongs to system's default set (Y: yes, N: no).
dest_group_set_name string Destination group set name (read-only, for service pool).
i_dest_group_set integer ID of the destination group set (for service pool).
i_service integer Unique ID of the service record.
i_service_type integer Unique ID of the related service type (e.g., 3: Voice calls, 16: IPTV).
i_st_charge_unit integer ID of the service type charge unit.
i_tax_transaction_code integer ID of the tax transaction code for xDR taxes.
internal string Indicates if service is for internal usage (Y: yes, N: no).
is_used integer Indicates if service is used (Y: yes, N: no).
name string Service name shown on the administrator interface.
rate_unit string Customer-visible name for billing units (max 16 characters).
rating_base string Billing attribute based on service type (read-only).
ratio integer Base ratio for billing units (e.g., 1024 bytes = 1 kilobyte).
service_pool_combination_list [object] List of service pool combinations (for pool services).
dg_name string Destination group name (read-only).
i_dest_group integer ID of the destination group.
i_service integer ID of the service.
pooled_ratio integer Ratio for pooled units (read-only).
pooled_unit string Pooled unit (read-only).
pooled_unit_ratio string Ratio for pooled units.
service_name string Service name (read-only).
unit_ratio integer Ratio for service pool units.
unit string Base units for measuring service consumption (read-only).
usage_rating string Indicates if service is charged by rating plan (Y: yes, N: no).
is_active integer Indicates if account is usable (1: usable, 0: not usable, read-only).
iso_4217 string ISO 4217 currency code for billing (read-only, inherited).
iso_639_1 string ISO 639-1 language code for IVR interaction (read-only).
issue_date date Date when the account was created (read-only).
last_recharge date-time Date and time of last recharge (read-only).
last_usage date-time Date and time of last account usage (read-only).
lastname string Account owner's last name.
life_time integer Availability period after first use (days).
login string User login for self-care interface (4-64 characters).
login_to_um_is_available integer Indicates if unified messaging access is allowed (read-only).
mac string MAC address of the CPE (read-only, 17 characters).
management_number string Custom account identifier (read-only).
master_account_id string ID of the master account (read-only, for alias/beneficiary accounts).
master_billing_model integer Type of master account (read-only).
midinit string Account owner's middle initial(s) (max 25 characters).
note string Short note about account's contact details (max 100 characters).
notepad string Notes about the account owner (e.g., change reasons).
opening_balance number Initial balance of the account.
out_date_format string Output date format for self-care interface.
out_date_time_format string Output date and time format for self-care interface.

Example Response

{
  "account_info": {
    "activation_date": "2009-09-18",
    "assigned_addons": [],
    "balance": 0.88027,
    "batch_name": "Batch_301",
    "bill_status": "O",
    "billing_model": 1,
    "blocked": "N",
    "control_number": 1,
    "credit_limit": null,
    "cust_bill_suspension_delayed": 0,
    "customer_bill_status": "O",
    "customer_bill_suspended": 0,
    "customer_blocked": "N",
    "customer_name": "EasyCall",
    "ecommerce_enabled": "N",
    "expiration_date": "2023-01-13",
    "first_usage": "2009-09-26",
    "first_usage_time": "2009-09-26 02:00:00",
    "h323_password": "3qqedemk",
    "has_custom_fields": 1,
    "i_account": 100055,
    "i_account_role": 1,
    "i_acl": 155,
    "i_batch": 17,
    "i_customer": 12,
    "i_lang": "en",
    "i_product": 135,
    "i_role": 6,
    "i_subscriber": 1749,
    "i_time_zone": 113,
    "i_vd_plan": 166,
    "id": "33398700001",
    "idle_days": 3839,
    "in_date_format": "YYYY-MM-DD",
    "in_time_format": "HH24:MI:SS",
    "inactivity_expire_time": null,
    "included_services": [],
    "is_active": 1,
    "iso_4217": "USD",
    "iso_639_1": "en",
    "issue_date": "2009-09-18",
    "last_usage": "2009-09-27 16:01:56",
    "life_time": null,
    "login": "33398700001",
    "opening_balance": 0,
    "out_date_format": "YYYY-MM-DD",
    "out_date_time_format": "YYYY-MM-DD HH24:MI:SS",
    "out_time_format": "HH24:MI:SS",
    "password": "sw7yte",
    "password_lifetime": 258173509,
    "password_timestamp": "2012-01-26 12:47:51",
    "product_name": "Internet",
    "service_features": [],
    "service_flags": " ^^^~NNN ^YN~ ~YN",
    "status": "",
    "time_zone_name": "Europe/Prague"
  }
}

Response (500)

{
faultcode: string           The error code
faultstring: string         Text description of the error
}