PortaBilling XML/JSON API Reference

You are viewing a document related to an older software Maintenance Release%XX%. Click here to see the latest version of PortaSwitch

About PortaBilling API

Preface

This document provides information for developers who want to interface their applications with PortaBilling via XML and JSON API. The PortaSIP Media Applications XML and JSON API is described in the PortaSIP Media Applications XML/JSON API Reference Guide.

What is new

View the list of API changes as a PDF document.

Overview

PortaBilling allows you to perform operations such as data retrieval or data modification via API using the following Web Application Services: XML (SOAP) and JSON RPC.

Performing operations via the API has several advantages:

It is based on either XML/SOAP (Simple Object Access Protocol) or JSON (JavaScript Object Notation) Web Application Services and HTTPS transport, so is accessible from any platform or operating system, and all server and client communications are secure.
The business logic embedded in the API provides integrity checks for all data modifications, and can also compile records from several database tables to create a single customer information retrieval structure.
The PortaBilling® API is accessible to every owner of a virtual environment or to every reseller. Each user's access is automatically limited to his "visible" portion of the available data, e.g. a reseller can only retrieve information about his own sub-customers or their accounts.

The PortaBilling® XML/JSON API allows users to select, update, insert or delete operations on entities such as customers or accounts. Each user has his own login credentials, and each operation he wishes to perform is analyzed to determine if it is possible with regard to general data integrity (e.g. a new account cannot be created without being assigned to a customer) as well as the given user’s security permissions (role) (e.g. while it is generally possible to create new accounts, a certain user may be prohibited from doing so).

By default, all API requests that contain attributes with the date and time must be sent within the UTC timezone. The date and time attributes must be in the following format:

date: 'YYYY-MM-DD' time: 'HH24:MM:SS' datetime: 'YYYY-MM-DD HH24:MM:SS'

The API returns date and time information in the UTC timezone, respectively. Please note that some methods can receive and return date and time information in timezones different from the UTC (e.g. UTC+08). In these cases, the attributes of such methods contain the appropriate descriptions.

Security

Connection to the XML/JSON API is provided via HTTPS. Authentication is done using a pair: a user login and either the API access token or the user password for the admin web interface. Each request to the API should contain the AuthInfoStructure structure as the header attribute.

HeaderRequest structure
Property	Type	Description
auth_info	AuthInfoStructure	The user login for the PortaBilling web interface.

Note that we strongly recommend using the session_id property (which must be received during the authorization via the login request) in the AuthInfoStructure structure for all session requests. Otherwise, if you use the login-password or the API access token authentication pairs for every request, new sessions will be created and cause additional load to the database.

The example below illustrates the login request in JSON format using the cURL command line tool:

curl https://demo.portaone.com:443/rest/Session/login -d params='{"login":"demo","password":"pAssw0rd"}'

The response returns the session ID value:

{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}

XML API

XML (SOAP) API has its own advantages and drawbacks as compared with JSON API. Among the benefits are the following:

There is a wide range of reusable software available to programmers to handle XML so they do not have to re-invent code.
XML (SOAP) is more verbose compared with JSON, but because of this, the data encoding result is typically larger than the equivalent encoding in JSON API.

Access to XML API

All SOAP requests to PortaBilling API must be sent to the following URL:
https://portabilling-web.yourdomain.com:port/soap/

Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.

Replace 'port' with the required port. The SOAP interface is available for administrators on port 443, the interface for customers is available on port 8444, the interface for resellers is available on port 8442 and the interface for accounts is available on port 8445.

Error Handling

SOAP faults are used to carry error information within a SOAP message. If the actual response has a SOAP fault element as the body entry, then an error has occurred. In this case, any other fields in the response cannot be guaranteed as accurate; only the fault sub-elements should be used to identify an error. Currently, these sub-elements are:

faultcode is intended for use by the client software and provides an algorithmic mechanism for identifying the fault;
faultstring provides a human readable explanation of the fault, and is not intended for algorithmic processing.

JSON API

As an alternative to XML API, PortaBillling supports JSON API, thus providing your development department with a choice of Web Application Services that can be used. Among the advantages of JSON API are the following:

Simple data structures that can be easily read and written.
JSON format is faster in parsing and generating data due to simple syntax, thus there is little influence on web server performance.
Supports the same methods as those in the SOAP.
Simplifies the creation of front-end web sites that receive and modify data in PortaBilling with minimum impact on performance.

Access to JSON API

All JSON requests to PortaBilling® API must be sent to the following URL:
https://portabilling-web.yourdomain.com:port/rest/service/method/

Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.

Replace 'port' with the required port. The JSON interface is available for administrators on port 443, the interface for customers is available on port 8444, the interface for resellers is available on port 8442 and the interface for accounts is available on port 8445.

Replace 'service' with the API service that contains the required method (e.g. specify the Account service to manage account information.)

Replace 'method' with the required API method (e.g. specify get_account_info method in order to get an account record from the database.)

Here is an example of the URL to send a POST request to:
https://demo.portaone.com:443/rest/Account/get_account_list/

Sending an HTTP request

For HTTP requests you must include the following parameters (in JSON format) in the POST request body:

auth_info - The mandatory authentication information (see the Security section).
params - A set of method parameters (in JSON format) that depend on a method structure. Note that method parameters and their structures are the same as those in the SOAP.

The Content-Type header field used with a HTTPS POST request must have one of the following values:

application/x-www-form-urlencoded
multipart/form-data

You can run JSON requests in the asynchronous mode so that they are executed in the background. For this, add the aux_info structure as the additional argument into the request. The structure has the following fields:

async - indicates that the method must be run in the asynchronous mode.
bg_request_id – the ID of the background task started.
dry_run – indicates that the method must be run in the dry run mode (possible values: all, simple).

NOTE: The asynchronous API requests are not processed during the software upgrade.

Examples

The examples below illustrate sending API requests using the cURL command line tool.

Receive the information about a subscriber:

curl https://demo.portaone.com:443/rest/Account/get_account_info -d auth_info='{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}' -d params='{"i_account":"2194329"}'
Run an API request in the asynchronous mode:

curl https://demo.portaone.com:443/rest/Account/get_account_info -d auth_info='{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}' -d params='{"i_account":"2194329"}' –d aux_info='{"async":"1"}'
Perform advanced customer data search:
You can perform an advanced customer / account data search by using the get_extended_data_list API method. To make this happen, create a custom JSON request where you specify an object (e.g. Customers or Accounts) and the filters to be used for data search. A filter can be a property of a different object (e.g. Invoice.invoice_total); several filters can be linked with each other.
The example below illustrates how to filter customers by country and invoice amount:

https://demo.portaone.com:443/rest/Generic/get_extended_data_list/ -d auth_info='{"session_id":"527865ee75368ff2d2c4f4881cd2758a"}' -d params='{"data":[{"object":"Customers","fields":["*"]}],"filters":[{"entries":[{"object":"Customers","field":"country","values":["US"]},{"object":"Invoices","field":"amount_paid","values":[50]}]}],"get_total":1,"offset":0,"limit":50}'

Error Handling
If the server returns the '500 Internal Server Error' status code in the HTTP response, then the response body contains a JSON object which includes two elements (keys) that carry error information:

faultcode, that is intended for use by the client software and provides an algorithmic mechanism for identifying the fault.
faultstring, that provides a human readable explanation of the fault, and is not intended for algorithmic processing.

Backward compatibility policy

The PortaBilling® XML/JSON API is backward compatible. This allows your applications to communicate with new versions of PortaBilling® with very little reconfiguration.
Some API methods can become obsolete. They are kept for a few MRs and can be deleted once the first LTS release after the one where the method became obsolete is crossed. For instance, if an API method is found to no longer be useful in MR67, it can be deleted in MR71 onwards.

You can still enable obsolete API methods by adding the [API]AllowObsoleteMethods=1 option for the WebCustom group on the Configuration server. However, we don’t recommend it since using them alongside the new API logic may result in the incorrect operations of your applications. Instead, we recommend that you keep your API applications up to date.

WSDL

Each installation of PortaBilling contains its own set of WSDL documents available for download from the web server from the following URL:
https://portabilling-web.yourdomain.com/wsdl/

Please replace the portabilling-web.yourdomain.com with the actual hostname of your PortaBilling web server.

All requests to PortaBilling API are handled via an SSL connection. By default, PortaBilling installations contain a self-signed certificate that provides the means to encrypt data. However, since the authenticity of this certificate cannot be validated, you may experience some problems when connecting to an SSL site. In this case, it may be necessary to obtain a certificate from a genuine certificate authority. Another option is to generate your own certificate authority and have certificates deployed to all API clients. However, this goes beyond the scope of the present document.

PortaBilling API methods

Establishing authenticated session

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Session

Authenticated session management

change_password
The API method enables an API user to change their password (also changes expired passwords)
Parameters	SessionChangePasswordRequest
Return Value	SessionChangePasswordResponse
Realm	administrator, reseller, account, retail customer, cc staff, representative, distributor
Standalone mode support	No

SessionChangePasswordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
login	Yes	string	No	The username for the PortaBilling web interface.
new_password	Yes	string	No	The new user password for the PortaBilling web interface.	Max value: 32
password	Yes	string	No	The user password for the PortaBilling web interface.	Max value: 32

SessionChangePasswordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	string	No	1 is case of success, exception error message in case of failure.

generate_captcha
Enables an API user to generate a captcha image
Parameters	GenerateCaptchaRequest
Return Value	GenerateCaptchaResponse
Realm	administrator, reseller, account, retail customer, cc staff, representative, distributor
Standalone mode support	No

GenerateCaptchaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GenerateCaptchaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ca_content	Yes	string	No	The encoded captcha image.
ca_token	Yes	string	No	The captcha token.

get_espf_api_token
This method enables an API user to get the ESPF API token
Parameters	GetEspfApiTokenRequest
Return Value	GetEspfApiTokenResponse
Realm	administrator
Standalone mode support	No

GetEspfApiTokenRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetEspfApiTokenResponse
Property	Mandatory	Type	Nillable	Description	Possible values
espf_api_token	Yes	string	No	The ESPF API access token of a user. Can be used to access ESPF API, such as for getting logs, generating events, etc.

get_session_context
This method enables an API user to get the euuid for the current session
Parameters	GetSessionContextRequest
Return Value	GetSessionContextResponse
Realm	administrator, reseller, distributor, cc staff, retail customer, account, representative
Standalone mode support	No

GetSessionContextRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetSessionContextResponse
Property	Mandatory	Type	Nillable	Description	Possible values
euuid	No	string	No	The unique identifier of the environment.

login
This method checks the validity of login and password or token and returns the session_id on success. API Fault is thrown on failure
Parameters	LoginRequest
Return Value	LoginResponse
Realm	administrator, reseller, account, retail customer, cc staff, representative, distributor
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Session/login \ -d params='{ "login":"my_user_login", "password":"my_user_password" }'`
Response example	`{ "session_id":"9c2c9d8be75cdb1a50431d956d300ecd" }`

LoginRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ca_code	No	string	No	The captcha code.
ca_token	No	string	No	The captcha token.
enable_csrf_protection	No	int	No	The flag shows whether to permanently enable CSRF protection for the session.
login	Yes	string	No	User Name, as specified on web interface.
password	No	string	No	Password, as specified on web interface.
token	No	string	No	The API access token of a user.

LoginResponse
Property	Mandatory	Type	Nillable	Description	Possible values
session_id	Yes	string	No	The unique ID of the newly opened session.

login_to_realm
This method creates a session for the specific login and realm
Parameters	LoginToRealmRequest
Return Value	LoginToRealmResponse
Realm	administrator, reseller, representative
Standalone mode support	No

LoginToRealmRequest
Property	Mandatory	Type	Nillable	Description	Possible values
enable_csrf_protection	No	int	No	The flag shows whether to permanently enable CSRF protection for the session.
login	Yes	string	No	The user name as specified on the web interface.
realm	Yes	string	No	The realm name the user wants to log into for the specified login; possible values: reseller, customer, accounts, representative, vendor.	Possible values: reseller, customer, accounts, representative, vendor

LoginToRealmResponse
Property	Mandatory	Type	Nillable	Description	Possible values
session_id	Yes	string	No	The unique ID of the newly opened session.

logout
This method enables an API user to terminate a session. Call logout to terminate the session properly
Parameters	LogoutRequest
Return Value	LogoutResponse
Realm	administrator, reseller, account, retail customer, cc staff, representative, distributor
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Session/logout \ -d params='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}'`
Response example	`{ "success" : 1 }`

LogoutRequest
Property	Mandatory	Type	Nillable	Description	Possible values
session_id	No	string	No	The ID of a previously opened session.

LogoutResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, 0 for failure.

ping
This method checks the validity of a previously opened session and returns the user_id on success. API Fault is thrown on failure
Parameters	PingRequest
Return Value	PingResponse
Realm	administrator, reseller, account, retail customer, cc staff, representative, distributor
Standalone mode support	No

PingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
nonce	No	string	No	A 32-symbol (128-bit) hexadecimal nonce previously sent to an email address as a part of the allowance link (it can be found at the end of the link).
session_id	Yes	string	No	The ID of a previously opened session.

PingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
user_id	No	unsignedLong	No	The ID of the user currently logged into the specified session.

reset_password
This method enables an API user to reset the password (when the user forgets it, for example) and create a new one
Parameters	ResetPasswordRequest
Return Value	ResetPasswordResponse
Realm	administrator, reseller, account, retail customer, cc staff, representative, distributor
Standalone mode support	No

ResetPasswordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_url	No	string	No	Optional link to the reset password page (e.g. http://yourdomain.com/reset_password). If not supplied then the default PortaBilling "forgot password" page url will be sent.
email	No	string	No	The user email address.
id	No	string	No	The reset password ID – A 32- symbol (128-bit) hexadecimal nonce previously sent to an email address as a part of the password reset link (it can be found at the end of the link).
login	No	string	No	The user login for the PortaBilling web interface.
password	No	string	No	A new password.	Max value: 32

ResetPasswordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

set_session_context
This method enables an API user to change the euuid for the current session
Parameters	SetSessionContextRequest
Return Value	SetSessionContextResponse
Realm	administrator, reseller, distributor, cc staff, representative
Standalone mode support	No

SetSessionContextRequest
Property	Mandatory	Type	Nillable	Description	Possible values
euuid	No	string	No	The unique identifier of the environment.
i_customer	No	unsignedLong	No	The unique ID of the customer record.

SetSessionContextResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

Access control tools

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/AccessControl

Access control management

get_operation_access_id
This method enables getting access ID for a particular operation. The ID will be sent to the email/mobile of the requestor
Parameters	GetOperationAccessIdRequest
Return Value	GetOperationAccessIdResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

GetOperationAccessIdRequest
Property	Mandatory	Type	Nillable	Description	Possible values
operation	Yes	string	No	A unique operation name that requires an additional ID for access.	Min value: 1

GetOperationAccessIdResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 on success.

Access policy information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/AccessPolicy

Access policy management

add_access_policy
This method enables an API user to create an access policy using the supplied data
Parameters	AddAccessPolicyRequest
Return Value	AddAccessPolicyResponse
Realm	administrator, reseller
Standalone mode support	No

AddAccessPolicyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_policy_info	Yes	AccessPolicyInfo structure	No	The data related to the access policy.

AddAccessPolicyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_access_policy	Yes	unsignedLong	No	The unique ID of the access policy.

delete_access_policy
This method enables an API user to delete an existing access policy
Parameters	DeleteAccessPolicyRequest
Return Value	DeleteAccessPolicyResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteAccessPolicyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_access_policy	Yes	unsignedLong	No	The unique ID of the access policy.

DeleteAccessPolicyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, exception error message in case of failure.

get_access_policy_info
This method enables an API user to get information about access policy
Parameters	GetAccessPolicyInfoRequest
Return Value	GetAccessPolicyInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAccessPolicyInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	If set to '1', the 'is_used' field will be provided in the response.
i_access_policy	Yes	unsignedLong	No	The unique ID of the Access Policy.
with_access_phases	No	int	No	If set to '1', the list of access_phases will be provided in the response.
with_attributes	No	int	No	If set to '1', the list of related service policy attribute values will be provided in the response.

GetAccessPolicyInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_policy_info	No	AccessPolicyInfo structure	No	Access Policy information.

get_access_policy_list
This method enables an API user to get the list of access policy records
Parameters	GetAccessPolicyListRequest
Return Value	GetAccessPolicyListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAccessPolicyListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	If set to '1', the 'is_used' field will be provided for every record in the response.
get_total	No	int	No	Get the total number of retrieved records.
limit	No	int	No	The number of rows to retrieve.
managed_by	No	unsignedLong	No	The unique ID of the reseller who owns the access policy.
name	No	string	No	The name of the access policy.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
with_access_phases	No	int	No	If set to '1', the list of 'access_phases' will be provided for every record in the response.
with_attributes	No	int	No	If set to '1', the list of related service policy attribute values will be provided for every record in the response.

GetAccessPolicyListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_policy_list	No	Array of AccessPolicyInfo structure	No	The list of access policy records.
total	No	int	No	The total number of retrieved records.

update_access_policy
This method enables an API user to modify an existing access policy using the supplied data
Parameters	UpdateAccessPolicyRequest
Return Value	UpdateAccessPolicyResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateAccessPolicyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_policy_info	Yes	AccessPolicyInfo structure	No	The data related to the access policy.

UpdateAccessPolicyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_access_policy	Yes	unsignedLong	No	The unique ID of the access policy.

Access role information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/AccessRole

Access role management

add_access_role
This method enables an API user to create a new access role record using the supplied data
Parameters	AddAccessRoleRequest
Return Value	AddUpdateAccessRoleResponse
Realm	administrator
Standalone mode support	No

AddAccessRoleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_role_info	Yes	AccessRoleInfo structure	No	The information about the access role.

AddUpdateAccessRoleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_role	Yes	unsignedLong	No	The identifier of the access role.

delete_access_role
This method enables an API user to delete the access role record from the database
Parameters	DeleteAccessRoleRequest
Return Value	DeleteAccessRoleResponse
Realm	administrator
Standalone mode support	No

DeleteAccessRoleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_role	Yes	unsignedLong	No	The identifier of the access role.

DeleteAccessRoleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

get_access_role_info
This method enables an API user to get an access role record
Parameters	GetAccessRoleInfoRequest
Return Value	GetAccessRoleInfoResponse
Realm	administrator
Standalone mode support	Yes

GetAccessRoleInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_role	Yes	unsignedLong	No	The identifier of the access role.
with_permissions	No	int	No	Flag that indicates if the access role permissions should be returned.
with_usage	No	int	No	Flag that indicates if the access role usage should be returned.

GetAccessRoleInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_role_info	No	AccessRoleInfo structure	No	Data on the access role.

get_access_role_list
This method enables an API user to get the list of access role records
Parameters	GetAccessRoleListRequest
Return Value	GetAccessRoleListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAccessRoleListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
complex_ordering	No	Array of ComplexOrderingInfo structure	No	Orders the retrieved access role records by multiple fields.
get_total	No	int	No	Get the total number of the retrieved access roles.
i_role_type	No	int	No	The type of the access role.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The name of the access role.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
with_usage	No	int	No	Flag that indicates if the access role usage should be returned.

GetAccessRoleListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_roles	Yes	Array of AccessRoleInfo structure	Yes	The list of access roles.
total	No	int	No	The total number of the access roles.

get_access_role_type_info
This method enables an API user to get the access role type info
Parameters	GetAccessRoleTypeInfoRequest
Return Value	GetAccessRoleTypeInfoResponse
Realm	administrator
Standalone mode support	Yes

GetAccessRoleTypeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_role_type	Yes	unsignedLong	No	The unique ID of the access role type record to be fetched.
with_metadata	No	int	No	Specifies whether to retrieve components tree metadata for the access role type.

GetAccessRoleTypeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_role_type_info	No	AccessRoleTypeInfo structure	No	Access role type info.

get_access_role_type_list
This method enables an API user to get the list of access role type records
Parameters	GetAccessRoleTypeListRequest
Return Value	GetAccessRoleTypeListResponse
Realm	administrator
Standalone mode support	Yes

GetAccessRoleTypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
with_metadata	No	int	No	Specifies whether the retrieve components tree metadata for the access role type.

GetAccessRoleTypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_role_types	Yes	Array of AccessRoleTypeInfo structure	Yes	The list of access role types.

update_access_role
This method enables an API user to update an access role record using the supplied data
Parameters	UpdateAccessRoleRequest
Return Value	AddUpdateAccessRoleResponse
Realm	administrator
Standalone mode support	No

UpdateAccessRoleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_role_info	Yes	AccessRoleInfo structure	No	The information about the access role.

Account information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Account

Account management

add_account
This method allows an API user to create a new account record using the supplied data
Parameters	AddAccountRequest
Return Value	AddUpdateAccountResponse
Realm	administrator, reseller, representative
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Account/add_account \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}' \ -d params='{ "account_info":{ "i_customer":600, "id":"999888777", "i_product":3, "billing_model":1, "login":"999888777", "password":"qwerty123", "expiration_date":"2020-05-01", "h323_password":"aqsw1defr3" } }'`
Response example	`{ "i_account" : 1141766 }`

AddAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_info	No	AccountInfo structure	No	Note: i_account will be ignored; most fields may be omitted.
generate_web_password	No	int	No	Specifies whether to autogenerate a password to the account self-care interface. Possible values: 1 – Generate a password; 0 – Do not generate a password.

AddUpdateAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the created/modified account record.

change_password
This method enables an API user to change their password. The old_password is mandatory only when the method is executed under the account realm
Parameters	ChangeAccountPasswordRequest
Return Value	ChangePasswordResponse
Realm	retail customer, account
Standalone mode support	No

ChangeAccountPasswordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account record.
new_password	Yes	string	No	The new password.	Max value: 32 Min value: 1
old_password	No	string	No	The old password.

ChangePasswordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
errors	No	ChangePasswordResponseErrMessages structure	No	Error explanation.
success	Yes	int	No	1 for success, 0 for failure.

get_account_info
This method allows an API user to get an account record from the database. The account must be viewable (owned) by the user making the request
Parameters	GetAccountInfoRequest
Return Value	GetAccountInfoResponse
Realm	administrator, reseller, distributor, account, retail customer, cc staff, representative
Standalone mode support	Yes
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Account/get_account_info \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}' \ -d params='{ "id":"33398700001", "without_service_features":1 }'`
Response example	{ "account_info" : { "is_active" : 1, "batch_name" : "Batch_301", "customer_bill_status" : "O", "i_customer" : 12, "has_custom_fields" : 1, "bill_status" : "O", "password" : "sw7yte", "password_lifetime" : 258173509, "i_subscriber" : 1749, "in_date_format" : "YYYY-MM-DD", "out_date_time_format" : "YYYY-MM-DD HH24:MI:SS", "i_account_role" : 1, "i_batch" : 17, "first_usage_time" : "2009-09-26 02:00:00", "iso_639_1" : "en", "control_number" : 1, "included_services" : [], "i_acl" : 155, "customer_blocked" : "N", "i_account" : 100055, "out_time_format" : "HH24:MI:SS", "credit_limit" : null, "i_role" : 6, "i_vd_plan" : 166, "idle_days" : 3839, "in_time_format" : "HH24:MI:SS", "inactivity_expire_time" : null, "ecommerce_enabled" : "N", "password_timestamp" : "2012-01-26 12:47:51", "service_flags" : " ^^^~NNN ^YN~ ~YN", "out_date_format" : "YYYY-MM-DD", "status" : "", "customer_name" : "EasyCall", "product_name" : "Internet", "first_usage" : "2009-09-26", "expiration_date" : "2023-01-13", "blocked" : "N", "i_lang" : "en", "i_time_zone" : 113, "h323_password" : "3qqedemk", "login" : "33398700001", "issue_date" : "2009-09-18", "iso_4217" : "USD", "assigned_addons" : [], "time_zone_name" : "Europe/Prague", "service_features" : [], "life_time" : null, "balance" : 0.88027, "opening_balance" : 0, "cust_bill_suspension_delayed" : 0, "customer_bill_suspended" : 0, "activation_date" : "2009-09-18", "billing_model" : 1, "last_usage" : "2009-09-27 16:01:56", "i_product" : 135, "id" : "33398700001" } }

GetAccountInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
aux_field_names	No	Array of string structure	No	Additional field names to fetch.
batch_name	No	string	No	Name of batch to which the account belongs.	Max value: 32 Min value: 0
control_number	No	int	No	Sequential number of the account in the batch. This attribute serves to determine what account from the batch you wish to retrieve the information about. Mandatory for the API request with the batch_name property specified.	Max value: 4294967295 Min value: 0
detailed_info	No	int	Yes	Detailed information.
expand_alias	No	int	No	For account aliases: indicates whether the information should be retrieved from the alias or from the related master account.
get_included_services	No	int	No	Specifies whether to retrieve the list of services configured for the account. Possible values: 1 – Retreive the list of services; 0 – Do not retrieve the list of services.
get_service_features	No	ArrayOfString	No	Specifies which service features to show.
i_account	No	unsignedLong	No	The unique ID of the account.	Max value: 4294967295 Min value: 1
i_batch	No	unsignedLong	No	Refers to batch record to which the account belongs.	Max value: 4294967295 Min value: 1
i_subscriber	No	unsignedLong	No	The unique ID of the account's subscriber record. Refers to the Subscribers table.
id	No	string	No	ID (PIN) of the account on the PortaBilling interface, unique in the environment.	Min value: 0
login	No	string	No	Account login for the account web self-care interface. The unique in the environment.	Min value: 0
with_customer_info	No	int	No	If with_customer_info == 1 then return information about customer.
with_reseller_info	No	int	No	If with_reseller_info == 1 then return information about reseller.
without_service_features	No	int	No	Specifies whether the information about service features should be included in the response. Note that SOAP requests without information requests about service features are 30% faster, so specify "1" here if you don't need information about service features.

GetAccountInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_info	No	AccountInfo structure	No	Information about an account.
customer_info	No	CustomerInfo structure	No	Information about a retail customer.
reseller_info	No	CustomerInfo structure	No	Information about a reseller.

get_account_list
This method allows an API user to get the list of account records. The account must be viewable (owned) by the user making the request
Parameters	GetAccountListRequest
Return Value	GetAccountListResponse
Realm	administrator, reseller, retail customer, representative
Standalone mode support	Yes

GetAccountListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_role_list	No	Array of AccountRoleInfo structure	No	A list of account roles to search for the accounts in.	Min value: 1
batch_name	No	string	No	The batch name to which the account belongs.	Max value: 32 Min value: 0
bill_status	No	string	No	The billing status of the account to search by. Possible values: O – open; I – inactive; C – terminated.	Possible values: O, I, C
billing_model	No	int	No	The account type. Possible values: -1 – Debit; 0 – Recharge voucher; 1 – Credit.	Possible values: 0, -1, 4, 1
callshop_enabled	No	string	No	Set this value to filter Accounts whose customers have callshop feature enabled or disabled. Possible values: Y – enabled, N – disabled.	Possible values: Y, N
city	No	string	No	City of account owner's address.
companyname	No	string	No	Account owner's company name.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
control_number	No	unsignedLong	No	The sequential number of the account in the batch.
control_number_list	No	Array of AccountControlNumberInfo structure	No	A list of control numbers to search the account by.
country	No	string	No	Country code.
custom_fields_values	No	Array of CustomFieldsValuesInfo structure	No	The list of Custom Fields values.
email	No	string	No	Account's email address.
expand_alias	No	int	No	For account aliases: indicates whether the information should be retrieved from the alias or from the related master account.
faxnum	No	string	No	Fax number.
firstname	No	string	No	Account owner's first name.
free_of_extension	No	int	No	Get only the accounts that aren't assigned to any extension.
get_not_closed_accounts	No	int	Yes	Get only accounts with statuses different from "closed".
get_only_real_accounts	No	int	Yes	Get only accounts and skip account aliases.
get_service_features	No	ArrayOfString	No	Specifies the list of service features to get for each account.
get_statuses	No	int	No	Get the statuses of the accounts.
get_total	No	int	Yes	Get the total number of the retrieved accounts.
i_account_balance_control_type	No	unsignedLong	No	The unique ID of the account's balance control type.	Possible values: 1, 2, 3
i_addon_product	No	unsignedLong	No	The unique ID of the record of the addon product that is assigned to the account.	Max value: 4294967295 Min value: 1
i_batch	No	unsignedLong	Yes	Refers to batch record to which the account belongs.	Max value: 4294967295 Min value: 1
i_customer	No	unsignedLong	No	Refers to the customer record to which the account belongs.	Max value: 4294967295 Min value: 1
i_customer_site	No	unsignedLong	Yes	The unique ID of the customer site.	Max value: 4294967295 Min value: 1
i_master_account	No	unsignedLong	No	The internal ID of the master account record.
i_product	No	unsignedLong	No	Refers to the product record which is assigned to the account.	Max value: 4294967295 Min value: 1
id	No	string	No	Search pattern for account IDs.	Min value: 0
lastname	No	string	No	Account owner's last name.
legal_intercept_only	No	int	Yes	Get only accounts with "Legal Intercept" enabled.
limit	No	int	No	The number of rows to retrieve.	Default value: 50 Max value: 1000 Min value: 1
login	No	string	No	User login for self-care web interface.
midinit	No	string	No	Account owner's middle initial(s).
note	No	string	No	Short note (description).
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0 Max value: 4294967295 Min value: 0
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
salutation	No	string	No	Account owner's salutation.
sip_status	No	int	No	Indicates whether the account is used by a SIP phone to register with a PortaSIP server: 1 – online (the account is used by a SIP phone to register with a PortaSIP server); 0 – offline.	Max value: 1 Min value: 0
state	No	string	No	Province or state.
subscriber_email	No	string	No	Subscriber's email address.
with_addon_products	No	int	No	A flag that indicates whether the add-on products of the account will be returned. Possible values: 1 - supplement account information with the list of add-on products, 0 - the list of addon products will not be included in the response. Default value: 0.
zip	No	string	No	Postal (zip) code.

GetAccountListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_list	No	Array of AccountInfo structure	No	Set of account data records.
total	No	int	No	The total number of the retrieved accounts.

get_provisioning_status_list
The method enables an API user to retrieve the list of account provisioning statuses
Parameters	GetAccountProvisioningStatusListRequest
Return Value	GetAccountProvisioningStatusListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountProvisioningStatusListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account.
i_group	No	unsignedLong	No	The unique ID of the provisioning group.

GetAccountProvisioningStatusListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
provisioning_status_list	No	Array of AccountProvisioningStatusInfo structure	No	The list of the account provisioning statuses.

move_account
This method enables an administrator to "move" an account to a different customer. The "movement" is performed in two steps: 1) The clone of the account is created for the appropriate customer; 2) The original account is terminated. If an account has any subscriptions (active and / or not yet active), they "move" together with it. The subscription usage data are preserved. For instance, the clone of the original account will be charged according to the promotional period that was applied before the transfer (e.g. $5 for the 9th subscription period). All subscriptions (both active and not yet active) of the original account are closed. The end date will be the day before the transfer is performed. No fees are applied to the original account (e.g. a cancellation fee). If the account is "moved" when the subscription charges in advance have already been applied, then a refund is issued for the "unused" subscription time (e.g. 15 days)
Parameters	MoveAccountRequest
Return Value	MoveAccountResponse
Realm	administrator
Standalone mode support	No

MoveAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
batch_name	Yes	string	No	The name of the batch to put the account into.
i_account	Yes	unsignedLong	No	The unique ID of the account to be moved.
i_customer	Yes	unsignedLong	No	The unique ID of the customer to move account to.
i_product	No	unsignedLong	Yes	The unique ID of the product.
i_routing_plan	No	unsignedLong	Yes	The unique ID of the routing plan.
i_vd_plan	No	unsignedLong	Yes	The unique ID of the volume discount plan.

MoveAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The new unique ID of the account that was moved.
old_i_account	Yes	unsignedLong	No	The old ID of the account that was moved.
warnings	No	ArrayOfString	Yes	Warnings accumulated while moving the account.

terminate_account
This method allows an API user to terminate an existing account record
Parameters	TerminateAccountRequest
Return Value	TerminateAccountResponse
Realm	administrator, reseller, representative
Standalone mode support	No

TerminateAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
force	No	int	No	The flag specifies whether associated non-disconnectable active sessions should be ignored.
i_account	Yes	unsignedLong	No	The unique ID of the account.
release_assigned_did	No	int	No	The flag specifies whether the previously assigned DID number should be released to the pool (true by default).	Default value: 1

TerminateAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.
warnings	No	ArrayOfString	No	Returns procedure warnings if any.

update_account
This method enables an API user to update an existing account record using the supplied data. Note that if a user is not allowed to manage (create/read/update/delete access types) some field by an ACL, then the client application must not send this property in the request (Otherwise PortaBilling® will reject the whole request). That is why we recommend you to make sure that your customer portals and other external applications correspond to the ACL configuration in PortaBilling®. Use the get_my_permissions_for_objects method to find out the permissions for every object on the PortaBilling® web interface.
Parameters	UpdateAccountRequest
Return Value	AddUpdateAccountResponse
Realm	administrator, reseller, distributor, retail customer, account, cc staff, representative
Standalone mode support	No

UpdateAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_info	Yes	AccountInfo structure	No	Note: i_account is a mandatory field; only fields requiring modification should be provided.
release_assigned_did	No	int	No	The flag specifies whether the previously assigned DID number should be released to the pool (true by default).	Default value: 1

validate_account_info
This method enables an API user to check if the supplied data can be used to create a new account record or update an existing one. If successful, the completed data is returned. Note that if a user is not allowed to manage (create/read/update/delete access types) some field by an ACL, then the client application must not send this property in the request (Otherwise PortaBilling® will reject the whole request). That is why we recommend you to make sure that your customer portals and other external applications correspond to the ACL configuration in PortaBilling®. Use the get_my_permissions_for_objects method to find out the permissions for every object on the PortaBilling® web interface.
Parameters	ValidateAccountInfoRequest
Return Value	ValidateAccountInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

ValidateAccountInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_info	No	AccountInfo structure	No	Complete information about an account; note: omit i_account to check if data can be used to create a new account record.

ValidateAccountInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_info	No	AccountInfo structure	No	Data about an account, see AccountInfo above.

Account role management

get_role_info
This method enables an API user to get the information about an account role by i_account_role
Parameters	GetAccountRoleInfoRequest
Return Value	GetAccountRoleInfoResponse
Realm	administrator, reseller, distributor, account, retail customer, cc staff, representative
Standalone mode support	Yes

GetAccountRoleInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_role	Yes	unsignedLong	No	The identifier of the account role.

GetAccountRoleInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
role_info	No	AccountRoleInfo structure	No	Information about an account role info.

get_role_list
This method enables an API user to retrieve the information about account roles by their fields
Parameters	GetAccountRoleListRequest
Return Value	GetAccountRoleListResponse
Realm	administrator, reseller, distributor, account, retail customer, cc staff, representative
Standalone mode support	Yes

GetAccountRoleListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved records.
i_account_role	No	unsignedLong	No	The unique ID of the account role type.
inventory_usage	No	string	No	Specifies whether to retrieve the inventory for the account role type.	Possible values: Y, N
limit	No	int	No	The number of records to retrieve.
name	No	string	No	The name of the account role type.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
realm	No	string	No	The top realm of the account role type.
validation_format	No	string	No	The validation for the ID of the account role type.

GetAccountRoleListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
role_list	No	Array of AccountRoleInfo structure	Yes	The list of account roles.
total	No	int	No	The total number of the retrieved account rules.

Alias management

add_alias
This method allows an API user to add an alias
Parameters	AddAccountAliasRequest
Return Value	AddAccountAliasResponse
Realm	administrator, reseller, representative
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Account/add_alias \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}' \ -d params='{ "alias_info":{ "i_master_account":1141766, "id":"alias-id@somewhere.com" } }'`
Response example	`{ "success" : 1, "i_account" : 1141767 }`

AddAccountAliasRequest
Property	Mandatory	Type	Nillable	Description	Possible values
alias_info	Yes	AliasInfo structure	No	Alias information.

AddAccountAliasResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	Yes	The unique ID of the alias record.
success	Yes	int	No	1 for success, 0 for failure.

delete_alias
This method allows an API user to remove an alias
Parameters	DeleteAccountAliasRequest
Return Value	DeleteAccountAliasResponse
Realm	administrator, reseller, representative
Standalone mode support	No

DeleteAccountAliasRequest
Property	Mandatory	Type	Nillable	Description	Possible values
alias_info	Yes	AliasInfo structure	No	Alias information.
force	No	int	No	The flag specifies whether associated non-disconnectable active sessions should be ignored.
release_assigned_did	No	int	No	The flag specifies whether the previously assigned DID number should be released to the pool (true by default).	Default value: 1

DeleteAccountAliasResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if success, SOAP fault otherwise.
warnings	No	ArrayOfString	No	Returns procedure warnings if any.

get_alias_list
This method allows an API user to get the list of aliases
Parameters	GetAccountAliasListRequest
Return Value	GetAccountAliasListResponse
Realm	administrator, reseller, representative, account, retail customer
Standalone mode support	Yes

GetAccountAliasListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
blocked	No	string	No	The filter to search aliases by the 'blocked' field.
check_did	No	int	No	Pass this flag to check if the alias has an associated DID number.
get_total	No	int	Yes	Get the total number of the retrieved aliases.
i_account_role	No	unsignedLong	No	The unique ID of the account role to search aliases by.
i_master_account	Yes	unsignedLong	No	ID of a master account record.
id	No	string	No	The pattern to search aliases by the 'id' field.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
realm	No	string	No	The pattern to search aliases by the 'realm' field.

GetAccountAliasListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
alias_list	No	Array of AliasInfo structure	No	The list of aliases.
total	No	int	No	The number of the retrieved aliases.

update_alias
This method allows an API user to update an alias
Parameters	UpdateAccountAliasRequest
Return Value	UpdateAccountAliasResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateAccountAliasRequest
Property	Mandatory	Type	Nillable	Description	Possible values
alias_info	Yes	AliasInfo structure	No	Alias information.
release_assigned_did	No	int	No	The flag specifies whether the previously assigned DID number should be released to the pool (true by default).	Default value: 1

UpdateAccountAliasResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

Async API notification management

disable_api_notifications
This method is obsolete. Use the new disable_api_notifications method of the CallControl service instead. Obsolete. Use CallControl.disable_api_notifications method instead
Parameters	DisableApiNotificationsAccountRequest
Return Value	DisableApiNotificationsAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No
Mode	Syncronous only

DisableApiNotificationsAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
event	Yes	string	No	The event name.	Possible values: sip.call_control_notifications
i_account	No	unsignedLong	No	The unique ID of the account record.
i_ivr_an	No	unsignedLong	No	The unique ID of the IVR access number.

DisableApiNotificationsAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successfully completed.

enable_api_notifications
This method is obsolete. Use the new enable_api_notifications method of the CallControl service instead. Obsolete. Use CallControl.enable_api_notifications method instead
Parameters	EnableApiNotificationsAccountRequest
Return Value	EnableApiNotificationsAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No
Mode	Syncronous only

EnableApiNotificationsAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
event	Yes	string	No	The event name.	Possible values: sip.call_control_notifications
i_account	No	unsignedLong	No	The unique ID of the account record.
i_ivr_an	No	unsignedLong	No	The unique ID of the IVR access number.

EnableApiNotificationsAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successfully completed.

Auto-payment management

add_auto_payment
This method enables an API user to set up automated periodic payments
Parameters	AddUpdateAutoPaymentInfoRequest
Return Value	AddUpdateAutoPaymentInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

AddUpdateAutoPaymentInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
auto_payment_info	Yes	AutoPaymentInfo structure	No	Auto-payment data.

AddUpdateAutoPaymentInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_object	Yes	unsignedLong	No	The unique ID of either an account or a customer.

delete_auto_payment
This method enables an API user to delete an account's automated periodic payment
Parameters	DeleteAutoPaymentRequest
Return Value	DeleteAutoPaymentResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DeleteAutoPaymentRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_object	Yes	unsignedLong	No	The unique ID of an account or a customer. Not mandatory when the method that requires this structure is executed from the retail customer realm.

DeleteAutoPaymentResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_auto_payment_info
This method enables an API user to get an account’s automated periodic payment record
Parameters	GetAutoPaymentInfoRequest
Return Value	GetAutoPaymentInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAutoPaymentInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_object	Yes	unsignedLong	No	The unique ID of an account or a customer. Not mandatory when the method that requires this structure is executed from the retail customer realm or the account realms.

GetAutoPaymentInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
auto_payment_info	Yes	AutoPaymentInfo structure	Yes	Auto-payment data.

update_auto_payment
This method enables an API user to update automated periodic payments
Parameters	AddUpdateAutoPaymentInfoRequest
Return Value	AddUpdateAutoPaymentInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

Batch management

generate_accounts
This method enables an API user to generate a batch of accounts
Parameters	GenerateAccountsRequest
Return Value	GenerateAccountsResponse
Realm	administrator, reseller
Standalone mode support	No

GenerateAccountsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	date	No	The date when the account becomes usable.	Default value: current date
addon_products	No	ArrayOfInt	No	The list of effective add-on products for the given accounts.
batch	Yes	string	No	Name of existing batch or new one.	Max value: 32 Min value: 1
billing_model	No	int	No	One of the following: -1 – Debit; 0 – Recharge Voucher;1 – Credit .	Default value: -1 Possible values: -1, 1, 0
blocked	No	string	No	Shows whether account will be blocked after creation; default: N.	Default value: N Possible values: Y, N
check_available_dids	No	int	No	If 'gen_method' is set to 'D' and the field is set to '1', the method will check available numbers and fall with an error if the number of available numbers is less than the value in the 'gen_amount' field.
check_available_sim_cards	No	int	No	If the account role is set to 'Mobile' and the field is set to '1', the method will check available SIM cards and raise an error if the number of available SIM cards is less than the value in the 'gen_amount' field.
credit_limit	No	float	No	Account's credit limit value. Only for credit accounts; default: 0.
ecommerce_enabled	No	string	No	Allow the account's owner to make online payments or set up periodical payments on the account's self-care interface.	Default value: N Possible values: Y, N
expiration_date	No	date	Yes	The date when the account become unusable.
gen_amount	No	int	No	Amount of accounts to generate.	Default value: 1000 Max value: 10000 Min value: 1
gen_credentials_method	No	string	No	Method of login and password generation: empty, auto.	Default value: auto Possible values: empty, auto
gen_h323_length	No	int	No	Length of service password to generate for method auto_digits; default: defined by cfg option Cardissue.NumericH323PasswordLength.
gen_h323_method	No	string	No	Method of service password generation: empty, auto, auto_digits. Only for Debit accounts and Recharge vouchers.	Default value: empty Possible values: empty, auto, auto_digits
gen_i_do_batch	No	unsignedLong	No	ID of DID owner batch to use DID numbers from. Only for DID Inventory method.
gen_id_length	No	int	No	Account ID length. Only for the Random method.	Default value: 12 Max value: 128 Min value: 4
gen_id_prefix	No	string	No	Account ID prefix. Only for the Random method.	Max value: 64
gen_method	No	string	No	The accounts generation method: R – Random; S – Sequential; D – DID Inventory.	Default value: R Possible values: R, S, D
gen_start_did	No	string	No	Starting DID number. Only for the DID Inventory method.
gen_start_id	No	string	No	Account's start ID. Only for Sequential method.
gen_start_imsi	No	string	No	Starting IMSI SIM number. Only for the Mobile account role. It is used to specify the starting IMSI SIM numbers in the generated accounts. The starting sequence should be a string containing from 6 to 15 digits. Note that SIM cards with a specified starting IMSI should be available in the SIM card inventory. The UI equivalent of this field is the "Assign IMSI sequentially starting with" field on the "Account generation optional configuration" panel.
i_account_balance_control_type	No	unsignedLong	No	The unique ID of the Account_Balance_Control_Types record (the Balance Control field on the PortaBilling web interface).
i_account_role	No	unsignedLong	No	The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID.	Default value: 1
i_acl	No	unsignedLong	No	The unique ID for the account's access level; refers to the Access_Levels table.
i_batch	No	unsignedLong	No	The unique ID of the batch to which the account belongs.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.
i_customer_site	No	unsignedLong	No	The unique ID of a customer site record.
i_distributor	No	unsignedLong	No	The unique ID of the distributor. Only for Debit accounts and Recharge vouchers.
i_product	Yes	unsignedLong	No	The unique ID of the product record.
i_role	No	unsignedLong	No	The unique ID of the account's access role; refers to the Roles table.
i_time_zone	No	unsignedLong	No	The unique ID of the time zone record.	Default value: 370
in_date_format	No	string	No	Input format for date indication.	Default value: YYYY-MM-DD Max value: 16
in_time_format	No	string	No	Input format for time indication.	Default value: HH24:MI:SS Max value: 16
inactive	No	string	No	Shows whether account will be inactive after creation. Only for Debit accounts and Recharge vouchers. The default value is: Y.	Default value: Y Possible values: Y, N
inactivity_expire_time	No	int	No	Specifies the number of days the account remains active after its last use or recharge.	Max value: 65535 Min value: 1
language	No	string	No	The accounts' language.	Max value: 2 Min value: 2
life_time	No	int	Yes	Accounts will expire on the first usage time + lifetime days.	Max value: 65535 Min value: 1
opening_balance	No	float	No	The initial balance of the account.	Default value: 10 Max value: 99999999999.99998 Min value: -9999999999.99999 Precision: 15, Scale: 5
out_date_format	No	string	No	Output format for date indication.	Default value: YYYY-MM-DD Max value: 16
out_date_time_format	No	string	No	Output format for full date/time indication.	Default value: YYYY-MM-DD HH24:MI:SS Max value: 32
out_time_format	No	string	No	Output format for time indication.	Default value: HH24:MI:SS Max value: 16
service_features	No	Array of ServiceFeatureInfo structure	No	Contains values for account's service attributes.

GenerateAccountsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_batch	No	unsignedLong	No	The ID of the batch to which the accounts belong.
success	Yes	int	No	Returns 1 if an accounts generation procedure was queued.

generate_aliases
This method enables an API user to generate a batch of aliases
Parameters	GenerateAliasesRequest
Return Value	GenerateAliasesResponse
Realm	administrator, reseller
Standalone mode support	No

GenerateAliasesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
blocked	No	string	No	Shows whether the alias will be blocked after creation and using it for the authentication is not possible; default: N.	Default value: N Possible values: Y, N
check_available_dids	No	int	No	If set the method will check all available numbers and terminate with an error if there are less numbers available than the value in the 'gen_amount' field.
gen_amount	No	int	No	The number of aliases to generate.	Default value: 1000 Max value: 10000 Min value: 1
gen_i_do_batch	No	unsignedLong	No	The ID of DID owner batch to use DID numbers from.
gen_start_did	No	string	No	Starting DID number.	Max value: 32
i_account_role	No	unsignedLong	No	The ID of the account role. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and is used for account ID validation.	Default value: 1 Possible values: 1, 2
i_master_account	Yes	unsignedLong	No	The ID of the parent account record.
realm	No	string	No	An account realm enables administrators to impose a scope of uniqueness for an account ID.	Max value: 100

GenerateAliasesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 if an aliases generation procedure was queued.

update_accounts_batch
This method allows an API user to update accounts of a particular batch
Parameters	UpdateAccountsBatchRequest
Return Value	UpdateAccountsBatchResponse
Realm	administrator, reseller
Standalone mode support	Yes

UpdateAccountsBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
activate	No	int	No	Indicates that accounts should be activated. Only for debit accounts and vouchers.
activation_date	No	date	No	The date from which accounts are usable.
addon_products	No	ArrayOfInt	No	The list of effective add-on products for the given accounts.
advanced_search	No	AccountsAdvancedSearchInfo structure	No	Enables filtering accounts which should be updated by specific fields.
batch	No	string	No	The batch name.	Max value: 32 Min value: 1
blocked	No	string	No	Indicates whether accounts should be blocked or unblocked.	Possible values: Y, N
charge	No	float	No	The amount to charge accounts.	Max value: 99999999999.99998 Min value: 0.00001 Precision: 15, Scale: 5
control_number	No	string	No	Comma-separated integer control numbers and/or ranges of integer control numbers. For example: 3,5-9,12.	Min value: 1
credit	No	float	No	The amount to credit accounts.	Max value: 99999999999.99998 Min value: 0.00001 Precision: 15, Scale: 5
expiration_date	No	date	Yes	The date from which accounts will become unusable.
force_terminate	No	int	No	Indicates that accounts should be terminated (ignoring associated non-disconnectable active sessions).
i_batch	No	unsignedLong	No	The unique ID of batch record.
i_customer_site	No	unsignedLong	Yes	The unique ID of Customer Site record.
i_distributor	No	unsignedLong	Yes	The unique ID of Distributor.
i_product	No	unsignedLong	No	The unique ID of Product record .
i_role	No	unsignedLong	No	The unique ID of the account's access role.
i_time_zone	No	unsignedLong	No	The unique ID of Time Zone record.
ivr_language	No	string	Yes	Preferred IVR language.	Max value: 5 Min value: 2
life_time	No	int	Yes	Accounts will expire on the first usage time + lifetime days.	Max value: 65535 Min value: 1
opening_balance	No	float	No	The initial balance of the account.	Max value: 99999999999.99998 Min value: -9999999999.99999 Precision: 15, Scale: 5
reapply_subscriptions	No	int	No	Product subscriptions will be reapplied for accounts.
redirect_number	No	string	No	Associated number.	Max value: 128
terminate	No	int	No	Indicates that accounts should be terminated.
unified_messaging	No	string	No	Enable/disable or set as defined by the product UM service feature.	Possible values: ~, Y, N

UpdateAccountsBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 if accounts batch update has been successful.
warnings	No	ArrayOfString	No	Returns procedure warnings if any.

Call barring rules management

get_call_barring_options
This method allows an API user to retrieve all available options for account call barring and check their status
Parameters	GetCallBarringOptionsRequest
Return Value	GetCallBarringOptionsResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetCallBarringOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_effective_values	No	int	No	Possible values: 1 – Retreive the call barring rules defined at the customer level; 0 – Retreive only those call barring rules that were defined for the account.
i_account	Yes	unsignedLong	No	The unique ID of the account.

GetCallBarringOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
options	No	Array of CallBarringRuleInfo structure	Yes	Call barring options.

update_call_barring_options
This method allows an API user to update options for account call barring, i.e. enable or disable the corresponding items
Parameters	UpdateCallBarringOptionsRequest
Return Value	UpdateCallBarringOptionsResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

UpdateCallBarringOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.
options	Yes	Array of CallBarringRuleInfo structure	No	Call barring options.

UpdateCallBarringOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

Call screening management

add_cp_condition
This method allows an API user to add a call screening condition
Parameters	AddCPConditionRequest
Return Value	AddCPConditionResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

AddCPConditionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cp_condition_info	Yes	CPConditionInfo structure	No	Call screening condition structure.

AddCPConditionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call screening condition record.

add_cp_rule
This method allows an API user to create a new call screening rule
Parameters	AddCPRuleRequest
Return Value	AddCPRuleResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

AddCPRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cp_rule_info	Yes	CPRuleInfo structure	No	Call screening rule info structure. Note: i_account is a mandatory field.

AddCPRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_rule	Yes	unsignedLong	No	The unique ID of the call screening rule record.

arrange_cp_rules
This method allows an API user to redefine the order in which call screening rules are applied
Parameters	ArrangeCPRulesRequest
Return Value	ArrangeCPRulesResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

ArrangeCPRulesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.
rules	Yes	Array of unsignedLong structure	No	Array of IDs of CPRuleInfo structures.

ArrangeCPRulesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	One of the following: 1 – success, 0 – failed.

delete_cp_condition
This method enables an API user to delete an existing call screening condition
Parameters	DeleteCPConditionRequest
Return Value	DeleteCPConditionResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

DeleteCPConditionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cp_condition_info	Yes	CPConditionInfo structure	No	Call screening condition.

DeleteCPConditionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	One of the following: 1 – success, 0 – failed.

delete_cp_rule
This method allows an API user to delete an existing call screening rule
Parameters	DeleteCPRuleRequest
Return Value	DeleteCPRuleResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

DeleteCPRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cp_rule_info	Yes	CPRuleInfo structure	No	The unique ID of the call screening rule record.

DeleteCPRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	One of the following: 1 – success, 0 – failed.

get_cp_condition_info
This method enables an API user to retrieve the info about a call screening condition
Parameters	GetCPConditionInfoRequest
Return Value	GetCPConditionInfoResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetCPConditionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call screening condition record.

GetCPConditionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cp_condition_info	No	CPConditionInfo structure	No	Call screening condition structure.

get_cp_condition_list
This method allows an API user to retrieve the list of call screening conditions defined for a given customer
Parameters	GetCPConditionListRequest
Return Value	GetCPConditionListResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetCPConditionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved call processing rule data records.
i_account	Yes	unsignedLong	No	The unique ID of the account.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	Name pattern of the condition.
offset	No	int	No	The number of rows to skip at the beginning of the list.
type	No	string	Yes	One of the following: FromNumber, ToNumber, TimeWindow.

GetCPConditionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cp_condition_list	No	Array of CPConditionInfo structure	No	Array of CPConditionInfo structures.
total	No	int	No	The total number of the retrieved call processing rule records.

get_cp_rule_list
This method allows an API user to retrieve the information about defined call screening rules
Parameters	GetCPRuleListRequest
Return Value	GetCPRuleListResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetCPRuleListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved rate data records.
i_account	Yes	unsignedLong	No	The unique ID of the account.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.

GetCPRuleListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cp_rule_list	No	Array of CPRuleInfo structure	No	Array of CPRuleInfo structures.
total	No	int	No	The total number of records.

update_cp_condition
This method allows an API user to update an existing call screening condition
Parameters	UpdateCPConditionRequest
Return Value	UpdateCPConditionResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

UpdateCPConditionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cp_condition_info	Yes	CPConditionInfo structure	No	Call screening condition structure.

UpdateCPConditionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call screening condition rule.

update_cp_rule
This method allows an API user to update an existing call screening rule
Parameters	UpdateCPRuleRequest
Return Value	UpdateCPRuleResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

UpdateCPRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cp_rule_info	Yes	CPRuleInfo structure	No	Call screening rule info structure. Note: i_account will be ignored.

UpdateCPRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_rule	Yes	unsignedLong	No	The unique ID of the call screening rule record.

Commitment management

assign_commitment
The method enables an API user to assign a commitment to an account
Parameters	AssignCommitmentRequest
Return Value	AssignCommitmentResponse
Realm	administrator, reseller
Standalone mode support	No

AssignCommitmentRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The identifier of the account record.
i_commitment	Yes	unsignedLong	No	The identifier of the commitment record.
min_terminate_date	No	date	No	The end date of the minimum period after which the commitment can be terminated without penalties.
sale_discount_configuration_list	No	Array of SaleDiscountConfigurationInfo structure	No	The list of the sale discounts configuration. Allows to apply additional discounts to the recurring charges configured on the commitment level. The sale discounts are applied along with the commitment discounts. The sale discount period can be bigger than the standard commitment discount period.
start_date	No	date	No	The date when the commitment services are enabled. The charges activation may be postponed by the config option 'Commitments.ActivationDelay'.

AssignCommitmentResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.

cancel_scheduled_commitment_replacement
The method enables an API user to cancel a scheduled commitment replacement
Parameters	DeleteScheduledCommitmentRecordReplacementRequest
Return Value	DeleteScheduledCommitmentRecordReplacementResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteScheduledCommitmentRecordReplacementRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	Yes	unsignedLong	No	The unique identifier of the account commitment record.

DeleteScheduledCommitmentRecordReplacementResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

estimate_assigned_commitment_penalty_list
The method enables an API user to estimate the penalty for a commitment termination
Parameters	EstimateAssignedCommitmentPenaltyListRequest
Return Value	EstimateAssignedCommitmentPenaltyListResponse
Realm	administrator
Standalone mode support	No

EstimateAssignedCommitmentPenaltyListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_one_time_term_list	No	Array of AccountCommitmentOneTimeTermInfo structure	No	The list of the one-time terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag.
commitment_recurring_term_list	No	Array of AccountCommitmentRecurringTermInfo structure	No	The list of the recurring terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag.
finish_date	Yes	date	No	The date when the commitment finishes.
i_account_commitment	Yes	unsignedLong	No	The unique identifier of the account commitment record.
penalty_period_from	No	date	No	Calculate penalties starting from the specified date.
penalty_period_to	No	date	No	Calculate penalties until the specified date.

EstimateAssignedCommitmentPenaltyListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_one_time_term_list	No	Array of AccountCommitmentOneTimeEstimateTermInfo structure	No	The list of the penalties for the one-time charges termination.
commitment_recurring_term_list	No	Array of AccountCommitmentRecurringEstimateTermInfo structure	No	The list of the penalties for the recurring charges termination.

get_assigned_commitment_record_info
The method enables an API user to get the information about the commitment assigned to an account
Parameters	GetAssignedCommitmentRecordInfoRequest
Return Value	GetAssignedCommitmentRecordInfoResponse
Realm	administrator, reseller
Standalone mode support	No

GetAssignedCommitmentRecordInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	Yes	unsignedLong	No	The unique identifier of the account commitment record.

GetAssignedCommitmentRecordInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_commitment_info	No	AccountCommitmentInfo structure	No	The account commitment record information.

get_assigned_commitment_record_list
The method enables an API user to get the set of commitments assigned to an account
Parameters	GetAssignedCommitmentRecordListRequest
Return Value	GetAssignedCommitmentRecordListResponse
Realm	administrator, reseller
Standalone mode support	No

GetAssignedCommitmentRecordListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved records.
i_account	No	unsignedLong	No	The unique identifier of the account.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetAssignedCommitmentRecordListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_commitment_list	No	Array of AccountCommitmentInfo structure	No	The set of account commitment records.
total	No	int	No	The total number of found records.

get_assigned_commitment_terms
The method enables an API user to get account commitment terms associated with an assigned commitment
Parameters	GetAssignedCommitmentTermsRequest
Return Value	GetAssignedCommitmentTermsResponse
Realm	administrator, reseller
Standalone mode support	No

GetAssignedCommitmentTermsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.

GetAssignedCommitmentTermsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_one_time_term_list	No	Array of AccountCommitmentOneTimeTermInfo structure	No	The list of one-time terms associated with the account commitment record.
commitment_recurring_term_list	No	Array of AccountCommitmentRecurringTermInfo structure	No	The list of recurring terms associated with the account commitment record.

get_scheduled_commitment_record_replacement_info
The method enables an API user to get the information about a scheduled commitment replacement
Parameters	GetScheduledCommitmentRecordReplacementRequest
Return Value	GetScheduledCommitmentRecordReplacementResponse
Realm	administrator, reseller
Standalone mode support	No

GetScheduledCommitmentRecordReplacementRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	Yes	unsignedLong	No	The unique identifier of the account commitment record.

GetScheduledCommitmentRecordReplacementResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_commitment_replacement_info	No	ScheduledCommitmentReplacementInfo structure	No	The information about the scheduled account commitment replacement.

pause_assigned_commitment_record
The method enables an API user to temporary pause commitment conditions. The recurring charges won't be applied and the services won't be provided during the pause
Parameters	PauseAssignedCommitmentRecordRequest
Return Value	PauseAssignedCommitmentRecordResponse
Realm	administrator, reseller
Standalone mode support	No

PauseAssignedCommitmentRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	Yes	unsignedLong	No	The unique identifier of the account commitment record.
pause_from_date	No	date	No	Specifies the start date of the pause.
pause_to_date	No	date	No	Specifies the end date of the pause.

PauseAssignedCommitmentRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

schedule_commitment_record_replacement
The method enables an API user to schedule a commitment replacement with a new one. The new addon product, specified in the request, will be assigned to the account until the specified replacement date
Parameters	ScheduleCommitmentRecordReplacementRequest
Return Value	ScheduleCommitmentRecordReplacementResponse
Realm	administrator, reseller
Standalone mode support	No

ScheduleCommitmentRecordReplacementRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_commitment_replacement_info	Yes	ScheduledCommitmentReplacementInfo structure	No	The information about the scheduled account commitment replacement.

ScheduleCommitmentRecordReplacementResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

terminate_assigned_commitment_record
The method enables an API user to terminate a commitment. The user may set custom rules for applying termination penalties to the commitment itself, or overwrite the rule for applying penalties for separate terms
Parameters	TerminateAssignedCommitmentRecordRequest
Return Value	TerminateAssignedCommitmentRecordResponse
Realm	administrator, reseller
Standalone mode support	No

TerminateAssignedCommitmentRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
apply_penalties	No	string	No	The flag specifies whether the penalties should be applied for early termination (default: they should). It may be overwritten for the specific commitment terms.	Possible values: Y, N
apply_prev_penalty	No	string	No	The flag specifies whether the penalties should be applied from previous commitments (default: they should).	Possible values: Y, N
commitment_one_time_term_list	No	Array of AccountCommitmentOneTimeTermInfo structure	No	The list of the one-time terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag.
commitment_recurring_term_list	No	Array of AccountCommitmentRecurringTermInfo structure	No	The list of the recurring terms with the information whether the penalties should be applied. May be used for overwriting the global 'apply_penalties' flag.
finish_date	No	date	No	Specifies the date on which the commitment should be terminated. The services will be deactivated and the charges terminated on the specified date at the end of the day in the customer's timezone. If no date is specified, the commitment will be terminated on the same day, at the end of the day in the customer's timezone. If no date is specified and the commitment activation delay (specified by the Commitments.ActivationDelay config option) is not yet over, the commitment will be terminated immediately, the addons will be deactivated and the customer won't be charged.
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.
penalty_period_from	No	date	No	Specifies the date staring from which the penalties are calculated.
penalty_period_to	No	date	No	Specifies the date until which the penalties are calculated.

TerminateAssignedCommitmentRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

transfer_assigned_commitment_record
The method enables an API user to move an assigned commitment to another account
Parameters	TransferAssignedCommitmentRecordRequest
Return Value	TransferAssignedCommitmentRecordResponse
Realm	administrator, reseller
Standalone mode support	No

TransferAssignedCommitmentRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
apply_transfer_fee	No	string	No	The flag specifies whether the transfer fee should be applied.	Possible values: Y, N
i_account_commitment	Yes	unsignedLong	No	The unique identifier of the account commitment record.
i_account_to	Yes	unsignedLong	No	The identifier of the account to move the commitment to.
i_new_commitment	No	unsignedLong	No	The unique identifier of the new commitment if the old one should be replaced.

TransferAssignedCommitmentRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	Yes	int	No	The transferred commitment record identifier.

unpause_assigned_commitment_record
The method enables an API user to unpause a previously paused commitment record
Parameters	UnpauseAssignedCommitmentRecordRequest
Return Value	UnpauseAssignedCommitmentRecordResponse
Realm	administrator, reseller
Standalone mode support	No

UnpauseAssignedCommitmentRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.

UnpauseAssignedCommitmentRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

update_assigned_commitment_record
The method enables an API user to update a commitment assigned to an account
Parameters	UpdateAssignedCommitmentRecordRequest
Return Value	UpdateAssignedCommitmentRecordResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateAssignedCommitmentRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_commitment_info	No	AccountCommitmentInfo structure	No	The updated account commitment info.

UpdateAssignedCommitmentRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.

Custom field management

get_custom_fields_schema
This method allows an API user to get the list of account's custom fields with information about their types and allowed values
Parameters	GetAccountCustomFieldsSchemaRequest
Return Value	GetAccountCustomFieldsSchemaResponse
Realm	administrator, reseller, retail customer, account, distributor, cc staff, representative
Standalone mode support	Yes

GetAccountCustomFieldsSchemaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record. If not provided, the ID of the entity that is logged in will be used.

GetAccountCustomFieldsSchemaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields	No	Array of AccountCustomFieldsInfo structure	Yes	The list of Custom Fields with information for the given account.

get_custom_fields_values
This method allows an API user to get the list of account's custom fields
Parameters	GetAccountCustomFieldsValuesRequest
Return Value	GetAccountCustomFieldsValuesResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetAccountCustomFieldsValuesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetAccountCustomFieldsValuesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields_values	No	Array of CustomFieldsValuesInfo structure	Yes	The list of Custom Fields values for the given account.

update_custom_fields_values
This method allows an API user to modify customer's custom fields
Parameters	UpdateAccountCustomFieldsValuesRequest
Return Value	UpdateAccountCustomFieldsValuesResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Account/update_custom_fields_values \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}' \ -d params='{ "i_account":"1141766", "custom_fields_values":[ { "name":"Driver_license", "text_value":"#123456" }, { "name":"License_storage_period", "text_value":"10" } ] }'`
Response example	`{ "custom_fields_values" : [ { "i_custom_field" : 61, "i_custom_field_value" : 251, "name" : "Driver_license", "text_value" : "#123456", "db_value" : "#123456" }, { "i_custom_field" : 66, "i_custom_field_value" : 256, "name" : "License_storage_period", "db_value" : "10", "text_value" : "10" } ], "i_account" : 1141766 }`

UpdateAccountCustomFieldsValuesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields_values	Yes	Array of CustomFieldsValuesInfo structure	Yes	The list of Custom Fields values for the given account.
i_account	No	unsignedLong	No	The unique ID of the account record.

UpdateAccountCustomFieldsValuesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields_values	No	Array of CustomFieldsValuesInfo structure	Yes	The list of Custom Fields values for the given account.
i_account	No	unsignedLong	Yes	The unique ID of the account record.

Favourites list management

add_preferable_account
This method enables an API user to add a record to the account’s Favourites list
Parameters	AddPreferableAccountRequest
Return Value	AddPreferableAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

AddPreferableAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
preferable_account_info	Yes	PreferableAccountInfo structure	No	Information about a frequently used account.

AddPreferableAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_preferable_account	Yes	unsignedLong	No	The unique ID of the frequently used account.

delete_preferable_account
This method enables an API user to delete a record in the account’s Favourites list
Parameters	DeletePreferableAccountRequest
Return Value	DeletePreferableAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DeletePreferableAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_preferable_account	Yes	unsignedLong	No	The unique ID of the frequently used account.

DeletePreferableAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	One of the following: 1 – success, 0 – failed.

get_preferable_account
This method enables an API user to obtain information about the account’s Favourites list record
Parameters	GetPreferableAccountRequest
Return Value	GetPreferableAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetPreferableAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_preferable_account	Yes	unsignedLong	No	The unique ID of the frequently used account.

GetPreferableAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
preferable_account_info	No	PreferableAccountInfo structure	No	Information about a frequently used account.

get_preferable_account_list
This method enables an API user to obtain the list of the account’s Favourites list records
Parameters	GetPreferableAccountListRequest
Return Value	GetPreferableAccountListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetPreferableAccountListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved frequently used accounts.
group_name	No	string	No	The name used to group frequently used accounts.
i_owner_account	Yes	unsignedLong	No	The unique ID of the owner account for a frequently used account.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Max value: 1000 Min value: 1
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Max value: 4294967295 Min value: 0

GetPreferableAccountListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
preferable_account_list	No	Array of PreferableAccountInfo structure	No	The list of frequently used accounts.
total	No	int	No	The number of the retrieved frequently used accounts.

update_preferable_account
This method enables an API user to update a record in the account’s Favourites list
Parameters	UpdatePreferableAccountRequest
Return Value	UpdatePreferableAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

UpdatePreferableAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
preferable_account_info	Yes	PreferableAccountInfo structure	No	Information about a frequently used account.

UpdatePreferableAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_preferable_account	Yes	unsignedLong	No	The unique ID of the frequently used account.

Follow-me settings management

add_followme_number
This method allows an API user to add a new follow-me entry (number) associated with an account. If successful, a new ID number is returned. Note: the newly added number becomes the last entry in the list of the account’s follow-me numbers
Parameters	AddFollowMeNumberRequest
Return Value	AddUpdateFollowMeNumberResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

AddFollowMeNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
number_info	No	FollowMeNumberInfo structure	No	Follow-me number to be added to account's follow-me entries.

AddUpdateFollowMeNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_follow_me_number	Yes	unsignedLong	No	ID of follow-me number database record.

add_followme_number_list
This method allows an API user to add a list of follow-me entries (numbers) associated with an account
Parameters	AddFollowMeNumberListRequest
Return Value	AddUpdateFollowMeNumberListResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

AddFollowMeNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
followme_numbers	No	Array of FollowMeNumberInfo structure	No	Array of Follow-me numbers is to be added to account's follow-me entries.

AddUpdateFollowMeNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	Follow-Me numbers are saved and valid.

arrange_followme_numbers
This method arranges follow-me entries in a specified order
Parameters	ArrangeFollowMeNumbersRequest
Return Value	ArrangeFollowMeNumbersResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

ArrangeFollowMeNumbersRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.
numbers	No	Array of unsignedLong structure	No	The list of i_follow_me_number values in the desired order; this may be partial, i.e. it is possible to swap the first two numbers, providing two values only.

ArrangeFollowMeNumbersResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

delete_followme_number
This method allows an API user to delete an existing follow-me entry (number) associated with the account. It requires an ID number returned, for example, by the add_followme_number method
Parameters	DeleteFollowMeNumberRequest
Return Value	DeleteFollowMeNumberResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DeleteFollowMeNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_follow_me_number	Yes	unsignedLong	No	ID of follow-me number database record to be deleted.

DeleteFollowMeNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_account_followme
This method retrieves the follow-me settings associated with an account. Follow-me entries (numbers) are returned in the order of their priority
Parameters	GetAccountFollowMeRequest
Return Value	GetAccountFollowMeResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetAccountFollowMeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account record.
i_follow_me	No	unsignedLong	No	ID of the Follow_Me record.
with_period_definition	No	unsignedLong	No	If set, each follow-me number will contain a 'period_definition' field in the response.

GetAccountFollowMeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
default_followme_numbers_timeout	No	int	No	The default number of seconds to wait until a call is answered.
followme_info	No	FollowMeInfo structure	No	Follow-me settings associated with the account.
followme_numbers	No	Array of FollowMeNumberInfo structure	No	The list of follow-me numbers associated with the account.

update_account_followme
This method allows an API user to update the follow-me settings associated with an account. It does not add or update follow-me entries
Parameters	UpdateAccountFollowMeRequest
Return Value	UpdateAccountFollowMeResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

UpdateAccountFollowMeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
followme_info	Yes	FollowMeInfo structure	No	Follow-me settings associated with the account.
i_account	Yes	unsignedLong	No	The unique ID of the account record.

UpdateAccountFollowMeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_follow_me	Yes	unsignedLong	No	The unique ID of the follow-me database record.

update_followme_number
This method allows an API user to update an existing follow-me entry (number) associated with an account. It requires an ID number returned, for example, by the add_followme_number method
Parameters	UpdateFollowMeNumberRequest
Return Value	AddUpdateFollowMeNumberResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

UpdateFollowMeNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_follow_me_number	Yes	unsignedLong	No	ID of follow-me number database record to be updated.
number_info	Yes	FollowMeNumberInfo structure	No	Follow-me number to be added to account's follow-me entries.

update_followme_number_list
This method enables an API user to update, add or remove numbers from the list of follow-me entries associated with an account. It requires an ID number to be returned, for example, by the add_followme_number method. For adding new follow-me entries to the list, this method requires specifying such parameters as i_follow_me, name, redirect_number, and active. For removing unnecessary follow-me entries from the list, their IDs must not be included in the request
Parameters	UpdateFollowMeNumberListRequest
Return Value	AddUpdateFollowMeNumberListResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	No

UpdateFollowMeNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
followme_numbers	No	Array of FollowMeNumberInfo structure	No	Array of Follow-me number to be updated.

Fraud condition management

get_account_state
This method allows an administrator to obtain the current condition applied to the account by the Fraud Prevention feature (e.g. Active, Screened, Quarantined)
Parameters	GetAccountStateRequest
Return Value	GetAccountStateResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAccountStateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_acc_state_type	No	unsignedLong	No	The unique ID of the account state type: 1 – voice_fraud_suspicion. This property is mandatory if state_name and service_type are not specified.
i_account	Yes	unsignedLong	No	The unique ID of the account record.
service_type	No	string	No	The name of the service type. This property is mandatory if i_acc_state_type is not specified.	Possible values: INTERNAL, SESSION, VOICE, DATA, NETACCESS, QUANTITY, WIFI, DIALUP, MSG, CONFERENCE
state_name	No	string	No	The name of the account state type. This property is mandatory if i_acc_state_type is not specified.	Possible values: voice_fraud_suspicion

GetAccountStateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
value	No	int	No	The state of the account. Possible values: 0 – ACTIVE, 1 – SCREENED – Allow calls only via the Screening IVR, 2 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user once, 3 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user twice, 4 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user three times, 5 – QUARANTINED – Disallow all calls.

set_account_state
This method allows an administrator to change the account's condition for the Fraud Prevention feature (e.g. Active, Screened, Quarantined)
Parameters	SetAccountStateRequest
Return Value	SetAccountStateResponse
Realm	administrator, reseller
Standalone mode support	No

SetAccountStateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_acc_state_type	No	unsignedLong	No	The unique ID of the account state type: 1 – voice_fraud_suspicion This property is mandatory if state_name and service_type are not specified.
i_account	Yes	unsignedLong	No	The unique ID of the account record.
notify_users	No	int	No	Specifies whether the state change notification should be triggered for administrators (the notification for customers is always triggered).
service_type	No	string	No	The name of the service type. This property is mandatory if i_acc_state_type is not specified.	Possible values: INTERNAL, SESSION, VOICE, DATA, NETACCESS, QUANTITY, WIFI, DIALUP, MSG, CONFERENCE
state_name	No	string	No	The name of the account state type. Possible value: voice_fraud_suspicion service_type. This property is mandatory if i_acc_state_type is not specified.	Possible values: voice_fraud_suspicion
value	Yes	int	No	The state of the account. Possible values: 0 – ACTIVE; 1 – SCREENED – Allow calls only via the Screening IVR; 2 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user once; 3 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user twice; 4 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user three times; 5 – QUARANTINED – Disallow all calls.	Max value: 5 Min value: 0

SetAccountStateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Indicates whether the account's state setting was: 1 – successful, 0 – unsuccessful.

IP device assignment management

assign_ua
This method allows an API user to assign a UA to an account
Parameters	AssignUARequest
Return Value	AssignUAResponse
Realm	administrator, reseller
Standalone mode support	No

AssignUARequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.
i_ua	Yes	unsignedLong	No	ID of UA record.
port	No	int	No	UA port used by this account. Note: if the type of UA is PortaPhone, the port field is not mandatory.	Min value: 1
ports_config_list	No	Array of AssignMultiserviceUAPortInfo structure	No	List of ports configuration. Only for multiservice devices. Substitutes the 'port' field if passed.

AssignUAResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 in case of success, 0 in case of failure.

release_ua
This method allows an API user to release an account's UA
Parameters	ReleaseUARequest
Return Value	ReleaseUAResponse
Realm	administrator, reseller
Standalone mode support	No

ReleaseUARequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account.

ReleaseUAResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 in case of success, 0 in case of failure.

Information and statistics management

get_account_product_info
This method allows an API user to get the information about the account's product
Parameters	GetAccountProductInfoRequest
Return Value	GetProductInfoResponse
Realm	retail customer, account
Standalone mode support	Yes

GetAccountProductInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetProductInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
product_info	Yes	ProductInfo structure	Yes	Complete information about the product.

get_member_of_huntgroups_list
This method allows an API user to get account's huntgroup
Parameters	GetMemberOfHuntgroupsList
Return Value	GetHGListInfoResponse
Realm	retail customer, account
Standalone mode support	Yes

GetMemberOfHuntgroupsList
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetHGListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
huntgroup_list	No	Array of HGInfo structure	No	The list of huntgroups.
total	No	int	No	Number of huntgroups.

get_moh_list_info
This method allows an API user to get the list of account's music on hold entries
Parameters	GetAccountMOHListInfoRequest
Return Value	GetAccountMOHListInfoResponse
Realm	retail customer, account
Standalone mode support	Yes

GetAccountMOHListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetAccountMOHListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
moh_list_info	No	AccountMOHListInfo structure	No	Account MOH List object.

get_permitted_sip_proxies_info
This method allows an API user to get the list of permitted IP addresses for proxying
Parameters	GetAccountPermittedProxyInfoRequest
Return Value	GetAccountPermittedProxyInfoResponse
Realm	retail customer, account
Standalone mode support	Yes

GetAccountPermittedProxyInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetAccountPermittedProxyInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
is_add_new_sip_proxy_allowed	No	int	No	Indicates whether the adding of a new proxy is allowed.
permitted_sip_proxies	No	Array of PermittedSipProxiesInfo structure	Yes	The list of permitted SIP proxies.

get_service_wallet_xdr_list
This method enables the user to fetch the Account Service Wallet XDRs
Parameters	GetAccountSWXDRListRequest
Return Value	GetAccountSWXDRListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountSWXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
connect_time_after	No	dateTime	No	Get xDRs with connect_time after this date.
connect_time_before	No	dateTime	No	Get xDRs with connect_time before this date.
from_date	Yes	dateTime	No	Get xDRs with bill_time starting from this date.
get_total	No	int	No	Get the total number of the retrieved xDRs.	Default value: 0 Max value: 1 Min value: 0
history_pattern	No	string	Yes	Specifies whether to show xDRs with history that matches the pattern.
i_account	Yes	unsignedLong	No	The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Min value: 0
to_date	Yes	dateTime	No	Get XDRs with bill_time before this date.
with_aux_xdrs	No	int	No	Includes the array of auxiliary xDRs to the retrieved XDRs list.
with_usage	No	int	No	Includes usage records to the retrieved XDRs list.

GetAccountSWXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved xDRs.
xdr_list	No	Array of ServiceWalletXDRInfo structure	No	Array of the account service wallet xDRs and taxes.

get_services_consumption
This method allows an API user to get the information about services consumed by an account
Parameters	GetAccountConsumedServiceRequest
Return Value	GetAccountConsumedServiceResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountConsumedServiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	No	dateTime	No	Get information recorded starting from this date.
get_total	No	int	No	Get the total number of the retrieved services.	Default value: 0
group_by_roaming	No	int	No	Group xDRs by their roaming status.
i_account	No	unsignedLong	No	The unique ID of the account record.
i_invoice	No	unsignedLong	No	Indicates what xDRs will be shown: nill – Midterm xDRs and out-of-turn xDRs; 0 – Out Of Turn xDRs; Not set – xDRs of all types.
i_service	No	unsignedLong	No	The unique ID of the service record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Default value: 50
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
show_unsuccessful	No	int	No	Show records of unsuccessful attempts.
to_date	No	dateTime	No	Get information recorded before this date.

GetAccountConsumedServiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
consumed_service_list	No	Array of ConsumedServiceInfo structure	Yes	The list of ConsumedServices records.
total	No	int	No	The total number of the retrieved services.

get_sip_status
This method allows an API user to check if an account is currently being used by a SIP UA to register with the SIP server and retrieve registration information, such as the user agent’s identification or URI
Parameters	GetSipStatusRequest
Return Value	GetSipStatusResponse
Realm	administrator, reseller, representative
Standalone mode support	Yes

GetSipStatusRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetSipStatusResponse
Property	Mandatory	Type	Nillable	Description	Possible values
additional_sip_info_list	No	Array of SipStatusInfo structure	No	Additional information about SIP UA registrations.
sip_info	No	SipStatusInfo structure	No	Information about SIP UA registration.
sip_status	No	int	Yes	1 - online (account is used by SIP UA to register with the SIP server), 0 - offline.

get_status_history
This method allows an API user to retrieve account status change history
Parameters	GetAccountStatusHistoryRequest
Return Value	GetAccountStatusHistoryResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetAccountStatusHistoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.
i_status	No	unsignedLong	No	The unique ID of the status record. Enables retrieving account history by the status. One of the following status options is possible: 1 - 'Open'; 2 - 'Closed'; 3 - 'Inactive'.	Possible values: 1, 2, 3
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0

GetAccountStatusHistoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
status_history_list	Yes	Array of StatusHistoryInfo structure	Yes	The list of account status changes.

get_vd_counter_history_list
The method enables an API user to retrieve a list of the counter updates
Parameters	GetAccountVdCounterHistoryListRequest
Return Value	GetAccountVdCounterHistoryListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountVdCounterHistoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Include the total number of records.
i_avd_counter	Yes	unsignedLong	No	The ID of the Counter record from Account_VD_Counters table.
i_xdr	No	unsignedLong	No	The ID of the XDR record from CDR_Accounts table.
limit	No	int	No	The number of records to retrieve.
offset	No	int	No	The number of records to skip at the beginning.	Default value: 0

GetAccountVdCounterHistoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved records.
vd_counter_history_list	No	Array of AccountVdCounterHistoryInfo structure	No	The list of the counter updates.

get_vd_notification_list
The method enables an API user to retrieve the list of volume discount notifications for the account
Parameters	GetAccountVdNotificationListRequest
Return Value	GetAccountVdNotificationListResponse
Realm	administrator
Standalone mode support	Yes

GetAccountVdNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
addon_priority	No	int	No	The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 – Main product, 10 – Low, 15 – Medium low, 20 – Medium, 25 – Medium high, 30 – High.	Possible values: 0, 10, 15, 20, 25, 30, 255
get_total	No	int	No	Include the total number of records.
i_account	No	unsignedLong	No	The unique ID of the account record.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group to apply the top-up to.
i_service	No	unsignedLong	No	The unique ID of the service record.
limit	No	int	No	The number of records to retrieve.
offset	No	int	No	The number of records to skip at the beginning.	Default value: 0
peak_level	No	int	No	Possible values: 0 – The peak period; 1 – The off-peak period; 2 – The 2nd off-peak period.	Possible values: 0, 1, 2

GetAccountVdNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved records.
vd_notification_list	No	Array of AccountVdNotificationInfo structure	No	The list of the notifications.

get_xdr_list

This method retrieves Account XDR records

Parameters

GetAccountXDRListRequest

Return Value

GetAccountXDRListResponse

Realm

administrator, reseller, account, retail customer, representative

Standalone mode support

Attachments

Type	Download
Formats	csv
Mandatory	No

GetAccountXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
call_id	No	string	No	The unique identifier of the call.
call_recording	No	int	No	Set this flag to filter xDRs by their call recording status. When it's not provided, all xDRs are obtained.
cld	No	string	No	Calling line destination.
cli	No	string	No	The calling party phone number.
connect_time_after	No	dateTime	No	Get xDRs with connect_time after this date.
connect_time_before	No	dateTime	No	Get xDRs with connect_time before this date.
enable_safe_mode	No	int	No	The flag shows whether to check the amount of data before processing.
format	No	string	No	This parameter allows to get xDRs in other formats via SOAP attachment. Currently only the "csv" format is supported.
from_date	No	dateTime	No	Get xDRs with bill_time starting from this date.
get_split_xdrs	No	int	No	If set, split XDRs will be present in the response.
get_total	No	int	No	Get the total number of the retrieved xDRs.	Default value: 0
h323_conf_id	No	string	No	The unique identifier of the session.
history_pattern	No	string	No	Specifies whether to show xDRs with history that matches the pattern.
i_account	No	unsignedLong	No	The unique ID of the account record.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_service	No	unsignedLong	Yes	ID of Service, refer to Services table.
i_service_type	No	unsignedLong	No	ID of the Service Type that can be used instead of i_service.
limit	No	int	Yes	The number of rows to retrieve.	Default value: 0
offset	No	int	Yes	The number of rows to skip at the beginning of the list.	Default value: 0
quality	No	string	No	The call quality. Possible values: good, fair, poor, unknown.	Possible values: unknown, poor, fair, good
roaming	No	int	No	Set this flag to filter xDRs by their roaming status. When it's not provided, all xDRs are obtained.
show_unsuccessful	No	int	No	Show xDRs of unsuccessful attempts.
to_date	No	dateTime	No	Get xDRs with bill_time before this date.
with_cr_download_ids	No	int	No	If set, then each xDR will contain download ids to the recorded files if any.
with_netaccess_usage	No	int	No	If set, then each netaccess xDR will contain 'bytes_downloaded' and 'bytes_uploaded' fields in the response.

GetAccountXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved xDRs.
xdr_list	No	Array of AccountXDRInfo structure	No	The list of XDRs.

get_xdr_quality_info
The method enables an API user to fetch the information about XDR metric data
Parameters	GetAccountXDRQualityInfoRequest
Return Value	GetAccountXDRQualityInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAccountXDRQualityInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	unsignedLong	No	ID of the XDR record.

GetAccountXDRQualityInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
quality_info	No	XDRQualityMetricInfo structure	Yes	The information about XDR quality metrics.

mark_xdr_out_of_turn
This method allows an administrator to include a transaction on an out-of-turn invoice to be issued on demand
Parameters	MarkXdrOutOfTurnRequest
Return Value	MarkXdrOutOfTurnResponse
Realm	administrator, reseller
Standalone mode support	No

MarkXdrOutOfTurnRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_xdr	Yes	unsignedLong	No	The unique ID of the XDR record.

MarkXdrOutOfTurnResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

Location management

add_allowed_location
This method enables an API user to add a new allowed location
Parameters	AddAllowedLocationRequest
Return Value	AddAllowedLocationResponse
Realm	administrator, reseller
Standalone mode support	No

AddAllowedLocationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
allowed_location_info	No	AllowedLocationInfo structure	No	Allowed location information.

AddAllowedLocationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_a_verified_locations	Yes	unsignedLong	No	The ID of the account's allowed location record.

delete_allowed_location
This method enables an API user to delete an allowed location
Parameters	DeleteAllowedLocationRequest
Return Value	DeleteAllowedLocationResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteAllowedLocationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_a_verified_locations	Yes	unsignedLong	No	The ID of the account's allowed location record.

DeleteAllowedLocationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 in case of success, 0 in case of failure.

get_allowed_location_list
This method enables an API user to get the list of allowed locations
Parameters	GetAllowedLocationListRequest
Return Value	GetAllowedLocationListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAllowedLocationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved allowed locations.
i_account	Yes	unsignedLong	No	The unique ID of the account record.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
period_from	No	dateTime	No	The start date and time for the allowed location.
period_to	No	dateTime	No	The end date and time for the allowed location.
verified_by	No	string	No	The mark that shows whether the record was set by screening or by admin via the web interface.	Possible values: A, S

GetAllowedLocationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
allowed_location_list	No	Array of AllowedLocationInfo structure	No	The list of the account's allowed locations.
total	No	int	No	The number of the retrieved records.

get_used_location_list
This method enables an API user to get the list of used locations
Parameters	GetUsedLocationListRequest
Return Value	GetUsedLocationListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUsedLocationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved used locations.
group_by_ip	No	int	No	Group usage locations by their subscriber ip.
i_account	Yes	unsignedLong	No	The unique ID of the account record.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetUsedLocationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved records.
used_location_list	No	Array of UsedLocationInfo structure	No	The list of the account's allowed locations.

update_allowed_location
This method enables an API user to update an allowed location
Parameters	UpdateAllowedLocationRequest
Return Value	UpdateAllowedLocationResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateAllowedLocationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
allowed_location_info	No	AllowedLocationInfo structure	No	Allowed location information.

UpdateAllowedLocationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_a_verified_locations	Yes	unsignedLong	No	The ID of the account's allowed location record.

Payment and topup management

delete_payment_method
This method allows an API user to delete the payment information
Parameters	DeleteAccountPaymentMethodRequest
Return Value	DeleteAccountPaymentMethodResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DeleteAccountPaymentMethodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	ID of account record.

DeleteAccountPaymentMethodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

estimate_taxes
This method enables an API user to show tax rates or calculate the tax for a list of xDRs. To calculate the tax, the provided xDRs must have the charged_amount specified. All other properties are optional.
Parameters	AccountEstimateTaxesRequest
Return Value	AccountEstimateTaxesResponse
Realm	administrator, reseller, retail customer, account, distributor
Standalone mode support	Yes

AccountEstimateTaxesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
calc_taxes	No	int	No	Specifies whether to calculate the tax or just show tax rates Possible values: 0 or undefined – return tax rates; 1 – calculate the tax for the provided xDRs.	Default value: 0
i_account	Yes	unsignedLong	No	The unique ID of the account record.
issue_date	No	dateTime	No	The date when transactions took place (xDRs were created). It is used only for the EZtax (formerly known as BillSoft EZtax) plug-in.	Default value: current date and time
use_xdrs_from_db_up_to_date	No	dateTime	No	Get transactions (xDRs) from the database instead of xdr_list. The transactions for the period starting from the previous bill_to time to the specified time will be taken. Possible values: A specific date and time in the 'YYYYMM-DD HH24:MI:SS' format; 'now'.
xdr_list	No	Array of EstimateTaxesXDRInfo structure	No	List of XDRs.

AccountEstimateTaxesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
taxes_list	No	Array of EstimatedTax structure	No	List of the estimated/calculated taxes.
warnings	No	ArrayOfString	No	Returns procedure warnings if any.

get_payment_method_info
This method allows an API user to retrieve the information about the payment method (e.g. payment card info) assigned to an account
Parameters	GetAccountPaymentMethodInfoRequest
Return Value	GetAccountPaymentMethodInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountPaymentMethodInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
empty_if_not_configured	No	int	No	Set this flag to receive undef value if payment method not configured. When it's not provided error returns.
i_account	Yes	unsignedLong	No	The unique ID of the account.

GetAccountPaymentMethodInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_method_info	No	AccountPaymentMethodInfo structure	No	PaymentMethodInfo object.

get_payment_transaction_list
This method allows an API user to get a list of account's payment transactions
Parameters	GetAccountPaymentTransactionListRequest
Return Value	GetAccountPaymentTransactionListResponse
Realm	administrator, reseller, retail customer, account, cc staff, distributor
Standalone mode support	Yes

GetAccountPaymentTransactionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	No	dateTime	No	Get records starting from this date.
get_total	No	int	No	Get the total number of the retrieved transactions.
hide_restricted	No	int	No	Specifies whether it is necessary to remove the payment transactions of the terminated entities from the response.
i_account	No	unsignedLong	No	The unique ID of the account.
i_merchant_account	No	unsignedLong	No	The unique payment system ID for the transaction.
i_payment_method	No	unsignedLong	No	Unique ID of the payment method.
i_payment_transaction	No	unsignedLong	No	The unique ID of a payment transaction.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
search	No	string	No	A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields.
status	No	string	No	Status of the transaction.	Possible values: VOIDED, CANCELLED, COMPLETED, FAILED, AUTHORIZED, STARTED
test_mode	No	string	No	Indicates whether the payment processor was in the test mode at the moment when the transaction was processed - Y/N.	Possible values: Y, N
to_date	No	dateTime	No	Get records before this date.

GetAccountPaymentTransactionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_transactions	No	Array of AccountTransactionInfo structure	Yes	The set of payment transactions.
total	No	int	No	The total number of the retrieved records.

topup_account
This method allows an API user to top up an account using voucher
Parameters	TopupAccountRequest
Return Value	TopupAccountResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

TopupAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_info	Yes	AccountInfo structure	No	Data about an account. Note: only i_account is used.
use_debit_voucher	No	int	Yes	Specifies whether to use another prepaid card to recharge an account (both accounts must have the same main product assigned). Possible values: 1 – Use prepaid card, 0 – Use voucher.
voucher_info	Yes	VoucherInfo structure	No	The information about a voucher.

TopupAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	Amount by which the account's balance will increase.
available_funds	No	float	No	For debit accounts, this is equal to the h323-credit-amount. For credit accounts, this returns the actual amount of available funds (the difference between the credit limit and the current balance with respect to the credit limits for the individual account and customer). This field is not present in the response for accounts with the unlimited available funds.
balance	Yes	float	No	The current amount of the account's balance.
billing_model	Yes	string	No	Shows the account type.
breakage	Yes	float	Yes	The breakage amount of the account's product.
credit_limit	Yes	float	Yes	The account's credit limit value.
currency	Yes	string	No	Shows the account currency.
customer_balance	Yes	float	No	The customer's balance.
customer_credit_limit	Yes	float	Yes	The customer's credit limit value.

update_payment_method
This method enables an API user to assign a preferred payment method to an account. For online payment methods, all the information required by the payment processor should be provided, and an appropriate payment processor must be set up and properly configured beforehand. Note that the number, name, address, and / or zip fields are not mandatory in the PaymentMethodInfo structure as long as credit card was already set
Parameters	UpdateAccountPaymentMethodRequest
Return Value	UpdateAccountPaymentMethodResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

UpdateAccountPaymentMethodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.
payment_method_info	Yes	AccountPaymentMethodInfo structure	No	Data about payment method.

UpdateAccountPaymentMethodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_credit_card	Yes	unsignedLong	Yes	ID of modified payment method record.

Phonebook management

add_phonebook_record
This method allows an API user to add a record to the account's Phonebook
Parameters	AddUpdatePhoneBookRecordRequest
Return Value	AddUpdatePhoneBookRecordResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

AddUpdatePhoneBookRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
phonebook_rec_info	No	PhoneBookRecInfo structure	No	Phonebook record data.

AddUpdatePhoneBookRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_phonebook	No	unsignedLong	Yes	The unique ID of the PhoneBook's record.

delete_phonebook_record
This method allows an API user to delete a record from the account's Phonebook
Parameters	DeletePhoneBookRecordRequest
Return Value	DeletePhoneBookRecordResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DeletePhoneBookRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_phonebook	No	unsignedLong	No	The unique ID of the Phone book record.

DeletePhoneBookRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	One of the following: 1 – success, 0 – failed.

estimate_call_price
This method allows an API user to see the price for calls to a specific destination (e.g. to a number from a user’s contact list) with applicable volume discounts
Parameters	AccountEstimateCallPriceRequest
Return Value	AccountEstimateCallPriceResponse
Realm	administrator, reseller, distributor, account, retail customer, cc staff
Standalone mode support	Yes

AccountEstimateCallPriceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the owner account.
number	Yes	string	No	A number to estimate the call price for.	Min value: 1
rating_context	No	string	No	An abstract string with rating context information. For example: 'i_service_type=3,i_node=1,accessCode=ANY,selectCode=ANY,oliCode=0'.

AccountEstimateCallPriceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
call_price_info	Yes	EstimatedCallPriceInfo structure	No	The information about the estimated call price.

get_phonebook_list
This method allows an API user to obtain the list of the account's Phonebook records
Parameters	GetPhoneBookListRequest
Return Value	GetPhoneBookListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetPhoneBookListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of Phone book records.	Default value: 0
i_account	Yes	unsignedLong	No	The unique ID of the owner account. Not mandatory when the method that requires this structure is executed from the account realm.
limit	Yes	int	No	Limit of Phonebook records (the maximum quantity of Phonebook records, number of rows to retrieve).
offset	Yes	int	No	Starting position for a Phonebook list (number of rows to skip at the beginning of the list).
phone_number_pattern	No	string	No	Phone Number Pattern.	Default value: %

GetPhoneBookListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
phonebook_rec_list	No	Array of PhoneBookRecInfo structure	No	The list of Phonebook records.
total	No	int	No	The total number of Phone book records.

get_phonebook_record
This method allows an API user to obtain the account's Phonebook record
Parameters	GetPhoneBookRecordRequest
Return Value	GetPhoneBookRecordResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetPhoneBookRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_phonebook	Yes	unsignedLong	No	The unique ID of the Phonebook’s record.

GetPhoneBookRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
phonebook_rec_info	No	PhoneBookRecInfo structure	Yes	Phonebook record data.

update_phonebook_record
This method allows an API user to update a record in the account's Phonebook
Parameters	AddUpdatePhoneBookRecordRequest
Return Value	AddUpdatePhoneBookRecordResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

SIM card management

assign_sim_card
This method enables an API user to assign a SIM card from the SIM card inventory to an account
Parameters	AssignSIMCardRequest
Return Value	AssignSIMCardResponse
Realm	administrator, reseller
Standalone mode support	No

AssignSIMCardRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The ID of the account record.
i_sim_card	Yes	unsignedLong	No	The ID of the SIM card record.

AssignSIMCardResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 if the SIM card was assigned to an account.

release_sim_card
This method enables an API user to release a previously assigned SIM card from an account
Parameters	ReleaseSIMCardRequest
Return Value	ReleaseSIMCardResponse
Realm	administrator, reseller
Standalone mode support	No

ReleaseSIMCardRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The ID of the account record.

ReleaseSIMCardResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 if the SIM card was successfully released.

Service features management

get_service_features
This method allows an API user to access service features data
Parameters	GetAccountServiceFeaturesRequest
Return Value	GetAccountServiceFeaturesResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountServiceFeaturesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record.

GetAccountServiceFeaturesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_features	No	Array of ServiceFeatureInfo structure	Yes	The list of service features.

update_service_features
This method allows an API user to update settings for account service features
Parameters	UpdateAccountServiceFeaturesRequest
Return Value	UpdateAccountServiceFeaturesResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Account/update_service_features \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}' \ -d params='{ "i_account":1141766, "service_features":[ { "name":"netaccess_static_ip", "flag_value": "Y", "attributes":[ { "name":"address", "values":["1.2.3.4"] }, { "name":"netmask", "values":["255.255.255.0"] } ] } ] }'`
Response example	`{ "i_account" : 1141766 }`

UpdateAccountServiceFeaturesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Specifies whether a list of Service Features will be returned in the response or not.
i_account	No	unsignedLong	No	The unique ID of the account.
service_features	No	Array of ServiceFeatureInfo structure	Yes	The list of service features.

UpdateAccountServiceFeaturesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account.
service_features	No	Array of ServiceFeatureInfo structure	No	The list of service features.

Subscription management

activate_subscriptions
This method allows an API user to instantly activate an accounts's pending subscriptions, where the start date is less than or equal to today's date (in the customer’s time zone). An activation fee will be charged for each subscription, if applicable
Parameters	ActivateAccountSubscriptionsRequest
Return Value	ActivateAccountSubscriptionsResponse
Realm	administrator, reseller
Standalone mode support	No

ActivateAccountSubscriptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.

ActivateAccountSubscriptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

add_subscription
This method allows an API user to add a new subscription associated with an account. If successful, a new subscription ID is returned
Parameters	AddAccountSubscriptionRequest
Return Value	AddUpdateAccountSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

AddAccountSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.
subscription_info	Yes	AccountSubscriptionInfo structure	No	Note: i_account_subscription will be ignored; i_subscription is a mandatory field, and must be unique among all of the account's pending and active subscriptions.

AddUpdateAccountSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_subscription	Yes	unsignedLong	No	The unique ID of the created/modified account subscription record.

charge_subscription_fees
This method allows an administrator to immediately charge all of an account's subscriptions (otherwise later this will be done automatically)
Parameters	ChargeAccountSubscriptionFeesRequest
Return Value	ChargeAccountSubscriptionFeesResponse
Realm	administrator
Standalone mode support	No

ChargeAccountSubscriptionFeesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record to be charged.
immediately_in_advance	No	int	No	Amount of periods that should be charged in advance.	Max value: 50 Min value: 1

ChargeAccountSubscriptionFeesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

close_subscription
This method allows an API user to close an existing active subscription associated with an account. It requires an ID number returned, for example, by the add_subscription method
Parameters	CloseDeleteAccountSubscriptionRequest
Return Value	CloseAccountSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

CloseDeleteAccountSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_subscription	Yes	unsignedLong	No	The unique ID of the account's subscription record to be closed / deleted.

CloseAccountSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_subscription	Yes	unsignedLong	No	The unique identifier of the account's subscription record.

delete_subscription
This method allows an API user to delete a pending subscription associated with an account. It requires an ID number returned, for example, by the add_subscription method
Parameters	CloseDeleteAccountSubscriptionRequest
Return Value	DeleteAccountSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteAccountSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_subscriptions
This method allows an API user to get the list of subscription records associated with an account
Parameters	GetAccountSubscriptionsRequest
Return Value	GetAccountSubscriptionsResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetAccountSubscriptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_name	No	string	No	The commitment name.
i_account	Yes	unsignedLong	No	The unique ID of the account.
i_commitment	No	unsignedLong	No	The unique ID of the commitment.

GetAccountSubscriptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subscriptions	No	Array of AccountSubscriptionInfo structure	No	Set of account subscription data records.

update_subscription
This method allows an API user to update an existing subscription record associated with an account. It requires an ID number returned, for example, by the add_subscription method
Parameters	UpdateAccountSubscriptionRequest
Return Value	AddUpdateAccountSubscriptionResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

UpdateAccountSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.
i_account_subscription	Yes	unsignedLong	No	The unique ID of the account subscription record to be updated.
subscription_info	Yes	AccountSubscriptionInfo structure	No	Note: i_account_subscripti on and i_subscription will be ignored.

Transaction management

get_transactions_total_info
This method allows an API user to get the list of account's transactions
Parameters	GetAccountTransactionsTotalInfoRequest
Return Value	GetAccountTransactionsTotalInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccountTransactionsTotalInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
billing_model	No	int	No	Specifies the account type for which to show transactions; one of the following: -1 – Debit account; 1 – Credit account.	Possible values: -1, 1
cld	No	string	No	The called party phone number.
cli	No	string	No	The calling party phone number.
from_date	Yes	dateTime	No	Get transactions made after this date.
i_account	Yes	unsignedLong	No	The unique ID of the account record.
i_service	No	unsignedLong	Yes	The unique ID of the Service record; refers to the Services table.
show_unsuccessful	No	int	No	Show the records of unsuccessful attempts. The field applies only to the admin realm.
to_date	Yes	dateTime	No	Get transactions made before this date.

GetAccountTransactionsTotalInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
count	No	int	No	The total number of transactions.
iso_4217	No	string	No	Transactions currency.
per_service_info	No	Array of AccountPerServiceInfo structure	Yes	The list of objects containing information on per-service basis.
sessions_count	No	int	No	The total number of sessions.
total_amount	No	float	No	Total transactions amount.
total_info	No	Array of TotalTransInfo structure	No	The list of per-service total values.

make_transaction
This method allows an API user to adjust an account's balance or issue a payment transaction, including e-commerce transactions
Parameters	MakeAccountTransactionRequest
Return Value	MakeAccountTransactionResponse
Realm	administrator, reseller, retail customer, account, cc staff, distributor
Standalone mode support	No

MakeAccountTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	Balance adjustment operation type. Defines how the balance will be adjusted.	Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, Refund, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment, Void, Transfer Funds, TransferTo
amount	Yes	float	No	The amount by which the customer's balance will increase / decrease. The number of digits depends on the maximum number of decimal places allowed by the currency.	Min value: 0
card_info	No	AccountPaymentMethodInfo structure	No	Payment Method information for this transaction.
date_inside_billing_period	No	date	No	A date associated with the manual charge/credit transaction. For example, you can specify a date for a manual credit transaction for when an account was credited.
datetime_inside_billing_period	No	dateTime	No	A date and time associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited.
enable_balance_fraud_protection	No	int	No	Indicates whether to perform balance fraud checks to make sure the charged amount never exceeds the available balance.
h323_conf_id	No	string	No	Optional tax transaction code that should be applied to transaction.	Max value: 36
i_account	Yes	unsignedLong	No	The unique ID of the account record.
i_payment_transaction	No	unsignedLong	No	This option identifies a previously issued Authorization only / E-commerce payment transaction. It is used for Capture payment and E-Commerce refund transactions.
i_service	No	unsignedLong	No	The unique ID of the Service record; refers to the Services table.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser, and accessible only directly from the database.	Max value: 200
recipient_id	No	int	No	The unique ID of the recipient account record for transactions between accounts.
return_url	No	string	No	The URL to redirect users back to after they authenticate or cancel their payment on the payment method’s app or site.
save_card	No	string	No	Indicates whether the supplied payment method should be saved as preferred.	Default value: N Possible values: Y, N
suppress_notification	No	int	No	1 - do not send email notifications to the customer, 0 - send the notifications.
transaction_id	No	string	No	Applicable to Capture payment and E-Commerce refund transactions. Must contain the ID of a previously issued Authorization only / E-commerce payment transaction.	Max value: 48
visible_comment	No	string	No	A comment on this transaction visible in the xDR browser.

MakeAccountTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authorization	No	string	No	E-Commerce authorization code.
balance	Yes	float	No	Modified account balance.
i_payment_transaction	No	unsignedLong	No	The unique ID of the transaction.
i_xdr	No	unsignedLong	No	The unique ID of the XDR record.
redirect_url	No	string	No	The URL to redirect a user to in order to authenticate the transaction (3D Secure).
result_code	No	string	No	E-Commerce operation result code.
transaction_id	No	string	No	E-Commerce transaction ID.

register_transaction
This method enables an API user to register a transaction initiated for an account
Parameters	AccountRegisterTransactionRequest
Return Value	AccountRegisterTransactionResponse
Realm	administrator, reseller, account
Standalone mode support	No

AccountRegisterTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	The amount for payment.
i_account	No	unsignedLong	No	Unique ID of the Account for which a transaction will be registered.
i_payment_method	Yes	unsignedLong	No	Unique ID of the chosen Payment Method.

AccountRegisterTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
transaction	No	TransactionInfo structure	No	The information about the transaction.

Volume discount management

get_full_vd_counter_info
This method allows an API user to get full information about volume discount counters
Parameters	GetAccountFullVDCounterListInfoRequest
Return Value	GetFullVDCounterListInfoResponse
Realm	administrator, retail customer, account, reseller, cc staff, representative, distributor
Standalone mode support	Yes

GetAccountFullVDCounterListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm.
separate_units	No	int	No	Specifies whether to provide threshold values and discount amount units (e.g., minutes) in a separate field.
with_discount_info	No	int	No	Specifies whether to provide the discount information of a counter.
with_service_pool_info	No	int	No	Specifies whether to provide service pool information of counter.

GetFullVDCounterListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
counter_list	No	Array of FullCounterInfo structure	Yes	Array of full counter objects.

get_used_vd_dest_group_list
This method enables an API user to obtain information about the volume discount destination groups used by the account
Parameters	GetAccountUsedVdDestGroupListRequest
Return Value	GetAccountUsedVdDestGroupListResponse
Realm	administrator
Standalone mode support	Yes

GetAccountUsedVdDestGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_from	Yes	dateTime	No	The start of the date-time interval to search for the volume discount destination groups.
date_to	No	dateTime	No	The end of the date-time interval to search for the volume discount destination groups (leave empty for current date-time).
i_account	Yes	unsignedLong	No	The unique ID of the owner account.
i_service_type	No	unsignedLong	No	The unique ID of the service type.

GetAccountUsedVdDestGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vd_dest_group_list	Yes	Array of VdDestGroupInfo structure	No	Array of vd destination groups.

get_vd_counter_info
This method enables an API user to retrieve the information about an account-level counter
Parameters	GetAccountVdCounterInfoRequest
Return Value	GetAccountVdCounterInfoResponse
Realm	administrator
Standalone mode support	Yes

GetAccountVdCounterInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_avd_counter	Yes	unsignedLong	No	The unique ID of the record.

GetAccountVdCounterInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vd_counter_info	No	CounterInfo structure	No	The information about the account-level counter.

get_vd_counter_list
This method allows an API user to get the information about volume discount counters for the specified account
Parameters	GetAccountVDCounterListRequest
Return Value	GetAccountVDCounterListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAccountVDCounterListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_info	No	int	Yes	Detailed information.
dg_name	No	string	No	Destination group name pattern.
i_account	Yes	unsignedLong	No	The unique ID of the account record.
peak_level	No	int	No	ID of the Peak Level (0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period).	Possible values: 0, 1, 2
service_name	No	string	No	Service name pattern.

GetAccountVDCounterListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
counter_list	No	Array of CounterInfo structure	Yes	Array of counter objects.

vd_topup
This method allows an administrator to top-up the volume of a service (e.g. free minutes or gigabytes) provided to an end-user (account) with the discount
Parameters	AccountVDTopupRequest
Return Value	VDTopupResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

AccountVDTopupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
addon_priority	No	int	No	The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 – Main product, 10 – Low, 15 – Medium low, 20 – Medium, 25 – Medium high, 30 – High.	Default value: 255 Possible values: 0, 10, 15, 20, 25, 30, 255
h323_conf_id	No	string	No	Custom data for third-party application processing.	Max value: 255
i_account	Yes	unsignedLong	No	The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm.
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group to apply the top-up to.	Min value: 0
i_service	Yes	unsignedLong	No	The unique ID of the service record.	Min value: 1
payment_info	No	AccountPaymentInfo structure	No	The payment information.
peak_level	Yes	int	No	Possible values: 0 – The peak period; 1 – The off-peak period; 2 – The 2nd off-peak period.	Possible values: 0, 1, 2
topup_amount	Yes	float	No	The top-up amount.
topup_expires	No	dateTime	No	A date and time in the UTC format when the topped up volume discount becomes expired (YYYY-MM-DD HH24:MI:SS).	Min value: current date and time
voucher_info	No	VoucherInfo structure	No	The information about a voucher.

VDTopupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
counter_info	No	FullCounterInfo structure	No	The volume discount counter. See the FullCounterInfo structure in the Customer Information section.
status	No	string	No	This field specifies the status of the transaction on the payment gateway side. Possible values: STARTED - transaction pending, COMPLETED - transaction completed, FAILED - transaction failed.

ACL system

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/ACL

ACL management

get_acl_list
This method allows an API user to get the list of ACL
Parameters	GetAclListRequest
Return Value	GetAclListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAclListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
group	No	string	No	The name of ACL group to search.	Max value: 32
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Search ACL by name.	Max value: 64
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295
subsystem	No	string	No	The name of subsystem ACL belongs to.	Max value: 32
type	No	string	No	Type of ACL to search. Possible values: Component, User, Customer, CC Staff, Account, Vendor, Representative, Reseller, Distributor.	Possible values: Component, User, Customer, CC Staff, Account, Vendor, Representative, Reseller, Distributor
with_i_acl	No	unsignedLong	No	If the entity has customized default ACL (instead of the predefined one), specify the unique ID of this customized default ACL here. Then it will be included to the list.

GetAclListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
acl_list	Yes	Array of AclInfo structure	No	The list of ACL records.
total	No	int	No	The total number of found ACLs.

get_my_permissions_for_objects
This method allows an API user to get a list of ACL permissions for specific objects on the PortaBilling web interface
Parameters	GetMyAclForObjectsRequest
Return Value	GetMyAclForObjectsResponse
Realm	administrator, reseller, retail customer, account, cc staff, representative, distributor
Standalone mode support	Yes

GetMyAclForObjectsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
objects	Yes	Array of string structure	No	A list of web interface objects for which the ACL permissions will be collected (e.g. selfcare, WebForms, etc.).

GetMyAclForObjectsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_level	No	AccessLevelInfo structure	No	The information about the ACL permissions.

Asynchronous request information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/AsyncRequest

API notification management

disable_api_notifications
This method enables an API user to disable the receipt of notifications about the status of API requests execution in the asynchronous mode
Parameters	DisableAsyncApiNotificationsRequest
Return Value	DisableAsyncApiNotificationsResponse
Realm	administrator, reseller, distributor, cc staff, representative, retail customer, account
Standalone mode support	No
Mode	Syncronous only

DisableAsyncApiNotificationsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

DisableAsyncApiNotificationsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successful.

enable_api_notifications
This method enables an API user to receive notifications about the status of API requests execution in the asynchronous mode
Parameters	EnableAsyncApiNotificationsRequest
Return Value	EnableAsyncApiNotificationsResponse
Realm	administrator, reseller, distributor, cc staff, representative, retail customer, account
Standalone mode support	No
Mode	Syncronous only

EnableAsyncApiNotificationsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

EnableAsyncApiNotificationsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successful.

Asynchronous request management

delete_request_list
This method enables deleting async requests
Parameters	DeleteAsyncRequestListRequest
Return Value	DeleteAsyncRequestListResponse
Realm	administrator, reseller, distributor, cc staff, representative, retail customer, account
Standalone mode support	No
Mode	Syncronous only

DeleteAsyncRequestListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
request_list	Yes	Array of AsyncRequestInfo structure	No	The set of async request records.	Min value: 1

DeleteAsyncRequestListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successful.

get_request_info
This method enables an API user to check the status of the JSON request being executed in the asynchronous mode
Parameters	GetAsyncRequestInfoRequest
Return Value	GetAsyncRequestInfoResponse
Realm	administrator, reseller, distributor, cc staff, representative, retail customer, account
Standalone mode support	No

GetAsyncRequestInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_async_request	Yes	unsignedLong	No	The unique ID of the request.

GetAsyncRequestInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
request_info	No	AsyncRequestInfo structure	No	The asynchronous request info.

get_request_list
This method enables getting the list of async requests
Parameters	GetAsyncRequestListRequest
Return Value	GetAsyncRequestListResponse
Realm	administrator, reseller, distributor, cc staff, representative, retail customer, account
Standalone mode support	No
Mode	Syncronous only

GetAsyncRequestListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetAsyncRequestListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
request_list	No	Array of AsyncRequestInfo structure	No	A set of asynchronous request records.

Authorization rule information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/AuthzRule

Authorization rule management

add_authz_rule
This method allows an API user to define manual authentication rules allowing PortaSIP servers to handle incoming calls in the desired manner
Parameters	AddUpdateAuthzRuleRequest
Return Value	AddUpdateAuthzRuleResponse
Realm	administrator
Standalone mode support	No

AddUpdateAuthzRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
authz_rule_info	Yes	AuthzRuleInfo structure	No	Authentication rule data.
override_autogenerated	No	int	No	Specifies whether to override existing autogenerated rules: 1 – if an autogenerated rule for this IP address already exists, override it by the new manual rule, 0 – if an autogenerated rule for this IP address already exists, throw SOAP fault 'duplicate ip pattern'.

AddUpdateAuthzRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_authz_rule	No	unsignedLong	No	The unique ID of the created authentication rule.

delete_authz_rule
This method allows an API user to delete authentication rules
Parameters	DeleteAuthzRuleRequest
Return Value	DeleteAuthzRuleResponse
Realm	administrator
Standalone mode support	No

DeleteAuthzRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_authz_rule	Yes	unsignedLong	No	The unique ID of the authentication rule record to delete.

DeleteAuthzRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_authz_method_type_list
This method enables an API user to get the list of authentication method types
Parameters	GetAuthzMethodTypeListRequest
Return Value	GetAuthzMethodTypeListResponse
Realm	administrator
Standalone mode support	Yes

GetAuthzMethodTypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetAuthzMethodTypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authz_method_type_list	Yes	Array of AuthzMethodTypeInfo structure	No	The list of authentication method types.

get_authz_rule_list
This method allows an API user to get a list of authentication rules that show how PortaSIP servers handle incoming calls. An authentication rule combines an authorization method and call parameters
Parameters	GetAuthzRuleListRequest
Return Value	GetAuthzRuleListResponse
Realm	administrator
Standalone mode support	No

GetAuthzRuleListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
auto_link_type	No	string	Yes	The filter to search the authentication rules by the 'auto_link_type' DB column.
autogenerated	No	int	No	The filter to search autogenerated or manually created authentication rules. Possible values: 1 - autogenerated, 0 - manually created.
with_extended_info	No	int	No	If set to 1, the method returns the following additional fields in the response AuthzRuleInfo structures: 'account_id', 'connection_description' and 'node_name'.

GetAuthzRuleListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authz_rule_list	Yes	Array of AuthzRuleInfo structure	Yes	A list of authentication rules found.

rearrange_authz_rule_list
This method enables an API user to change the 'order_number' value of all existing manually created authentication rules
Parameters	RearrangeAuthzRuleListRequest
Return Value	RearrangeAuthzRuleListResponse
Realm	administrator
Standalone mode support	No

RearrangeAuthzRuleListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
authz_rule_list	Yes	Array of RearrangeAuthzRuleInfo structure	No	The list of authentication rules.	Min value: 2

RearrangeAuthzRuleListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, exception error message in case of failure.

update_authz_rule
This method allows an API user to update manual authentication rules to change how PortaSIP servers handle incoming calls
Parameters	AddUpdateAuthzRuleRequest
Return Value	AddUpdateAuthzRuleResponse
Realm	administrator
Standalone mode support	No

Billing sessions information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/BillingSession

Billing session management

disconnect_session
This method enables an administrator to disconnect the current voice call or Internet session
Parameters	DisconnectSessionRequest
Return Value	DisconnectSessionResponse
Realm	administrator
Standalone mode support	No

DisconnectSessionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
billing_session_id	No	string	No	The h323-conf-id of the session.	Max value: 36 Min value: 1
service_session_id	No	string	No	The call-id of the session.	Max value: 100 Min value: 1

DisconnectSessionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success.

get_active_calls_list
This method allows an API user to get the list of active calls
Parameters	GetActiveCallsRequest
Return Value	GetActiveCallsResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetActiveCallsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
actual	No	string	No	Return only actual records.	Default value: N Possible values: Y, N
i_account	No	unsignedLong	No	The unique ID of the account.
i_customer	No	unsignedLong	No	The unique ID of the customer.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 1
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Max value: 4294967295 Min value: 0

GetActiveCallsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
active_calls_list	Yes	Array of ActiveCallInfo structure	Yes	The list of active calls.

get_active_sessions_list
This method enables an API user to get the list of active sessions
Parameters	GetActiveSessionsRequest
Return Value	GetActiveSessionsResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetActiveSessionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID (PIN) of the account on the PortaBilling interface, unique in the environment.	Max value: 128
call_id	No	string	No	The call-id of the session.	Max value: 100
cld	No	string	No	The called line phone number.	Max value: 128
cli	No	string	No	The calling line phone number.	Max value: 128
get_total	No	int	No	Get the total number of the retrieved active session records.
h323_conf_id	No	string	No	The h323-conf-id of the session.	Max value: 36
hotlined	No	string	No	The flag that shows whether the session is hotlined (Internet sessions only).	Possible values: Y, N
i_connection	No	unsignedLong	No	The unique ID of the connection.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_node	No	unsignedLong	No	The unique ID of the node.
i_parent	No	unsignedLong	Yes	Omit for a direct customer; i_customer of the reseller for a subcustomer.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
on_net	No	string	No	Filter the session list by the on-net status. Possible values: 'on-net_only' - Include only on-net sessions; 'exclude' - Do not include on-net sessions; 'exclude_incoming' - Do not include incoming on-net sessions.	Possible values: on-net_only, exclude, exclude_incoming
parent_session_id	No	string	Yes	The parent session ID.	Max value: 36
source_ip	No	string	No	The IP address of the entity.	Max value: 15 Min value: 7
with_cld_country	No	int	No	Specifies whether the information about country and subdivision of CLD should be included in the response.
with_nodes	No	int	No	Specifies whether the information about used nodes should be included in the response.
with_resale_hierarchy	No	int	No	Specifies whether the information about the resellers hierarchy should be included in the response.

GetActiveSessionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
active_session_list	No	Array of ActiveSessionInfo structure	No	The list of active sessions.
total	No	int	No	The total number of the retrieved sessions.

Call recording management

manage_active_call_recording
This method allows an API user to start or stop recording during the call
Parameters	ManageActiveCallRecordingRequest
Return Value	ManageActiveCallRecordingResponse
Realm	administrator, retail customer, account
Standalone mode support	No

ManageActiveCallRecordingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
call_id	Yes	string	No	The unique ID of the call.
command	Yes	string	No	Allows you to start or stop call recording. One of the following: stop; start.	Possible values: start, stop

ManageActiveCallRecordingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cld_status	Yes	string	No	Callee part call recording start/stop status; enum [ FAILED - some errors happened during attempt to enabled/disable recording; DENIED - action isn't allowed according to BE data; OK - action processed successfully ].
cli_status	Yes	string	No	Caller part call recording start/stop status; enum [ FAILED - some errors happened during attempt to enabled/disable recording; DENIED - action isn't allowed according to BE data; OK - action processed successfully ].

Internet session management

add_disconnect_queue_record
This method allows an administrator to disconnect an Internet session (by adding a record to the disconnect queue)
Parameters	AddDisconnectQueueRecordRequest
Return Value	AddDisconnectQueueRecordResponse
Realm	administrator
Standalone mode support	No

AddDisconnectQueueRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	Yes	string	No	Account number.	Max value: 128
at_time	No	dateTime	No	Time when status should be applied.	Default value: current date and time
i_node	No	unsignedLong	No	Unique ID of Nodes record (should be POD server).	Min value: 1
i_service_type	No	unsignedLong	No	The unique ID of the related service type. Default: 6 (NETACCESS).	Default value: 6 Min value: 2
param1	No	string	No	Formatted disconnector parameters string.	Max value: 255
session_id	No	string	No	ID of the session to work with.	Max value: 36
tx_expire	No	dateTime	No	Expiration time.

AddDisconnectQueueRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_pod	Yes	unsignedLong	No	The unique ID of the disconnect request. Refers to the DisconnectQuery table.

Brand pane information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/BrandPane

Brand pane management

get_brand_pane_zip

This method is obsolete. Use the new get_brandpane_archive method of the Brandpane service instead.
This method allows an API user to get the brandpane template and css files. The brandpane-related files are returned in a MIME attachment

Parameters

GetBrandPaneRequest

Return Value

GetBrandPaneResponse

Realm

administrator, reseller, retail customer, account

Standalone mode support

Yes

Attachments

Type	Download
Formats	zip
Mandatory	No

GetBrandPaneRequest
Property	Mandatory	Type	Nillable	Description	Possible values
env	Yes	unsignedLong	No	This property represents environments. It must be 'default' (for an unspecified environment) or the i_env number.
realm	Yes	string	No	Realm name as in the configuration (admin, accounts, cc_staff, customer, vendor, representative, etc.).	Possible values: admin, customer, accounts, cc_staff, vendor, representative

GetBrandPaneResponse
Property	Mandatory	Type	Nillable	Description	Possible values
css_file_name	No	string	No	A path (relative to /home/porta-admin directory) to the brandpane's style – CSS file (e.g. /brandpane/env_3/accounts/brandpane.css).
html_file_name	No	string	No	A path (relative to /home/porta-admin directory) to the brandpane’s template – HTML file named 'brandpane.tmpl' (e.g. /brandpane/env_3/accounts/brandpane.tmpl).

Brandpane information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Brandpane

Brandpane management

get_brandpane_archive

This method enables an API user to get the brandpane template and css files. The brandpane-related files are returned in a MIME attachment

Parameters

GetBrandpaneArchiveRequest

Return Value

GetBrandpaneArchiveResponse

Realm

administrator, reseller, retail customer, account

Standalone mode support

Yes

Attachments

Type	Download
Formats	zip
Mandatory	No

GetBrandpaneArchiveRequest
Property	Mandatory	Type	Nillable	Description	Possible values
realm	No	string	No	The realm name as in the configuration (accounts, customer, cc_staff, representative, admin, vendor).	Possible values:

GetBrandpaneArchiveResponse
Property	Mandatory	Type	Nillable	Description	Possible values
css_file_name	No	string	No	The path to the brandpane's style - CSS file (e.g. /brandpane/env_3/accounts/brandpane.css).
html_file_name	No	string	No	The path to the brandpane’s template - HTML file named 'brandpane.tmpl' (e.g. /brandpane/env_3/accounts/brandpane.tmpl.

Bundle promotion information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/BundlePromotion

Bundle promotion management

add_bundle_promotion
This method allows an API user to add a new bundle promotion
Parameters	AddBundlePromotionRequest
Return Value	AddUpdateBundlePromotionResponse
Realm	administrator
Standalone mode support	No

AddBundlePromotionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
bundle_promotion_info	Yes	BundlePromotionInfo structure	No	The information about the bundle promotion. Note that the name, i_dest_group_set, iso_4217 parameters of the BundlePromotionInfo structure are mandatory in this case.

AddUpdateBundlePromotionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_bd_plan	No	unsignedLong	No	The unique ID of the Bundle Promotion Plan.

delete_bundle_promotion
This method allows an API user to delete the bundle promotion
Parameters	GetDeleteBundlePromotionRequest
Return Value	DeleteBundlePromotionResponse
Realm	administrator
Standalone mode support	No

GetDeleteBundlePromotionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_bd_plan	Yes	unsignedLong	No	The unique ID of the bundle promotion plan.

DeleteBundlePromotionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 – The bundle promotion is successfully deleted. 0 – The bundle promotion has not been deleted.

get_bundle_promotion_info
This method allows an API user to get the bundle promotion information
Parameters	GetDeleteBundlePromotionRequest
Return Value	GetBundlePromotionInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetBundlePromotionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
bundle_promotion_info	No	BundlePromotionInfo structure	No	The information about the bundle promotion.

get_bundle_promotion_list
This method allows an API user to get the list of bundle promotions
Parameters	GetBundlePromotionListRequest
Return Value	GetBundlePromotionListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetBundlePromotionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
filter	No	string	No	Allows retrieving bundle promotions by the name or part of the name.
get_total	No	int	No	Specifies whether to show the total number of found bundle promotions. Then, even if, e.g. the limit property is specified, the total number of bundle promotions that satisfy other conditions will be shown.
i_dest_group_set	No	unsignedLong	Yes	The unique ID of the destination group set associated with this bundle promotion plan.
iso_4217	No	string	No	The bundle promotion plan currency in the three-letter format (ISO 4217).
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
managed_by	No	unsignedLong	No	The unique ID of the reseller who manages the required bundle promotions.
managed_by_admin	No	string	No	Specifies that only those bundle promotions that are managed by administrator must be retrieved. Possible values: Y – Retrieve only bundle promotions managed by admin; N – Retrieve all bundle promotions.	Default value: N Possible values: Y, N
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request.	Default value: 0

GetBundlePromotionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
bundle_promotion_list	Yes	Array of BundlePromotionInfo structure	Yes	The list of Bundle Promotion Plans.
total	No	int	No	The total number of bundle promotion plans found.

update_bundle_promotion
This method allows an API user to update the bundle promotion information
Parameters	UpdateBundlePromotionRequest
Return Value	AddUpdateBundlePromotionResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateBundlePromotionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
bundle_promotion_info	No	BundlePromotionInfo structure	No	The information about the bundle promotion.

Criterium management

add_criterion
This method allows an API user to add a new bundle promotion criterion
Parameters	AddUpdateCriterionRequest
Return Value	AddUpdateCriterionResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateCriterionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
criterion_info	Yes	CriterionInfo structure	No	The information about the bundle promotion criteria. The i_bd_criteria parameter is mandatory for the update_criterion method.

AddUpdateCriterionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_bd_criteria	No	unsignedLong	No	The unique ID of the bundle promotion criterion.

delete_criterion
This method allows an API user to delete the bundle promotion criterion
Parameters	DeleteCriterionRequest
Return Value	DeleteCriterionResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCriterionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_bd_criteria	Yes	unsignedLong	No	The unique ID of the bundle promotion criterion.

DeleteCriterionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 – The bundle promotion criteria are successfully deleted. 0 – The bundle promotion criteria have not been deleted.

get_criteria_list
This method allows an API user to get the list of the bundle promotion criteria
Parameters	GetCriteriaListRequest
Return Value	GetCriteriaListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCriteriaListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Specifies whether to show the total number of criteria found. Then, even if, e.g. the limit property is specified, the total number of criteria that satisfy other conditions will be shown.
i_bd_plan	Yes	unsignedLong	No	The unique ID of the Bundle Promotion Plan.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
with_thresholds	No	int	No	Specifies whether to show the list of thresholds associated with the criteria. 1 – Show the list of thresholds. 0 – Do not show the list of thresholds.

GetCriteriaListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
criteria_list	Yes	Array of CriterionInfo structure	Yes	The list of Bundle Discount Criteria found.
total	No	int	No	The total number of Criteria found.

get_criterion
This method allows an API user to get the information about the bundle promotion criterion
Parameters	GetCriterionRequest
Return Value	GetCriterionInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCriterionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_bd_criteria	Yes	unsignedLong	No	The unique ID of the bundle promotion criteria.
with_thresholds	No	int	No	Specifies whether to show the list of thresholds associated with the criteria. Possible values: 1 – Show the list of thresholds. 0 – Do not show the list of thresholds.

GetCriterionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
criterion_info	No	CriterionInfo structure	Yes	The information about the bundle promotion criterion.

update_criterion
This method allows an API user to update the bundle promotion criterion
Parameters	AddUpdateCriterionRequest
Return Value	AddUpdateCriterionResponse
Realm	administrator, reseller
Standalone mode support	No

Calendar information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Calendar

Calendar management

add_dates_batch
This method enables an API user to add the list of calendar date records
Parameters	AddDatesBatchRequest
Return Value	AddDatesBatchResponse
Realm	administrator
Standalone mode support	No

AddDatesBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_list	Yes	Array of CalendarDateInfo structure	No	The list of calendar date records.	Min value: 1

AddDatesBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

delete_dates_batch
This method enables an API user to delete the list of calendar date records
Parameters	DeleteDatesBatchRequest
Return Value	DeleteDatesBatchResponse
Realm	administrator
Standalone mode support	No

DeleteDatesBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_list	No	Array of CalendarDateInfo structure	No	The list of calendar date records to delete. Only the "i_calendar_day" field must be specified for each record. Note: it overrides the "from", "to" and "type" filters. These filters are ignored if "date_list" is present.	Min value: 1
from	No	date	No	Delete all calendar date records starting from this date. Cannot be used with the "date_list" parameter.
to	No	date	No	Delete all calendar date records up to and including this date. Cannot be used with the "date_list" parameter.
type	No	string	No	Delete only calendar date records of a specific type. Cannot be used with the "date_list" parameter. Possible values: working, non-working.	Possible values: non-working, working

DeleteDatesBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

get_date_list
This method enables an API user to get the list of calendar date records (e.g. the list of non-working days for this year)
Parameters	GetDateListRequest
Return Value	GetDateListResponse
Realm	administrator
Standalone mode support	No

GetDateListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from	No	date	No	Get all calendar date records starting from this date.
limit	No	int	No	The number of rows to retrieve. Used to limit the number of records returned in the response. Can be used without the "offset" parameter.
offset	No	int	No	The number of rows to skip at the beginning of the list. Can be used only if the "limit" parameter is set. Default value: 0.	Default value: 0
to	No	date	No	Get all calendar date records up to and including this date.
type	No	string	No	Get only calendar date records of a specific type. Possible values: working, non-working.	Possible values: non-working, working

GetDateListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
date_list	Yes	Array of CalendarDateInfo structure	Yes	The list of calendar date records.

update_dates_batch
This method enables an API user to update the list of calendar date records
Parameters	UpdateDatesBatchRequest
Return Value	UpdateDatesBatchResponse
Realm	administrator
Standalone mode support	No

UpdateDatesBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_list	Yes	Array of CalendarDateInfo structure	No	The list of calendar date records.	Min value: 1

UpdateDatesBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

upload_dates

This method enables an API user to upload a file with calendar date records information

Parameters

UploadDatesBatchRequest

Return Value

UploadDatesBatchResponse

Realm

administrator

Standalone mode support

Attachments

Type	Upload
Formats	csv
Mandatory	Yes

UploadDatesBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

UploadDatesBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

Call barring information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CallBarring

Call barring class management

add_call_barring_class
This method enables an API user to create a new call barring class record using the supplied data
Parameters	AddCallBarringClassRequest
Return Value	AddCallBarringClassResponse
Realm	administrator
Standalone mode support	No

AddCallBarringClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
call_barring_class_info	Yes	CallBarringClassInfo structure	No	Information about the call barring class.

AddCallBarringClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call barring class.

delete_call_barring_class
This method enables an API user to delete a call barring class record from the DB
Parameters	DeleteCallBarringClassRequest
Return Value	DeleteCallBarringClassResponse
Realm	administrator
Standalone mode support	No

DeleteCallBarringClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call barring class.

DeleteCallBarringClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception error message in case of failure.

get_call_barring_class_info
This method enables an API user to fetch the information about a call barring class
Parameters	GetCallBarringClassInfoRequest
Return Value	GetCallBarringClassInfoResponse
Realm	administrator
Standalone mode support	Yes

GetCallBarringClassInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the call barring class is in use.
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call barring class.

GetCallBarringClassInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
call_barring_class_info	No	CallBarringClassInfo structure	No	Information about a call barring class.

get_call_barring_class_list
This method enables an API user to fetch a list of call barring classes
Parameters	GetCallBarringClassListRequest
Return Value	GetCallBarringClassListResponse
Realm	administrator
Standalone mode support	Yes

GetCallBarringClassListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the call barring class is in use.
get_total	No	int	No	Get the total number of records in the DB.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
matching_type	No	string	No	The mode of number selection for the call barring class. Possible values: 'excluding' - bar numbers that do not fit the patterns defined in the number_pattern_list, 'including' - bar numbers that fit the patterns defined in the number_pattern_list.	Possible values: excluding, including
name	No	string	No	Call barring class name.
number	No	string	No	The call barring class number pattern.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetCallBarringClassListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
call_barring_class_list	No	Array of CallBarringClassInfo structure	No	A list of call barring classes.
total	No	int	No	The total number of retrieved records.

update_call_barring_class
This method enables an API user to modify a call barring class record using the supplied data
Parameters	UpdateCallBarringClassRequest
Return Value	UpdateCallBarringClassResponse
Realm	administrator
Standalone mode support	No

UpdateCallBarringClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
call_barring_class_info	Yes	CallBarringClassInfo structure	No	Information about the call barring class.

UpdateCallBarringClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call barring class.

Call barring options management

add_default_cb_option
This method enables an API user to add a new default call barring option record using supplied data
Parameters	AddGetDefaultCallBarringOptionRequest
Return Value	AddDefaultCallBarringOptionResponse
Realm	administrator
Standalone mode support	No

AddGetDefaultCallBarringOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of the call barring class.

AddDefaultCallBarringOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_default_cb_option	Yes	unsignedLong	No	The unique ID of the default call barring option.

get_default_cb_option_info
This method enables an API user to get a default call barring option record from the DB
Parameters	AddGetDefaultCallBarringOptionRequest
Return Value	GetDefaultCallBarringOptionInfoResponse
Realm	administrator
Standalone mode support	Yes

GetDefaultCallBarringOptionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
default_cb_option_info	No	DefaultCallBarringOptionInfo structure	No	The information about the default call barring option.

Call simulation management

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CallSimulation

Call simulation management

make_call
This method enables an API user to simulate a call between accounts
Parameters	MakeCallRequest
Return Value	MakeCallResponse
Realm	administrator
Standalone mode support	Yes

MakeCallRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cld	No	string	No	The called party phone number. Mandatory if no INVITE provided via the 'custom_invite' parameter.
cli	No	string	No	The calling party phone number. Mandatory if no INVITE provided via the 'custom_invite' parameter.
custom_invite	No	string	No	The INVITE request that will be sent to the callee. If not set, an INVITE request will be built by the system using the values of the 'cli', 'cld' and 'privacy_headerds' parameters.
i_connection	No	unsignedLong	No	The unique ID of the outgoing vendor connection that will be used during the call.
privacy_headers	No	Array of SIPPrivacyHeaderInfo structure	No	If no INVITE is provided via the 'custom_invite' parameter, use this parameter to add the privacy headers to the INVITE request sent to the callee. Possible values: 'P-Asserted-Identity', 'P-Preferred-Identity', 'Remote-Party-ID', 'Privacy', 'Diversion', 'History-Info', 'P-Charge-Info'.
vip_address	Yes	string	No	The Virtual IP (VIP) address of the SIP cluster to which the outgoing request will be sent.

MakeCallResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cld_errors	No	string	No	The errors that occurred on the callee side.
cld_message_list	No	Array of SIPMessageInfo structure	No	The list of the messages sent or received by the callee.
cli_errors	No	string	No	The errors that occurred on the caller side.
cli_message_list	No	Array of SIPMessageInfo structure	No	The list of the messages sent or received by the caller.

CC staff information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CCStaff

CC staff management

add_cc_staff
This method allows an API user to add a CC staff record
Parameters	AddCCStaffRequest
Return Value	AddCCStaffResponse
Realm	administrator, reseller
Standalone mode support	No

AddCCStaffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cc_staff_info	Yes	CCStaffInfo structure	No	Complete information about the CC staff record.

AddCCStaffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cc_staff	No	unsignedLong	No	The unique ID of the created CC staff record.

delete_cc_staff
This method enables an API user to delete a CC staff record
Parameters	DeleteCCStaffRequest
Return Value	DeleteCCStaffResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCCStaffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_cc_staff	Yes	unsignedLong	No	The unique ID of the CC Staff record to be deleted.

DeleteCCStaffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_cc_staff_info
This method enables an API user to get a CC staff info
Parameters	GetCCStaffInfoRequest
Return Value	GetCCStaffInfoResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetCCStaffInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_cc_staff	Yes	unsignedLong	No	The unique ID of the CC staff record to be fetched.

GetCCStaffInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cc_staff_info	No	CCStaffInfo structure	No	Information about the CC staff record.

get_cc_staff_list
This method enables an API user to get a list of CC staff info records
Parameters	GetCCStaffListRequest
Return Value	GetCCStaffListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCCStaffListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of the retrieved CC staff records.
i_customer	No	int	No	The unique ID of the reseller.
limit	No	int	No	The number of rows to retrieve.
login	No	int	No	A login pattern.
offset	No	int	No	The number of rows to skip at the beginning of the list.

GetCCStaffListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
cc_staff_list	No	Array of CCStaffInfo structure	Yes	Set of the CC staff data records.
total	No	int	No	The total number of the retrieved CC staff records.

update_cc_staff
This method enables an API user to update a CC staff record
Parameters	UpdateCCStaffRequest
Return Value	UpdateCCStaffResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCCStaffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cc_staff_info	Yes	CCStaffInfo structure	No	Complete information about the CC staff record.

UpdateCCStaffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_cc_staff	No	unsignedLong	No	The unique ID of the updated CC staff record.

CDR information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CDR

Call recording management

batch_delete_call_recording
This method enables an API user to delete a call recording record
Parameters	BatchDeleteCallRecordingRequest
Return Value	BatchDeleteCallRecordingResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

BatchDeleteCallRecordingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
xdr_list	Yes	Array of CRInfo structure	No	The list of call recording info.	Min value: 1

BatchDeleteCallRecordingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
result_list	Yes	Array of BatchDeleteCRStatusInfo structure	No	The statuses of deleted call recording records.
success	Yes	int	No	1 on success, exception on failure.

get_call_recording

This method enables an API user to get the list of call recording records

Parameters

GetCallRecordingRequest

Return Value

GetCallRecordingResponse

Realm

administrator, reseller, retail customer, account, representative

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetCallRecordingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
call_recording_id	No	string	No	The ID of the call recording record.	Max value: 40 Min value: 1
i_xdr	Yes	unsignedLong	No	ID of XDR record.

GetCallRecordingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

Disconnect reason management

get_disconnect_reason_list
The method enables an API user to fetch the list of available xDR disconnect reasons
Parameters	GetDisconnectReasonListRequest
Return Value	GetDisconnectReasonListResponse
Realm	administrator, reseller, cc staff, distributor, representative, retail customer, account
Standalone mode support	Yes

GetDisconnectReasonListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetDisconnectReasonListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
disconnect_reason_list	Yes	Array of DisconnectReasonInfo structure	No	Set of disconnect reason data records.

XDR management

get_aux_xdr_type_list
The method enables an API user to fetch information about auxiliary XDR types
Parameters	GetAuxXDRTypeListRequest
Return Value	GetAuxXDRTypeListResponse
Realm	administrator
Standalone mode support	Yes

GetAuxXDRTypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetAuxXDRTypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
aux_xdr_type_list	No	Array of AuxXDRTypeInfo structure	No	The list of aux XDR type records.

get_netaccess_usage_record_list

The method enables an API user to fetch detailed information about net access usage related to accounts' xDR(s)

Parameters

GetNetaccessUsageRecordListRequest

Return Value

GetNetaccessUsageRecordListResponse

Realm

administrator

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv
Mandatory	No

GetNetaccessUsageRecordListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
format	No	string	No	This parameter enables the user to get xDRs in other formats via a SOAP attachment. Currently only the "csv" format is supported.	Possible values: csv
h323_conf_id	No	string	No	The unique identifier of the session. At least one of the following fields is mandatory in the request: xdr_id_list, h323_conf_id.	Max value: 36
limit	No	int	No	The number of rows to retrieve.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0 Min value: 0
xdr_id_list	No	Array of unsignedLong structure	No	The list of xDR ids to filter the response. At least one of the following fields is mandatory in the request: xdr_id_list, h323_conf_id.	Min value: 1

GetNetaccessUsageRecordListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
netaccess_usage_record_list	No	Array of NetaccessUsageRecordInfo structure	No	The list of net access usage records related to accounts' xDR(s).

revert_xdr_list
The method enables an API user to revert all transactions for a list of xDRs
Parameters	RevertXDRListRequest
Return Value	RevertXDRListResponse
Realm	administrator, reseller
Standalone mode support	No

RevertXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
revert_list	Yes	Array of XDRRevertInfo structure	No	The information about xDRs that are going to be reverted.

RevertXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

Codec converter tool

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CodecConverter

Codec converter file management

add_file

This method enables an API user to upload a file

Parameters

AddCodecConverterFileRequest

Return Value

AddCodecConverterFileResponse

Realm

administrator, account, retail customer, reseller

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	Yes

AddCodecConverterFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
audio_profile	No	string	No	The audio profile.	Possible values: normalize
callback	No	string	No	The callback name.
callback_params	No	string	No	The callback params.
codec_list	No	ArrayOfString	No	The codec list.
file_name	No	string	No	The file name.	Max value: 64 Min value: 1
handler	No	string	No	The handler name.	Default value: audio_file Possible values: dial_by_name, ringback_tone, moh, audio_file
i_object	No	unsignedLong	No	The unique identifier of the object.
object	No	string	No	The object type. Possible values: 'account', 'customer'.	Possible values: account, customer
storage_info	No	int	No	The flag that shows whether to include storage information into the response.

AddCodecConverterFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
codec_list	No	ArrayOfString	No	The codec list.
id	Yes	unsignedLong	No	The unique identifier of the file.
storage_info	No	CodecConverterStorageInfo structure	No	The storage information.

delete_file
This method enables an API user to delete the file
Parameters	DeleteCodecConverterFileRequest
Return Value	DeleteCodecConverterFileResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DeleteCodecConverterFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
handler	No	string	No	The handler name.	Default value: audio_file Possible values: dial_by_name, ringback_tone, moh, audio_file
id	Yes	unsignedLong	No	The unique identifier of the file.	Min value: 1

DeleteCodecConverterFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

get_file

This method enables an API user to get the file

Parameters

GetCodecConverterFileRequest

Return Value

GetCodecConverterFileResponse

Realm

administrator, reseller, retail customer, account

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetCodecConverterFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
codec	No	string	No	The codec name.	Possible values: a_law, u_law, g729, g723, wav, mp3
handler	No	string	No	The handler name.	Default value: audio_file Possible values: dial_by_name, ringback_tone, moh, audio_file
id	Yes	unsignedLong	No	The unique identifier of the file.	Min value: 1
info_only	No	int	No	The flag that shows whether to fetch only the information without attachment.	Max value: 1

GetCodecConverterFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
error_message	No	string	No	The error message.
file_name	No	string	No	The file name.
i_owner	No	unsignedLong	No	The owner id.
id	No	unsignedLong	No	The unique identifier of the file.
name	No	string	No	The file name.
owner_type	No	string	No	The owner type.
status	No	string	No	The file status.

get_file_list
This method enables an API user to get the file list
Parameters	GetCodecConverterFileListRequest
Return Value	GetCodecConverterFileListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetCodecConverterFileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
handler	Yes	string	No	The handler name.	Possible values: dial_by_name, ringback_tone, moh, audio_file
i_owner	No	unsignedLong	No	The unique identifier of the owner.
owner_type	No	string	No	The owner type.	Possible values: product, account, system, user, customer

GetCodecConverterFileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
file_list	No	Array of CodecConverterFileInfo structure	No	The file list.

Commission plan information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CommissionPlan

Commission plan management

add_commission_plan
This method allows an API user to add a commission plan record
Parameters	AddCommissionPlanRequest
Return Value	AddCommissionPlanResponse
Realm	administrator, reseller
Standalone mode support	No

AddCommissionPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
commission_plan_info	Yes	CommissionPlanInfo structure	No	Complete information about the commission plan.

AddCommissionPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_commission_plan	Yes	unsignedLong	No	The unique ID of the commission plan.

delete_commission_plan
This method allows an API user to delete a commission plan record from the database
Parameters	DeleteCommissionPlanRequest
Return Value	DeleteCommissionPlanResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCommissionPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_commission_plan	Yes	unsignedLong	No	The unique ID of the commission plan.

DeleteCommissionPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_commission_plan_base_list
This method enables an API user to get the list of the commission plan base records
Parameters	GetCommissionPlanBaseListRequest
Return Value	GetCommissionPlanBaseListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCommissionPlanBaseListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetCommissionPlanBaseListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commission_plan_base_list	Yes	Array of CommissionPlanBaseInfo structure	No	The set of the commission plan base data records.

get_commission_plan_info
This method allows an API user to get a commission plan record from the database
Parameters	GetCommissionPlanInfoRequest
Return Value	GetCommissionPlanInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCommissionPlanInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_commission_plan	Yes	unsignedLong	No	The unique ID of the commission plan.

GetCommissionPlanInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commission_plan_info	No	CommissionPlanInfo structure	No	Complete information about the commission plan.

get_commission_plan_list
This method allows an API user to get a list of commission plans from the database
Parameters	GetCommissionPlanListRequest
Return Value	GetCommissionPlanListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCommissionPlanListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Flag which indicates whether the total number of the commission plans should be retrurned.
i_cp_base	No	int	No	The unique ID of the commission plan base.
iso_4217	No	string	No	The commission plan currency.	Max value: 3
limit	No	int	No	The number of rows to retrieve.
managed_by	No	unsignedLong	Yes	The unique ID of entity, which manage the commission plan.
name	No	string	No	The commission plan name.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetCommissionPlanListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commission_plan_list	Yes	Array of CommissionPlanInfo structure	No	The set of the commission plans data records.
total	No	int	No	The total number of found commission plans.

update_commission_plan
This method allows an API user to update a commission plan record
Parameters	UpdateCommissionPlanRequest
Return Value	UpdateCommissionPlanResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCommissionPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
commission_plan_info	Yes	CommissionPlanInfo structure	No	Complete information about the commission plan.

UpdateCommissionPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_commission_plan	Yes	unsignedLong	No	The unique ID of the commission plan.

Commitment information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Commitment

Commitment management

add_commitment
The method enables an API user to add a new commitment
Parameters	AddUpdateCommitmentRequest
Return Value	AddUpdateCommitmentResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateCommitmentRequest
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_info	Yes	CommitmentInfo structure	No	The commitment information.

AddUpdateCommitmentResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_commitment	No	unsignedLong	No	The unique identifier of the commitment record.

add_commitment_one_time_term
The method enables an API user to add a one-time term to the commitment
Parameters	AddCommitmentOneTimeTermRequest
Return Value	AddCommitmentOneTimeTermResponse
Realm	administrator, reseller
Standalone mode support	No

AddCommitmentOneTimeTermRequest
Property	Mandatory	Type	Nillable	Description	Possible values
one_time_term_info	Yes	CommitmentOneTimeTermInfo structure	No	The commitment one-time term information.

AddCommitmentOneTimeTermResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_one_time_term	No	unsignedLong	No	The unique identifier of the one-time term.

add_commitment_recurring_term
The method enables an API user to add a recurring term to the commitment
Parameters	AddCommitmentRecurringTermRequest
Return Value	AddCommitmentRecurringTermResponse
Realm	administrator, reseller
Standalone mode support	No

AddCommitmentRecurringTermRequest
Property	Mandatory	Type	Nillable	Description	Possible values
recurring_term_info	Yes	CommitmentRecurringTermInfo structure	No	The commitment recurring term information.

AddCommitmentRecurringTermResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_recurring_term	No	unsignedLong	No	The unique identifier of the record.

delete_commitment
The method enables an API user to delete a commitment record
Parameters	DeleteCommitmentRequest
Return Value	DeleteCommitmentResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCommitmentRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_commitment	Yes	unsignedLong	No	The unique identifier of the commitment record.

DeleteCommitmentResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

delete_commitment_one_time_term
The method enables an API user to delete a one-time term record associated with a commitment
Parameters	DeleteCommitmentOneTimeTermRequest
Return Value	DeleteCommitmentOneTimeTermResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCommitmentOneTimeTermRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_one_time_term	Yes	unsignedLong	No	The unique identifier of the one-time term.

DeleteCommitmentOneTimeTermResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

delete_commitment_recurring_term
The method enables an API user to delete a recurring term record associated with a commitment
Parameters	DeleteCommitmentRecurringTermRequest
Return Value	DeleteCommitmentRecurringTermResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCommitmentRecurringTermRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_recurring_term	Yes	unsignedLong	No	The unique identifier of the recurring term.

DeleteCommitmentRecurringTermResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	The result of the operation, or an exception in case of failure.

estimate_commitment_price_for_first_billing_period
The method enables an API user to estimate the cost of a commitment in the first billing period
Parameters	EstimateCommitmentPriceForFirstBillingPeriodRequest
Return Value	EstimateCommitmentPriceForFirstBillingPeriodResponse
Realm	administrator, reseller
Standalone mode support	No

EstimateCommitmentPriceForFirstBillingPeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_billing_period	No	unsignedLong	No	The ID of the customer's billing period; refers to the Billing_Period table.	Default value: 4 Possible values: 1, 2, 3, 4
i_commitment	Yes	unsignedLong	No	The unique identifier of the commitment record.
no_activation_charge	No	int	No	The flag specifies if the activation fee should be excluded from the estimated price.

EstimateCommitmentPriceForFirstBillingPeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
amount	No	float	No	The full price the user has to pay for the first billing period of the commitment.
iso_4217	No	string	No	The currency.

get_commitment_info
The method enables an API user to get the information about a commitment
Parameters	GetCommitmentInfoRequest
Return Value	GetCommitmentInfoResponse
Realm	administrator, reseller
Standalone mode support	No

GetCommitmentInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Flag specifies whether it is necessary to check if the commitment is assigned to one account at least.	Max value: 1 Min value: 0
i_commitment	Yes	unsignedLong	No	The unique identifier of the commitment record.

GetCommitmentInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_info	No	CommitmentInfo structure	No	The commitment information.

get_commitment_list
The method enables an API user to get a set of commitment records
Parameters	GetCommitmentListRequest
Return Value	GetCommitmentListResponse
Realm	administrator, reseller
Standalone mode support	No

GetCommitmentListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	The flag that specifies whether it is needed to check if the commitment is assigned to at least one account.
get_total	No	int	No	Get the total number of the retrieved records.
i_addon_product	No	unsignedLong	No	Filter only commitments that include the specified addon product.
i_subscription	No	unsignedLong	No	Filter only commitments that include recurring charges set via a specified subscription.
iso_4217	No	string	No	Filter commitments by the currency.
limit	No	int	No	The number of rows to retrieve.
managed_by	No	unsignedLong	No	Return only commitments managed by the specified reseller.
min_period	No	int	No	Filter the commitments by their minimum period.
min_period_filter	No	string	No	Specifies the condition to be used for filtering the commitments by min_period. Possible values: less, equal, greater.	Default value: equal Possible values: less, equal, greater
name	No	string	No	The commitment name.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetCommitmentListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_list	No	Array of CommitmentInfo structure	No	The set of commitments.
total	No	int	No	The total number of found records.

get_commitment_terms
The method enables an API user to get the set of the recurring and one-time commitment terms associated with a commitment record
Parameters	GetCommitmentTermsRequest
Return Value	GetCommitmentTermsResponse
Realm	administrator, reseller
Standalone mode support	No

GetCommitmentTermsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_commitment	Yes	unsignedLong	No	The unique identifier of the commitment record.

GetCommitmentTermsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
commitment_one_time_term_list	No	Array of CommitmentOneTimeTermInfo structure	No	The set of one-time terms associated with the commitment .
commitment_recurring_term_list	No	Array of CommitmentRecurringTermInfo structure	No	The set of recurring terms associated with the commitment .

update_commitment
The method enables an API user to update the commitment information
Parameters	AddUpdateCommitmentRequest
Return Value	AddUpdateCommitmentResponse
Realm	administrator, reseller
Standalone mode support	No

update_commitment_one_time_term
The method enables an API user to update a one-time term record associated with a commitment
Parameters	UpdateCommitmentOneTimeTermRequest
Return Value	UpdateCommitmentOneTimeTermResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCommitmentOneTimeTermRequest
Property	Mandatory	Type	Nillable	Description	Possible values
one_time_term_info	Yes	CommitmentOneTimeTermInfo structure	No	The commitment one-time term information.

UpdateCommitmentOneTimeTermResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_one_time_term	No	unsignedLong	No	The unique identifier of the record.

update_commitment_recurring_term
The method enables an API user to update a recurring term record associated with a commitment
Parameters	UpdateCommitmentRecurringTermRequest
Return Value	UpdateCommitmentRecurringTermResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCommitmentRecurringTermRequest
Property	Mandatory	Type	Nillable	Description	Possible values
recurring_term_info	Yes	CommitmentRecurringTermInfo structure	No	The commitment recurring term information.

UpdateCommitmentRecurringTermResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_recurring_term	No	unsignedLong	No	The unique identifier of the record.

Content-based charging information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/ContentBasedCharging

Marketing group management

add_marketing_group
This method enables an API user to add a marketing group
Parameters	AddMarketingGroupRequest
Return Value	AddMarketingGroupResponse
Realm	administrator
Standalone mode support	No

AddMarketingGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
marketing_group_info	Yes	MarketingGroupInfo structure	No	The information about the marketing group.

AddMarketingGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_marketing_group	No	unsignedLong	No	The ID of the marketing group.

delete_marketing_group
This method enables an API user to delete a marketing group record
Parameters	DeleteMarketingGroupRequest
Return Value	DeleteMarketingGroupResponse
Realm	administrator
Standalone mode support	No

DeleteMarketingGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_marketing_group	Yes	unsignedLong	No	The ID of the marketing group.

DeleteMarketingGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	Possible values: 1 - for success; 0 - for failure.

get_marketing_group_info
This method enables an API user to retrieve the information about a marketing group – a certain type of network traffic (e.g. Messengers, Social Networks, etc.)
Parameters	GetMarketingGroupInfoRequest
Return Value	GetMarketingGroupInfoResponse
Realm	administrator
Standalone mode support	Yes

GetMarketingGroupInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_external_info	No	int	No	This flag indicates whether a local group or a group from the CoSS server should be returned.	Default value: 0
i_marketing_group	No	unsignedLong	No	The ID of the marketing group.
id	No	int	No	Marketing group code on the CoSS server.
name	No	string	No	Marketing group name.

GetMarketingGroupInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
marketing_group_info	No	MarketingGroupInfo structure	No	The information about the marketing group.

get_marketing_group_list
This method enables an API user to retrieve the list of existing marketing groups
Parameters	GetMarketingGroupListRequest
Return Value	GetMarketingGroupListResponse
Realm	administrator
Standalone mode support	Yes

GetMarketingGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_external_groups	No	int	No	This flag indicates whether local groups or groups from the CoSS server should be returned.	Default value: 0
id	No	string	No	Marketing group code pattern.
name	No	string	No	Marketing group name pattern.

GetMarketingGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
marketing_group_list	No	Array of MarketingGroupInfo structure	No	Set of the marketing group records.

update_marketing_group
This method enables an API user to update the information about a marketing group
Parameters	UpdateMarketingGroupRequest
Return Value	UpdateMarketingGroupResponse
Realm	administrator
Standalone mode support	No

UpdateMarketingGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
marketing_group_info	Yes	MarketingGroupInfo structure	No	The information about the marketing group.

UpdateMarketingGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	One of the following: 1 – success, 0 – failed.

Rating group management

add_rating_group
This method enables an API user to add a rating group
Parameters	AddRatingGroupRequest
Return Value	AddRatingGroupResponse
Realm	administrator
Standalone mode support	No

AddRatingGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rating_group_info	Yes	RatingGroupInfo structure	No	The information about the rating group.

AddRatingGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rating_group	No	unsignedLong	No	The ID of the rating group.

delete_rating_group
This method enables an API user to delete a rating group record
Parameters	DeleteRatingGroupRequest
Return Value	DeleteRatingGroupResponse
Realm	administrator
Standalone mode support	No

DeleteRatingGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rating_group	Yes	unsignedLong	No	The ID of the rating group.

DeleteRatingGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	Possible values: 1 - for success; 0 - for failure.

get_rating_group_info
This method enables an API user to retrieve the information about a rating group
Parameters	GetRatingGroupInfoRequest
Return Value	GetRatingGroupInfoResponse
Realm	administrator
Standalone mode support	Yes

GetRatingGroupInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rating_group	No	unsignedLong	No	The ID of the rating group.
id	No	int	No	The rating group code used for communication with the CoSS server.
name	No	string	No	The name of the rating group.

GetRatingGroupInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rating_group_info	No	RatingGroupInfo structure	No	The information about the rating group.

get_rating_group_list
This method enables an API user to retrieve the list of existing rating groups
Parameters	GetRatingGroupListRequest
Return Value	GetRatingGroupListResponse
Realm	administrator
Standalone mode support	Yes

GetRatingGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
id	No	int	No	Rating group code pattern on the CoSS server.
name	No	string	No	Rating group name pattern.

GetRatingGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rating_group_list	No	Array of RatingGroupInfo structure	No	Set of rating group records.

update_rating_group
This method enables an API user to update the information about a rating group
Parameters	UpdateRatingGroupRequest
Return Value	UpdateRatingGroupResponse
Realm	administrator
Standalone mode support	No

UpdateRatingGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rating_group_info	Yes	RatingGroupInfo structure	No	The information about the rating group.

UpdateRatingGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	Possible values: 1 - for success; 0 - for failure.

Currency information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Currency

Currencies exchange management

convert_money
This method allows an API user to convert an amount from one currency to another
Parameters	ConvertMoneyRequest
Return Value	ConvertMoneyResponse
Realm	administrator, reseller
Standalone mode support	Yes

ConvertMoneyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	The amount of money to convert.	Min value: 0
from_iso_4217	Yes	string	No	The initial currency.
to_iso_4217	Yes	string	No	The target currency.

ConvertMoneyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
converted	No	float	No	The amount in the target currency (the converted amount).

get_exchange_rate_list
This method allows an API user to get a list of all exchange rates used within the system
Parameters	GetXrateListRequest
Return Value	GetXrateListResponse
Realm	administrator, reseller
Standalone mode support	No

GetXrateListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get total amount of exchange rates.
iso_4217	No	string	No	Get only exchange rates for provided iso_4217.
limit	No	int	No	Limit of response list.
offset	No	int	No	Offset of response list.
only_active	No	int	No	Get only active exchange rates.

GetXrateListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
exchange_rate_list	No	Array of XrateInfo structure	No	The list of exchange rate records.
total	No	int	No	The total number of the retrieved exchange rate data records.

sync_exchange_rates
This method enables an API user to synchronize exchange rates with their external sources
Parameters	SyncXratesRequest
Return Value	SyncXratesResponse
Realm	administrator, reseller
Standalone mode support	No

SyncXratesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

SyncXratesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

Currency management

add_currency
This method allows an API user to add a currency
Parameters	AddCurrencyRequest
Return Value	AddCurrencyResponse
Realm	administrator, reseller
Standalone mode support	No

AddCurrencyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
currency_info	Yes	CurrencyInfo structure	No	Complete information about the Currency.

AddCurrencyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ma_currency	No	unsignedLong	No	The unique merchant account currency identifier.
iso_4217	Yes	string	No	The unique ID of the Currency record.

delete_currency
This method allows an API user to delete a currency
Parameters	DeleteCurrencyRequest
Return Value	DeleteCurrencyResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCurrencyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ma_currency	No	unsignedLong	No	The unique merchant account currency identifier.
iso_4217	Yes	string	No	The unique ID of the Currency record.

DeleteCurrencyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_currency_info
This method allows an API user to get information about a currency created in PortaBilling
Parameters	GetCurrencyInfoRequest
Return Value	GetCurrencyInfoResponse
Realm	administrator, reseller, representative, cc staff, distributor
Standalone mode support	Yes

GetCurrencyInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ma_currency	No	unsignedLong	No	The unique merchant account currency identifier.
iso_4217	Yes	string	No	Currency ISO4217 code.

GetCurrencyInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
currency_info	Yes	CurrencyInfo structure	No	Complete information about the Currency.

get_currency_list
This method allows an API user to get the list of currencies created in PortaBilling
Parameters	GetCurrencyListRequest
Return Value	GetCurrencyListResponse
Realm	administrator, reseller, cc staff, representative
Standalone mode support	Yes

GetCurrencyListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Flag which allows to include the total number of retrieved records into the response.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.
search	No	string	No	Pattern that allows to search by Currency name. Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character.
skip_merchant_account_info	No	int	No	Specifies whether to remove merchant account info related to a currency record from the response.

GetCurrencyListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
currency_list	Yes	Array of CurrencyInfo structure	No	Set of Currency data records.
total	No	int	No	The total number of the retrieved currencies records.

update_currency
This method allows an API user to update a currency
Parameters	UpdateCurrencyRequest
Return Value	UpdateCurrencyResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCurrencyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
currency_info	Yes	CurrencyInfo structure	No	Complete information about the Currency.

UpdateCurrencyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ma_currency	No	unsignedLong	No	The unique merchant account currency identifier.
iso_4217	Yes	string	No	The unique ID of the Currency record.

Custom fields information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CustomFields

Custom field management

add_custom_field
This method enables an API user to add a custom field
Parameters	AddCustomFieldRequest
Return Value	AddCustomFieldResponse
Realm	administrator, reseller
Standalone mode support	No

AddCustomFieldRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_field_info	Yes	CustomFieldsInfo structure	No	The custom field information.

AddCustomFieldResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_custom_field	Yes	unsignedLong	No	The unique ID of the custom field record.

delete_custom_field
This method enables an API user to delete a custom field
Parameters	DeleteCustomFieldRequest
Return Value	DeleteCustomFieldResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomFieldRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_custom_field	Yes	unsignedLong	No	The unique ID of the custom field record.

DeleteCustomFieldResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

get_custom_field_info
This method enables an API user to get a custom field
Parameters	GetCustomFieldInfoRequest
Return Value	GetCustomFieldInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomFieldInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_custom_field	Yes	unsignedLong	No	The unique ID of the custom field record.

GetCustomFieldInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_field_info	No	CustomFieldsInfo structure	No	The custom field information.

get_custom_field_list
This method enables an API user to get the list of custom fields with information about their types and possible values
Parameters	GetCustomFieldListRequest
Return Value	GetCustomFieldListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomFieldListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the custom field was used.
managed_by	No	unsignedLong	No	The unique ID of the reseller who manages the Custom field record. If undefined, only custom fields managed by administrator will be returned.
mandatory	No	string	No	The flag shows whether the custom field is mandatory. Possible values: 'Y', 'N'.	Possible values: Y, N
name	No	string	No	The custom field name pattern.
object	No	string	No	The object the custom field is applicable to. Possible values: 'customer', 'account'.	Possible values: customer, account
type	No	string	No	The canonical name of the custom field type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'.	Possible values: number, date, text, datetime, list
visible_to_end_user	No	string	No	The flag shows whether the custom field is visible to the end user. Possible values: 'Y', 'N'.	Possible values: Y, N

GetCustomFieldListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields	No	Array of CustomFieldsInfo structure	No	The list of available custom fields.

update_custom_field
This method enables an API user to update a custom field
Parameters	UpdateCustomFieldRequest
Return Value	UpdateCustomFieldResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomFieldRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_field_info	Yes	CustomFieldsInfo structure	No	The custom field information.

UpdateCustomFieldResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_custom_field	Yes	unsignedLong	No	The unique ID of the custom field record.

Customer class information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/CustomerClass

Business model management

get_business_models_list
This method enables an API user to get the list of business model records
Parameters	GetBusinessModelsListRequest
Return Value	GetBusinessModelsListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetBusinessModelsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetBusinessModelsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
business_models	No	Array of BusinessModelInfo structure	No	The list of available business models.

Customer class management

add_customer_class
This method allows an API user to add a customer class record
Parameters	AddUpdateCustomerClassRequest
Return Value	AddUpdateCustomerClassResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateCustomerClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_class_info	Yes	CustomerClassInfo structure	No	Complete information about customer class records.

AddUpdateCustomerClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class record.

clone_customer_class
This method enables an API user to clone a customer class record
Parameters	CloneCustomerClassRequest
Return Value	CloneCustomerClassResponse
Realm	administrator, reseller
Standalone mode support	No

CloneCustomerClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class to use the info from for the cloning procedure.
managed_by	No	unsignedLong	Yes	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The unique ID of the reseller who is going to manage the customer class.
name	No	string	Yes	The name of the new cloned customer class.	Max value: 100

CloneCustomerClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the new cloned customer class.

delete_customer_class
This method allows an API user to delete a customer class record
Parameters	DeleteCustomerClassRequest
Return Value	DeleteCustomerClassResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class record.

DeleteCustomerClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_customer_class_info
This method allows an API user to get information about the customer class records
Parameters	GetCustomerClassInfoRequest
Return Value	GetCustomerClassInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomerClassInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
i_customer_class	No	unsignedLong	No	The unique ID of the customer class record.
name	No	string	No	Name of the customer class on the PortaBilling interface, unique in the environment.	Max value: 100

GetCustomerClassInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_class_info	No	CustomerClassInfo structure	No	Complete information about customer class records.

get_customer_class_list
This method allows an API user to get the list of customer class records
Parameters	GetCustomerClassListRequest
Return Value	GetCustomerClassListResponse
Realm	administrator, reseller, representative
Standalone mode support	Yes

GetCustomerClassListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the customer class is in use.
get_total	No	int	No	Get the total number of retrieved records.	Default value: 1
i_business_model	No	unsignedLong	No	The unique ID of the business model.
i_customer	No	unsignedLong	Yes	ID of the reseller who manages the customer class.
invoicing_status	No	string	No	Possible values: 1 - both regular and out-of-turn invoicing enabled , 2 - regular invoicing enabled, 3 - out-of-turn invoicing enabled, 4 - invoicing disabled.	Possible values: 1, 2, 3, 4
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The name of the customer class.
offset	No	int	No	The number of rows to skip at the beginning of the list.
search	No	string	No	Search in the name and description of a customer class.
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.

GetCustomerClassListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_class_list	No	Array of CustomerClassInfo structure	No	The list of customer classes.
total	No	int	No	The total number of the retrieved customer class records.

get_default_customer_class
This method allows an API user to get information about the default customer class records
Parameters	GetDefaultCustomerClassRequest
Return Value	GetDefaultCustomerClassResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDefaultCustomerClassRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	ID of the reseller who manages the customer class (undefined in case of Managed By Administrator Only).

GetDefaultCustomerClassResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_class_info	No	CustomerClassInfo structure	No	Complete information about customer class records.

update_customer_class
This method allows an API user to update a customer class record
Parameters	AddUpdateCustomerClassRequest
Return Value	AddUpdateCustomerClassResponse
Realm	administrator, reseller
Standalone mode support	No

Notification template management

get_notification_category_list
This method enables an API user to get the list of notification categories of the customer class
Parameters	GetCustomerClassNotificationCategoryListRequest
Return Value	GetCustomerClassNotificationCategoryListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomerClassNotificationCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	No	unsignedLong	No	The unique ID of the customer class.

GetCustomerClassNotificationCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_category_list	No	Array of CustomerClassNotificationCategoryInfo structure	No	The list of notification categories with their properties.

get_notification_list
This method enables an API user to get the list of notifications of the customer class
Parameters	GetCustomerClassNotificationListRequest
Return Value	GetCustomerClassNotificationListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomerClassNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	No	unsignedLong	No	The unique ID of the customer class.

GetCustomerClassNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_list	No	Array of NotificationInfo structure	No	The list of notifications with their properties.
total	Yes	int	No	The total amount of notifications.

get_notification_template_info
This method is obsolete. Use the new get_notification_template_info method of the Notification service instead. This method allows an API user to get information about the notification template configured for a customer class
Parameters	GetCustomerClassNotificationTemplateInfoRequest
Return Value	GetCustomerClassNotificationTemplateInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomerClassNotificationTemplateInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
name	Yes	string	No	The name of the either email or sms notification template as it appears in the Notifications table in the database.

GetCustomerClassNotificationTemplateInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
bcc	No	string	No	An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas.
body	No	string	No	The content of the message.
subject	No	string	No	The subject as it appears in an email to a recepient.
variables	No	Array of NotificationTemplateVariable structure	No	The set of available variables with information about them.

send_me_notification_sample
This method is obsolete. Use the new send_me_notification_sample method of the Notification service instead. This method allows an API user to send a sample notification
Parameters	SendMeCustomerClassNotificationSampleRequest
Return Value	SendMeCustomerClassNotificationSampleResponse
Realm	administrator, reseller
Standalone mode support	Yes

SendMeCustomerClassNotificationSampleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
messaging_service_type	Yes	string	No	The type of the notification.	Possible values: mail, sms
name	Yes	string	No	The name of the notification.

SendMeCustomerClassNotificationSampleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
is_sent	Yes	int	No	Specifies whether the notification was sent. Possible values: 1 – The notification was sent, 0 – The notification was not sent.

update_notification_category_list
This method is obsolete. Use the new update_notification_list method of the CustomerClass service instead. This method enables an API user to update the list of notification categories of customer class
Parameters	UpdateCustomerClassNotificationCategoryListRequest
Return Value	UpdateCustomerClassNotificationCategoryListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerClassNotificationCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
notification_category_list	Yes	Array of CustomerClassNotificationCategoryInfo structure	No	The list of notification categories with their properties.	Min value: 1

UpdateCustomerClassNotificationCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

update_notification_list
This method enables an API user to update the list of notifications of the customer class
Parameters	UpdateCustomerClassNotificationListRequest
Return Value	UpdateCustomerClassNotificationListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerClassNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
notification_list	Yes	Array of CustomerClassNotificationInfo structure	No	The list of notifications with their properties.	Min value: 1

UpdateCustomerClassNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

update_notification_template
This method is obsolete. Use the new update_notification_template method of the Notification service instead. This method allows an API user to update the notification template configured for the customer class
Parameters	UpdateCustomerClassNotificationTemplateRequest
Return Value	UpdateCustomerClassNotificationTemplateResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerClassNotificationTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
bcc	No	string	No	An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas.
body	No	string	No	The content of the message.
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
name	Yes	string	No	The name of the either email or sms notification template as it appears in the Notifications table in the database.
reset_to_default	No	int	No	Specifies whether to reset the notification template to its default value. Possible values: 1 – Reset the notification template to its default value, 0 – Do not reset the notification template.
subject	No	string	No	The subject as it appears in an email to a recepient.
variables	No	Array of NotificationTemplateVariable structure	No	The set of available variables with information about them.

UpdateCustomerClassNotificationTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authorship	No	string	No	Specifies whether the template has been modified. Possible values: System – The template has not been modified; Custom – The template has been modified.
is_updated	Yes	int	No	Specifies whether the notification template was updated. Possible values: 1 – The notification template was updated, 0 – The notification template was not updated.

Payments, taxation and invoice management

get_taxation_info
This method allows an API user to retrieve information about the plug-in module which is used to make tax calculations and its parameters
Parameters	GetCustomerClassTaxationInfoRequest
Return Value	GetCustomerClassTaxationInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomerClassTaxationInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class record.

GetCustomerClassTaxationInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
estimate_taxes	No	string	No	Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled.
i_tax_transaction_code	No	unsignedLong	Yes	The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table.
taxation_info	Yes	TaxationInfo structure	No	TaxationInfo object.

update_taxation
This method allows an API user to set which plugin module will be used to make tax calculations and set up parameters that affect taxation
Parameters	UpdateCustomerClassTaxationRequest
Return Value	UpdateCustomerClassTaxationResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerClassTaxationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
estimate_taxes	No	string	No	Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled.	Possible values: Y, N
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class record.
i_tax_transaction_code	No	unsignedLong	Yes	The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table.
taxation_info	Yes	TaxationInfo structure	No	TaxationInfo object.

UpdateCustomerClassTaxationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

Customer information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Customer

Abbreviated dialing number management

add_abbreviated_dialing_number
This method allows an API user to add an abbreviated dialing number for a customer
Parameters	AddUpdateCustomerAbbreviatedDialingNumberRequest
Return Value	AddUpdateCustomerAbbreviatedDialingNumberResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

AddUpdateCustomerAbbreviatedDialingNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
abbreviated_dialing_number_info	Yes	AbbreviatedDialingNumberInfo structure	No	Abbreviated dialing number object.
i_customer	Yes	unsignedLong	No	ID of customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.

AddUpdateCustomerAbbreviatedDialingNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ab_dialing	Yes	unsignedLong	No	ID of abbreviated dialing number record.

delete_abbreviated_dialing_number
This method allows an API user to remove an abbreviated dialing number
Parameters	DeleteCustomerAbbreviatedDialingNumberRequest
Return Value	DeleteCustomerAbbreviatedDialingNumberResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

DeleteCustomerAbbreviatedDialingNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ab_dialing	Yes	unsignedLong	No	ID of abbreviated dialing number record.

DeleteCustomerAbbreviatedDialingNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if success, otherwise SOAP fault.

get_abbreviated_dialing_number_list
This method allows an API user to retrieve an abbreviated number list for a customer
Parameters	GetCustomerAbbreviatedDialingNumberListRequest
Return Value	GetCustomerAbbreviatedDialingNumberListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerAbbreviatedDialingNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295

GetCustomerAbbreviatedDialingNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
abbreviated_dialing_number_list	No	Array of AbbreviatedDialingNumberInfo structure	No	Array of abbreviated dialing number objects.
total	Yes	int	No	The number of the retrieved abbreviated dialing number objects.

update_abbreviated_dialing_number
This method allows an API user to update an existing abbreviated dialing number
Parameters	AddUpdateCustomerAbbreviatedDialingNumberRequest
Return Value	AddUpdateCustomerAbbreviatedDialingNumberResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

Account batch management

add_batch
This method allows an API user to add a new batch
Parameters	AddUpdateCustomerBatchRequest
Return Value	AddUpdateCustomerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateCustomerBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
batch_info	Yes	CustomerBatchInfo structure	No	Information about the batch.

AddUpdateCustomerBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_batch	Yes	unsignedLong	No	The unique ID of the batch.

delete_batch
This method allows an API user to delete the existing batch
Parameters	DeleteCustomerBatchRequest
Return Value	DeleteCustomerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_batch	Yes	unsignedLong	No	The unique ID of the batch.

DeleteCustomerBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 – In case of success; 0 - for failure.

get_batch_info
This method allows an API user to obtain the information about the batch parameters
Parameters	GetCustomerBatchInfoRequest
Return Value	GetCustomerBatchInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerBatchInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_batch	Yes	unsignedLong	No	The unique ID of the batch.

GetCustomerBatchInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
batch_info	No	CustomerBatchInfo structure	No	Information about the batch.

get_batch_list
This method allows an API user to get the list of batches of accounts
Parameters	GetCustomerBatchList
Return Value	GetCustomerBatchListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerBatchList
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the batch is in use.	Default value: 1
get_total	No	int	No	Get the total number of the retrieved batches.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The name of the batch. This property is useful when it is required to retieve the list of batches which names fit a particular pattern.	Max value: 32
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetCustomerBatchListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
batch_list	Yes	Array of CustomerBatchInfo structure	Yes	The list of the account batches under this customer.
total	No	int	No	The total number of the retrieved records.

update_batch
This method allows an API user to update the existing batch
Parameters	AddUpdateCustomerBatchRequest
Return Value	AddUpdateCustomerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

Async API notification management

disable_api_notifications
This method is obsolete. Use the new disable_api_notifications method of the CallControl service instead. Obsolete. Use CallControl.disable_api_notifications method instead
Parameters	DisableApiNotificationsCustomerRequest
Return Value	DisableApiNotificationsCustomerResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No
Mode	Syncronous only

DisableApiNotificationsCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
event	Yes	string	No	The event name.	Possible values: sip.call_control_notifications
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_main_office	No	unsignedLong	No	The unique ID of a сustomer's record with headquarters office type.

DisableApiNotificationsCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successfully completed.

enable_api_notifications
This method is obsolete. Use the new enable_api_notifications method of the CallControl service instead. Obsolete. Use CallControl.enable_api_notifications method instead
Parameters	EnableApiNotificationsCustomerRequest
Return Value	EnableApiNotificationsCustomerResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No
Mode	Syncronous only

EnableApiNotificationsCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
event	Yes	string	No	The event name.	Possible values: sip.call_control_notifications
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_main_office	No	unsignedLong	No	The unique ID of a сustomer's record with headquarters office type.

EnableApiNotificationsCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successfully completed.

Auto-payment management

add_auto_payment
This method allows an API user to set up automated periodic payments. If you want to charge a customer’s credit card whenever his balance crosses a specified threshold, then specify the pay_amount and balance_threshold properties, and when the customer’s balance crosses this threshold, their credit card will be charged for the amount specified in the pay_amount field
Parameters	AddUpdateAutoPaymentInfoRequest
Return Value	AddUpdateAutoPaymentInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

delete_auto_payment
This method enables an API user to delete customer's automated periodic payments
Parameters	DeleteAutoPaymentRequest
Return Value	DeleteAutoPaymentResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

get_auto_payment_info
This method allows an API user to get a customer’s automated periodic payment record
Parameters	GetAutoPaymentInfoRequest
Return Value	GetAutoPaymentInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

update_auto_payment
This method allows an API user to update automated periodic payments. A customer's credit card will be charged when the billing period is closed. If you want to charge a customer's credit card whenever his balance crosses a specified threshold, then specify the pay_amount and balance_threshold properties, and when the customer's balance crosses this threshold, their credit card will be charged for the amount specified in the pay_amount field
Parameters	AddUpdateAutoPaymentInfoRequest
Return Value	AddUpdateAutoPaymentInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

Call barring rule management

get_call_barring_options
This method enables an API user to retrieve all available options for customer call barring and check their status
Parameters	GetCustomerCallBarringOptionsRequest
Return Value	GetCustomerCallBarringOptionsResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerCallBarringOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.

GetCustomerCallBarringOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
options	No	Array of CallBarringRuleInfo structure	Yes	Call barring options.

update_call_barring_options
This method enables an API user to update the options for customer call barring, i.e. enable or disable the corresponding items
Parameters	UpdateCustomerCallBarringOptionsRequest
Return Value	UpdateCustomerCallBarringOptionsResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

UpdateCustomerCallBarringOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.
options	Yes	Array of CallBarringRuleInfo structure	No	Call barring options.

UpdateCustomerCallBarringOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	One of the following: 1 – success, 0 – failed.

Call queue management

add_callqueue

This method enables an API user to add the call queue to a hunt group

Parameters

AddCallQueueRequest

Return Value

AddUpdateCallQueueResponse

Realm

administrator, retail customer

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	No

AddCallQueueRequest
Property	Mandatory	Type	Nillable	Description	Possible values
callqueue_info	No	CQInfo structure	No	Information about the call queue.

AddUpdateCallQueueResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_queue	Yes	unsignedLong	No	The unique ID of the call queue record.

delete_callqueue
This method allows an API user to remove the call queue from a huntgroup
Parameters	DeleteCallQueueRequest
Return Value	DeleteCallQueueResponse
Realm	administrator, retail customer
Standalone mode support	No

DeleteCallQueueRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_queue	Yes	unsignedLong	No	The unique ID of the call queue record to be deleted.

DeleteCallQueueResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if success, otherwise SOAP fault.

get_callqueue_info
This method allows an API user to get call queue information
Parameters	GetCQInfoRequest
Return Value	GetCQInfoResponse
Realm	administrator, retail customer
Standalone mode support	Yes

GetCQInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_queue	Yes	unsignedLong	No	The unique ID of a call queue record.

GetCQInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
callqueue_info	No	CQInfo structure	No	Information about the call queue.

get_callqueue_list
This method allows an API user to get the list of a customer's call queues
Parameters	GetCQListInfoRequest
Return Value	GetCQListInfoResponse
Realm	administrator, retail customer, account
Standalone mode support	Yes

GetCQListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_info	No	int	No	Specifies whether detailed information will be returned in the response or not.
get_main_office_callqueues	No	int	No	Specifies whether the main office's call queues should be shown instead of call queues of the specified customer.
i_c_group	No	unsignedLong	No	Enables retrieving the huntgroup list by huntgroup ID.
i_customer	Yes	unsignedLong	No	The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295

GetCQListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
callqueue_list	No	Array of CQInfo structure	No	Information about the call queue.
total	No	int	No	The total number of retrieved call queues.

get_callqueue_moh_file

This method enables an API user to get the file with the music on hold for a specific call queue

Parameters

GetCQMohFileRequest

Return Value

GetCQMohFileResponse

Realm

administrator, retail customer

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetCQMohFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_queue	Yes	unsignedLong	No	The unique record of a call queue.

GetCQMohFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
moh_error	No	string	No	Error message, if any.
moh_status	No	string	No	Status of MOH conversion.
success	Yes	int	No	1 for success, 0 for failure.

get_callqueue_prompt_file

This method enables an API user to get the file with prompts for a specific call queue

Parameters

GetCQPromptFileRequest

Return Value

GetCQPromptFileResponse

Realm

administrator, retail customer

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetCQPromptFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_queue	Yes	unsignedLong	No	The unique record of a call queue.

GetCQPromptFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
prompt_error	No	string	No	Error message, if any.
prompt_status	No	string	No	Status of prompt conversion.
success	Yes	int	No	1 for success, 0 for failure.

update_callqueue

This method allows an API user to update the call queue configured for a huntgroup

Parameters

UpdateCallQueueRequest

Return Value

AddUpdateCallQueueResponse

Realm

administrator, retail customer

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	No

UpdateCallQueueRequest
Property	Mandatory	Type	Nillable	Description	Possible values
callqueue_info	No	CQInfo structure	No	Information about the call queue.

Custom field management

get_custom_fields_schema
This method allows an API user to get the list of customer's custom fields with information about their types and possible values
Parameters	GetCustomerCustomFieldsSchemaRequest
Return Value	GetCustomerCustomFieldsSchemaResponse
Realm	administrator, reseller, retail customer, distributor, cc staff, representative
Standalone mode support	Yes

GetCustomerCustomFieldsSchemaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	ID of customer record.

GetCustomerCustomFieldsSchemaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields	No	Array of CustomerCustomFieldsInfo structure	Yes	Array of Custom Field Values and Validation Schemas for the given Customer.

get_custom_fields_values
This method allows an API user to get the list of customer's custom fields
Parameters	GetCustomerCustomFieldsValuesRequest
Return Value	GetCustomerCustomFieldsValuesResponse
Realm	administrator, reseller, retail customer, representative
Standalone mode support	Yes

GetCustomerCustomFieldsValuesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.

GetCustomerCustomFieldsValuesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields_values	No	Array of CustomFieldsValuesInfo structure	Yes	The list of Custom Fields values for the given customer.

update_custom_fields_values
This method allows an API user to modify a customer's custom fields
Parameters	UpdateCustomerCustomFieldsValuesRequest
Return Value	UpdateCustomerCustomFieldsValuesResponse
Realm	administrator, reseller, retail customer, representative
Standalone mode support	No

UpdateCustomerCustomFieldsValuesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields_values	Yes	Array of CustomFieldsValuesInfo structure	Yes	The list of Custom Fields values for the given customer.
i_customer	No	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.

UpdateCustomerCustomFieldsValuesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields_values	No	Array of CustomFieldsValuesInfo structure	Yes	The list of Custom Fields values for the given customer.
i_customer	No	unsignedLong	Yes	The unique ID of the customer record.

Customer management

add_customer
This method allows an API user to create a new customer record using the supplied data
Parameters	AddCustomerRequest
Return Value	AddUpdateCustomerResponse
Realm	administrator, reseller, representative
Standalone mode support	No
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Customer/add_customer \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}' \ -d params='{ "customer_info":{ "name":"EasyCall", "i_customer_class":7, "i_billing_period":1, "i_time_zone":97, "login":"login_easycall", "password":"login_3easycall", "iso_4217":"USD", "i_template":0, "ot_i_template":0 } }'`
Response example	`{ "i_customer" : 600 }`

AddCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_info	No	CustomerInfo structure	No	Notes: i_customer will be ignored; most fields may be omitted, but iso_4217 and name are mandatory; for reseller API users, the i_customer_type and i_parent fields will be replaced with predefined values; default customer class will be set in case if i_customer_class is not defined.
generate_web_password	No	int	No	Specifies whether to autogenerate a password for the customer self-care interface. Possible values: 1 - Generate a password; 0 - Do not generate a password.

AddUpdateCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	ID of created / modified customer record.

add_subreseller
This method enables an API user to create a new subreseller record using the supplied data
Parameters	AddSubresellerRequest
Return Value	AddUpdateSubresellerResponse
Realm	administrator, reseller
Standalone mode support	No

AddSubresellerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
clone_product_list	No	Array of CloneProductInfo structure	No	The list of the resale products that will be cloned.
clone_tariff_list	No	Array of CloneTariffInfo structure	No	The list of the resale tariffs that will be cloned.
customer_info	No	CustomerInfo structure	No	Notes: i_customer will be ignored; iso_4217 and name are mandatory;.
generate_web_password	No	int	No	Specifies whether to autogenerate a password for the customer self-care interface. Possible values: 1 - Generate a password; 0 - Do not generate a password.

AddUpdateSubresellerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	ID of created / modified subreseller record.

change_password
This method allows a customer to change his password
Parameters	ChangeCustomerPasswordRequest
Return Value	ChangePasswordResponse
Realm	retail customer
Standalone mode support	No

ChangeCustomerPasswordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer record.
new_password	Yes	string	No	New password.	Max value: 32 Min value: 6
old_password	Yes	string	No	Old password.

cleanup_personal_data
This method enables an API user to cleanup personal data of an existing retail customer or reseller Asynchronous only
Parameters	CleanupPersonalDataRequest
Return Value	CleanupPersonalDataResponse
Realm	administrator, reseller
Standalone mode support	No
Mode	Asyncronous only

CleanupPersonalDataRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The ID of the customer record to be cleaned up.

CleanupPersonalDataResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

close_billing_period
This method enables an API user to schedule a customer's billing period closure. Can be used only for the customers that require administrator's approval for billing period closure
Parameters	CloseBillingPeriodRequest
Return Value	CloseBillingPeriodResponse
Realm	administrator
Standalone mode support	No

CloseBillingPeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.

CloseBillingPeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

delete_customer
This method allows an API user to delete an existing retail customer or reseller, provided it has no accounts, subcustomers, CDRs or managed objects
Parameters	DeleteCustomerRequest
Return Value	DeleteCustomerResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	ID of customer record to be deleted.

DeleteCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, 0 for failure.

get_customer_info
This method allows an API user to get a customer record from the database. The customer must be viewable (owned) by the user making the request
Parameters	GetCustomerInfoRequest
Return Value	GetCustomerInfoResponse
Realm	administrator, reseller, distributor, retail customer, cc staff, representative
Standalone mode support	Yes

GetCustomerInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
aux_field_names	No	Array of string structure	No	Additional field names to fetch.
detailed_info	No	int	No	Specifies whether detailed information will be returned in the response.
effective_values	No	int	No	Get customer info (including the values that were overridden or inherited from other entities).
get_auth_info	No	int	No	If set to '1', the information about the customer's authorization parameters will be provided in the response.
get_main_office_info	No	int	No	If set to '1', information will be provided for the requested Branch Office (site) customer about the Main Office (HQ) customer which is linked with it.
get_rt_auth_info	No	int	No	If set to '1', the customer's RT information will be provided in the response.
get_time_zone_name	No	int	No	If set to '1', the customer's time zone will be provided in the response; refers to Time_Zones table.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
login	No	string	No	User Name, as specified on web interface.
name	No	string	No	The ID of the customer on the PortaBilling interface, unique in the environment.
refnum	No	string	No	Reference number (custom field).
with_reseller_info	No	int	No	If with_reseller_info == 1 then return information about reseller.

GetCustomerInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_info	No	CustomerInfo structure	No	The complete information about a customer; for more information, see below.
main_office_info	No	CustomerInfo structure	No	The complete information about the Main Office (HQ) customer, linked with this subordinate one.
reseller_info	No	CustomerInfo structure	No	The complete information about a reseller.

get_customer_list
This method allows an API user to get a list of customer records. The customer must be viewable (or owned) by the user making the request
Parameters	GetCustomerListRequest
Return Value	GetCustomerListResponse
Realm	administrator, reseller, retail customer, cc staff, distributor, representative
Standalone mode support	Yes

GetCustomerListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
bcc	No	string	No	BCC email address.
bill_status	No	string	No	The billing status of the customer to search by. Possible values: O, S, C, E, D. O – The customer is open. S – The customer is suspended due to an overdue invoice. C – The customer is closed due to an unpaid invoice. E – The customer is exported. D – The customer is deactivated due to provisional termination. .	Possible values: , O, S, E, C, D, L
callshop_enabled	No	string	No	Filter the customer list by the 'callshop_enabled' field.	Possible values: Y, N
check_usage	No	int	No	Check whether the customer has entities assigned.
city	No	string	No	City of customer's address.	Max value: 31
companyname	No	string	No	Customer's company name.
cont1	No	string	No	Main contact person.	Max value: 120
cont2	No	string	No	Alternative contact person.	Max value: 120
country	No	string	No	The ISO 3166 two-letter country code. To change the country, use the update_customer API method or select the desired country on the UI. Note: after changing the country, the state may have a wrong value.
credit_limit_exceeded	No	int	No	Include into the response only the customers who exceeded their credit limit. Possible values: 1 - Credit limit exceeded; 0 - Credit limit not exceeded.
custom_fields_values	No	Array of CustomFieldsValuesInfo structure	No	The list of Custom Fields values.
detailed_info	No	int	No	Specifies whether detailed information will be returned in the response.
email	No	string	No	Email address.
faxnum	No	string	No	Fax number.	Max value: 21
firstname	No	string	No	Customer's first name.	Max value: 120
get_auth_info	No	int	No	If set to '1', the information about the customer's authorization parameters will be provided in the response.
get_notepad	No	int	No	Specifies whether to include the notes into the info. Possible values: 1 - Include the notes into the info; 0 - Do not include the notes into the info.
get_statuses	No	int	No	Get the statuses of the customers.
get_total	No	int	No	Get the total number of the retrieved customers.
has_invoices	No	int	No	Filters customer list by invoice presence. Possible values: 1 - Return customers with at least one invoice present; 0 - Return customers with no invoices.
i_customer_class	No	unsignedLong	No	The unique ID of the customer class; refers to Customer_Classes table.
i_customer_type	No	unsignedLong	No	The type of the customer. Possible values: 1 - Retail customer or subcustomer, 2 - Reseller, 3 - Distributor.	Possible values: 1, 2, 3
i_distributor	No	unsignedLong	Yes	The unique ID of the distributor associated with the customer. The distributor indicates the percentage commission from payments of related customers. To change the distributor, use the update_customer API method or select the desired distributor on the UI. Note: after changing the distributor, the distributor commission payment may change.
i_main_customer	No	unsignedLong	No	The unique ID of the "main" customer (Main Office (HQ) customer) record within one linked customers' group.
i_office_type	No	unsignedLong	No	The unique ID of the Office_Types record. Possible values: 1 – none; 2 – branch_office; 3 – main_office.	Possible values: 1, 2, 3
i_parent	No	unsignedLong	Yes	The unique ID of the reseller who manages the customer.
i_rep	No	unsignedLong	Yes	The unique ID of the customer's representative; refers to Representatives table.
invoicing_enabled	No	int	No	Filters customer list by their invoicing status. Possible values: 1 - Invoicing enabled; 0 - Invoicing disabled.
iso_4217	No	string	No	ISO4217 code for currency in which the customer is billed.	Max value: 3
lastname	No	string	No	Customer's last name.	Max value: 120
limit	Yes	int	No	The number of rows to retrieve.
login	No	string	No	Customer's login for self-care web interface.	Max value: 64
marked_for_porting	No	int	No	Specifies whether to list customers that will be ported. Possible values: 1 - the result list contains only customers that are marked for porting, 0 - the result list contains only customers that aren't marked for porting.	Default value: 0 Max value: 1 Min value: 0
midinit	No	string	No	Customer's middle initial(s).
name	No	string	No	The customer name pattern.
note	No	string	No	Short note (description).
offset	Yes	int	No	The number of rows to skip at the beginning of the list.
phone1	No	string	No	Main phone number.	Max value: 21
phone2	No	string	No	Alternative phone number.	Max value: 21
salutation	No	string	No	Customer's salutation.	Max value: 15
skip_exported	No	int	No	Specifies whether the customers with 'bill_status'='E' should be excluded from the response.
spending_limit_reached	No	int	No	Include into the response only the customers who reached their spending limit. Possible values: 1 - Spending limit reached; 0 - Spending limit not reached.
state	No	string	No	Province or state.
tax_id	No	string	No	Tax ID.
with_bp_charge_cc	No	int	No	Specifies whether to include customers' bp_charge_cc into the list. Possible values: 1 - Include customers' bp_charge_cc into the list; 0 - Do not include customers' bp_charge_cc into the list. Default value: 1.	Default value: 1
with_commission_plan	No	int	No	Specifies whether to include customers' commission plan into the list. Possible values: 1 - Include customers' commission plan into the list; 0 - Do not include customers commission plan into the list. Default value: 1.	Default value: 1
with_credit_limit_warnings	No	int	No	Specifies whether to include customers' credit limit warnings into the list. Possible values: 1 - Include customers' credit limit warnings into the list; 0 - Do not include customers' credit limit warnings into the list. Default value: 1.	Default value: 1
with_subresellers	No	int	No	Specifies whether to include subresellers into the list. Possible values: 1 - Include subresellers into the list; 0 - Do not include subresellers into the list.
with_terminated	No	int	No	Specifies whether to include terminated customers into the list. Possible values: 1 - Include terminated customers into the list; 0 - Do not include terminated customers into the list.
zip	No	string	No	Postal (zip) code.

GetCustomerListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_list	No	Array of CustomerInfo structure	No	Set of customer data records.
total	No	int	No	The total number of the retrieved customers.

suspend_customer
This method allows to suspend all services to a retail customer, reseller or distributor
Parameters	SuspendCustomerRequest
Return Value	SuspendCustomerResponse
Realm	administrator, reseller
Standalone mode support	No

SuspendCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.

SuspendCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

terminate_customer
This method allows an API user to terminate an existing retail customer or reseller
Parameters	TerminateCustomerRequest
Return Value	TerminateCustomerResponse
Realm	administrator, reseller, representative
Standalone mode support	No

TerminateCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	ID of customer record to be terminated.
supress_notification	No	int	No	Suppress the notification about customer termination.

TerminateCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure .

unsuspend_customer
This method allows to unsuspend all services to a retail customer, reseller or distributor
Parameters	UnsuspendCustomerRequest
Return Value	UnsuspendCustomerResponse
Realm	administrator, reseller
Standalone mode support	No

UnsuspendCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.

UnsuspendCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

update_customer
This method allows an API user to update an existing customer record using the supplied data
Parameters	UpdateCustomerRequest
Return Value	AddUpdateCustomerResponse
Realm	administrator, reseller, retail customer, cc staff, distributor, representative
Standalone mode support	No

UpdateCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_info	No	CustomerInfo structure	No	Note: i_customer is a mandatory field; fields not requiring modification may be omitted; the iso_4217, i_customer_type, i_parent and opening_balance fields are read-only.
update_params	No	UpdateCustomerParams structure	No	Additional conditions/options for updating the customer.

validate_customer_info
This method allows an API user to check if the supplied data can be used to create a new customer record or update an existing one
Parameters	ValidateCustomerInfoRequest
Return Value	ValidateCustomerInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

ValidateCustomerInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_info	No	CustomerInfo structure	No	Complete information about a customer; note: omit i_customer to check if data can be used to create a new customer record.

ValidateCustomerInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_info	No	CustomerInfo structure	No	Data about a customer, see CustomerInfo above.

Extension management

add_customer_extension

This method allows a retail customer to add an extension

Parameters

AddCustomerExtensionRequest

Return Value

AddUpdateCustomerExtensionResponse

Realm

administrator, retail customer

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	No

AddCustomerExtensionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account.
i_customer	Yes	unsignedLong	No	The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm.
id	Yes	string	No	Extension number.	Max value: 32 Min value: 1
name	No	string	No	Extension name.	Max value: 32
prompt_action	No	string	No	Possible values: set – Add (or replace) a prompt for an extension. The sound file is sent in a MIME attachment to the API request; unset – Remove existing prompt. Note that the Apache Cassandra database must be enabled for this method property to work.	Possible values: set, unset
published	No	string	No	Indicates whether the extensions is accessible via dial-by-name.	Possible values: Y, N

AddUpdateCustomerExtensionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_ext	Yes	unsignedLong	No	ID of the created extension.

delete_customer_extension
This method allows a retail customer to remove an extension
Parameters	DeleteCustomerExtensionRequest
Return Value	DeleteCustomerExtensionResponse
Realm	administrator, retail customer
Standalone mode support	No

DeleteCustomerExtensionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_ext	Yes	unsignedLong	No	The unique ID of the created extension.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.

DeleteCustomerExtensionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_customer_extension_info

This method enables an API user to get an extension record from the database

Parameters

GetCustomerExtensionInfoRequest

Return Value

GetCustomerExtensionInfoResponse

Realm

administrator, reseller, retail customer

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetCustomerExtensionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_info	No	int	No	Detailed information.
get_prompt_file	No	int	No	The prompt file associated with this extension.
i_c_ext	Yes	unsignedLong	No	The unique ID of the extension record. Refers to the Centrex_Extensions table.

GetCustomerExtensionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
extension_info	No	ExtensionsInfo structure	No	The full set of data for the specified extension.

get_extensions_list
This method allows an API user to get the list of extensions for phone lines within a customer's IP Centrex environment
Parameters	GetExtensionsListInfoRequest
Return Value	GetExtensionsListInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetExtensionsListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	Search pattern for account IDs.
detailed_info	No	int	No	Detailed information.
extension	No	string	No	Search pattern for extension numbers. Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character.
get_main_office_extensions	No	int	No	If set to '1', then additionally a list of main office extensions will be provided for its branch office .
get_published	No	int	No	If specified, shows whether to retrieve only publicly available or only private extensions. Possible values: 1 – Get only the extensions that are in the public directory (in this case, the Top Management/internal extensions are not retrieved); 0 – Get only the extensions excluded from the public directory.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
limit	No	int	Yes	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Search pattern for extension names. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character.	Max value: 32
offset	No	int	Yes	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295

GetExtensionsListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
extensions_list	No	Array of ExtensionsInfo structure	No	The list of extensions.
total	No	int	No	The number of entries.

update_customer_extension

This method allows a retail customer to modify an extension

Parameters

UpdateCustomerExtensionRequest

Return Value

AddUpdateCustomerExtensionResponse

Realm

administrator, retail customer

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	No

UpdateCustomerExtensionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	Yes	The unique ID of the account.
i_c_ext	Yes	unsignedLong	No	ID of the modified extension.
i_customer	No	unsignedLong	No	The unique ID of the customer.
id	No	string	No	Extension number.	Max value: 32 Min value: 1
name	No	string	Yes	Extension name.	Max value: 32
primary_i_c_group	No	unsignedLong	No	The unique ID of a huntgroup to be assigned as the primary group for an extension (0 to unset).
prompt_action	No	string	No	When creating an extension you can upload a voice prompt with the person's name. Possible values: set – Add (or replace) a prompt for an extension. The sound file is sent in a MIME attachment to the API request; unset – Remove existing prompt. Note that The Apache Cassandra database must be enabled for this method property to work.	Possible values: set, unset
published	No	string	No	When creating an extension you can mark it as "published" so that it is included in the dial-by-name directory. One of the following: Y – Makes an extensions accessible via dial-by-name; N – Excludes a certain extension from being accessible via dial-by- name (e.g. you do not want telemarketers to directly reach your CEO or CFO because their names are publicly accessible).	Possible values: Y, N

Huntgroup management

add_customer_huntgroup

This method allows a retail customer to create a huntgroup

Parameters

AddCustomerHuntgroupRequest

Return Value

AddUpdateCustomerHuntgroupResponse

Realm

administrator, retail customer

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	No

AddCustomerHuntgroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
add_callqueue	No	CQInfo structure	No	Information about the call queue.
add_extensions	No	Array of AssignedExtensionsInfo structure	No	The list of extension IDs to be added.
hunt_keep_original_cli	No	string	No	'Y' - The call is redirected with the phone number and name of the original caller. 'N' - The call is redirected with the phone number and name of the huntgroup. 'I' - Id Only, The call is redirected with the phone number of the original caller and name of the huntgroup .	Possible values: Y, N, I
hunt_sequence	No	string	No	Ringing strategy.	Possible values: Order, Random, Simultaneous, LeastUsed
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.
i_ringback_tone	No	unsignedLong	Yes	The unique ID of the assigned ringback tone file.
id	Yes	string	No	Huntgroup number.	Max value: 32 Min value: 1
name	Yes	string	No	Huntgroup name.	Max value: 32 Min value: 1
pickup_allowed	No	string	No	Allows extensions inside this huntgroup to pick up calls.	Possible values: Y, N
prompt_action	No	string	No	The name of action to perform with the prompt.	Possible values: set, unset

AddUpdateCustomerHuntgroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_group	Yes	unsignedLong	No	The unique ID of the created huntgroup.

delete_customer_huntgroup
This method allows a retail customer to remove a huntgroup
Parameters	DeleteCustomerHuntgroupRequest
Return Value	DeleteCustomerHuntgroupResponse
Realm	administrator, retail customer
Standalone mode support	No

DeleteCustomerHuntgroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_c_ext	No	unsignedLong	No	Obsolete. The unique ID of the extension.
i_c_group	Yes	unsignedLong	No	The unique ID of the created extension.
i_customer	No	unsignedLong	No	Obsolete. The unique ID of the customer record.

DeleteCustomerHuntgroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_huntgroup_info

This method enables an API user to retrieve a huntgroup record from the database

Parameters

GetHGInfoRequest

Return Value

GetHGInfoResponse

Realm

administrator, retail customer

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetHGInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_prompt_file	No	int	No	The prompt file associated with this huntgroup.
i_c_group	Yes	unsignedLong	No	The unique ID of the huntgroup record.

GetHGInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
huntgroup_info	No	HGInfo structure	No	The information about the huntgroup.

get_huntgroup_list
This method allows a retail customer to get the list of huntgroups (except for a huntgroup specified in the self_ref property)
Parameters	GetHGListInfoRequest
Return Value	GetHGListInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetHGListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_main_office_huntgroups	No	int	No	If provided, the list of the main office huntgroups will be returned together with a branch office huntgroups.
i_c_ext	No	unsignedLong	No	The unique extension ID. If provided, will return the list of huntgroups this extension is assigned to. Otherwise returns the list of all huntgroups .
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory if sent from the retail customer realm.
limit	No	int	Yes	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Enables retrieving the huntgroups list by name.
offset	No	int	Yes	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295
self_ref	No	int	No	Reference to a huntgroup which will be excluded from the list.

update_customer_huntgroup

This method allows a retail customer to modify a huntgroup

Parameters

UpdateCustomerHuntgroupRequest

Return Value

AddUpdateCustomerHuntgroupResponse

Realm

administrator, retail customer

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	No

UpdateCustomerHuntgroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
add_callqueue	No	CQInfo structure	Yes	Information about the call queue to be assigned to a huntgroup.
add_extensions	No	Array of AssignedExtensionsInfo structure	Yes	The list of extension IDs to be added.
chg_callqueue	No	CQInfo structure	Yes	Information about the call queue to be updated.
chg_extensions	No	Array of AssignedExtensionsInfo structure	Yes	The list of extension records to be updated.
del_callqueue	No	int	Yes	The unique ID of the call queue name to be deleted.	Min value: 1
del_extensions	No	ArrayOfInt	Yes	The list of extension IDs within the huntgroup (i_cg_ext) to be removed.
hunt_keep_original_cli	No	string	No	'Y' - The call is redirected with the phone number and name of the original caller. 'N' - The call is redirected with the phone number and name of the huntgroup. 'I' - Id Only, The call is redirected with the phone number of the original caller and name of the huntgroup .	Possible values: Y, N, I
hunt_sequence	No	string	No	The ringing strategy.	Possible values: Order, Random, Simultaneous, LeastUsed
i_c_ext	No	unsignedLong	No	Obsolete. Present in schema only for backward compatibility.
i_c_group	Yes	unsignedLong	No	The unique ID of the huntgroup.
i_customer	No	unsignedLong	No	Obsolete. Present in schema only for backward compatibility.
i_ringback_tone	No	unsignedLong	Yes	The unique ID of the assigned ringback tone file.
id	No	string	No	Huntgroup number.	Max value: 32 Min value: 1
name	No	string	No	Extension name.	Max value: 32 Min value: 1
pickup_allowed	No	string	No	Flag that marks the Huntgroup as a Pickup Group.	Possible values: Y, N
prompt	No	string	No	A SOAP attachment name to be used in prompt operations.
prompt_action	No	string	No	The name of action to perform with the prompt.	Possible values: set, unset

Information and statistics management

get_account_aliases_list
This method allows a retail customer to get the list of his account aliases
Parameters	GetAllAccAliasesListInfoRequest
Return Value	GetAllAccAliasesListInfoResponse
Realm	retail customer
Standalone mode support	Yes

GetAllAccAliasesListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved records.	Default value: 1
i_customer	Yes	unsignedLong	No	Refers to customer record to which the alias belongs. Not mandatory when the method that requires this structure is executed from the retail customer realm.
limit	No	int	Yes	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	Yes	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295

GetAllAccAliasesListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
account_aliases_list	No	Array of AccAliasesListInfo structure	No	The list of aliases.
total	No	int	No	Number of aliases.

get_credit_limit_history
This method enables an API user to get the credit limit history
Parameters	GetCreditLimitHistoryRequest
Return Value	GetCreditLimitHistoryResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCreditLimitHistoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.

GetCreditLimitHistoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
credit_limit_history	No	Array of CreditLimitChangeInfo structure	No	The credit limit history.

get_custom_xdr_report

This method allows to obtain a custom xDR report for a specific customer

Parameters

GetCustomXdrReportRequest

Return Value

GetCustomXdrReportResponse

Realm

administrator, reseller, retail customer

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetCustomXdrReportRequest
Property	Mandatory	Type	Nillable	Description	Possible values
file_name	No	string	No	The name of the report file (the unique report ID).
i_customer	Yes	unsignedLong	No	The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.

GetCustomXdrReportResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_custom_xdr_report_list
This method allows to obtain a list of custom xDR reports for a specific customer. In addition to the standard customer xDR report it is possible to obtain site-based reports. These reports can be downloaded by customers and administrators in CSV and PDF formats. Fields shown in the report can be configured separately for CSV and PDF files
Parameters	GetCustomXdrReportListRequest
Return Value	GetCustomXdrReportListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomXdrReportListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
period_from	No	date	No	Get custom xDR reports dated starting from this date.
period_to	No	date	No	Get custom xDR reports dated before this date.
type	No	string	No	The name of a custom xDR report type.

GetCustomXdrReportListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
report_list	Yes	Array of CustomXdrReportInfo structure	No	A list of custom reports available for download.
total	Yes	int	No	The number of the retrieved reports.

get_custom_xdr_report_types
This method allows to obtain a list of available custom xDR report types
Parameters	GetCustomXdrReportTypesRequest
Return Value	GetCustomXdrReportTypesResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomXdrReportTypesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetCustomXdrReportTypesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
report_types	Yes	Array of CustomXdrReportType structure	No	A list of available custom reports.

get_customer_xdrs

The cdr_entity attribute allows the use of this method in three modes. In the customer mode, this method only returns CDRs that directly belong to a given customer. In the account mode, this method only returns CDRs that belong to the accounts under a given customer. Supply this attribute with empty value to retrieve CDRs that belong to a given customer and his accounts

Parameters

GetRetailCustomerXDRListRequest

Return Value

GetRetailCustomerXDRListResponse

Realm

administrator, reseller, retail customer, representative

Standalone mode support

Attachments

Type	Download
Formats	csv
Mandatory	No

GetRetailCustomerXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
billing_model	No	int	No	Indicates whether the data should be retrieved for the credit entries or for the debit ones: 1 - Credit accounts; -1 - Debit accounts; Empty - Return both.	Possible values: -1, 1
call_id	No	string	No	The unique identifier of the call.
call_recording	No	int	No	Set this flag to filter xDRs by their call recording status. When it's not provided, all xDRs are obtained.
cdr_entity	No	string	No	Flag indicates from where CDRs should be returned: A - account xDRs; C - customer xDRs; Do not send - Return account and customer xDRs.	Possible values: A, C
cld	No	string	No	The called party phone number.
cli	No	string	No	The calling party phone number.
connect_time_after	No	dateTime	No	Get xDRs with connect_time after this date.
connect_time_before	No	dateTime	No	Get xDRs with connect_time before this date.
enable_safe_mode	No	int	No	The flag shows whether to check the amount of data before processing.
for_current_period	No	int	No	Specifies whether to show xDRs for the current billing period.
format	No	string	No	This parameter allows API user to get xDRs in other formats via SOAP attachment. Currently only the ".csv" format is supported.	Possible values: csv,
from_date	No	dateTime	No	Get xDRs with bill_time starting from this date.
get_split_xdrs	No	int	No	If set, split XDRs will be present in the response.
get_total	No	int	Yes	Get the total number of the retrieved xDRs.	Min value: 1
h323_conf_id	No	string	No	The unique identifier of the session.
history_pattern	No	string	No	Specifies whether to show xDRs with history that matches the pattern.
i_customer	No	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer real.
i_customer_type	No	unsignedLong	No	The unique ID of the XDR owner customer type.	Possible values: 1, 2
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_invoice	No	unsignedLong	No	Indicates what xDRs will be shown: nill - Midterm xDRs and out-ofturn xDRs; 0 - Out Of Turn xDRs; Not set – xDRs of all types.
i_service	No	unsignedLong	Yes	ID of the Service, refers to the Services table.
i_service_type	No	unsignedLong	No	The unique ID of the related service type.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Min value: 0
quality	No	string	No	The call quality.	Possible values: unknown, poor, fair, good
roaming	No	int	No	Set this flag to filter xDRs by their roaming status. When it's not provided, all xDRs are obtained.
show_hidden	No	int	No	If the method is called by the administrator and is set to 1, the list of hidden xDRs will be provided in the response.	Default value: 1
show_unsuccessful	No	int	No	Show xDRs of unsuccessful attempts.
to_date	No	dateTime	No	Get XDRs with bill_time before this date.
with_cr_download_ids	No	int	No	If set, then each xDR will contain download ids to the recorded files if any.
with_netaccess_usage	No	int	No	If set, then each netaccess xDR will contain the 'bytes_downloaded' and 'bytes_uploaded' fields in the response.

GetRetailCustomerXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved xDRs.
xdr_list	Yes	Array of CustomerXDRInfo structure	No	Array of customer or account xDR objects.

get_dial_rule_samples
This method allows a retail customer to get the sample dialing rules
Parameters	GetDialRuleSamplesRequest
Return Value	GetDialRuleSamplesResponse
Realm	retail customer
Standalone mode support	Yes

GetDialRuleSamplesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetDialRuleSamplesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dial_rule_samples_list	No	Array of SampleDialingRulesInfo structure	No	Array of SampleDialingRulesInfo objects.

get_last_billing_date_constraint_list
The method enables an API user to get constraints related to last billing date
Parameters	GetLastBillingDateConstraintListRequest
Return Value	GetLastBillingDateConstraintListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetLastBillingDateConstraintListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_time_zone	Yes	unsignedLong	No	The unique ID of the time zone.

GetLastBillingDateConstraintListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
constraint_list	Yes	Array of CustomerLastBillingDateConstraintInfo structure	No	The list of constraints related to last billing date for the specific time zone.

get_moh_list_info
This method allows an API user to get the list of music on hold entries
Parameters	GetMOHListInfoRequest
Return Value	GetMOHListInfoResponse
Realm	administrator, retail customer
Standalone mode support	Yes

GetMOHListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	Yes	The unique ID of the Customer Record.

GetMOHListInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
moh_list_info	No	MOHListInfo structure	No	MOH list object.

get_my_info
This method allows a reseller to get information about his own customer info record
Parameters	GetMyInfoRequest
Return Value	GetMyInfoResponse
Realm	reseller, distributor
Standalone mode support	Yes

GetMyInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetMyInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
customer_info	Yes	CustomerInfo structure	No	Reseller information.

get_rt_requestor_list
This method allows to obtain a list of RT requestors
Parameters	GetCustomerRTRequestorListRequest
Return Value	GetCustomerRTRequestorListResponse
Realm	administrator
Standalone mode support	Yes

GetCustomerRTRequestorListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved records.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The pattern to search requestors by in the 'name' field.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetCustomerRTRequestorListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rt_requestor_list	No	Array of RTRequestorInfo structure	No	The list of the RT requestors.
total	No	int	No	The number of the records found.

get_rt_tickets_list
This method allows to obtain tickets for a customer from the RT server
Parameters	GetCustomRTTicketsListRequest
Return Value	GetCustomRTTicketsListResponse
Realm	administrator, reseller, retail customer, cc staff
Standalone mode support	Yes

GetCustomRTTicketsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
created	No	dateTime	No	Ticket creation time.
get_total	No	int	No	Get the total number of retrieved tickets.
i_customer	Yes	unsignedLong	No	The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
id	No	int	No	Ticket number.
last_updated	No	dateTime	No	Last date when ticket has been updated.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
priority	No	int	No	Ticket priority.
status	No	string	No	Ticket status.
subject	No	string	No	Ticket subject.

GetCustomRTTicketsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
tickets_list	Yes	Array of TicketInfo structure	No	The list of tickets.
total	No	int	No	The number of retrieved reports.

get_service_wallet_xdr_list
This method enables the user to fetch the Customer Service Wallet XDRs
Parameters	GetRetailCustomerSWXDRListRequest
Return Value	GetRetailCustomerSWXDRListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetRetailCustomerSWXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
connect_time_after	No	dateTime	No	Get xDRs with connect_time after this date.
connect_time_before	No	dateTime	No	Get xDRs with connect_time before this date.
from_date	Yes	dateTime	No	Get xDRs with bill_time starting from this date.
get_total	No	int	No	Get the total number of the retrieved xDRs.	Default value: 0 Max value: 1 Min value: 0
history_pattern	No	string	Yes	Specifies whether to show xDRs with history that matches the pattern.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Min value: 0
to_date	Yes	dateTime	No	Get XDRs with bill_time before this date.
with_aux_xdrs	No	int	No	Includes the array of auxiliary xDRs to the retrieved XDRs list.
with_usage	No	int	No	Include usage records to the retrieved XDRs list.

GetRetailCustomerSWXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved xDRs.
xdr_list	No	Array of ServiceWalletXDRInfo structure	No	Array of the customer service wallet xDRs and taxes.

get_services_consumption
This method allows an API user to get information about services consumed by a customer
Parameters	GetCustomerConsumedServiceRequest
Return Value	GetCustomerConsumedServiceResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerConsumedServiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
billing_model	No	int	No	Indicates whether the data should be retrieved for the credit entries or for the debit ones: -1 - Debit account type; 1 - Credit account type.	Possible values: -1, 1
from_date	No	dateTime	No	Get information recorded starting from this date.
get_total	No	int	No	Get the total number of the retrieved services.	Default value: 0
group_by_roaming	No	int	No	Group xDRs by their roaming status.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.
i_invoice	No	unsignedLong	No	Indicates what xDRs will be shown: nill - Midterm xDRs and out-of-turn xDRs; 0 - Out Of Turn xDRs; Not set - xDRs of all types.
i_service	No	unsignedLong	Yes	The unique ID of the service record.
limit	No	int	No	The number of servies to retrieve. Mandatory for an API request with the offset property specified.	Default value: 50
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
show_unsuccessful	No	int	No	Show records of unsuccessful attempts.
to_date	No	dateTime	No	Get information recorded before this date.

GetCustomerConsumedServiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
consumed_service_list	No	Array of ConsumedServiceInfo structure	Yes	The list of ConsumedServices records.
total	No	int	No	The total number of the retrieved services.

get_status_history
This method allows an API user to track important events in a customer's lifecycle, such as when a customer was blocked / unblocked, suspended / unsuspended or terminated
Parameters	GetCustomerStatusHistoryRequest
Return Value	GetCustomerStatusHistoryResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerStatusHistoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.

GetCustomerStatusHistoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
status_history_changes	Yes	Array of StatusHistoryInfo structure	Yes	The list of customer status changes.

get_vd_counter_history_list
The method enables an API user to retrieve a list of the counter updates
Parameters	GetCustomerVdCounterHistoryListRequest
Return Value	GetCustomerVdCounterHistoryListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerVdCounterHistoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Include the total number of records.
i_cvd_counter	Yes	unsignedLong	No	The ID of the Counter record from Customer_VD_Counters table.
i_xdr	No	unsignedLong	No	The ID of the XDR record from CDR_Accounts table (CDR_Customers if applied to Reseller).
limit	No	int	No	The number of records to retrieve.
offset	No	int	No	The number of records to skip at the beginning.	Default value: 0

GetCustomerVdCounterHistoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved records.
vd_counter_history_list	No	Array of CustomerVdCounterHistoryInfo structure	No	The list of the counter updates.

get_vd_notification_list
The method enables an API user to retrieve the list of volume discount notifications for the customer
Parameters	GetCustomerVdNotificationListRequest
Return Value	GetCustomerVdNotificationListResponse
Realm	administrator
Standalone mode support	Yes

GetCustomerVdNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Include the total number of records.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group to apply the top-up to.
i_service	No	unsignedLong	No	The unique ID of the service record.
limit	No	int	No	The number of records to retrieve.
offset	No	int	No	The number of records to skip at the beginning.	Default value: 0
peak_level	No	int	No	Possible values: 0 – The peak period; 1 – The off-peak period; 2 – The 2nd off-peak period.	Possible values: 0, 1, 2

GetCustomerVdNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved records.
vd_notification_list	No	Array of CustomerVdNotificationInfo structure	No	The list of the notifications.

get_xdr_quality_info
The method enables an API user to fetch the information about XDR metric data
Parameters	GetRetailCustomerXDRQualityInfoRequest
Return Value	GetRetailCustomerXDRQualityInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRetailCustomerXDRQualityInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	unsignedLong	No	ID of the XDR record.

GetRetailCustomerXDRQualityInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
quality_info	No	XDRQualityMetricInfo structure	Yes	The information about XDR quality metrics.

mark_xdr_out_of_turn
This method allows an administrator to include a transaction on an out-of-turn invoice to be issued on demand
Parameters	MarkXdrOutOfTurnRequest
Return Value	MarkXdrOutOfTurnResponse
Realm	administrator, reseller
Standalone mode support	No

Measured service management

get_customer_billing_periods_history
This method allows an API user to get the history of a customer's billing periods. Used for information about previous measured service charges
Parameters	GetCustomerBillingPeriodsHistoryRequest
Return Value	GetCustomerBillingPeriodsHistoryResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerBillingPeriodsHistoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm.
include_current	No	int	No	Specifies whether to include the current open billing period or not. Possible values: 1 – Include the current open billing period, 0 – Do not include the current open billing period.
only_periods	No	int	No	Specifies whether to show only the period_from and period_to dates of the billing period or include additional information as well (all information about the history record). Possible values: 1 – Show only the period_from and period_to dates, 0 – Include additional information as well.

GetCustomerBillingPeriodsHistoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
billing_periods	No	Array of BillingPeriodHistoryInfo structure	No	A list of the customer's billing periods history records.

get_metrics_data
This method allows an API user to get the collected data (for instance, the number of concurrent calls for a period of time) of the customer's metrics. Used for charts
Parameters	GetMetricsDataRequest
Return Value	GetMetricsDataResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetMetricsDataRequest
Property	Mandatory	Type	Nillable	Description	Possible values
agg	Yes	string	No	The name of the data aggregation method. Possible values: MIN - Minimal value of the service consumption; MAX - Maximal value of the service consumption is used; AVG - Average value of the service consumption is used.	Possible values: AVG, MAX, MIN
date_from	No	dateTime	No	The start of the date and time interval for the metric data to be fetched.	Default value: date and time 4 months ago
date_to	No	dateTime	No	The end of the date and time interval for the metric data to be fetched.	Default value: current date and time
i_customer	Yes	unsignedLong	No	The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_metric	Yes	unsignedLong	No	The unique ID of the measured service.

GetMetricsDataResponse
Property	Mandatory	Type	Nillable	Description	Possible values
metrics_data	No	Array of MetricDataInfo structure	No	A list of customer's measurement records.

Payments, taxation and invoice management

delete_payment_method
This method allows an API user to delete the payment information
Parameters	DeleteCustomerPaymentMethodRequest
Return Value	DeleteCustomerPaymentMethodResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

DeleteCustomerPaymentMethodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer. Not mandatory when sent from the retail customer interface.

DeleteCustomerPaymentMethodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

estimate_taxes
This method allows an API user to show tax rates or calculate the tax for a list of xDRs
Parameters	CustomerEstimateTaxesRequest
Return Value	CustomerEstimateTaxesResponse
Realm	administrator, reseller, retail customer, distributor
Standalone mode support	Yes

CustomerEstimateTaxesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
additional_taxes_mode	No	string	No	Specifies the mode for additional taxes. Possible values: 'all' or undefined - calculate all additional taxes for the invoice, 'invoice_only' - calculate only the invoice tax.	Default value: all Possible values: all, invoice_only
calc_additional_taxes	No	int	No	0 or undef -- do not calculate additional taxes; 1 -- calculate additional taxes; .	Default value: 0
calc_taxes	No	int	No	Specifies whether to calculate the tax or just show tax rates. Possible values: 0 or undefined – return tax rates; 1 – calculate the tax for the provided xDRs.	Default value: 0
i_customer	Yes	unsignedLong	No	The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm.
issue_date	No	dateTime	No	The date when transactions took place (xDRs were created). It is used only for the EZtax (formerly known as the BillSoft EZtax) plugin.	Default value: current date and time
save_estimates	No	string	No	Save estimated results; possible values: none - don't save, remote_plugin - save results on tax plugin side.	Possible values: none, remote_plugin
use_xdrs_from_db_up_to_date	No	dateTime	No	Get transactions (xDRs) from the database instead of xdr_list. The transactions for the period starting from the previous bill_to time to the specified time will be taken. Possible values: A specific date and time in the 'YYYY-MM-DD HH24:MI:SS' format; 'now'.
xdr_list	No	Array of EstimateTaxesXDRInfo structure	No	The list of transactions (XDRs) Note that the xDRs' charged_amount field is mandatory .

CustomerEstimateTaxesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
taxes_list	No	Array of EstimatedTax structure	No	The list of tax rates or taxes calculated for the provided xDRs.
warnings	No	ArrayOfString	No	Returns procedure warnings if any.

get_customer_invoices
This method allows a customer to get the list of customer's invoices
Parameters	GetCustomerInvoicesRequest
Return Value	GetCustomerInvoicesResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerInvoicesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	No	date	Yes	Get invoices dated starting from this date.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
invoice_number	No	string	No	Invoice Number – unique identifier of the invoice (a customer can see only his own invoices).
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	Yes	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
only_last_unpaid_invoice	No	int	Yes	Show only last unpaid invoice.
only_pay_required	No	int	Yes	Show invoices that require payment.
show_void	No	int	Yes	Show void invoices.
to_date	No	date	Yes	Get invoices dated before this date.

GetCustomerInvoicesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
invoices	No	Array of CustomerInvoicesListInfo structure	No	The list of customer's invoices.
invoices_summary	No	CustomerInvoicesSummary structure	Yes	Information about the invoices summary.
total	No	int	No	Number of invoices.

get_payment_method_info
This method allows an API user to retrieve information about the payment method (e.g. payment card info) assigned to a customer
Parameters	GetCustomerPaymentMethodInfoRequest
Return Value	GetCustomerPaymentMethodInfoResponse
Realm	administrator, reseller, retail customer, representative
Standalone mode support	Yes

GetCustomerPaymentMethodInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
empty_if_not_configured	No	int	No	Set this flag to receive undef value if payment method not configured. When it's not provided error returns.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.

GetCustomerPaymentMethodInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_method_info	No	PaymentMethodInfo structure	No	PaymentMethodInfo object.

get_payment_transaction_list
This method allows an API user to get a list of customer's payment transactions
Parameters	GetCustomerPaymentTransactionListRequest
Return Value	GetCustomerPaymentTransactionListResponse
Realm	administrator, reseller, retail customer, cc staff, distributor
Standalone mode support	Yes

GetCustomerPaymentTransactionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	No	dateTime	No	Get records starting from this date.
get_total	No	int	No	Get the total number of the retrieved transactions.
hide_restricted	No	int	No	Specifies whether it is necessary to remove the payment transactions of the terminated entities from the response.
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_customer_type	No	unsignedLong	No	The unique identifier of a customer. Possible values: 1 (retail customer or subcustomer), 2 (reseller), 3 (distributor).	Possible values: 1, 3, 2
i_merchant_account	No	unsignedLong	No	The unique Payment System ID for the transaction.
i_payment_method	No	unsignedLong	No	Unique ID of the payment method.
i_payment_transaction	No	unsignedLong	No	The unique ID of a payment transaction.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
search	No	string	No	A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields.
status	No	string	No	Status of the transaction.	Possible values: VOIDED, CANCELLED, COMPLETED, FAILED, AUTHORIZED, STARTED
test_mode	No	string	No	Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N.	Possible values: Y, N
to_date	No	dateTime	No	Get records before this date.

GetCustomerPaymentTransactionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_transactions	No	Array of CustomerTransactionInfo structure	Yes	The set of payment transactions.
total	No	int	No	The total number of the retrieved records.

get_taxation_info
This method allows an API user to retrieve information about the plug-in module which is used to make tax calculations and its parameters
Parameters	GetCustomerTaxationInfoRequest
Return Value	GetCustomerTaxationInfoResponse
Realm	administrator, reseller, representative
Standalone mode support	Yes

GetCustomerTaxationInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
effective_values	No	int	No	Get taxation info, including the values that were inherited from the customer class.
i_billing_processor	Yes	unsignedLong	No	Taxation processor to get the info for, instead of the one assigned to the customer.
i_customer	Yes	unsignedLong	No	ID of customer record.

GetCustomerTaxationInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
estimate_taxes	No	string	No	Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled.
i_tax_transaction_code	No	unsignedLong	Yes	The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table.
taxation_info	Yes	TaxationInfo structure	No	TaxationInfo object.

update_payment_method
This method allows an API user to assign a preferred payment method to a customer. For online payment methods, all the information required by the payment processor should be provided, and an appropriate payment processor must be set up and properly configured beforehand. Note that "number", "name", "address", and / or "zip" fields are not mandatory in the PaymentMethodInfo structure as long as credit card was already set
Parameters	UpdateCustomerPaymentMethodRequest
Return Value	UpdateCustomerPaymentMethodResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

UpdateCustomerPaymentMethodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.
payment_method_info	Yes	PaymentMethodInfo structure	No	Information about payment method; see below.

UpdateCustomerPaymentMethodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_credit_card	Yes	unsignedLong	Yes	ID of modified payment method record.

update_taxation
This method allows an API user to set which plugin module will be used to make tax calculations and set up parameters that affect taxation
Parameters	UpdateCustomerTaxationRequest
Return Value	UpdateCustomerTaxationResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerTaxationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
estimate_taxes	No	string	No	Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled.	Possible values: Y, N
i_customer	Yes	unsignedLong	No	ID of customer record.
i_tax_transaction_code	No	unsignedLong	Yes	The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table.
taxation_info	Yes	TaxationInfo structure	No	TaxationInfo object.

UpdateCustomerTaxationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

Service features management

get_service_features
This method allows an API user to access service features data
Parameters	GetCustomerServiceFeaturesRequest
Return Value	GetCustomerServiceFeaturesResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerServiceFeaturesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of a customer record.

GetCustomerServiceFeaturesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_features	No	Array of ServiceFeatureInfo structure	Yes	The list of service features.

update_service_features
This method allows an API user to update settings for customer service features
Parameters	UpdateCustomerServiceFeaturesRequest
Return Value	UpdateCustomerServiceFeaturesResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

UpdateCustomerServiceFeaturesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Flag which shows whether an array of Service Features should be returned in response or not.
i_customer	No	unsignedLong	No	The unique ID a of customer record.
service_features	No	Array of ServiceFeatureInfo structure	Yes	The list of service features.

UpdateCustomerServiceFeaturesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer record.
service_features	No	Array of ServiceFeatureInfo structure	No	The list of service features.

Site management

add_customer_site
This method allows an API user to create a cutomer site
Parameters	AddCustomerSiteRequest
Return Value	AddCustomerSiteResponse
Realm	administrator, reseller
Standalone mode support	No

AddCustomerSiteRequest
Property	Mandatory	Type	Nillable	Description	Possible values
site_info	Yes	CustomerSiteInfo structure	No	Information about a customer site.

AddCustomerSiteResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_site	No	unsignedLong	No	The unique ID of a customer site.

delete_customer_site
This method allows an API user to delete a cutomer site
Parameters	DeleteCustomerSiteRequest
Return Value	DeleteCustomerSiteResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerSiteRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_site	Yes	unsignedLong	No	The unique ID of a customer site.

DeleteCustomerSiteResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if success, otherwise SOAP fault.

get_network_connectivity_list
This method allows an API user to get the list of network connectivity profiles defined in PortaBilling
Parameters	GetNetworkConnectivityListRequest
Return Value	GetNetworkConnectivityListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetNetworkConnectivityListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetNetworkConnectivityListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
connectivities	No	Array of NetworkConnectivityInfo structure	Yes	The list of customer sites.

get_site_info
This method allows an API user to get information about a customer site and its service features
Parameters	GetSiteInfoRequest
Return Value	GetSiteInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetSiteInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_site	Yes	unsignedLong	No	The unique ID of a customer site.

GetSiteInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
site	No	CustomerSiteInfo structure	No	Information about a customer site.

get_sites
This method allows an API user to retrieve the list of customer sites (a group of customer's accounts managed as a single entity)
Parameters	GetCustomerSitesRequest
Return Value	GetCustomerSitesResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerSitesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_service_features	No	int	No	Specifies whether the information about service features should be included into the response.
i_customer	No	unsignedLong	No	The unique ID of a customer record.

GetCustomerSitesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
sites	Yes	Array of CustomerSiteInfo structure	Yes	The list of customer sites.

update_customer_site
This method allows an API user to update a cutomer site or its service features
Parameters	UpdateCustomerSiteRequest
Return Value	UpdateCustomerSiteResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerSiteRequest
Property	Mandatory	Type	Nillable	Description	Possible values
site_info	Yes	CustomerSiteInfo structure	No	Information about a customer site.

UpdateCustomerSiteResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_site	No	unsignedLong	No	The unique ID of a customer site.

Spending counter management

get_spending_counter_info
This method allows an API user to retrieve information about the traffic profile spending counter
Parameters	GetSpendingCounterRequest
Return Value	GetSpendingCounterResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetSpendingCounterRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.

GetSpendingCounterResponse
Property	Mandatory	Type	Nillable	Description	Possible values
spending_counter_info	No	SpendingCounterInfo structure	No	The information about the traffic profile spending counter.

get_spending_counter_list
This method enables an API user to retrieve the list of the traffic profile spending counter records
Parameters	GetSpendingCounterListRequest
Return Value	GetSpendingCounterListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetSpendingCounterListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved records.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
period_from_end	No	dateTime	No	The end date and time when the spending counter is activated.
period_from_start	No	dateTime	No	The start date and time when the spending counter is activated.
period_to_end	No	dateTime	No	The end date and time when the spending counter expires.
period_to_start	No	dateTime	No	The start date and time when the spending counter expires.

GetSpendingCounterListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
spending_counter_list	No	Array of SpendingCounterInfo structure	No	The list of spending counter records.
total	No	int	No	The total number of the retrieved records.

modify_spending_limit
This method allows an API user to modify a spending limit.
Parameters	ModifySpendingLimitRequest
Return Value	ModifySpendingLimitResponse
Realm	administrator, reseller
Standalone mode support	No

ModifySpendingLimitRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.
new_spending_limit	No	float	No	The total amount of money that a customer can spend in the period on services.	Min value: 0 Precision: 15, Scale: 5
reset_spent_amount	No	int	No	Specifies whether to reset the current spending limit. Possible values: 1 - Reset the current spending limit; 0 - Do not reset the current spending limit.	Max value: 1 Min value: 0

ModifySpendingLimitResponse
Property	Mandatory	Type	Nillable	Description	Possible values
constraint_amount	No	float	No	The initial amount of money that the customer can spend on services in the period.
extra_amount	No	float	No	The additional credit for the period - temporarily amount that increases the customer's spending limit.
i_c_spend_counter	No	unsignedLong	No	The unique ID of the customer's spending counter.
spent_amount	No	float	No	The amount actually spent.

Subscription management

activate_subscriptions
This method allows an API user to instantly activate a customer’s pending subscriptions, where the start date is equal to today’s date (in the customer’s time zone). An activation fee will be charged for each subscription, if applicable
Parameters	ActivateCustomerSubscriptionsRequest
Return Value	ActivateCustomerSubscriptionsResponse
Realm	administrator, reseller
Standalone mode support	No

ActivateCustomerSubscriptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	ID of customer record.

ActivateCustomerSubscriptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

add_subscription
This method allows an API user to create a new subscription and assign it to a customer. If successful, a new subscription ID is returned
Parameters	AddCustomerSubscriptionRequest
Return Value	AddUpdateCustomerSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

AddCustomerSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	ID of customer record.
subscription_info	Yes	CustomerSubscriptionInfo structure	No	Note: i_customer_subscription will be ignored; i_subscription is a mandatory field, and must be unique among all of the customer’s pending and active subscriptions.

AddUpdateCustomerSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_subscription	Yes	unsignedLong	No	ID of created/modified customer subscription record.

charge_subscription_fees
This method enables an administrator to immediately charge all of a customer’s active subscriptions (e.g. if you have just applied a subscription to a customer with a daily billing period). Otherwise, it will be done automatically within the hour
Parameters	ChargeCustomerSubscriptionFeesRequest
Return Value	ChargeCustomerSubscriptionFeesResponse
Realm	administrator, reseller
Standalone mode support	No

ChargeCustomerSubscriptionFeesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record to be charged.
immediately_in_advance	No	int	No	Amount of periods that should be charged in advance.	Max value: 50 Min value: 1

ChargeCustomerSubscriptionFeesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

close_subscription
This method allows an API user to close an existing active subscription assigned to a customer. It requires an ID number returned, for example, by the add_subscription method
Parameters	CloseDeleteCustomerSubscriptionRequest
Return Value	CloseCustomerSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

CloseDeleteCustomerSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_subscription	Yes	unsignedLong	No	The unique ID of the customer subscription record to be closed/deleted.

CloseCustomerSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_subscription	Yes	unsignedLong	No	1 in case of success, 0 in case of failure.

delete_subscription
This method allows an API user to delete a pending subscription assigned to a customer. It requires an ID number returned, for example, by the add_subscription method
Parameters	CloseDeleteCustomerSubscriptionRequest
Return Value	DeleteCustomerSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_subscriptions
This method allows an API user to get the list of subscription records associated with a customer
Parameters	GetCustomerSubscriptionsRequest
Return Value	GetCustomerSubscriptionsResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerSubscriptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	ID of customer record.

GetCustomerSubscriptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subscriptions	No	Array of CustomerSubscriptionInfo structure	No	Set of customer subscription data records.

update_subscription
This method allows an API user to update an existing subscription record assigned to a customer. It requires an ID number returned, for example, by the add_subscription method
Parameters	UpdateCustomerSubscriptionRequest
Return Value	AddUpdateCustomerSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateCustomerSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	ID of customer record.
i_customer_subscription	Yes	unsignedLong	No	ID of customer subscription record to be updated.
subscription_info	Yes	CustomerSubscriptionInfo structure	No	Note: i_customer_subscription and i_subscription will be ignored.

Support request management

add_zendesk_organization
This method enables an API user to add an organization in the Zendesk platform
Parameters	AddZendeskOrganizationRequest
Return Value	AddUpdateZendeskOrganizationResponse
Realm	administrator
Standalone mode support	No

AddZendeskOrganizationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_domain	No	string	No	Override the domain for this Organization with the value specified here. If empty, the domain will be automatically calculated by the system based on the customer's email address.
i_customer	Yes	unsignedLong	No	Create or update the Zendesk organization for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side.

AddUpdateZendeskOrganizationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side.

get_zendesk_organization_info
This method allows an API user to get information about an organization from the Zendesk platform
Parameters	GetZendeskOrganizationInfoRequest
Return Value	GetZendeskOrganizationInfoResponse
Realm	administrator
Standalone mode support	Yes

GetZendeskOrganizationInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side.

GetZendeskOrganizationInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
zendesk_organization_info	No	ZendeskOrganizationInfo structure	No	A Zendesk organization record.

get_zendesk_organization_list
This method enables an API user to obtain organizations from the Zendesk platform
Parameters	GetZendeskOrganizationListRequest
Return Value	GetZendeskOrganizationListResponse
Realm	administrator
Standalone mode support	Yes

GetZendeskOrganizationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved Zendesk organizations.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The name pattern of a Zendesk organization.
offset	No	int	No	The number of rows to skip at the beginning of the list. The value must be a multiple of get_total, it will be recounted. For example, if get_total is equal 50 and: - the value is < 50, it will be canged to '0'; - the value is in the range of [50-99], it will be canged to '50' etc.	Default value: 0

GetZendeskOrganizationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of retrieved Zendesk organizations.
zendesk_organization_list	No	Array of ZendeskOrganizationInfo structure	No	Set of Zendesk organization records.

get_zendesk_ticket_list
This method enables an API user to obtain tickets for a customer from the Zendesk platform
Parameters	GetZendeskTicketListRequest
Return Value	GetZendeskTicketListResponse
Realm	administrator
Standalone mode support	Yes

GetZendeskTicketListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
created_at_end	No	dateTime	No	The end date and time when the Zendesk ticket was created.
created_at_start	No	dateTime	No	The start date and time when the Zendesk ticket was created.
get_total	No	int	No	Get the total number of retrieved Zendesk tickets.
i_customer	Yes	unsignedLong	No	The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The value must be a multiple of get_total, it will be recounted. For example, if get_total is equal 50 and: - the value is < 50, it will be canged to '0'; - the value is in the range of [50-99], it will be canged to '50' etc.	Default value: 0
priority	No	string	No	The priority of the Zendesk ticket.	Possible values: urgent, high, normal, low
status	No	string	No	The status of the Zendesk ticket.	Possible values: new, open, pending, hold, solved, closed
subject	No	string	No	The subject of the Zendesk ticket.
type	No	string	No	The type of the Zendesk ticket.	Possible values: problem, incident, question, task
updated_at_end	No	dateTime	No	The end date and time when the Zendesk ticket last got updated.
updated_at_start	No	dateTime	No	The start date and time when the Zendesk ticket last got updated.
zendesk_ticket_id	No	unsignedLong	No	The unique ID number of the Zendesk ticket.

GetZendeskTicketListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of retrieved Zendesk tickets.
zendesk_ticket_list	No	Array of ZendeskTicketInfo structure	No	A set of Zendesk ticket records.

update_zendesk_organization
This method enables an API user to update an organization in the Zendesk platform
Parameters	UpdateZendeskOrganizationRequest
Return Value	AddUpdateZendeskOrganizationResponse
Realm	administrator
Standalone mode support	No

UpdateZendeskOrganizationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_domain	No	string	No	Override the domain for this Organization with the value specified here. If empty, the domain will be automatically calculated by the system based on the customer's email address.
i_customer	Yes	unsignedLong	No	Create or update the Zendesk organization for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side.
zendesk_organization_id	No	unsignedLong	No	The Zendesk organization ID number. If you want to bind the Zendesk organization with the Customer, it is needed to pass the organization identifier in this field.

Transaction management

get_transactions_total_info
This method allows a customer to get the list of customer's transactions
Parameters	GetCustomerTransactionsTotalInfoRequest
Return Value	GetCustomerTransactionsTotalInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerTransactionsTotalInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
billing_model	Yes	int	Yes	Specifies the account type for which to show transactions; one of the following: -1 – Debit account; 1 – Credit account.	Possible values: -1, 1
cld	No	string	No	The called party phone number.
cli	No	string	No	The calling party phone number.
from_date	Yes	dateTime	No	Get information recorded starting from this date.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_service	No	unsignedLong	Yes	The unique ID of a service for which to show transactions; refers to the Services table.
show_unsuccessful	No	int	No	Show the records of unsuccessful attempts. The field applies only to the admin realm.
to_date	Yes	dateTime	No	Get information recorded before this date.

GetCustomerTransactionsTotalInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
count	No	int	No	The total number of transactions.
iso_4217	No	string	No	Transactions currency.
per_service_info	No	Array of CustomerPerServiceInfo structure	Yes	The list of objects containing information on per-service basis.
sessions_count	No	int	No	The total number of sessions.
total_amount	No	float	No	Total transactions amount.
total_info	No	Array of TotalTransInfo structure	No	The list of per-service total values.

make_transaction
This method allows an API user to adjust a customer’s balance or issue a payment transaction, including e-commerce transactions.
Parameters	MakeCustomerTransactionRequest
Return Value	MakeCustomerTransactionResponse
Realm	administrator, reseller, retail customer, cc staff, distributor, representative
Standalone mode support	No

MakeCustomerTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	The same as those available on the Balance Adjustments tab of the Customer edit interface, including e-commerce transactions.	Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, Refund, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment, Void, Transfer Funds, TransferTo
amount	Yes	float	No	Amount by which the customer's balance will increase / decrease. The number of digits depends on the maximum number of decimal places allowed by the currency.	Min value: 0 Precision: 15, Scale: 5
card_info	No	PaymentMethodInfo structure	No	Payment Method information for this transaction.
date_inside_billing_period	No	date	No	A date associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited.
datetime_inside_billing_period	No	dateTime	No	A date and time associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited.
delay_invoice_payment	No	int	No	The flag shows whether to apply payment to the unpaid invoices. When you create an out-of-turn invoice and choose to pay it immediately, then the PortaBilling first proceeds the payment and only after that generates the invoice. Generally, PortaBilling applies the payment received to the oldest unpaid invoice, thus in case you want to use the payment to cover the freshly generated out-of-turn invoice, you must explicitly indicate it. This option specifies whether the payment must be immediately applied to the existing unpaid invoices or the system must wait and apply the payment to the first Out-of-Turn invoice generated after the payment. Possible values: 1 - Apply the payment to the out-of-turn invoice generated after the payment; 0 - Apply the payment to the existing unpaid invoices.
enable_balance_fraud_protection	No	int	No	Indicates whether to perform balance fraud checks to make sure the charged amount never exceeds the available balance.
h323_conf_id	No	string	No	Optional tax transaction code that should be applied to transaction.	Max value: 36
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_payment_transaction	No	unsignedLong	No	This option identifies a previously issued Authorization only / E-commerce payment transaction. It is used for Capture payment and E-Commerce refund transactions.
i_service	No	unsignedLong	No	The unique ID of the service record; refers to the Services table.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly.	Max value: 200
return_url	No	string	No	The URL to redirect users back to after they authenticate or cancel their payment on the payment method’s app or site.
save_card	No	string	No	Indicates whether the supplied payment method should be saved as preferred.	Default value: N Possible values: Y, N
suppress_notification	No	int	No	One of the following: 1 - do not send email notifications to the customer, 0 - send the notifications.
transaction_id	No	string	No	Applicable to Capture payment and E-Commerce refund transactions. Must contain ID of a previously issued Authorization only / E-commerce payment transaction.	Max value: 48
visible_comment	No	string	No	A comment on this transaction visible to the customer in the xDR browser.

MakeCustomerTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authorization	No	string	No	E-Commerce authorization code.
balance	Yes	float	No	Customer's modified balance.
i_payment_transaction	No	unsignedLong	No	The unique ID of the transaction.
i_xdr	No	unsignedLong	No	The unique ID of the xdr record.
redirect_url	No	string	No	The URL to redirect a user to in order to authenticate the transaction (3D Secure).
result_code	No	string	No	E-Commerce operation result code.
transaction_id	No	string	No	E-Commerce transaction ID.

register_transaction
This method enables an API user to register a transaction initiated for a retail customer
Parameters	CustomerRegisterTransactionRequest
Return Value	CustomerRegisterTransactionResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

CustomerRegisterTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	The amount for payment.
i_customer	No	unsignedLong	No	Unique ID of the Customer for which the transaction will be registered.
i_payment_method	Yes	unsignedLong	No	Unique ID of the chosen Payment Method.

CustomerRegisterTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
transaction	No	TransactionInfo structure	No	The information about the transaction .

Voice prompt management

get_prompt_file

This method allows an API user to get information about a voice prompt and the prompt file itself in a MIME attachment to the API response (if available). This method can be used for both extensions and huntgroups

Parameters

GetPromptFileRequest

Return Value

GetPromptFileResponse

Realm

administrator, reseller, retail customer

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetPromptFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
codec	Yes	string	No	Name of codec, by which file in response was encoded.	Possible values: a_law, u_law, g729
description_only	No	int	No	Non-zero value means that the method should not attach a prompt file.
handler	No	string	No	Name of the handler to be used for fetching the prompt. Possible values: 'dial_by_name', 'audio_file'.	Default value: dial_by_name Possible values: dial_by_name, audio_file
i_prompt	Yes	unsignedLong	No	ID of requested Prompt.

GetPromptFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
prompt_error	No	string	No	Error message, if any.
prompt_status	No	string	No	Status of prompt conversion.
success	Yes	int	No	1 for success, 0 for failure.

Volume discount management

get_full_vd_counter_info
This method allows an API user to get full information about volume discount counters (e.g. used discount amount, remaining discount amount, current and next discount values) for the specified customer
Parameters	GetCustomerFullVDCounterListInfoRequest
Return Value	GetFullVDCounterListInfoResponse
Realm	administrator, reseller, retail customer, cc staff, representative, distributor
Standalone mode support	Yes

GetCustomerFullVDCounterListInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
separate_units	No	int	No	Specifies whether to provide threshold values and discount amount units (e.g., minutes) in a separate field.
with_discount_info	No	int	No	Specifies whether to provide discount information of a counter.
with_service_pool_info	No	int	No	Specifies whether to provide service pool information of counter.

get_vd_counter_info
This method enables an API user to retrieve the information about a customer-level counter
Parameters	GetCustomerVdCounterInfoRequest
Return Value	GetCustomerVdCounterInfoResponse
Realm	administrator
Standalone mode support	Yes

GetCustomerVdCounterInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_cvd_counter	Yes	unsignedLong	No	The unique ID of the record.

GetCustomerVdCounterInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vd_counter_info	No	CounterInfo structure	No	The information about the customer-level counter.

get_vd_counter_list
This method allows an API user to get the information about volume discount counters for the specified customer
Parameters	GetCustomerVDCounterListRequest
Return Value	GetCustomerVDCounterListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerVDCounterListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_info	No	int	Yes	Detailed information.
dg_name	No	string	No	Destination group name pattern.
i_customer	Yes	unsignedLong	No	The unique ID of the customer record.
peak_level	No	int	No	ID of the Peak Level: 0 (Peak Period), 1 (Off-Peak Period), 2 (2nd Off-Peak Period).	Possible values: 0, 1, 2
service_name	No	string	No	Service name pattern.

GetCustomerVDCounterListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
counter_list	No	Array of CounterInfo structure	Yes	Array of counter objects.

vd_topup
This method allows an administrator to top-up the volume of a service (e.g. free minutes or gigabytes) provided to a customer with the discount
Parameters	CustomerVDTopupRequest
Return Value	VDTopupResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

CustomerVDTopupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
h323_conf_id	No	string	No	Custom data for third-party application processing.	Max value: 255
i_customer	Yes	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group to apply the top-up to.	Min value: 0
i_service	Yes	unsignedLong	No	The unique ID of a service; refers to the Services table.	Min value: 1
payment_info	No	PaymentInfo structure	No	The payment information.
peak_level	Yes	int	No	Possible values: 0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period.	Possible values: 0, 1, 2
topup_amount	Yes	float	No	The top-up amount.
topup_expires	No	dateTime	No	A date and time in UTC when the topped up volume discount becomes expired (YYYY-MM-DD HH24:MI:SS).	Min value: current date and time

Destination information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Destination

Destination group management

add_dest_group
This method allows an API user to add a destination group
Parameters	AddDestGroupRequest
Return Value	AddDestGroupResponse
Realm	administrator
Standalone mode support	No

AddDestGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
add_destinations	No	Array of unsignedLong structure	No	The list of destinations to be added to the destination group.
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set.
name	Yes	string	No	The destination group name.	Max value: 100 Min value: 1

AddDestGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group.

delete_dest_group
This method allows an API user to delete a destination group
Parameters	DeleteDestGroupRequest
Return Value	DeleteDestGroupResponse
Realm	administrator
Standalone mode support	No

DeleteDestGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group.

DeleteDestGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_dest_group_info
This method allows an API user to get information about a destination group
Parameters	GetDestGroupInfoRequest
Return Value	GetDestGroupInfoResponse
Realm	administrator
Standalone mode support	Yes

GetDestGroupInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
country	No	string	No	The country to search destinations.	Max value: 64
description	No	string	No	Destination description to search destinations.	Max value: 64
get_total	No	int	No	Get the total number of the retrieved destinations.
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group record.
iso_3166_1_a2	No	string	No	Search by ISO 3166 two-letter country code.	Max value: 2 Min value: 2
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
prefix	No	string	No	The prefix by which to search destinations. Note that the search parameters prefix, country and description are exclusive with the following priority: prefix->country->description. E.g., if you provide both prefix and country properties, then search will be done only by the prefix.	Max value: 16
without_destination_list	No	int	No	Show Destination Group info only.

GetDestGroupInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	Destination Group description.
destination_list	No	Array of DestinationPrefixInfo structure	No	Set of destination data records.
i_dest_group	No	unsignedLong	No	Destination Group ID.
i_dest_group_set	No	unsignedLong	No	Destination Group Set ID.
name	No	string	No	The destination group name.
total	No	int	No	The total number of the retrieved destinations.

get_dest_group_list
This method allows an API user to get a list of destination groups
Parameters	GetDestGroupListRequest
Return Value	GetDestGroupListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDestGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
complete_match	No	string	No	This flag specifies whether the complete DG set should be considered.	Default value: N Possible values: Y, N, ALL
description	No	string	No	Destination pattern to search destination groups.	Max value: 100
exclude_default	No	string	No	Indicates whether a default group will be returned for the complete DG set. The default value is 1.	Default value: 1
get_total	No	int	No	Get total number of the retrieved destination groups.
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Search pattern in the names of destination groups.	Max value: 100
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
prefix	No	string	No	Prefix by which to search destination groups. Note that if you provide both name and prefix properties, then search will be done only by name.	Max value: 16

GetDestGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dest_group_list	No	Array of DestinationGroupInfo structure	No	Set of destination group data records.
total	No	int	No	The total number of the retrieved destination groups.

match_destination_groups
This method allows an administrator to locate a destination group by tariff and phone number
Parameters	MatchDestinationGroupsRequest
Return Value	MatchDestinationGroupsResponse
Realm	administrator
Standalone mode support	Yes

MatchDestinationGroupsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_prefixes_list	Yes	int	No	This indicates whether the list of destinations included in this group will be retrieved: 0 – retrieve, 1 – do not retrieve.
i_tariff	Yes	unsignedLong	No	The unique ID of the special tariff containing destination groups.
number	Yes	string	No	A caller number for searching the appropriate destination group in the tariff. Expected input: a string of the Latin 1 (ISO/IEC 8859-1) charset.	Max value: 32 Min value: 1

MatchDestinationGroupsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dest_group_list	No	Array of DestinationGroupInfo structure	No	Set of destination group data records.

update_dest_group
This method allows an API user to update an existing destination group
Parameters	UpdateDestGroupRequest
Return Value	UpdateDestGroupResponse
Realm	administrator
Standalone mode support	No

UpdateDestGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
add_destinations	No	Array of unsignedLong structure	No	List of destinations to be added to the destination group.
delete_destinations	No	Array of unsignedLong structure	No	The list of destinations to be removed from the destination group.
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group.
name	No	string	No	The destination group name.	Max value: 100 Min value: 1

UpdateDestGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group.

Destination group set management

add_dest_group_set
This method allows an API user to add a destination group set
Parameters	AddUpdateDestGroupSetRequest
Return Value	AddUpdateDestGroupSetResponse
Realm	administrator
Standalone mode support	No

AddUpdateDestGroupSetRequest
Property	Mandatory	Type	Nillable	Description	Possible values
dest_group_set_info	Yes	DestGroupSetInfo structure	No	Complete information about the destination group set.

AddUpdateDestGroupSetResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set.

delete_dest_group_set
This method allows an API user to delete a destination group set
Parameters	DeleteDestGroupSetRequest
Return Value	DeleteDestGroupSetResponse
Realm	administrator
Standalone mode support	No

DeleteDestGroupSetRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set.

DeleteDestGroupSetResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

download_dest_group_set

This method allows an API user to download a destination group set

Parameters

DownloadDGSetRequest

Return Value

DownloadDGSetResponse

Realm

administrator, reseller

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv, xlsx, xls
Mandatory	No

DownloadDGSetRequest
Property	Mandatory	Type	Nillable	Description	Possible values
file_format	No	string	No	This parameter enables the user to get a destination group set in other formats via an attachment.	Default value: csv Possible values: csv, xlsx, xls
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set.

DownloadDGSetResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 in case of success, 0 in case of failure.

get_dest_group_set_info
This method enables an API user to get the complete information about the destination group set
Parameters	GetDestGroupSetInfoRequest
Return Value	GetDestGroupSetInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDestGroupSetInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_set_emptiness	No	int	No	If set to '1', the 'is_set_empty' field will be present in the method response.
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set.

GetDestGroupSetInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dest_group_set_info	No	DestGroupSetInfo structure	No	The complete information about the destination group set.

get_dest_group_set_list
This method allows an API user to get a list of destination group sets
Parameters	GetDestGroupSetListRequest
Return Value	GetDestGroupSetListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDestGroupSetListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_set_emptiness	No	int	No	If set to '1', the 'is_set_empty' field will be present in the method response.
complete_match	No	string	No	Filter the list by the "complete match" property.	Default value: N Possible values: Y, N, ALL
get_total	No	int	No	Get total number of found destination group sets.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	Search pattern in the names of destination group sets.
offset	No	int	No	The number of rows to skip at the beginning of the list.

GetDestGroupSetListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dest_group_set_list	No	Array of DestGroupSetInfo structure	No	Set of destination group set data records.
total	No	int	No	The total number of the retrieved destination group sets.

update_dest_group_set
This method allows an API user to update a destination group set
Parameters	AddUpdateDestGroupSetRequest
Return Value	AddUpdateDestGroupSetResponse
Realm	administrator
Standalone mode support	No

upload_dest_group_set

This method allows an API user to upload a destination group set

Parameters

UploadDGSetRequest

Return Value

UploadDGSetResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	csv, xlsx, xls
Mandatory	Yes

UploadDGSetRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group_set	Yes	unsignedLong	No	The unique ID of the destination group set.

UploadDGSetResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

Destination management

add_destination
This method allows an API user to add a destination
Parameters	AddDestinationPrefixRequest
Return Value	AddDestinationPrefixResponse
Realm	administrator
Standalone mode support	No

AddDestinationPrefixRequest
Property	Mandatory	Type	Nillable	Description	Possible values
destination_info	Yes	DestinationPrefixInfo structure	No	Complete information about the destination; for more information, see below.

AddDestinationPrefixResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest	Yes	unsignedLong	No	The unique ID of a destination record.

delete_destination
This method enables an API user to delete an existing destination
Parameters	DeleteDestinationPrefixRequest
Return Value	DeleteDestinationPrefixResponse
Realm	administrator
Standalone mode support	No

DeleteDestinationPrefixRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest	Yes	unsignedLong	No	The unique ID of a destination record.

DeleteDestinationPrefixResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_default_destination_list

This method enables an API user to retrieve the list of default destination pre-set in a spreadsheet attachment

Parameters

GetDefaultDestinationPrefixListRequest

Return Value

GetDefaultDestinationPrefixListResponse

Realm

administrator

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv, xlsx, xls
Mandatory	No

GetDefaultDestinationPrefixListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
file_format	Yes	string	No	The file format of the response spreadsheet attachment.	Possible values: csv, xlsx, xls
format	Yes	string	No	The destination prefix format.	Possible values: e164, e212

GetDefaultDestinationPrefixListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

get_destination_info
This method allows an API user to get information about a destination
Parameters	GetDestinationPrefixInfoRequest
Return Value	GetDestinationPrefixInfoResponse
Realm	administrator
Standalone mode support	Yes

GetDestinationPrefixInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest	Yes	unsignedLong	No	The unique ID of a destination record.

GetDestinationPrefixInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
destination_info	No	DestinationPrefixInfo structure	No	Complete information about the destination; for more information, see below.

get_destination_list

This method allows an administrator to retrieve the list of destinations

Parameters

GetDestinationPrefixListRequest

Return Value

GetDestinationPrefixListResponse

Realm

administrator, reseller

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv, xlsx, xls
Mandatory	No

GetDestinationPrefixListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	Search by description.	Max value: 100
destination	No	string	No	Refers to the pattern of the destination prefix.	Max value: 16
destination_list	No	Array of RequestDestinationPrefixInfo structure	No	Set of destination records.
file_format	No	string	No	This parameter enables the user to get destinations in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'.	Possible values: csv, xlsx, xls
format	No	string	No	Search by number format.	Possible values: e164, e212, custom, charge_rate_code
get_total	No	int	No	Get the total number of the retrieved destination prefixes.
i_country_subdivision	No	unsignedLong	Yes	The unique ID of the state or province related to the destination.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set.
iso_3166_1_a2	No	string	No	Search by country prefix.	Max value: 2
limit	No	int	No	The number of rows to retrieve.
network	No	string	No	Mobile network name.	Max value: 200
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
order_by_destination	No	string	No	Specifies whether to sort destinations: 1 - descending order; 0 - ascending If this field is empty then destinations will be sorted by the i_dest field.
with_system	No	int	No	The flag shows whether the system's destinations should be included in the response.

GetDestinationPrefixListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
destination_list	No	Array of DestinationPrefixInfo structure	No	Set of destination data records.
total	No	int	No	The total number of the retrieved destination data records.

update_destination
This method allows an API user to update an existing destination
Parameters	UpdateDestinationPrefixRequest
Return Value	UpdateDestinationPrefixResponse
Realm	administrator
Standalone mode support	No

UpdateDestinationPrefixRequest
Property	Mandatory	Type	Nillable	Description	Possible values
destination_info	Yes	DestinationPrefixInfo structure	No	Complete information about the destination.

UpdateDestinationPrefixResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest	Yes	unsignedLong	No	The unique ID of a destination record.

upload

This method enables an API user to upload destinations

Parameters

UploadDestRequest

Return Value

UploadDestResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	csv, xlsx, xls
Mandatory	No

UploadDestRequest
Property	Mandatory	Type	Nillable	Description	Possible values
allow_update	No	int	No	Allow update while uploading if a destination already exists.	Default value: 1
default_set	No	int	No	1 for uploading the default destinations set.
number_format	No	string	No	The destination number format.	Default value: e164 Possible values: e164, e212, custom

UploadDestResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 for success, exception on failure.

Dialing rule information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/DialingRule

Dialing rule management

add_dialing_rule
This method allows an API user to add a dialing rule
Parameters	AddUpdateDialingRuleRequest
Return Value	AddUpdateDialingRuleResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

AddUpdateDialingRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
dialing_rule_info	Yes	DialingRuleInfo structure	No	The complete information about a dialing rule.

AddUpdateDialingRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dialing_rule	No	unsignedLong	No	The unique ID of the dialing rule record.

delete_dialing_rule
This method allows an API user to delete a dialing rule
Parameters	DeleteDialingRuleRequest
Return Value	DeleteDialingRuleResponse
Realm	administrator
Standalone mode support	No

DeleteDialingRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dialing_rule	Yes	unsignedLong	No	The unique ID of the dialing rule record.

DeleteDialingRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 if operation is successful, 0 if not.

get_dialing_rule_info
This method allows an API user to get the dialing rule data
Parameters	GetDialingRuleInfoRequest
Return Value	GetDialingRuleInfoResponse
Realm	administrator, reseller, retail customer, account, cc staff
Standalone mode support	Yes

GetDialingRuleInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the dialing rule is in use.
i_dialing_rule	No	unsignedLong	No	The unique ID of the dialing rule record.
i_owner	No	unsignedLong	No	The unique ID of the dialing rule owner record.
owner_type	No	string	No	The type of dialing rule owner.	Possible values: Customer, CustomerSite, Account
with_tech_prefix	No	int	No	1 – The response will include the special "tech prefix" dialing rule (for administrators only). 0 – The "tech prefix" dialing rule will not be included.

GetDialingRuleInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dialing_rule_info	No	DialingRuleInfo structure	No	The complete information about a dialing rule.

get_dialing_rules_list
This method allows an API user to get the list of dialing rules
Parameters	GetDialingRulesListRequest
Return Value	GetDialingRulesListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetDialingRulesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the dialing rule is in use.
description	No	string	No	A pattern for the dialing rule description to search by.
get_total	No	int	No	Get the total number of the retrieved dialing rules.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name_pattern	No	string	No	A pattern for the dialing rule name to search by.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
restricted	No	string	No	Specifies whether the response should include dialing rules with or without restriction.
rule_type	No	string	No	Dialing rule type.	Possible values: pbx, plan, advanced
usage_type	No	string	No	Where this rule applies: 'D'- dialing rules, 'O'- outgoing connections, 'I'- incoming connections, 'IO' - incoming and outgoing connections.	Possible values: D, I, O, IO
with_internal	No	int	No	Specifies whether predefined dialing rules should be included in the response.
with_tech_prefix	No	int	No	For administrators the response may contain a special "Tech Prefix" dialing rule.

GetDialingRulesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
dialing_rules_list	Yes	Array of DialingRuleInfo structure	No	The list of dialing rules.
total	No	int	No	The number of the retrieved dialing rules.

test_translation_rule
This method allows an API user to test a specific dialing rule (provided as a translation rule string) and a number
Parameters	TestTranslationRuleRequest
Return Value	TestTranslationRuleResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

TestTranslationRuleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
is_ivr_tr_rule	No	int	No	Defines whether a rule will be used by IVR applications.
rule	Yes	string	No	A translation rule to test, e.g. local_to_e164($_,{cc=>'1',ia=>'0', dp=>'1',ip=>'011',em=>'911',ex=>'411',cs=>'0'});'.	Max value: 255
string	Yes	string	No	A number to test on.	Max value: 255

TestTranslationRuleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
translated_string	Yes	string	Yes	A string with the result of the translation.

update_dialing_rule
This method allows an API user to update a dialing rule
Parameters	AddUpdateDialingRuleRequest
Return Value	AddUpdateDialingRuleResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

DID inventory

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/DID

Assignment management

assign_did_to_owner_batch
This method allows an API user to assign a DID number to the Pricing Batch.
Parameters	AssignDIDToOwnerBatchRequest
Return Value	AssignDIDToOwnerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

AssignDIDToOwnerBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
activation_fee	No	float	No	A one-time amount paid to the vendor for the DID number activation.
i_did_number	Yes	unsignedLong	No	The unique DID Number identifier.
i_do_batch	No	unsignedLong	No	The unique ID of the DID Pricing Batch.
periodic_fee	No	float	No	A monthly amount charged by the vendor for the provisioned DID number.

AssignDIDToOwnerBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation has been successfully completed.

release_did_from_owner_batch
This method allows an API user to release a DID number previously assigned to the Pricing Batch.
Parameters	ReleaseDIDFromOwnerBatchRequest
Return Value	ReleaseDIDFromOwnerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

ReleaseDIDFromOwnerBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	The unique DID Number identifier.

ReleaseDIDFromOwnerBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 – DID was released, 0 – DID was not released.

DID number management

add_number
This method allows an API user to add a DID number to the DID inventory
Parameters	AddNumberRequest
Return Value	AddNumberResponse
Realm	administrator
Standalone mode support	No

AddNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
number_info	Yes	DIDNumberInfo structure	No	The information about the DID Number.

AddNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	The unique ID of the DID number.
warning_list	No	Array of WarningInfo structure	No	The list of warnings.

assign_did_to_account
This method allows an API user to assign a DID number to a customer's account
Parameters	AssignDIDToAccountRequest
Return Value	AssignDIDToAccountResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

AssignDIDToAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	The unique ID of the DID number record.
i_master_account	Yes	unsignedLong	No	The unique ID of the account this DID number is assigned to.

AssignDIDToAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 – success, 0 – failed.

assign_did_to_customer
This method allows an API user to assign a DID number to a customer
Parameters	AssignDIDToCustomerRequest
Return Value	AssignDIDToCustomerResponse
Realm	administrator, reseller
Standalone mode support	No

AssignDIDToCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record to which the account belongs.
i_did_number	Yes	unsignedLong	No	The unique DID Number identifier.

AssignDIDToCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 – DID was assigned, 0 – DID was not assigned.

assign_did_to_reseller
This method allows an API user (administrator) to assign a DID number to a reseller
Parameters	AssignDIDToResellerRequest
Return Value	AssignDIDToResellerResponse
Realm	administrator
Standalone mode support	No

AssignDIDToResellerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the reseller record.
i_did_number	Yes	unsignedLong	No	The unique DID Number identifier.

AssignDIDToResellerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 – DID was assigned, 0 – DID was not assigned.

cancel_did_assignment
This method allows an API user to remove a previously assigned DID number from a customer's account
Parameters	CancelDIDAssignmentRequest
Return Value	CancelDIDAssignmentResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

CancelDIDAssignmentRequest
Property	Mandatory	Type	Nillable	Description	Possible values
dont_release_to_pool	No	int	No	If set, the flag shows that the DID number should not be released into the pool.
i_customer	Yes	unsignedLong	No	The unique ID of a customer record to which the account belongs. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_did_number	Yes	unsignedLong	No	The unique ID of the DID number record.

CancelDIDAssignmentResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 – success, 0 – failed.

delete_number
This method allows an API user to delete a DID number from the DID inventory
Parameters	DeleteDIDNumberRequest
Return Value	DeleteDIDNumberResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

DeleteDIDNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	DID number to delete.

DeleteDIDNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 – success, 0 – failed.

delete_number_list
The method enables an API user to remove DID numbers from the inventory
Parameters	DeleteDIDNumberListRequest
Return Value	DeleteDIDNumberListResponse
Realm	administrator
Standalone mode support	No

DeleteDIDNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
number_list	No	Array of DIDNumberInfo structure	No	The set of the DID number records that are going to be deleted.

DeleteDIDNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
statuses	Yes	Array of DeleteDIDNumberInfoStatus structure	No	The statuses of the DID numbers deleting process.
success	Yes	int	No	1 for success, exception on failure.

get_customer_numbers
This method allows an API user to obtain the list of DID numbers owned by him. An administrator can obtain the list of DID numbers owned by a retail customer (but not a reseller)
Parameters	GetCustomerDIDNumbersRequest
Return Value	GetCustomerDIDNumbersResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetCustomerDIDNumbersRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved records.	Default value: 1
i_account	No	unsignedLong	No	The unique ID of the master account record.
i_customer	No	unsignedLong	No	The unique ID of a retail customer record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
managed_by	No	int	No	The unique ID of the reseller who owns DID numbers.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property specified within the API request.

GetCustomerDIDNumbersResponse
Property	Mandatory	Type	Nillable	Description	Possible values
number_list	No	Array of CustomerDIDNumberInfo structure	No	The list of CustomerDIDNumberInfo records.
total	No	int	No	The total number of records.

get_number_info
This method allows an API user to get a DID number record from the database
Parameters	GetDIDNumberInfoRequest
Return Value	GetDIDNumberInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDIDNumberInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the DID number is in use.
number	Yes	string	No	DID Number.

GetDIDNumberInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
number_info	No	DIDNumberInfo structure	No	Data for account; see DIDNumberInfo above.

get_number_list

This method allows an API user to get the list of active DID numbers filtered by various parameters

Parameters

GetDIDNumberListRequest

Return Value

GetDIDNumberListResponse

Realm

administrator, reseller, representative

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv, xlsx, xls
Mandatory	No

GetDIDNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
area_code	No	string	No	The area code search pattern. Can be used only if the 'use_did_location' field in the request is absent or false.
area_code_description	No	string	No	The area code description search pattern. Can be used only if the 'use_did_location' field in the request is absent or false.
available_to_customer	No	unsignedLong	No	The unique ID of the customer to return available DID numbers for.
check_usage	No	int	No	Check whether the DID number is in use.
city_name	No	string	No	The area that numbers belong to.	Max value: 64
country	No	string	No	An ISO 3166 two-letter country code. Use it with the “use_did_location” attribute.	Max value: 2 Min value: 0
description	No	string	No	The description search pattern. Use it with the "use_did_location" attribute. To change the description, use the update_number or update_number_list API methods or provide the required description via the user interface.	Max value: 255
estimate_cost	No	EstimateDIDNumberCostInfo structure	No	If the structure is specified, the estimated_cost_list field with prices will be present for every DID number in the response.
external	No	int	No	Return DID numbers: 1 - received from an external DID provider, 0 - uploaded to the system manually.
format	No	string	No	This parameter enables the user to get DID numbers in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'.	Possible values: csv, xlsx, xls
get_total	No	int	No	Get the total number of retrieved DID numbers.
i_customer	No	unsignedLong	Yes	The unique ID of the customer who owns the DID number.
i_dv_batch	No	unsignedLong	Yes	The unique ID of the vendor batch this DID belongs to.
i_group	No	unsignedLong	Yes	The unique ID of the DID group.
i_vendor	No	unsignedLong	Yes	The unique ID of the vendor who owns the DID number.
limit	No	int	No	Number of rows to retrieve.	Default value: 50
managed_by	No	unsignedLong	Yes	The unique ID of the reseller who owns the DID Number.
max_activation_fee	No	float	No	Return DID numbers with the 'activation_fee' field value <= than the value in this field.	Precision: 15, Scale: 5
max_periodic_fee	No	float	No	Return DID numbers with the 'periodic_fee' field value <= than the value in this field.	Precision: 15, Scale: 5
min_activation_fee	No	float	No	Return DID numbers with the 'activation_fee' field value >= than the value in this field.	Precision: 15, Scale: 5
min_periodic_fee	No	float	No	Return DID numbers with the 'periodic_fee' field value >= than the value in this field.	Precision: 15, Scale: 5
number	No	string	No	Number search pattern.
number_list	No	Array of RequestDIDNumberInfo structure	No	Set of DID number records.
offset	No	int	No	Result offset.	Default value: 0
owner_batch	No	unsignedLong	Yes	Owner Batch ID.
owner_batch_individual	No	string	No	Shows DID numbers with a specific value of the 'owner_batch_individual' field.	Possible values: Y, N
reserve_term	No	int	No	Number of seconds to check for reservation. If number has been reserved more than reserve_term seconds ago (or not reserved at all) it will be fetched.	Default value: 0 Max value: 31795200 Min value: 0
start_number	No	string	No	Starting DID number. This field is used to get a list starting with a specific template or a specific DID number. For example: to get a list starting from number 123001 for list (..., 123000, 123001, 123002, ...), enter 123001 in this field.
usage	No	string	No	I - Idle (assigned to neither an account nor a customer); U - Used (assigned to an account); F - Not used (idle and / or assigned to a customer, but not to an account); A - All (the default value); Z - Frozen (displayed on the administrator's DID inventory page only).	Default value: A Possible values: A, U, F, I, Z
use_did_location	No	int	No	If set, use the DID Numbers country and description to search by.
with_extended_info	No	int	No	If the field is equal to 1, the method returns the following fields: vendor_name, reseller_name, customer_name, country_name.

GetDIDNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
number_list	No	Array of DIDNumberInfo structure	No	Set of DID number records.
total	No	int	No	The total number of retrieved DID numbers.

get_number_list_statistics
This method enables an API user to get the DID number list statistics
Parameters	GetDIDNumberListStatisticsRequest
Return Value	GetDIDNumberListStatisticsResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDIDNumberListStatisticsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetDIDNumberListStatisticsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
max_activation_fee	No	int	Yes	The maximum value of the 'activation_fee' field of DID numbers in the system.
max_periodic_fee	No	int	Yes	The maximum value of the 'periodic_fee' field of DID numbers in the system.
min_activation_fee	No	int	Yes	The minimum value of the 'activation_fee' field of DID numbers in the system.
min_periodic_fee	No	int	Yes	The minimum value of the 'periodic_fee' field of DID numbers in the system.
total	No	int	No	The total number of DID numbers.
total_free	No	int	No	The total number of DID numbers that are not used (including frozen ones).
total_frozen	No	int	No	The total number of frozen DID numbers.
total_used	No	int	No	The total number of DID numbers that are already in use.

release_did_from_customer
This method allows an API user to release a DID number previously assigned to a customer
Parameters	ReleaseDIDFromCustomerRequest
Return Value	ReleaseDIDFromCustomerResponse
Realm	administrator, reseller
Standalone mode support	No

ReleaseDIDFromCustomerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	DID number to release.
unassign_owner_batch	No	string	No	Specifies whether to unassign the DID number from a pricing batch. Possible values: Y – Unassign the DID number from a pricing batch; N – Do not unassign the DID number from a pricing batch. Default value is N.	Default value: N Possible values: Y, N

ReleaseDIDFromCustomerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 – success, 0 – failed.

release_did_from_reseller
This method allows an API user (administrator or reseller) to release a previously assigned DID number from a reseller
Parameters	ReleaseDIDFromResellerRequest
Return Value	ReleaseDIDFromResellerResponse
Realm	administrator, reseller
Standalone mode support	No

ReleaseDIDFromResellerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	The unique DID Number identifier.

ReleaseDIDFromResellerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 if failed.

release_number
This method allows an API user to release a previously reserved DID number
Parameters	ReleaseDIDNumberRequest
Return Value	ReleaseDIDNumberResponse
Realm	administrator, reseller
Standalone mode support	No

ReleaseDIDNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
number	No	string	No	DID number to release.	Max value: 32 Min value: 1
timestamp	No	string	No	Time stamp of previous reservation to check.	Max value: 99999999999 Min value: 1

ReleaseDIDNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 - success, 0 - failure.

reserve_number
This method allows an API user to reserve a DID number for future use. The reserved field will be filled with the current date and time. Note: before the reservation, this method checks that the number was not already reserved during the specified interval
Parameters	ReserveDIDNumberRequest
Return Value	ReserveDIDNumberResponse
Realm	administrator, reseller
Standalone mode support	No

ReserveDIDNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
number	No	string	No	DID Number to reserve.	Max value: 32 Min value: 1
reserve_term	No	int	No	Number of seconds to check for reserved status and avoid reservation of still reserved numbers.	Max value: 31795200 Min value: 1

ReserveDIDNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 - success, 0 - failure.
timestamp	No	string	No	Time stamp of reservation.

update_number
This method enables an API user to update a DID number description in the DID inventory
Parameters	UpdateDIDNumberRequest
Return Value	UpdateDIDNumberResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateDIDNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
number_info	Yes	DIDNumberInfo structure	No	The information about the DID Number.

UpdateDIDNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	The unique ID of the DID number.

update_number_list
The method enables an API user to update DID numbers in the inventory
Parameters	UpdateDIDNumberListRequest
Return Value	UpdateDIDNumberListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateDIDNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
frozen	No	string	No	Possible values: Y - mark the number list frozen; N - remove the frozen mark from the number list.	Possible values: Y, N
i_customer	No	unsignedLong	Yes	The unique ID of the customer the number list will be assigned to.
i_do_batch	No	unsignedLong	Yes	The unique ID of the DID pricing batch the number list will be assigned to.
i_dv_batch	No	unsignedLong	Yes	The unique ID of the vendor batch the number list will be assigned to.
i_group	No	unsignedLong	Yes	The unique ID of the DID group the number list will be assigned to.
number_list	No	Array of DIDNumberInfo structure	No	The set of the DID number records that are going to be updated.

UpdateDIDNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
statuses	Yes	Array of UpdateDIDNumberInfoStatus structure	No	The statuses of the DID numbers updating process.
success	Yes	int	No	1 for success, exception on failure.

upload_did_numbers

This method enables an API user to upload DID numbers into the system

Parameters

UploadDIDNumbersRequest

Return Value

UploadDIDNumbersResponse

Realm

administrator

Standalone mode support

Attachments

Type	Upload
Formats	csv, xlsx, xls
Mandatory	Yes

UploadDIDNumbersRequest
Property	Mandatory	Type	Nillable	Description	Possible values
default_action	No	string	No	The field shows which action will be performed by default for every row in the attached spreadsheet file. Possible values: 'add', 'update' or 'add_update'.	Default value: add Possible values: add_update, add, update
format	No	string	No	The format of the uploading file. The field is not mandatory if the file has a correct and supported extension. Possible values: 'csv', 'xls' or 'xlsx'.	Possible values: csv, xlsx, xls

UploadDIDNumbersResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

Group management

add_did_group
This method enables an API user to create a DID group record
Parameters	AddDIDGroupRequest
Return Value	AddDIDGroupResponse
Realm	administrator, reseller
Standalone mode support	No

AddDIDGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
group_info	Yes	DIDGroupInfo structure	No	The information about the DID group.

AddDIDGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_group	Yes	unsignedLong	No	The unique ID of the DID group.

delete_did_group
This method enables an API user to delete a DID group record from the DB
Parameters	DeleteDIDGroupRequest
Return Value	DeleteDIDGroupResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteDIDGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_group	Yes	unsignedLong	No	The unique ID of the DID group.

DeleteDIDGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception or 0 for failure.

get_did_group_list
This method enables an API user to get the list of DID group records
Parameters	GetDIDGroupListRequest
Return Value	GetDIDGroupListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDIDGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	DID group description.
get_did_total_usage	No	int	No	Get the usage of DID numbers for every DID group in list.
get_total	No	int	No	Get the total number of retrieved DID groups.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The name of the DID group.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetDIDGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
group_list	Yes	Array of DIDGroupInfo structure	No	The list of DIDGroupInfo records.
total	No	int	No	The total number of records in the list.

update_did_group
This method enables an API user to update a DID group record
Parameters	UpdateDIDGroupRequest
Return Value	UpdateDIDGroupResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateDIDGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
group_info	Yes	DIDGroupInfo structure	No	The information about the DID Number.

UpdateDIDGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_group	Yes	unsignedLong	No	The unique ID of the DID group.

Inventory management

get_inventory_option_info
This method enables an API user to get DID inventory option information
Parameters	GetDIDInventoryOptionInfoRequest
Return Value	GetDIDInventoryOptionInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDIDInventoryOptionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_inventory_option	No	unsignedLong	No	The unique ID of the inventory option record.

GetDIDInventoryOptionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
option_info	No	DIDInventoryOptionsInfo structure	No	The DID inventory option information.

get_inventory_options
This method enables an API user to get DID inventory options
Parameters	GetDIDInventoryOptionsRequest
Return Value	GetDIDInventoryOptionsResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDIDInventoryOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the reseller.

GetDIDInventoryOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
option_list	No	Array of DIDInventoryOptionsInfo structure	No	The DID inventory options.

update_inventory_options
This method enables an API user to update DID inventory options
Parameters	UpdateDIDInventoryOptionsRequest
Return Value	UpdateDIDInventoryOptionsResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateDIDInventoryOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the reseller.
option_list	Yes	Array of DIDInventoryOptionsInfo structure	No	The DID inventory options.	Min value: 1

UpdateDIDInventoryOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 if the operation is successful.

Pricing batch management

add_owner_batch
This method allows an API user (administrator or reseller) to add DID Pricing Batch.
Parameters	AddUpdateOwnerBatchRequest
Return Value	AddUpdateOwnerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateOwnerBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
owner_batch_info	Yes	DIDOwnerBatchInfo structure	No	DID Owner Batch info.

AddUpdateOwnerBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_do_batch	No	unsignedLong	No	The unique ID of the DID Pricing Batch.

delete_owner_batch
This method allows an API user (administrator or reseller) to delete DID Pricing Batch.
Parameters	DeleteOwnerBatchRequest
Return Value	DeleteOwnerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteOwnerBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_do_batch	Yes	unsignedLong	No	The unique ID of the DID Pricing Batch.

DeleteOwnerBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 – DID Pricing Batch was deleted, 0 – DID Pricing Batch was not deleted.

get_owner_batch_info
This method allows an API user (administrator or reseller) to get DID Pricing Batch info.
Parameters	GetOwnerBatchInfoRequest
Return Value	GetOwnerBatchInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetOwnerBatchInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the owner batch is in use.
get_did_total	No	int	No	Get the total number of DID numbers for a DID owner batch in the response.
get_did_total_usage	No	int	No	Get the usage of DID numbers for a DID owner batch in the response.
i_do_batch	Yes	unsignedLong	No	The unique ID of the DID Pricing Batch.
with_markup	No	int	No	If with_markup == 1 then return information about markup.

GetOwnerBatchInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
owner_batch_info	No	DIDOwnerBatchInfo structure	No	The information about a DID pricing batch.

get_owner_batch_list
This method allows an API user (administrator or reseller) to get the list of DID pricing batches filtered by various parameters
Parameters	GetOwnerBatchListRequest
Return Value	GetOwnerBatchListResponse
Realm	administrator, reseller, representative
Standalone mode support	Yes

GetOwnerBatchListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the owner batches are in use.
empty_markup_options	No	string	No	Filter DID owner batches by the empty markup options. Possible values: 'Y' - return batches with empty markup_options; 'N' - return batches with specified markup_options.	Possible values: Y, N
get_did_total	No	int	No	Get the total number of DID numbers for each DID owner batch in the response.
get_did_total_usage	No	int	No	Get the usage of DID numbers for each DID owner batch in the response.
get_total	No	int	No	Get the total number of the records in the DB.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller who owns the owner batch.
i_do_batch	No	unsignedLong	No	The unique ID of the pricing batch.
iso_4217	No	string	No	The currency of a pricing batch.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	The pricing batch name.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
order_by	No	string	No	Allows to sort the resulting list by a specific field.	Default value: name Possible values: total_dids, total_dids_used, name, total_dids_free
type	No	string	No	The type of the DID pricing batch.	Possible values: customer, reseller
with_markup	No	int	No	If with_markup == 1, return markup information.

GetOwnerBatchListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
owner_batch_list	Yes	Array of DIDOwnerBatchInfo structure	No	Set of the pricing batch records.
total	No	int	No	The total number of retrieved records.

update_owner_batch
This method allows an API user (administrator or reseller) to update DID Pricing Batch.
Parameters	AddUpdateOwnerBatchRequest
Return Value	AddUpdateOwnerBatchResponse
Realm	administrator, reseller
Standalone mode support	No

Vendor batch management

add_vendor_batch
This method enables an API user to create a new vendor DID batch
Parameters	AddVendorBatchRequest
Return Value	AddVendorBatchResponse
Realm	administrator
Standalone mode support	No

AddVendorBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_batch_info	Yes	VendorBatchInfo structure	No	Vendor DID batch info.

AddVendorBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dv_batch	No	unsignedLong	No	The unique ID of the vendor DID batch record.

delete_vendor_batch
This method enables an API user to delete a vendor DID batch
Parameters	DeleteVendorBatchRequest
Return Value	DeleteVendorBatchResponse
Realm	administrator
Standalone mode support	No

DeleteVendorBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dv_batch	Yes	unsignedLong	No	The unique ID of the vendor DID batch record.

DeleteVendorBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_vendor_batch_info
This method enables an API user (administrator or reseller) to get the information about the DID vendor batch
Parameters	GetVendorBatchInfoRequest
Return Value	GetVendorBatchInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVendorBatchInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_did_total_usage	No	int	No	Get the usage of DID numbers.
i_dv_batch	Yes	unsignedLong	No	The unique ID of the vendor batch record.

GetVendorBatchInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_batch_info	No	VendorBatchInfo structure	No	The information about the vendor batch.

get_vendor_batch_list
This method allows an API user (administrator or reseller) to get the list of DID vendor batches filtered by various parameters. The DID inventory must be accessible to the user making the request. Only those batches containing DID numbers owned by the user will be returned
Parameters	GetVendorBatchListRequest
Return Value	GetVendorBatchListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVendorBatchListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
area_code	No	string	No	Search pattern for area code.
area_code_description	No	string	No	Search pattern for area code description.
check_usage	No	int	No	Check whether the DID vendor batch is in use.
country	No	string	No	ISO 3166 two-letter country code.
description	No	string	No	The description of the vendor batch.
get_did_total_usage	No	int	No	Get the usage of DID numbers for each DID vendor batch in the response.
get_total	No	int	No	Get the total number of retrieved records.
get_used	No	int	No	If set to '1', the method returns only vendor batches that contain at least one used DID number.	Default value: 0
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Default value: 100
name	No	string	No	The name of the vendor batch.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
owner_batch	No	unsignedLong	No	The unique ID of the pricing batch record; the list will include only those vendor batches containing DID numbers included in this particular pricing batch.
reserve_term	No	int	No	The period in seconds during which a DID number is considered 'reserved' and thus the vendor batch that contains it must not be included in the result list. For example, if you send now the request with reserve_term property set to 60, then all the DID numbers that were reserved less than 60 seconds ago will not be included in the result list.	Default value: 0

GetVendorBatchListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of retrieved records.
vendor_batch_list	No	Array of VendorBatchInfo structure	No	Set of vendor batch records.

update_vendor_batch
This method enables an API user to update a vendor DID batch record
Parameters	UpdateVendorBatchRequest
Return Value	UpdateVendorBatchResponse
Realm	administrator
Standalone mode support	No

UpdateVendorBatchRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_batch_info	Yes	VendorBatchInfo structure	No	Vendor DID batch info.

UpdateVendorBatchResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_dv_batch	Yes	unsignedLong	No	The unique ID of the vendor DID batch record.

DID provider interface

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/DID_Provider

DID auto-provisioning management

cancel_provision
This method allows an API user to release a DID number allocated earlier from the providerIf DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified
Parameters	CancelDIDProvisionRequest
Return Value	CancelDIDProvisionResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

CancelDIDProvisionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_info	No	CustomerDIDProviderIdent structure	No	Parameters used to find a DID provider configured in PortaBilling.
i_did_number	Yes	unsignedLong	No	Provisioned number ID in the DID inventory.

CancelDIDProvisionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
is_canceled	Yes	int	No	Indicates whether the number has been released.

get_areas_list
This method allows an API user to retrieve the list of areas in a specified country where a number can be allocated from via the DID provider. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified
Parameters	GetDIDAreasListRequest
Return Value	GetDIDAreasListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetDIDAreasListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_info	No	CustomerDIDProviderIdent structure	No	Parameters used to find a DID provider configured in PortaBilling.
for_idle_numbers_only	No	string	No	Get the list of areas by numbers in the DID Pool (Y/N), default - N.	Default value: N Possible values: Y, N
req_params	No	DIDRequestParameters structure	No	Parameters which have been received by the get_countries_list method.
req_params_list	No	Array of DIDRequestParameters structure	No	The array of parameters that have been received by the get_countries_list method.

GetDIDAreasListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
areas_list	No	Array of DIDAreaInfo structure	Yes	The list of area data records.

get_countries_list
This method allows an API user to retrieve the list of countries where a number can be allocated from via the DID provider. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified
Parameters	GetDIDCountriesListRequest
Return Value	GetDIDCountriesListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetDIDCountriesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_info	No	CustomerDIDProviderIdent structure	No	Parameters used to find a DID provider configured in PortaBilling.
for_idle_numbers_only	No	string	No	Get the list of countries by numbers in the DID Pool, By default - N.	Default value: N Possible values: Y, N

GetDIDCountriesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
countries_list	No	Array of DIDCountryInfo structure	Yes	The list of country data records.

get_did_provider_info
This method enables an API user to get the DID provider information
Parameters	GetDIDProviderInfoRequest
Return Value	GetDIDProviderInfoResponse
Realm	administrator
Standalone mode support	Yes

GetDIDProviderInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_provider	Yes	unsignedLong	No	The unique ID of the DID provider.

GetDIDProviderInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
provider_info	No	DIDProviderInfo structure	No	The DID provider information.

get_did_provider_list
This method enables an API user to get information about supported DID providers
Parameters	GetDIDProviderListRequest
Return Value	GetDIDProviderListResponse
Realm	administrator
Standalone mode support	Yes

GetDIDProviderListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	The DID provider name pattern.

GetDIDProviderListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
provider_list	No	Array of DIDProviderInfo structure	No	The list of DID provider records.

get_numbers_list
This method allows an API user to retrieve the list of DID numbers for a specified country and area available for allocating from the DID provider. Note that not all DID providers may provide the list of numbers, so you may find out whether the DID provider supports this from the is_numbers_list_available field of the get_provider_info method. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified
Parameters	GetDIDNumbersListRequest
Return Value	GetDIDNumbersListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetDIDNumbersListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_info	No	CustomerDIDProviderIdent structure	No	Parameters used to find a DID provider configured in PortaBilling.
idle_only	No	string	No	Get the list of numbers in the DID Pool (Y/N), default - N.	Default value: N Possible values: Y, N
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
req_params	No	DIDRequestParameters structure	No	Parameters which have been received by the get_areas_list method.
req_params_list	No	Array of DIDRequestParameters structure	No	The array of parameters that have been received by the get_areas_list method.

GetDIDNumbersListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
numbers_list	No	Array of DIDNumberListInfo structure	Yes	The list of DID number records.

get_provider_info
This method enables an API user to get the DID provider information used by a customer (e.g., its currency). If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified
Parameters	GetProviderInfoRequest
Return Value	GetProviderInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetProviderInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_info	No	CustomerDIDProviderIdent structure	No	Parameters used to find a DID provider configured in PortaBilling.

GetProviderInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
provider_info	No	DIDProviderInfo structure	No	DID provider info.

obtain_number
This method enables an API user to allocate a DID number from the pool
Parameters	ObtainDIDNumberRequest
Return Value	ObtainDIDNumberResponse
Realm	administrator, retail customer
Standalone mode support	No

ObtainDIDNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer.
number	Yes	string	No	DID Number.

ObtainDIDNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
number_info	No	DIDNumberInfo structure	No	DID Number info.

provision_number
This method allows an API user to allocate a DID number from the provider. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified
Parameters	ProvisionDIDRequest
Return Value	ProvisionDIDResponse
Realm	administrator, reseller, retail customer
Standalone mode support	No

ProvisionDIDRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_info	No	CustomerDIDProviderIdent structure	No	Parameters used to find a DID provider configured in PortaBilling.
req_params	No	DIDRequestParameters structure	No	Parameters which should be passed to a DID provider while ordering a DID number.

ProvisionDIDResponse
Property	Mandatory	Type	Nillable	Description	Possible values
did_order_info	No	DIDNumberOrderInfo structure	Yes	Information about the DID number order.

return_number
This method enables an API user to return a DID number to the pool
Parameters	ReturnDIDNumberRequest
Return Value	ReturnDIDNumberResponse
Realm	administrator, retail customer
Standalone mode support	No

ReturnDIDNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	int	No	The unique ID of the customer.
number	Yes	string	No	DID Number.

ReturnDIDNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	One of the following: 1 – success, 0 – failed.

Discount plan information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/DiscountPlan

Discount management

add_discount
This method allows an API user to add a new discount (for a destination group)
Parameters	AddDiscountRequest
Return Value	AddDiscountResponse
Realm	administrator, reseller
Standalone mode support	No

AddDiscountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
discount_info	Yes	DiscountInfo structure	No	Complete information about the discount for a specific destination group.

AddDiscountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	Yes	unsignedLong	No	The unique ID of the discount for a specific destination group.

delete_discount
This method allows an API user to delete a discount (for a destination group)
Parameters	DeleteDiscountRequest
Return Value	DeleteDiscountResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteDiscountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	Yes	unsignedLong	No	The unique ID of the discount for a specific destination group to be deleted.

DeleteDiscountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_discount_info
This method allows an API user to get the information about a discount (for a destination group) in the specified volume discount plan
Parameters	GetDiscountInfoRequest
Return Value	GetDiscountInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDiscountInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	Yes	unsignedLong	No	The unique ID of the discount for a specific destination group.
with_thresholds	No	int	No	Specifies whether to retrieve thresholds for the discount.

GetDiscountInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
discount_info	No	DiscountInfo structure	No	Complete information about the discount for a specific destination group.

get_discount_list
This method allows an API user to get the information about discounts (per destination group) in the specified volume discount plan
Parameters	GetDiscountListRequest
Return Value	GetDiscountListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDiscountListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
dg_name	No	string	No	Destination group name pattern.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group to search the discount by.
i_service	No	unsignedLong	No	The unique ID of the service to search the discount by.
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan.
i_vd_type	No	unsignedLong	No	The unique ID of the discount type.
is_usage_period_set	No	int	No	Specifies whether to return discounts with filled or empty 'usage_period' field.
peak_level	No	int	No	ID of the Peak Level (0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period).	Possible values: 0, 1, 2
service_name	No	string	No	Service name pattern.
threshold_type	No	string	No	The type of the discount threshold type to search by. Possible values: 'Charged Amount','Charged Time'.
with_thresholds	No	int	No	Specifies whether to retrieve thresholds for the discount.

GetDiscountListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
discount_list	No	Array of DiscountInfo structure	Yes	Array of the volume discount plan structures.

update_discount
This method allows an API user to update a discount (for a destination group)
Parameters	UpdateDiscountRequest
Return Value	UpdateDiscountResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateDiscountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
discount_info	Yes	DiscountInfo structure	No	Complete information about the discount for a specific destination group.

UpdateDiscountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	Yes	unsignedLong	No	The unique ID of the discount for a specific destination group.

Discount plan management

add_discount_plan
This method allows an API user to add a volume discount plan
Parameters	AddDiscountPlanRequest
Return Value	AddDiscountPlanResponse
Realm	administrator, reseller
Standalone mode support	No

AddDiscountPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
discount_plan_info	Yes	DiscountPlanInfo structure	No	Complete information about a new volume discount plan.

AddDiscountPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan.

clone_discount_plan
This method allows an API user to clone a volume discount plan
Parameters	CloneDiscountPlanRequest
Return Value	CloneDiscountPlanResponse
Realm	administrator
Standalone mode support	No

CloneDiscountPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan to be cloned.
name	Yes	string	No	The name of the discount plan clone.	Max value: 100

CloneDiscountPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan clone.

delete_discount_plan
This method allows an API user to delete a volume discount plan
Parameters	DeleteDiscountPlanRequest
Return Value	DeleteDiscountPlanResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteDiscountPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan to be deleted.

DeleteDiscountPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_discount_plan_info
This method allows an API user to get detailed information about a volume discount plan by using its ID
Parameters	GetDiscountPlanInfoRequest
Return Value	GetDiscountPlanInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetDiscountPlanInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_complete_status	No	int	No	If set to '1', the 'is_complete' field will be returned in the response.
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan.

GetDiscountPlanInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
discount_plan_info	No	DiscountPlanInfo structure	No	Complete information about a volume discount plan.

get_discount_plan_list
This method allows an API user to retrieve detailed information about volume discount plans by their name patterns or owner ID
Parameters	GetDiscountPlanListRequest
Return Value	GetDiscountPlanListResponse
Realm	administrator, reseller, cc staff, representative, distributor
Standalone mode support	Yes

GetDiscountPlanListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_complete_status	No	int	No	If set to '1', the 'is_complete' field will be returned for every discount plan in the response.
check_usage	No	int	No	Check discount plans usage by entities.	Default value: 1
get_total	No	int	No	Get the total number of the retrieved volume discount plans.
i_customer	No	unsignedLong	No	The unique ID of the customer the volume discount plan is assigned to. Specify 0 or null to retrieve volume discount plans managed by the administrator.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set associated with this discount plan.
iso_4217	No	string	No	Volume discount plan currency.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Name pattern of a volume discount plan.	Max value: 100
offset	No	string	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
only_completed	No	int	No	Include completed discount plans only.
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.

GetDiscountPlanListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
discount_plan_list	No	Array of DiscountPlanInfo structure	No	The list of volume discount plans.
total	No	int	No	The number of the retrieved volume discount plans.

update_discount_plan
This method allows an API user to update a volume discount plan
Parameters	UpdateDiscountPlanRequest
Return Value	UpdateDiscountPlanResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateDiscountPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
discount_plan_info	Yes	DiscountPlanInfo structure	No	Complete information about a volume discount plan to be updated.

UpdateDiscountPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_plan	Yes	unsignedLong	No	The unique ID of the volume discount plan.

Threshold management

add_vd_threshold
This method allows an API user to add a threshold to a discount record
Parameters	AddVDThresholdRequest
Return Value	AddVDThresholdResponse
Realm	administrator, reseller
Standalone mode support	No

AddVDThresholdRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vd_threshold_info	Yes	VDThresholdInfo structure	No	Complete information about a threshold for a specific discount.

AddVDThresholdResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_threshold	No	unsignedLong	No	The unique ID of the threshold added for a specific discount.

delete_vd_threshold
This method allows an API user to delete a threshold from a discount record
Parameters	DeleteVDThresholdRequest
Return Value	DeleteVDThresholdResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteVDThresholdRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_threshold	Yes	unsignedLong	No	The unique ID of a threshold to be deleted from a specific discount.

DeleteVDThresholdResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 if operation is successful, 0 if not.

get_vd_threshold_info
This method allows an API user to get the information about a threshold (discount scheme) for the specified discount record
Parameters	GetVDThresholdInfoRequest
Return Value	GetVDThresholdInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVDThresholdInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_threshold	Yes	unsignedLong	No	The unique ID of a threshold from a specific discount.

GetVDThresholdInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vd_threshold	Yes	VDThresholdInfo structure	No	Complete information about the requested threshold.

get_vd_threshold_list
This method allows an API user to get the information about thresholds (discount scheme) for the specified discount record
Parameters	GetVDThresholdListRequest
Return Value	GetVDThresholdListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVDThresholdListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	Yes	unsignedLong	No	The unique ID of the discount for a specific destination group.

GetVDThresholdListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
threshold_list	No	Array of VDThresholdInfo structure	Yes	The list of thresholds of a specific discount.

update_vd_threshold
This method allows an API user to update a threshold in a discount record
Parameters	UpdateVDThresholdRequest
Return Value	UpdateVDThresholdResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateVDThresholdRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vd_threshold_info	Yes	VDThresholdInfo structure	No	Complete information about a threshold to be updated for a specific discount.

UpdateVDThresholdResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_threshold	No	unsignedLong	No	The unique ID of the volume discount threshold object.

Topup option management

add_topup_option
This method enables an API user to add a topup option. Make sure the topup_amount attribute is specified.
Parameters	AddVDTopupOptionRequest
Return Value	AddVDTopupOptionResponse
Realm	administrator, reseller
Standalone mode support	No

AddVDTopupOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
topup_option_info	No	VDTopupOptionInfo structure	No	The information about the topup option.

AddVDTopupOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_topup	No	unsignedLong	No	The unique ID of the volume discount topup record.

delete_topup_option
This method allows an API user to delete a topup option
Parameters	DeleteVDTopupOptionRequest
Return Value	DeleteVDTopupOptionResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteVDTopupOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_topup	Yes	unsignedLong	No	The unique ID of the volume discount topup record.

DeleteVDTopupOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 – The topup option is successfully deleted; 0 – The topup option is not deleted.

get_topup_option_info
This method allows an API user to get the information about a topup option
Parameters	GetVDTopupOptionInfoRequest
Return Value	GetVDTopupOptionInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetVDTopupOptionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_topup	Yes	unsignedLong	No	The unique ID of the volume discount topup record.

GetVDTopupOptionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
topup_option_info	No	VDTopupOptionInfo structure	No	The information about the topup option.

get_topup_option_list
This method allows an API user to get a list of topup options
Parameters	GetVDTopupOptionListRequest
Return Value	GetVDTopupOptionListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetVDTopupOptionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	Yes	unsignedLong	No	The unique ID of the discount for a specific destination group.
topup_amount	No	float	No	The amount of service units to topup.	Precision: 15, Scale: 5
topup_expiry_time	No	int	No	The lifetime of the top-up option, the number of days.
topup_fee	No	float	No	The amount of money an end user is charged for topup.	Precision: 15, Scale: 5

GetVDTopupOptionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
topup_option_list	No	Array of VDTopupOptionInfo structure	Yes	A list of topup options.

update_topup_option
This method allows an API user to update a topup option
Parameters	UpdateVDTopupOptionRequest
Return Value	UpdateVDTopupOptionResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateVDTopupOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
topup_option_info	No	VDTopupOptionInfo structure	No	The information about the topup option.

UpdateVDTopupOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_topup	No	unsignedLong	No	The unique ID of the volume discount topup record.

Transaction management

make_transaction
This method enables an API user to make transactions between DiscountPlan entites, that is, transfer services between service wallets / quotas
Parameters	MakeVDTransactionRequest
Return Value	MakeVDTransactionResponse
Realm	administrator, account, reseller, retail customer
Standalone mode support	No

MakeVDTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	Possible values: transfer.	Possible values: transfer
addon_priority	No	int	No	The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 – Main product, 10 – Low, 15 – Medium low, 20 – Medium, 25 – Medium high, 30 – High.	Possible values: 0, 10, 15, 20, 25, 30, 255
amount	Yes	float	No	The amount of service units to transfer.	Min value: 0
i_dest_group	Yes	unsignedLong	No	Unique Destination Group ID.
i_service	Yes	unsignedLong	No	Unique Service ID.
peak_level	Yes	string	No	An ID of the peak level.	Default value: 0 Possible values: 0, 1, 2
recipient_i_vd_dg	No	unsignedLong	No	The unique ID of the recipient's volume discount record.
recipient_id	Yes	int	No	The ID of the account record that receives services.
sender_i_vd_dg	No	unsignedLong	No	The unique ID of the sender's volume discount record.
sender_id	No	int	No	The ID of the account record that sends services.
verification_code	No	string	No	The verification code.
visible_comment	No	string	No	The comment for the transaction.
with_expiration_date	No	int	No	The flag shows whether to transfer the expiration date to the recipient's discount record; can be used only by administrators and resellers.

MakeVDTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_xdr	No	unsignedLong	No	The ID of XDR record.

Emergency routing unit information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/EmergencyUnit

Emergency routing unit management

add_emergency_unit
This method enables an API user to add a new emergency routing unit
Parameters	AddEmergencyUnitRequest
Return Value	AddUpdateEmergencyUnitResponse
Realm	administrator
Standalone mode support	No

AddEmergencyUnitRequest
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_info	Yes	EmergencyUnitInfo structure	No	Full information about a new emergency routing unit.

AddUpdateEmergencyUnitResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_emergency_unit	Yes	unsignedLong	No	The identifier of the emergency routing unit.

delete_emergency_unit
This method enables an API user to delete an emergency routing unit
Parameters	DeleteEmergencyUnitRequest
Return Value	DeleteEmergencyUnitResponse
Realm	administrator
Standalone mode support	No

DeleteEmergencyUnitRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_emergency_unit	Yes	unsignedLong	No	The identifier of the emergency routing unit.

DeleteEmergencyUnitResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	The result of deleting an emergency routing unit. 1 for success.

get_emergency_unit_info
This method enables an API user to get the information about an emergency routing unit
Parameters	GetEmergencyUnitInfoRequest
Return Value	GetEmergencyUnitInfoResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetEmergencyUnitInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_id	No	string	No	The canonical path of the administrative unit. Delimiter "." (dot).
i_emergency_unit	No	unsignedLong	No	The identifier of the emergency routing unit.
with_universal	No	int	No	If set to "1" or more, the list will include universal administrative units.	Default value: 0

GetEmergencyUnitInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_info	No	EmergencyUnitInfo structure	Yes	A set of emergency routing unit data records.

get_emergency_unit_list
This method enables an API user to retrieve the information about emergency routing units by their fields
Parameters	GetEmergencyUnitListRequest
Return Value	GetEmergencyUnitListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetEmergencyUnitListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_id	No	string	No	The canonical path of the administrative unit. Delimiter "." (dot).
get_total	No	int	No	Get the total number of the retrieved records.
i_emergency_unit	No	unsignedLong	No	The identifier of the administrative unit.
iso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
limit	No	int	No	The number of records to retrieve.
name	No	string	No	The name of the emergency administrative unit. The field is unique for "i_env" and "country".
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
routing_number	No	string	No	The (default) routing number, when the cld rule is not specified.
routing_number_rule	No	Array of EmergencyUnitRoutingNumberRuleInfo structure	No	The list of routing number rules.
with_universal	No	int	No	If set to "1" or more, the list will include universal administrative units.

GetEmergencyUnitListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_list	No	Array of EmergencyUnitInfo structure	Yes	The list of emergency routing units.
total	No	int	No	The total number of the retrieved emergency routing units.

update_emergency_unit
This method enables an API user to update an emergency routing unit
Parameters	UpdateEmergencyUnitRequest
Return Value	AddUpdateEmergencyUnitResponse
Realm	administrator
Standalone mode support	No

UpdateEmergencyUnitRequest
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_info	Yes	EmergencyUnitInfo structure	No	Updated information about the emergency routing unit. Note: emergency_unit_id is mandatory field.

upload_emergency_units

This method enables an API user to upload emergency routing units into the system

Parameters

UploadEmergencyUnitsRequest

Return Value

UploadEmergencyUnitsResponse

Realm

administrator

Standalone mode support

Attachments

Type	Upload
Formats	csv, xlsx, xls
Mandatory	Yes

UploadEmergencyUnitsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

UploadEmergencyUnitsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

Environment information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Env

Custom field management

get_custom_fields_schema
This method allows an API user to get the list of custom fields with information about their types and possible values
Parameters	GetCustomFieldsSchemaRequest
Return Value	GetCustomFieldsSchemaResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomFieldsSchemaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
managed_by	No	unsignedLong	No	Specifies the unique ID of the reseller who manages the custom field record. If undefined, only custom fields managed by administrator will be returned.
object	No	string	No	The entity the custom fileds belong to. Possible values: customer, account.	Possible values: customer, account
visible_to_end_user	No	string	No	Specifies whether the custom fields are visible to an end user. Possible values: Y, N.	Possible values: Y, N

GetCustomFieldsSchemaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_fields	No	Array of CustomFieldsInfo structure	No	The list of custom field information sets.

Custom tax management

add_custom_tax_option
This method allows an API user to add a new custom tax
Parameters	AddUpdateCustomTaxOptionRequest
Return Value	AddUpdateCustomTaxOptionResponse
Realm	administrator
Standalone mode support	No

AddUpdateCustomTaxOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_tax_option	Yes	CustomTaxOptionInfo structure	No	The custom tax information.

AddUpdateCustomTaxOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_option	Yes	unsignedLong	No	The unique ID of the custom tax.

delete_custom_tax_option
This method allows an API user to delete the existing custom tax
Parameters	DeleteCustomTaxOptionRequest
Return Value	DeleteCustomTaxOptionResponse
Realm	administrator
Standalone mode support	No

DeleteCustomTaxOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_option	Yes	unsignedLong	No	The unique ID of the custom tax.

DeleteCustomTaxOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Shows whether custom tax option was removed or not. Posible values: 1 - The tax was removed; 0 - The tax was not removed.

get_custom_tax_option
This method allows an API user to retrieve information about the custom tax
Parameters	GetCustomTaxOptionRequest
Return Value	GetCustomTaxOptionResponse
Realm	administrator
Standalone mode support	Yes

GetCustomTaxOptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_option	Yes	unsignedLong	No	The unique ID of the custom tax.

GetCustomTaxOptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_tax_option	No	CustomTaxOptionInfo structure	No	The custom tax information.

list_custom_tax_options
This method allows an API user to retrieve the list of custom taxes
Parameters	ListCustomTaxOptionsRequest
Return Value	ListCustomTaxOptionsResponse
Realm	administrator, reseller
Standalone mode support	Yes

ListCustomTaxOptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

ListCustomTaxOptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
custom_tax_options	Yes	Array of CustomTaxOptionInfo structure	No	The list of custom tax information sets.

update_custom_tax_option
This method allows an API user to update the existing custom tax
Parameters	AddUpdateCustomTaxOptionRequest
Return Value	AddUpdateCustomTaxOptionResponse
Realm	administrator
Standalone mode support	No

Environment management

get_env_info
This method allows an API user to get an Environment record from the database. The user can get the information about the Environment to which he belongs. Superusers can get information about any Environment
Parameters	GetEnvInfoRequest
Return Value	GetEnvInfoResponse
Realm	administrator
Standalone mode support	Yes

GetEnvInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetEnvInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
env_info	Yes	EnvInfo structure	No	Complete information about the Environment.

get_env_list
This method enables an API user (super user) to get environment records from the database
Parameters	GetEnvListRequest
Return Value	GetEnvListResponse
Realm	administrator
Standalone mode support	Yes

GetEnvListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetEnvListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
env_list	Yes	Array of EnvInfo structure	No	The list of environment records.

update_env
This method allows an API user to update an Environment record in the database
Parameters	UpdateEnvInfoRequest
Return Value	UpdateEnvInfoResponse
Realm	administrator
Standalone mode support	No

UpdateEnvInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
env_info	Yes	EnvInfo structure	No	Complete information about the Environment.

UpdateEnvInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_env	Yes	unsignedLong	No	The unique ID of the environment.

Notification template management

get_notification_template_info
This method is obsolete. Use the new get_notification_template_info method of the Notification service instead. This method allows an API user to retrieve information about the notification template
Parameters	GetEnvNotificationTemplateInfoRequest
Return Value	GetEnvNotificationTemplateInfoResponse
Realm	administrator
Standalone mode support	Yes

GetEnvNotificationTemplateInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the either email or sms notification template as it appears in the Notifications table in the database.

GetEnvNotificationTemplateInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
bcc	No	string	No	An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas.
body	No	string	No	The content of the message.
subject	No	string	No	The subject as it appears in an email to a recepient.
variables	No	Array of NotificationTemplateVariable structure	No	The set of available variables with information about them.

send_me_notification_sample
This method is obsolete. Use the new send_me_notification_sample method of the Notification service instead. This method allows an API user to "test" the notification by sending a message sample to their email address or phone number. The notification is sent to the user that is currently logged in
Parameters	SendMeEnvNotificationSampleRequest
Return Value	SendMeEnvNotificationSampleResponse
Realm	administrator
Standalone mode support	Yes

SendMeEnvNotificationSampleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
messaging_service_type	Yes	string	No	The type of the notification. Possible values: SMS, Mail.	Possible values: mail, sms
name	Yes	string	No	The name of the notification.

SendMeEnvNotificationSampleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
is_sent	Yes	int	No	Specifies whether the notification was sent. Possible values: 1 – The notification was sent, 0 – The notification was not sent.

update_notification_template
This method is obsolete. Use the new update_notification_template method of the Notification service instead. This method allows an API user to update the notification template
Parameters	UpdateEnvNotificationTemplateRequest
Return Value	UpdateEnvNotificationTemplateResponse
Realm	administrator
Standalone mode support	No

UpdateEnvNotificationTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
bcc	No	string	No	An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas.
body	No	string	No	The content of the message.
name	Yes	string	No	The name of either the email or sms notification template as it appears in the Notifications table in the database.
reset_to_default	No	int	No	Specifies whether to reset the notification template to its default value. Possible values: 1 – Reset the notification template to its default value. 0 – Do not reset the notification template.
subject	No	string	No	The subject as it appears in an email to a recepient.
variables	No	Array of NotificationTemplateVariable structure	No	The set of available variables with information about them.

UpdateEnvNotificationTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authorship	No	string	No	Specifies whether the template has been modified. Possible values: System - The template has not been modified; Custom - The template has been modified.
is_updated	Yes	int	No	Specifies whether the notification template was updated. Possible values: 1 – The notification template was updated, 0 – The notification template was not updated.

Generic system information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Generic

Billing period management

get_billing_period_list
This method allows an API user to get information about billing periods
Parameters	GetBillingPeriodListRequest
Return Value	GetBillingPeriodListResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetBillingPeriodListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetBillingPeriodListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
billing_period_list	Yes	Array of BillingPeriodInfo structure	No	The list of billing periods.

Currency management

get_global_currency_info
This method allows an API user to get information about a specific global currency
Parameters	GetGlobalCurrencyInfoRequest
Return Value	GetGlobalCurrencyInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetGlobalCurrencyInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
iso_4217	Yes	string	No	ISO4217 alphabetic code, the unique currency identifier.

GetGlobalCurrencyInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
global_currency_info	Yes	GlobalCurrencyInfo structure	Yes	Complete information about the global currency.

get_global_currency_list
This method allows an API user to get information about all actual and outdated world currencies
Parameters	GetGlobalCurrencyListRequest
Return Value	GetGlobalCurrencyListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetGlobalCurrencyListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
obsolete	No	string	No	Specifies whether the currency is obsolete. In the course of time, some currencies become obsolete (e.g. Deutsche Mark). The obsolete currency cannot be added to the system or selected as a base currency.	Possible values: Y, N

GetGlobalCurrencyListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
global_currency_list	Yes	Array of GlobalCurrencyInfo structure	Yes	The list of global currencies.

Extended information management

get_extended_data_list
This method enables an API user to the get list of any records from the following tables: Accounts, Products, Customers, Customer_Classes, Account_Product_Addons_At, Invoices.
Parameters	GetExtendedDataListRequest
Return Value	GetExtendedDataListResponse
Realm	administrator
Standalone mode support	Yes

GetExtendedDataListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
data	Yes	Array of ExtendedDataObjectInfo structure	No	The data definition to return.	Min value: 1
filters	No	Array of ExtendedDataFilterInfo structure	No	The filters.
get_total	No	int	No	Flag shows whether to include the total number of found items into the response.
limit	No	int	No	The number of rows to retrieve.	Default value: 50
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetExtendedDataListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
list	No	Array of ExtendedDataRecordInfo structure	No	The set of found records.
total	No	int	No	The total number of found records.

Generic information management

get_api_error_file

This method enables an API user to get a file with extended error messages

Parameters

GetAPIErrorFileRequest

Return Value

GetAPIErrorFileResponse

Realm

administrator, reseller, account, retail customer, cc staff, representative, distributor

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetAPIErrorFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
keep_stored	No	int	No	A flag that indicates whether to keep the file in the DB after fetching. Possible values: 1 - keep the file, 0 - remove it. Default value: 0.	Default value: 0
uuid	Yes	string	No	The unique identifier of the file. It usually is returned in the fault details of other API methods.

GetAPIErrorFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_api_schema
This method enables an API user to get the schema of porta-billing API methods
Parameters	GetAPISchemaRequest
Return Value	GetAPISchemaResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetAPISchemaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
method_name	No	string	No	The name of the API method.
service_name	No	string	No	The name of the API service.
with_output_schema	No	int	No	If set to '1', information about API methods' output structures will be shown in the response.	Default value: 0

GetAPISchemaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
api_service_list	Yes	Array of APIServiceInfo structure	No	The list of available API services.

get_codec_list
This method enables an API user to get the list of available codecs
Parameters	GetCodecListRequest
Return Value	GetCodecListResponse
Realm	administrator
Standalone mode support	Yes

GetCodecListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetCodecListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
codec_list	No	Array of CodecInfo structure	No	The list of the available codecs.

get_countries_list
This method allows an API user to get the list of countries
Parameters	GetCountriesListRequest
Return Value	GetCountriesListResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetCountriesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetCountriesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
countries_list	No	Array of CountryInfo structure	Yes	Set of country data records.

get_locale_languages_list
This method enables an API user to get the list of locale language records
Parameters	GetLocaleLanguagesListRequest
Return Value	GetLocaleLanguagesListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetLocaleLanguagesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetLocaleLanguagesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
locale_languages	No	Array of LocaleLanguageInfo structure	Yes	The set of locale languages.

get_subdivisions_list
This method allows an API user to get the list of country subdivisions for a specific counry
Parameters	GetSubdivisionsListRequest
Return Value	GetSubdivisionsListResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetSubdivisionsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
iso_3166_1_a2	No	string	Yes	A two-letter country code defined in ISO 3166-1 alpha-2.

GetSubdivisionsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subdivisions_list	No	Array of SubdivisionInfo structure	Yes	Set of country subdivision data records.

get_ui_config_list
This method enables an API user to get the list of the UI configs
Parameters	GetUIConfigListRequest
Return Value	GetUIConfigListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUIConfigListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
section_name	No	string	No	The name of the config section to filter the response by.

GetUIConfigListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ui_config_list	Yes	Array of UIConfigInfo structure	No	The list of the UI configs.

get_version
This method allows an API user to get the version of PortaBilling version
Parameters	GetVersionRequest
Return Value	GetVersionResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVersionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetVersionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
version	Yes	string	Yes	PortaBilling version.

update_ui_config_list
This method enables an API user to update the list of the UI configs
Parameters	UpdateUIConfigListRequest
Return Value	UpdateUIConfigListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateUIConfigListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ui_config_list	Yes	Array of UIConfigInfo structure	No	The list of the UI configs.	Min value: 1

UpdateUIConfigListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 in case of failure.

Time zone management

get_time_zone_info
This method allows an API user to get information about a specific time zone
Parameters	GetTimeZoneInfoRequest
Return Value	GetTimeZoneInfoResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetTimeZoneInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_time_zone	Yes	unsignedLong	No	The unique ID of the time zone.

GetTimeZoneInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
time_zone_info	Yes	TimeZoneInfo structure	Yes	Complete information about the time zone.

get_time_zone_list
This method allows an API user to get information about time zones
Parameters	GetTimeZoneListRequest
Return Value	GetTimeZoneListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes
Request example	`curl -k -X POST https://put-your-porta-billing-host.com/rest/Generic/get_time_zone_list \ -d auth_info='{"session_id":"9c2c9d8be75cdb1a50431d956d300ecd"}'`
Response example	`{ "time_zone_list" : [ { "time_zone_name" : "Africa/Abidjan", "i_time_zone" : 97 }, { "time_zone_name" : "Africa/Accra", "i_time_zone" : 145 }, ... ] }`

GetTimeZoneListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
search	No	string	No	Pattern that allows to search by a time zone name. Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character.

GetTimeZoneListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
time_zone_list	Yes	Array of TimeZoneInfo structure	Yes	The list of time zones.

Invoice information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Invoice

Invoice management

apply_invoice_adjustment
This method allows an API user to waive an amount from a customer invoice. The amount is deducted from the customer outstanding balance, so that he/she should pay only the reduced amount to cover the adjusted invoice in full. Used if a service provider needs to adjust old invoices issued for their customers (for example, if a customer has disputed his invoice and the service provider agreed to waive a disputable amount)
Parameters	ApplyInvoiceAdjustmentRequest
Return Value	ApplyInvoiceAdjustmentResponse
Realm	administrator, reseller
Standalone mode support	No

ApplyInvoiceAdjustmentRequest
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	An amount of adjustment.	Max value: 99999999999.99998 Min value: 0.00001 Precision: 15, Scale: 5
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly.	Max value: 128
refund_to_cc	Yes	int	No	For fully paid invoices only. If set to 1, the adjustment amount will be refunded to the credit card. Possible values: 1 – Refund the adjustment amount to the credit card. 0 – Do not refund the adjustment amount to the credit card.	Default value: 0 Max value: 1
visible_comment	No	string	No	A comment on this transaction visible to the customer in the xDR browser.	Max value: 128

ApplyInvoiceAdjustmentResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

generate_midterm_invoice
This method allows an administrator to generate a midterm invoice. For example, if during the middle of a billing period, a customer wants to pay for services consumed (up till now) and does not want to wait until the end for their invoice
Parameters	GenerateMidtermInvoiceRequest
Return Value	GenerateMidtermInvoiceResponse
Realm	administrator, reseller
Standalone mode support	No

GenerateMidtermInvoiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	Refers to the record of a customer for which a midterm invoice will be generated.
invoice_due	No	date	No	Invoice due date; if specified, this due date will be used instead of the system default value.	Min value: current date
period_to	No	date	No	The end date of the invoice period. If specified, all transactions that occurred before this date in the current billing period will be included into the invoice.

GenerateMidtermInvoiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.
warning	No	string	No	If the operation ended with a warning, the field contains the text of the warning.

generate_out_of_turn_invoice
This method allows an administrator to generate an out-of-turn invoice (with some transactions included)
Parameters	GenerateOutOfTurnInvoiceRequest
Return Value	GenerateOutOfTurnInvoiceResponse
Realm	administrator, reseller
Standalone mode support	No

GenerateOutOfTurnInvoiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
all_xdrs	No	int	No	Specifies whether to use all available xDRs (those marked accordingly) for generating an out-of-turn invoice. Possile values: 1 – Use all marked xDRs; 0 – Use only some of the marked xDRs.	Default value: 0
i_customer	Yes	unsignedLong	No	Refers to the record of a customer for which an outof-turn invoice will be generated.
invoice_due	No	date	No	The invoice due date. If specified, this due date will be used instead of the system default value.	Min value: current date
xdr_list	No	Array of OutOfTurnXDRInfo structure	No	The array of xDR IDs that will be included into an outof-turn invoice (xDRs must be marked to be included into an out-of-turn invoice).

GenerateOutOfTurnInvoiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	Unique ID of the invoice record.
success	Yes	int	No	1 if operation is successful, 0 if not.

get_invoice_info

This method allows an API user to get an invoice record from the database

Parameters

GetInvoiceInfoRequest

Return Value

GetInvoiceInfoResponse

Realm

administrator, reseller, distributor, retail customer, representative

Standalone mode support

Yes

Attachments

Type	Download
Formats	pdf
Mandatory	No

GetInvoiceInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_pdf	No	int	No	Specifies whether to return the invoice in the PDF format.
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_invoice	No	unsignedLong	No	The unique ID of the invoice record.
invoice_number	No	int	No	Invoice Number - unique identifier of the invoice(in borders if customer).	Min value: 1

GetInvoiceInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
invoice_info	No	InvoiceInfo structure	Yes	Information about the invoice. Also returns the invoice in the PDF format if that was requested.

get_invoice_list

This method allows an API user to get the list of invoice records

Parameters

GetInvoiceListRequest

Return Value

GetInvoiceListResponse

Realm

administrator, reseller, distributor, retail customer, representative

Standalone mode support

Yes

Attachments

Type	Download
Formats	zip
Mandatory	No

GetInvoiceListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
complex_ordering	No	Array of ComplexOrderingInfo structure	No	Orders the retrieved rate data records by multiple fields. Note that either the order_by or the complex_ordering option has effect and the order_by option has higher priority.
covers_date	No	dateTime	No	Return invoices that cover this billing date.
from_date	No	dateTime	No	Fetch invoices with start date of the billing period(period_from) later than this date.
get_arhived_pdfs	No	int	No	Specifies whether to return the archived PDF invoices.
hide_void	No	int	No	Exclude void invoices.
i_customer	No	unsignedLong	No	The unique ID of the customer the invoice belongs to.
i_parent	No	unsignedLong	No	The unique ID of the reseller (to get invoices for all subcustomers of this reseller).
invoice_number	No	int	No	Refers to Invoice Number – unique identifier of the invoice.	Min value: 1
invoice_number_list	No	Array of InvoiceNumberInfo structure	No	The list of invoice numbers to get invoices for.
invoice_status_list	No	Array of InvoiceStatusInfo structure	No	The list of invoice statuses to get invoices for.	Min value: 1
issued_after	No	date	No	Fetch invoices with the 'issue_date' later than this date.
issued_before	No	date	No	Fetch invoices with the 'issue_date' earlier than this date.
limit	Yes	int	No	Limit of invoices (maximum quantity of invoices).
offset	Yes	int	No	Starting position for the invoice list.	Max value: 4294967295
only_pay_required	No	int	No	Deprecated: the option is deprecated in MR87-0 and will be removed in MR91-0. Fetch only invoices which should be paid.
pdf_generated	No	int	No	Fetch only the invoices for which a pdf file has been created.
stage	No	string	No	Shows invoices in a specific phase. Possible values: generated, under_review .	Possible values: generated, under_review
to_date	No	dateTime	No	Fetch invoices with start date of the billing period(period_from) earlier than this date.

GetInvoiceListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
invoice_list	No	Array of InvoiceInfo structure	No	The list of invoices.
invoices_summary	No	CustomerInvoicesSummary structure	Yes	Information about the invoices summary.
total	No	int	No	The number of the retrieved invoices.

get_pay_required_invoices_summary
This method allows an API user to get the summary of the invoice records which should be paid
Parameters	GetPayRequiredInvoicesSummaryRequest
Return Value	GetPayRequiredInvoicesSummaryResponse
Realm	administrator, reseller, distributor, retail customer, representative
Standalone mode support	No

GetPayRequiredInvoicesSummaryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	Refers to the record of a customer.
with_last_invoice_info	No	int	No	Returns extra information about the last issued invoice.
with_last_payment_info	No	int	No	Returns extra information about the last payment applied to an invoice.

GetPayRequiredInvoicesSummaryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
iso_4217	No	string	Yes	ISO4217 code for customer's currency.
last_amount_due	No	float	No	The amount due of the last invoice issued.
last_due_date	No	date	No	The due date of the last invoice issued.
last_payment_amount	No	float	No	The amount of the last payment applied to an invoice.
last_payment_date	No	date	No	The date of the last payment applied to an invoice.
limitation_by_invoice	No	int	Yes	The number of the invoice, due to which customer's status can be changed to 'Limited' after invoice became overdue.
limitation_delayed_till	No	dateTime	Yes	Defines if a limitation is delayed and the customer will be limited later than on 'limitation_on' date.
limitation_on	No	dateTime	Yes	The date when the customer will be Limited due to an overdue invoice.
outstanding_balance	No	float	Yes	The outstanding balance.
overdue_balance	No	float	Yes	The amount which is overdue.
suspension_by_invoice	No	int	Yes	The number of the invoice, due to which customer's status can be changed to 'Suspended' after invoice became overdue.
suspension_delayed_till	No	dateTime	Yes	Defines if a suspension is delayed and the customer will be suspended later than on 'suspension_on' date.
suspension_on	No	dateTime	Yes	The date when the customer will be suspended due to an overdue invoice.

get_status_info
This method enables getting the information about the status of an invoice
Parameters	GetInvoiceStatusInfoRequest
Return Value	GetInvoiceStatusInfoResponse
Realm	administrator
Standalone mode support	Yes

GetInvoiceStatusInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice_status	Yes	unsignedLong	No	The unique ID of the invoice status record.

GetInvoiceStatusInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
status_info	No	InvoiceStatusInfo structure	Yes	The invoice status information.

get_type_info
This method enables getting the information about the type of an invoice
Parameters	GetInvoiceTypeInfoRequest
Return Value	GetInvoiceTypeInfoResponse
Realm	administrator
Standalone mode support	Yes

GetInvoiceTypeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice_type	Yes	unsignedLong	No	The unique ID of the invoice status record.

GetInvoiceTypeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
type_info	No	InvoiceTypeInfo structure	Yes	The invoice type information.

recalculate_invoices
This method allows an API user to recalculate invoices
Parameters	RecalculateInvoicesRequest
Return Value	RecalculateInvoicesResponse
Realm	administrator, reseller
Standalone mode support	No

RecalculateInvoicesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_list	No	ArrayOfInt	No	A list of Customer/Reseller IDs; if omitted, invoices will be recalculated for all applicable customers.	Min value: 1
from_date	Yes	dateTime	No	Recalculate invoices with 'period_from' starting from this date.
only_pdf	No	int	No	Generate new .pdf files according to the current template settings, no figures will be affected.	Max value: 1
void_closed_invoices	No	int	No	Void closed invoices and create them anew, has an effect if the 'only_pdf' option is false.	Max value: 1

RecalculateInvoicesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Specifies whether the invoice has been recalculated. Possible values: 1– The invoice has been successfully recalculated; 0 – The invoice has not been recalculated.

regenerate_invoice
This method enables an API user to store an invoice PDF creation task
Parameters	RegenerateInvoiceRequest
Return Value	RegenerateInvoiceResponse
Realm	administrator, reseller
Standalone mode support	No

RegenerateInvoiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

RegenerateInvoiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

regenerate_invoice_list
This method enables an API user to regenerate a list of invoice PDF files
Parameters	RegenerateInvoicePDFListRequest
Return Value	RegenerateInvoicePDFListResponse
Realm	administrator, reseller
Standalone mode support	No

RegenerateInvoicePDFListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
invoice_list	Yes	Array of RegenerateInvoicePDFInfo structure	No	A list of invoices to regenerate PDF files for.	Min value: 1

RegenerateInvoicePDFListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

review_invoice
This method allows an API user to either approve or regenerate under review invoices
Parameters	ReviewInvoiceRequest
Return Value	ReviewInvoiceResponse
Realm	administrator, reseller
Standalone mode support	No

ReviewInvoiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	The action to be applied to this invoice. Possible values: approve, regenerate.	Possible values: approve, regenerate
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.
postponed	No	int	No	Specifies whether to schedule delivery of approved invoices to customers / regeneration of selected invoices for off-peak.	Max value: 1

ReviewInvoiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

review_invoice_list
This method enables an API user to either approve or regenerate invoices under review
Parameters	ReviewInvoiceListRequest
Return Value	ReviewInvoiceListResponse
Realm	administrator, reseller
Standalone mode support	No

ReviewInvoiceListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
invoice_list	Yes	Array of ReviewInvoiceInfo structure	No	A list of invoices to review.	Min value: 1

ReviewInvoiceListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception error message in case of failure.

set_invoice_state
This method allows an API user to change an invoice status (either opened or closed).
Parameters	SetInvoiceStateRequest
Return Value	SetInvoiceStateResponse
Realm	administrator, reseller
Standalone mode support	No

SetInvoiceStateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.
state	Yes	string	No	Change the invoice state to either of these: opened, closed.	Possible values: closed, opened

SetInvoiceStateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

void_invoice
This method allows an API user to void an invoice. It sometimes happens that an error is detected after an invoice has been generated and delivered to the customer. A new invoice must be produced, but the old one must be kept for audit purposes. The void invoice operation marks the invoice as canceled (this will also be visible in the PDF file), and then a new invoice is automatically produced Asynchronous only
Parameters	VoidInvoiceRequest
Return Value	VoidInvoiceResponse
Realm	administrator, reseller
Standalone mode support	No
Mode	Asyncronous only

VoidInvoiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

VoidInvoiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique ID of the invoice record.

Template management

get_template_list
This method allows an API user to get the list of invoice template records
Parameters	GetInvoiceTemplateListRequest
Return Value	GetInvoiceTemplateListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetInvoiceTemplateListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API reques.	Max value: 4294967295

GetInvoiceTemplateListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
template_list	Yes	Array of TemplateInfo structure	No	The list of the retrieved invoice templates.
total	Yes	int	No	The number of the retrieved invoice templates.

IPTV packages information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/IPTV

Channel package management

get_channel_package_list
A channel package is a set of IPTV channels available within this package (e.g. a Basic channel package includes only local TV channels while a Gold package also includes sport, movie, music and news channels). Use this method to retrieve the list of IPTV channel packages imported in PortaBilling
Parameters	GetIPTVChannelPackageListRequest
Return Value	GetIPTVChannelPackageListResponse
Realm	administrator
Standalone mode support	Yes

GetIPTVChannelPackageListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
channel_package_list	No	Array of IptvChannelPackageFilter structure	No	Filters for IPTV channel packages.
provider_name	No	string	No	Provider name pattern. Used for retrieving a set of IPTV channel packages by the provider name.

GetIPTVChannelPackageListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
package_list	Yes	Array of IPTVChannelPackage structure	No	The list of IPTV channel packages.

Service package management

get_service_package_list
A service package is a set of auxiliary IPTV services such as pay per view or video on demand, multi-platform player, etc. Use this method to retrieve the list of IPTV service packages imported in PortaBilling
Parameters	GetIPTVServicePackageListRequest
Return Value	GetIPTVServicePackageListResponse
Realm	administrator
Standalone mode support	Yes

GetIPTVServicePackageListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetIPTVServicePackageListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
package_list	Yes	Array of IPTVServicePackage structure	No	The list of IPTV service packages.

IVR applications information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/IVRApplications

Access number management

add_access_number
This method enables an API user to add the IVR access number
Parameters	AddAccessNumberRequest
Return Value	AddAccessNumberResponse
Realm	administrator
Standalone mode support	No

AddAccessNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_number_info	Yes	AccessNumberInfo structure	No	IVR access number information.

AddAccessNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ivr_an	Yes	unsignedLong	No	The unique ID of the IVR access number.

add_access_number_list
This method enables an API user to add the IVR access numbers list
Parameters	AddAccessNumberListRequest
Return Value	AddAccessNumberListResponse
Realm	administrator
Standalone mode support	No

AddAccessNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_number_list	Yes	Array of AccessNumberInfo structure	No	The list of IDs of the access numbers that will be moved to the cloned IVR application.	Min value: 1
i_voice_app_access_number	Yes	unsignedLong	No	The unique ID of the IVR application.

AddAccessNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	unsignedLong	No	1 in case of success.

delete_access_number
This method enables an API user to delete the IVR access number
Parameters	DeleteAccessNumberRequest
Return Value	DeleteAccessNumberResponse
Realm	administrator
Standalone mode support	No

DeleteAccessNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ivr_an	Yes	unsignedLong	No	The unique ID of the IVR access number.

DeleteAccessNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success.

get_access_number_info
This method enables an API user to get the IVR access number information
Parameters	GetAccessNumberInfoRequest
Return Value	GetAccessNumberInfoResponse
Realm	administrator
Standalone mode support	Yes

GetAccessNumberInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ivr_an	Yes	unsignedLong	No	The unique ID of the IVR access number.

GetAccessNumberInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_number_info	Yes	AccessNumberInfo structure	No	IVR access number information.

get_access_number_list
This method enables an API user to get the list of IVR access numbers
Parameters	GetAccessNumberListRequest
Return Value	GetAccessNumberListResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetAccessNumberListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check the usage of the IVR access number.
get_total	No	int	No	Include the total number of the records.
i_account	No	unsignedLong	No	The unique ID of the account record.
i_voice_app_access_number	No	unsignedLong	No	The ID of the corressponding IVR application.
limit	No	int	No	The number of records to retrieve.
number_pattern	No	string	No	The pattern for matching the CLD.
offset	No	int	No	The number of records to skip at the beginning.	Default value: 0

GetAccessNumberListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_number_list	Yes	Array of AccessNumberInfo structure	No	The list of IVR access number records.
total	No	int	No	The total number of records.

update_access_number
This method allows an API user to update the IVR access number
Parameters	UpdateAccessNumberRequest
Return Value	UpdateAccessNumberResponse
Realm	administrator
Standalone mode support	No

UpdateAccessNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
access_number_info	Yes	AccessNumberInfo structure	No	IVR access number information.

UpdateAccessNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ivr_an	Yes	unsignedLong	No	The unique ID of the IVR access number.

Application management

add_ivr_application
This method enables an API user to add the IVR application
Parameters	AddIvrApplicationRequest
Return Value	AddIvrApplicationResponse
Realm	administrator
Standalone mode support	No

AddIvrApplicationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ivr_application_info	Yes	IvrApplicationInfo structure	No	IVR application information.

AddIvrApplicationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_app_access_number	Yes	unsignedLong	No	The unique ID of the IVR application.

clone_ivr_application
This method enables an API user to clone the IVR application
Parameters	CloneIvrApplicationRequest
Return Value	CloneIvrApplicationResponse
Realm	administrator
Standalone mode support	No

CloneIvrApplicationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the IVR application.
i_voice_app_access_number	Yes	unsignedLong	No	The unique ID of the IVR application.
move_access_numbers	No	Array of AccessNumberInfo structure	No	The list of IDs of the access numbers that will be moved to the cloned IVR application.
name	Yes	string	No	The name of the IVR application.

CloneIvrApplicationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
access_numbers	No	Array of AccessNumberInfo structure	No	IVR access numbers information.
ivr_application_info	No	IvrApplicationInfo structure	No	IVR application information.

delete_ivr_application
This method enables an API user to delete the IVR application
Parameters	DeleteIvrApplicationRequest
Return Value	DeleteIvrApplicationResponse
Realm	administrator
Standalone mode support	No

DeleteIvrApplicationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_app_access_number	Yes	unsignedLong	No	The unique ID of the IVR access number.

DeleteIvrApplicationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success.

get_conference_settings
This method enables an API user to get a list of conference room parameters
Parameters	GetConferenceSettingsRequest
Return Value	GetConferenceSettingsResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetConferenceSettingsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetConferenceSettingsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
conf_max_participants_num	No	int	No	Specifies the maximum number of participants allowed for the conference.

get_ivr_application_info
This method enables an API user to get the IVR application information
Parameters	GetIvrApplicationInfoRequest
Return Value	GetIvrApplicationInfoResponse
Realm	administrator
Standalone mode support	Yes

GetIvrApplicationInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_app_access_number	Yes	unsignedLong	No	The unique ID of the IVR application.

GetIvrApplicationInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ivr_application_info	No	IvrApplicationInfo structure	No	IVR application information.

get_ivr_application_list
This method enables an API user to get the list of IVR applications
Parameters	GetIvrApplicationListRequest
Return Value	GetIvrApplicationListResponse
Realm	administrator
Standalone mode support	Yes

GetIvrApplicationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the IVR application.
get_total	No	int	No	Include the total number of records.
i_voice_application	No	unsignedLong	No	The ID of the corresponding voice application.
limit	No	int	No	The number of records to retrieve.
name	No	string	No	The name of the IVR application.
number_pattern	No	string	No	The pattern for matching the CLD of the assigned access numbers.
offset	No	int	No	The number of records to skip at the beginning.	Default value: 0
with_callbacks	No	int	No	Specifies whether the WEB, SMS, Email callbacks should be included in the response. If set to 1, External callbacks will be added to the response. The default value is 0, which means the response will not contain these records.	Default value: 0

GetIvrApplicationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ivr_application_list	Yes	Array of IvrApplicationInfo structure	No	The list of IVR application records.
total	No	int	No	The total number of the records.

get_ivr_option_list
This method enables an API user to get the list of all IVR application options
Parameters	GetIvrOptionListRequest
Return Value	GetIvrOptionListResponse
Realm	administrator
Standalone mode support	Yes

GetIvrOptionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_application	No	unsignedLong	No	The ID of the voice application.

GetIvrOptionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
option_list	No	Array of VoiceApplicationOptionInfo structure	No	Voice application options.

get_supported_language_list
This method enables an API user to get the list of available languages for voice applications
Parameters	GetSupportedLanguageRequest
Return Value	GetSupportedLanguageResponse
Realm	administrator
Standalone mode support	Yes

GetSupportedLanguageRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_application	No	unsignedLong	No	The ID of the voice application.

GetSupportedLanguageResponse
Property	Mandatory	Type	Nillable	Description	Possible values
supported_language_list	Yes	Array of SupportedLanguageInfo structure	No	The list of supported languages.

get_voice_application_list
This method enables an API user to get the list of voice applications
Parameters	GetVoiceApplicationListRequest
Return Value	GetVoiceApplicationListResponse
Realm	administrator
Standalone mode support	Yes

GetVoiceApplicationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetVoiceApplicationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
voice_application_list	Yes	Array of VoiceApplicationInfo structure	No	The list of voice application records.

update_ivr_application
This method enables an API user to update the IVR application
Parameters	UpdateIvrApplicationRequest
Return Value	UpdateIvrApplicationResponse
Realm	administrator
Standalone mode support	No

UpdateIvrApplicationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ivr_application_info	Yes	IvrApplicationInfo structure	No	IVR application information.

UpdateIvrApplicationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_app_access_number	Yes	unsignedLong	No	The unique ID of the IVR application.

IVR user application management

obtain_access_number
This method enables an API user to assign a random IVR access number to an account
Parameters	ObtainAccessNumberRequest
Return Value	ObtainAccessNumberResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

ObtainAccessNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account record.

ObtainAccessNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ivr_an	Yes	unsignedLong	No	The unique ID of the IVR access number record.

release_access_number
This method enables an API user to release an IVR access number from an account
Parameters	ReleaseAccessNumberRequest
Return Value	ReleaseAccessNumberResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

ReleaseAccessNumberRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ivr_an	Yes	unsignedLong	No	The unique ID of the IVR access number record.

ReleaseAccessNumberResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

Measured services information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/MeasuredServices

Customer class metric management

add_customer_class_metric
This method allows an API user to add a new measured service for a customer class
Parameters	AddUpdateCustomerClassMetricRequest
Return Value	AddUpdateCustomerClassMetricResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateCustomerClassMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_class_metric_info	Yes	CustomerClassMetricInfo structure	No	Customer Class Metric info.

AddUpdateCustomerClassMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer calss.

delete_customer_class_metric
This method allows an API user to delete a customer class's measured service
Parameters	DeleteCustomerClassMetricRequest
Return Value	DeleteCustomerClassMetricResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerClassMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
i_measured_metric	Yes	unsignedLong	No	The unique ID of the measured service.

DeleteCustomerClassMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 – If success, 0 – In case of failure.

get_customer_class_metrics_list
This method allows an API user to retrieve measured services for a customer class
Parameters	GetCustomerClassMetricListRequest
Return Value	GetCustomerClassMetricListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerClassMetricListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295

GetCustomerClassMetricListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
metrics	Yes	Array of CustomerClassMetricInfo structure	Yes	The customer class measured service info.
total	No	int	No	The total number of metrics found.

update_customer_class_metric
This method allows an API user to update a measured service for a customer class
Parameters	AddUpdateCustomerClassMetricRequest
Return Value	AddUpdateCustomerClassMetricResponse
Realm	administrator, reseller
Standalone mode support	No

Customer metric management

add_customer_metric
This method allows an API user to add a new measured service for a customer
Parameters	AddUpdateCustomerMetricRequest
Return Value	AddUpdateCustomerMetricResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateCustomerMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
customer_metric_info	Yes	CustomerMetricInfo structure	No	The customer measured service info.

AddUpdateCustomerMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.

delete_customer_metric
This method allows an API user to delete a customer's measured service
Parameters	DeleteCustomerMetricRequest
Return Value	DeleteCustomerMetricResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteCustomerMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer.
i_measured_metric	Yes	unsignedLong	No	The unique ID of the measured service.

DeleteCustomerMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 – If success, 0 – In case of failure.

get_customer_metrics_list
This method allows an API user to retrieve measured services for a customer
Parameters	GetCustomerMetricListRequest
Return Value	GetCustomerMetricListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetCustomerMetricListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer for which list of measured services should be retrieved. Not mandatory when the method that requires this structure is executed from the retail customer realm.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295

GetCustomerMetricListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
metrics	Yes	Array of CustomerMetricInfo structure	Yes	A list of customer’s measured services.
total	No	int	No	The total number of retrieved measured services.

update_customer_metric
This method allows an API user to update a measured service for a customer
Parameters	AddUpdateCustomerMetricRequest
Return Value	AddUpdateCustomerMetricResponse
Realm	administrator, reseller
Standalone mode support	No

Measured metric management

add_measured_metric
This method enables an API user to add a new measured metric
Parameters	AddMeasuredMetricRequest
Return Value	AddMeasuredMetricResponse
Realm	administrator
Standalone mode support	No

AddMeasuredMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
measured_metric_info	Yes	MeasuredMetricInfo structure	No	Information about the measured metric that can contain the name and description.

AddMeasuredMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_measured_metric	Yes	unsignedLong	No	The unique ID of the measured metric.

delete_measured_metric
This method enables an API user to delete a measured metric
Parameters	DeleteMeasuredMetricRequest
Return Value	DeleteMeasuredMetricResponse
Realm	administrator
Standalone mode support	No

DeleteMeasuredMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_measured_metric	Yes	unsignedLong	No	The unique ID of the measured metric.

DeleteMeasuredMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 for success, 0 in case of failure.

update_measured_metric
This method enables an API user to update a measured metric
Parameters	UpdateMeasuredMetricRequest
Return Value	UpdateMeasuredMetricResponse
Realm	administrator
Standalone mode support	No

UpdateMeasuredMetricRequest
Property	Mandatory	Type	Nillable	Description	Possible values
measured_metric_info	Yes	MeasuredMetricInfo structure	No	Information about the measured metric that can contain the unique metric ID, name and description.

UpdateMeasuredMetricResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 for success, 0 in case of failure.

Measured service management

get_measured_metrics_list
This method allows an API user to retrieve a list of measured services
Parameters	GetMeasuredMetricsListRequest
Return Value	GetMeasuredMetricsListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetMeasuredMetricsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	Enables retrieving the measured metrics list by name.

GetMeasuredMetricsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
metrics_list	Yes	Array of MeasuredMetricsInfo structure	Yes	A list of measured services.

get_metric_charge_methods_list
This method allows an API user to retrieve charge methods for measured services
Parameters	GetChargeMethodsListRequest
Return Value	GetChargeMethodsListResponse
Realm	administrator, reseller, retail customer
Standalone mode support	Yes

GetChargeMethodsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	Enables retrieving the charge methods list by name.

GetChargeMethodsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
charge_methods_list	Yes	Array of ChargeMethodsInfo structure	Yes	The List of Charge Methods.

Metric information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Metric

Measured metric management

get_measured_metric_data_list
This method enables an API user to get data related to the selected measured metrics
Parameters	GetMeasuredMetricDataRequest
Return Value	GetMeasuredMetricDataResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetMeasuredMetricDataRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_from	Yes	dateTime	No	The start of the date and time interval for the metric data to be fetched.
date_to	No	dateTime	No	The end of the date and time interval for the metric data to be fetched (the current date and time is picked if the field is left empty).	Default value: current date and time
i_measured_metric	Yes	unsignedLong	No	The unique ID of the measured metric.
i_object	Yes	unsignedLong	No	The unique identifier of the object.
object	Yes	string	No	The type of object to which the retrieval of measurement data is applied. Possible values: 'account', 'customer'.	Possible values: account, customer
with_child_records	No	int	No	The field indicates the depth of the method retrieval, for example, for a customer, all associated account records and customer records will be returned if the value of this field is 1, otherwise only customer data records will be returned.	Default value: 0 Max value: 1 Min value: 0

GetMeasuredMetricDataResponse
Property	Mandatory	Type	Nillable	Description	Possible values
measured_metric_data_list	No	Array of MetricDataInfo structure	No	The list of measured metric data, grouped by the metric name.

Measured service management

add_measured_metric_data
This method enables an API user to add one or more measured metrics into the system
Parameters	AddMeasuredMetricDataRequest
Return Value	AddMeasuredMetricDataResponse
Realm	administrator, reseller
Standalone mode support	No

AddMeasuredMetricDataRequest
Property	Mandatory	Type	Nillable	Description	Possible values
metric_info	Yes	MeasuredMetricDataInfo structure	No	The measured metrics meta information that contains a unique identifier for the metric, the object, and the measured data.

AddMeasuredMetricDataResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, 0 in case of failure.

upload_measured_metric_data

This method enables an API user to upload measured metrics data into the system as a file

Parameters

UploadMeasuredMetricDataRequest

Return Value

UploadMeasuredMetricDataResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	csv, xlsx, xls
Mandatory	Yes

UploadMeasuredMetricDataRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_measured_metric	Yes	unsignedLong	No	The unique identifier of the measured metric.
i_object	Yes	unsignedLong	No	The unique identifier of the object.
object	Yes	string	No	The type of object to which the measurement data upload is applied. Possible values: 'account', 'customer'.	Possible values: account, customer

UploadMeasuredMetricDataResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, 0 in case of failure.

System metric management

get_system_metric_data
This method enables an API user to get data related to the selected system metrics
Parameters	GetSystemMetricDataRequest
Return Value	GetSystemMetricDataResponse
Realm	administrator
Standalone mode support	Yes

GetSystemMetricDataRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_from	Yes	dateTime	No	The start of the date-time interval for the metric data to be fetched.
date_to	No	dateTime	No	The end of the date-time interval for the metric data to be fetched (current date-time is picked if the field is left empty).	Default value: current date and time
metric_list	Yes	Array of MetricInputInfo structure	No	A list of criteria to fetch the system metric data. The field shows the metrics to fetch data from.	Min value: 1

GetSystemMetricDataResponse
Property	Mandatory	Type	Nillable	Description	Possible values
system_metric_data_list	No	Array of SystemMetricDataInfo structure	No	A set of system metric data.

MOH information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/MOH

Music on hold file management

get_moh_file

This method enables the API user to download custom MOH file from the system.

Parameters

GetMOHFileRequest

Return Value

GetMOHFileResponse

Realm

administrator

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

GetMOHFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_moh	Yes	unsignedLong	No	The unique ID of the MOH record.

GetMOHFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 in case of success, 0 in case of failure.

upload_moh_file

This method enables an API user to upload and apply a new MOH file to an account or customer.

Parameters

UploadMOHFileRequest

Return Value

UploadMOHFileResponse

Realm

administrator

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	Yes

UploadMOHFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_object	Yes	unsignedLong	No	The unique ID of an account or a customer.
name	Yes	string	No	MOH record name.	Max value: 64
object	Yes	string	No	The type of entity (account/customer) to which the MOH file is applied.	Possible values: account, customer

UploadMOHFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_moh	Yes	unsignedLong	No	The unique ID of the MOH record.

Negotiated features information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/NegotiatedFeatures

Negotiated feature management

get_negotiated_feature_list
This method enables an API user to fetch the list of the negotiated features applied to a routing plan or connection
Parameters	GetNegotiatedFeatureListRequest
Return Value	GetNegotiatedFeatureListResponse
Realm	administrator
Standalone mode support	Yes

GetNegotiatedFeatureListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_object	No	unsignedLong	Yes	The unique ID of a routing plan or connection.
object	Yes	string	No	The entity the negotiated features belong to.	Possible values: connection, routing_plan

GetNegotiatedFeatureListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
negotiated_feature_list	No	Array of NegotiatedFeatureInfo structure	No	The list of the negotiated features.

update_negotiated_feature_list
{This method enables an API user to update the list of the negotiated features applied to a routing plan or connection
Parameters	UpdateNegotiatedFeatureListRequest
Return Value	UpdateNegotiatedFeatureListResponse
Realm	administrator
Standalone mode support	No

UpdateNegotiatedFeatureListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_object	No	unsignedLong	Yes	The unique ID of a routing plan or connection.
negotiated_feature_list	Yes	Array of NegotiatedFeatureInfo structure	No	The list of the negotiated features.
object	Yes	string	No	The entity the negotiated features belong to.	Possible values: connection, routing_plan

UpdateNegotiatedFeatureListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

Node information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Node

Node management

add_node
This method enables an API user to add a node
Parameters	AddNodeRequest
Return Value	AddNodeResponse
Realm	administrator
Standalone mode support	No

AddNodeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
node_info	Yes	NodeInfo structure	No	Full information about a new node.

AddNodeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_node	Yes	unsignedLong	No	The unique ID of the node.

delete_node
This method enables an API user to delete a node
Parameters	DeleteNodeRequest
Return Value	DeleteNodeResponse
Realm	administrator
Standalone mode support	No

DeleteNodeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_node	Yes	unsignedLong	No	The unique ID of the node.

DeleteNodeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

get_node_info
This method allows an API user to get a node record from the database
Parameters	GetNodeInfoRequest
Return Value	GetNodeInfoResponse
Realm	administrator
Standalone mode support	Yes

GetNodeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the node is in use.
i_node	No	unsignedLong	No	The unique ID of the node.

GetNodeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
node_info	No	NodeInfo structure	Yes	Set of node data records.

get_node_list
This method allows an API user to get the list of nodes
Parameters	GetNodeListRequest
Return Value	GetNodeListResponse
Realm	administrator
Standalone mode support	Yes

GetNodeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
aaa_protocol	No	string	No	Describes the AAA protocol used to communicate with the node.	Possible values: disabled, RADIUS, DIAMETER
check_usage	No	int	No	Check whether the nodes in the response are in use.
complex_ordering	No	Array of ComplexOrderingInfo structure	No	Enables sorting the resulting list by a specific field.
get_total	No	string	No	Get the total number of the retrieved records.
h323_id	No	string	No	For a VoIP node, this is equivalent to a hostname for an internet server (e.g. mail1.cyberdyne.com), i.e. a descriptive, human-readable name used for identification purposes. Expected input: a string that can contain a-z, A-Z, 0-9 and '.', '_', '-' symbols. It cannot be larger than 253 symbols. The UI equivalent of this field is the "Node ID" field on the "Create Node" panel.
i_node_type	No	unsignedLong	Yes	The unique ID of the node type.
ip	No	string	No	The IP address of the node.
limit	No	int	No	The number of records to retrieve.
manufacturer	No	string	No	The manufacturer of the node.
name	No	string	No	The logical name of the node.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
type	No	string	No	The node type.
voip_dynamic_routing	No	string	No	Specifies whether the node type supports VoIP dynamic routing.	Possible values: Y, N

GetNodeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
node_list	No	Array of NodeInfo structure	Yes	Set of node data records.
total	No	int	No	The total number of the retrieved records.

get_node_type_list
This method enables an API user to get the list of node types
Parameters	GetNodeTypeListRequest
Return Value	GetNodeTypeListResponse
Realm	administrator
Standalone mode support	Yes

GetNodeTypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetNodeTypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
node_type_list	No	Array of NodeTypeInfo structure	Yes	The list of node types.

update_node
This method enables an API user to update a node
Parameters	UpdateNodeRequest
Return Value	UpdateNodeResponse
Realm	administrator
Standalone mode support	No

UpdateNodeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
node_info	Yes	NodeInfo structure	No	Updated information about the node.

UpdateNodeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_node	Yes	unsignedLong	No	The unique ID of the node.

Notification information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Notification

Notification management

add_notification_preset
This method enables an API user to add a notification preset
Parameters	AddUpdateNotificationPresetRequest
Return Value	AddUpdateNotificationPresetResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateNotificationPresetRequest
Property	Mandatory	Type	Nillable	Description	Possible values
notification_preset_info	Yes	NotificationPresetInfo structure	No	The information about the notification preset.

AddUpdateNotificationPresetResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.

delete_notification_preset
This method enables an API user to delete a notification preset
Parameters	DeleteNotificationPresetRequest
Return Value	DeleteNotificationPresetResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteNotificationPresetRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.

DeleteNotificationPresetResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

get_notification_list
This method enables an API user to get the list of notifications
Parameters	GetNotificationListRequest
Return Value	GetNotificationListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.

GetNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_list	No	Array of NotificationInfo structure	No	The set of notification presets.

get_notification_preset_info
This method enables an API user to get the information about the notification preset
Parameters	GetNotificationPresetInfoRequest
Return Value	GetNotificationPresetInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetNotificationPresetInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.

GetNotificationPresetInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_preset_info	No	NotificationPresetInfo structure	No	The information about the notification preset.

get_notification_preset_list
This method enables an API user to get the list of notification presets
Parameters	GetNotificationPresetListRequest
Return Value	GetNotificationPresetListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetNotificationPresetListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	The flag shows whether to include the usage flag.
get_total	No	int	No	Get the total number of the retrieved records.
i_customer	No	unsignedLong	No	The identifier of the reseller who manages the preset.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The notification preset name.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
type	No	string	No	The type of the preset.	Possible values: user, customer_class

GetNotificationPresetListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_preset_list	No	Array of NotificationPresetInfo structure	No	The set of notification presets.
total	No	int	No	The total number of the retrieved records.

get_notification_template_info
This method enables an API user to get the information about the notification template
Parameters	GetNotificationTemplateInfoRequest
Return Value	GetNotificationTemplateInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetNotificationTemplateInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.
name	Yes	string	No	The notification template name.

GetNotificationTemplateInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_template_info	No	NotificationTemplateInfo structure	No	The information about the notification preset.

get_preset_category_list
This method enables an API user to get the list of notification preset categories
Parameters	GetPresetCategoryListRequest
Return Value	GetPresetCategoryListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetPresetCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.

GetPresetCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
category_list	No	Array of NotificationPresetCategoryInfo structure	No	The set of notification preset categories.

send_me_notification_sample
This method enables an API user to test the notification by sending a message sample to their email address or phone number. The notification is sent to the user that is currently logged in
Parameters	SendMeNotificationSampleRequest
Return Value	SendMeNotificationSampleResponse
Realm	administrator, reseller
Standalone mode support	Yes

SendMeNotificationSampleRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_preset	Yes	unsignedLong	No	The unique identifier of the notification preset.
message_type	Yes	string	No	The type of the notification. Possible values: sms, mail.	Possible values: mail, sms
name	Yes	string	No	The notification name.

SendMeNotificationSampleResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

update_notification_preset
This method enables an API user to update a notification preset
Parameters	AddUpdateNotificationPresetRequest
Return Value	AddUpdateNotificationPresetResponse
Realm	administrator, reseller
Standalone mode support	No

update_notification_template
This method enables an API user to update information about a notification template
Parameters	UpdateNotificationTemplateInfoRequest
Return Value	UpdateNotificationTemplateInfoResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateNotificationTemplateInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
notification_template_info	Yes	NotificationTemplateInfo structure	No	The information about the notification template.

UpdateNotificationTemplateInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
authorship	No	string	No	Specifies whether the template has been modified. Possible values: System - The template has not been modified, Custom - The template has been modified.
is_updated	Yes	int	No	Specifies whether the notification template was updated. Possible values: 1 - The notification template was updated, 0 - The notification template was not updated.

Number porting information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/NumberPorting

Number porting management

add_netnumber_info
This method enables an API user to save information about created and terminated accounts into the storage in the NetNumber format
Parameters	AddNetnumberInfoRequest
Return Value	AddNetnumberInfoResponse
Realm	administrator, reseller
Standalone mode support	No

AddNetnumberInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
numbers_list	Yes	Array of NetnumberInfo structure	No	The list of numbers to be updated in the NetNumber database.	Min value: 1

AddNetnumberInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

cancel_request
This method allows an API user to cancel the number porting request
Parameters	CancelRequestRequest
Return Value	CancelRequestResponse
Realm	administrator, reseller
Standalone mode support	No

CancelRequestRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_request	Yes	unsignedLong	No	The unique ID of the number porting request.

CancelRequestResponse
Property	Mandatory	Type	Nillable	Description	Possible values
porting_request_info	No	PortingRequestInfo structure	No	Complete information about the porting request.

create_portin_request
This method allows an API user to create a number porting request
Parameters	CreatePortInRequestRequest
Return Value	CreatePortInRequestResponse
Realm	administrator, reseller
Standalone mode support	No

CreatePortInRequestRequest
Property	Mandatory	Type	Nillable	Description	Possible values
due_date	No	date	No	The date by which the customer's request must be completed.
i_account	No	unsignedLong	No	The unique ID of the account the request relates to.
porting_number	No	string	No	The number being ported.	Max value: 128 Min value: 1
request_parameters	No	Array of PortingRequestParameterInfo structure	No	The list of objects for the porting request.

CreatePortInRequestResponse
Property	Mandatory	Type	Nillable	Description	Possible values
porting_request_info	No	PortingRequestInfo structure	No	Complete information about the porting request.

get_request_info
This method allows an API user to get the number porting request information
Parameters	GetPortingRequestRequest
Return Value	GetPortingRequestResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetPortingRequestRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account the request relates to.
i_request	No	unsignedLong	No	The unique ID of the number porting request.

GetPortingRequestResponse
Property	Mandatory	Type	Nillable	Description	Possible values
porting_request_info	No	PortingRequestInfo structure	No	Complete information about the porting request.

get_request_list
This method allows an API user to get the list of number porting requests
Parameters	GetRequestListRequest
Return Value	GetRequestListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRequestListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID of the account to search the porting request by.
due_date_from	No	dateTime	No	Search requests with the due_date starting from this date and time.
due_date_to	No	dateTime	No	Search requests with the due_date before this date and time.
get_total	No	int	No	Get the total number of the retrieved records.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
porting_number	No	string	No	The number being ported to search the porting request by.
status	No	string	No	The current processing status of the porting request to search by.
type	No	string	No	Porting request type Possible values: PORTIN (default); PORTOUT.	Default value: PORTIN Possible values: PORTIN, PORTOUT

GetRequestListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
porting_request_list	No	Array of PortingRequestInfo structure	No	A list of porting request objects.
total	No	int	No	The total number of the retrieved records.

modify_request
This method allows an API user to modify the number porting request
Parameters	ModifyRequestRequest
Return Value	ModifyRequestResponse
Realm	administrator, reseller
Standalone mode support	No

ModifyRequestRequest
Property	Mandatory	Type	Nillable	Description	Possible values
porting_request_info	No	PortingRequestInfo structure	No	Complete information about the porting request.

ModifyRequestResponse
Property	Mandatory	Type	Nillable	Description	Possible values
porting_request_info	No	PortingRequestInfo structure	No	Complete information about the porting request.

Offpeak period information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/OffPeak

Off-peak period management

get_off_peak_list
This method enables an API user to retrieve the list of off-peak periods
Parameters	GetOffPeakListRequest
Return Value	GetOffPeakListResponse
Realm	administrator
Standalone mode support	Yes

GetOffPeakListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	Yes	The unique ID of the reseller record (managed by).

GetOffPeakListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
off_peak_list	No	Array of OffPeakInfo structure	No	Set of off-peak data records.

Originating line information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/OLI

OLI management

get_oli_info
This method allows an API user to get an OLI record from the database
Parameters	GetOliInfoRequest
Return Value	GetOliInfoResponse
Realm	administrator
Standalone mode support	Yes

GetOliInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_oli	No	unsignedLong	No	The unique ID of the OLI record.

GetOliInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
oli_info	Yes	OliInfo structure	No	The OLI info.

get_oli_list
This method allows an API user to get the list of OLI
Parameters	GetOliListRequest
Return Value	GetOliListResponse
Realm	administrator
Standalone mode support	Yes

GetOliListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
oli	No	int	No	Enables retrieving the OLI list by oli.

GetOliListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
oli_list	Yes	Array of OliInfo structure	No	The list of OLI records.

Payment information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Payment

Merchant account management

add_merchant
This method allows an API user to add a payment or payment remittance system
Parameters	AddMerchantAccountRequest
Return Value	AddMerchantAccountResponse
Realm	administrator, reseller
Standalone mode support	No

AddMerchantAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Specifies whether the added record will be returned in response or not.
merchant_account	Yes	MerchantAccount structure	No	The Complete information about the payment or payment remittance system.

AddMerchantAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_merchant_account	Yes	unsignedLong	No	The unique ID of the Merchant_Account record.
merchant_account	No	MerchantAccount structure	No	The complete information about the payment or payment remittance system (a payment or payment remittance system to be added).

delete_merchant
This method allows an API user to delete a payment or payment remittance system
Parameters	DeleteMerchantAccountRequest
Return Value	DeleteMerchantAccountResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteMerchantAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_merchant_account	Yes	unsignedLong	No	The unique ID of the Merchant_Account record to be deleted.

DeleteMerchantAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_merchant
This method allows an API user to get a payment or payment remittance system data.
Parameters	GetMerchantAccountRequest
Return Value	GetMerchantAccountResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetMerchantAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_merchant_account	Yes	unsignedLong	No	The unique ID of the Merchant_Account record (a payment or payment remittance system to be shown).

GetMerchantAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
merchant_account	Yes	MerchantAccount structure	No	The complete information about the payment or payment remittance system.

list_merchants
This method allows an API user to obtain the list of avalilable payment and payment remittance systems for a given customer
Parameters	ListMerchantAccountsRequest
Return Value	ListMerchantAccountsResponse
Realm	administrator, reseller
Standalone mode support	Yes

ListMerchantAccountsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique Customer ID to list payment systems for.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Max value: 4294967295
remittance	No	int	No	Specifies whether to show payment remittance systems.

ListMerchantAccountsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
merchant_accounts	Yes	Array of MerchantAccount structure	No	The list of payment and payment remittance systems.
total	No	int	No	The total number of the retrieved payment and payment remittance systems records.

update_merchant
This method allows an API user to update a payment or payment remittance system
Parameters	UpdateMerchantAccountRequest
Return Value	UpdateMerchantAccountResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateMerchantAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Specifies whether updated record will be returned in response or not.
merchant_account	Yes	MerchantAccount structure	No	The complete information about the payment or payment remittance system.

UpdateMerchantAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_merchant_account	Yes	unsignedLong	No	The unique ID of the Merchant_Account record.
merchant_account	No	MerchantAccount structure	No	The complete information about the payment or payment remittance system.

Payment method management

get_payment_methods_for_owner
This method allows an API user to obtain a list of avalilable payment methods and processors for a given entity's currency.
Parameters	GetPaymentMethodsForOwnerRequest
Return Value	GetPaymentMethodsForOwnerResponse
Realm	administrator, reseller, retail customer, account, representative
Standalone mode support	Yes

GetPaymentMethodsForOwnerRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_owner	No	unsignedLong	No	The unique ID of the entity (e.g. i_account, i_customer). Used to get results for another entity.
owner_type	No	string	No	A symbolic title of system entity. Used when calling entity wants to get result for other entity. Possible values: 'Customer', 'Account'.	Possible values: Account, Customer

GetPaymentMethodsForOwnerResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_methods	No	Array of PaymentSystemInfo structure	Yes	The list of avalilable payment methods and processors for a given entity’s currency.

Processor management

get_processor
This method allows an API user to get a payment processor data
Parameters	GetPaymentProcessorRequest
Return Value	GetPaymentProcessorResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetPaymentProcessorRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_online_payment_processor	Yes	unsignedLong	No	The unique payment processor ID.

GetPaymentProcessorResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_processor	Yes	PaymentProcessor structure	No	The complete information about the payment processor.

list_processors
This method allows an API user to get a list of payment processors.
Parameters	ListPaymentProcessorsRequest
Return Value	ListPaymentProcessorsResponse
Realm	administrator, reseller
Standalone mode support	Yes

ListPaymentProcessorsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
remittance	No	int	No	Specifies whether a payment or a payment remittance system is to be shown.

ListPaymentProcessorsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_processors	Yes	Array of PaymentProcessor structure	No	The list of payment processor records.

Transaction management

finalize_transaction
This method enables an API user to update the pending payment transaction status with actual info received from the payment processor. If the transaction status is successful, the transaction amount will be applied to the customer's / account's balance
Parameters	FinalizeTransactionRequest
Return Value	FinalizeTransactionResponse
Realm	administrator, reseller, retail customer, account, cc staff, distributor, representative
Standalone mode support	No

FinalizeTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_payment_transaction	Yes	unsignedLong	No	The unique ID of a payment transaction.

FinalizeTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_payment_transaction_by_id
This method allows an API user to get info about a transaction by its ID
Parameters	GetPaymentTransactionRequest
Return Value	GetPaymentTransactionResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	Yes

GetPaymentTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_payment_transaction	Yes	unsignedLong	No	The unique ID of a payment transaction.

GetPaymentTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
transaction	No	TransactionInfo structure	No	Complete information about the entered transaction.

get_payment_transaction_list
This method allows an API user to get a list of payment transactions
Parameters	PaymentTransactionListRequest
Return Value	PaymentTransactionListResponse
Realm	administrator, reseller, retail customer, account, cc staff, distributor
Standalone mode support	Yes

PaymentTransactionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	No	dateTime	No	Get information recorded starting from this date.
get_total	No	int	No	Get the total number of the retrieved transactions.
hide_restricted	No	int	No	Specifies whether to remove payment transactions of terminated entities from the response.
i_customer_type	No	unsignedLong	No	The unique identifier of a customer. Possible values: 1 (retail customer or subcustomer), 2 (reseller), 3 (distributor).	Possible values: 1, 3, 2
i_merchant_account	No	unsignedLong	No	The unique Payment System ID for the Transaction.
i_object	No	unsignedLong	No	The unique ID of an account or a customer.
i_payment_method	No	unsignedLong	No	Unique ID of the payment method.
i_payment_transaction	No	unsignedLong	No	The unique ID of a payment transaction.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
object	No	string	No	The type of entity (account/customer) for which the payment transaction is applied.	Possible values: Account, Customer
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
search	No	string	No	A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields.
status	No	string	No	Status of the Transaction.	Possible values: VOIDED, CANCELLED, COMPLETED, FAILED, AUTHORIZED, STARTED
test_mode	No	string	No	Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N.	Possible values: Y, N
to_date	No	dateTime	No	Get information recorded before this date.

PaymentTransactionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
payment_transactions	No	Array of TransactionInfo structure	Yes	The list of payment transactions.
total	No	int	No	The total number of the retrieved transactions.

get_transaction_actions_list
This method enables an API user to get the list of transaction actions
Parameters	TransactionActionsListRequest
Return Value	TransactionActionsListResponse
Realm	administrator, reseller, retail customer, account, cc staff, distributor, representative
Standalone mode support	Yes

TransactionActionsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
billing_entity	No	string	No	Entity; enum [Vendor, RetailCustomer, WholesaleCustomer, Distributor, CreditAccount, DebitAccount, Voucher, Callshop].	Possible values: Vendor, RetailCustomer, WholesaleCustomer, Distributor, CreditAccount, DebitAccount, Voucher, Callshop
i_service	No	unsignedLong	No	The unique ID of the service record.

TransactionActionsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
manual_transactions	Yes	Array of TransactionActionInfo structure	No	The list of manual transactions records.

register_transaction
This method allows an API user to initiate an internal transaction in PortaBilling.Mainly used for making payments via processors with external authentication (the ones such as WorldPay Junior, Moneybookers, PayPal, PayNearMe and Luottokunta which require a user to go to their web page to get authenticated and confirm the transaction)
Parameters	RegisterTransactionRequest
Return Value	RegisterTransactionResponse
Realm	administrator, reseller, retail customer, account
Standalone mode support	No

RegisterTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	Paid amount (Should be equal to or greater than the Minimum Allowed Payment).
i_owner	No	unsignedLong	No	The unique ID of the entity (e.g. i_account, i_customer). Used to get results for another entity.
i_payment_method	Yes	unsignedLong	No	The unique ID of the chosen Payment Method.
owner_type	No	string	No	A symbolic title of system entity. Used when calling entity wants to get result for other entity. Possible values: 'Customer', 'Account'.	Possible values: Account, Customer
purpose	No	string	No	The purpose of the transaction.	Possible values: topup
purpose_details	No	string	No	Description of the purpose of the transaction.

RegisterTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
transaction	No	TransactionInfo structure	No	Complete information about the entered transaction.

Product information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Product

Group management

add_group
This method allows an API user to create a product group to provide customers with effective add-on management tools
Parameters	AddUpdateProductGroupRequest
Return Value	AddUpdateProductGroupResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateProductGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Indicates whether to show the added record in the response.
group_info	Yes	ProductGroupInfo structure	No	The complete information about a product group to be created.

AddUpdateProductGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
group_info	No	ProductGroupInfo structure	No	The complete information about a product group.
i_product_group	Yes	unsignedLong	No	The unique ID of the created/updated product group.

delete_group
This method allows an API user to delete a product group
Parameters	DeleteProductGroupRequest
Return Value	DeleteProductGroupResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteProductGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_product_group	Yes	unsignedLong	No	The unique ID of the created/updated product group.

DeleteProductGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 in case of success, 0 in case of failure.

get_group_info
This method allows an API user to get a product group
Parameters	GetProductGroupInfoRequest
Return Value	GetProductGroupInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetProductGroupInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_product_group	No	unsignedLong	Yes	The unique ID of the product group.
name	No	string	Yes	The name of the product group.

GetProductGroupInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
group_info	Yes	ProductGroupInfo structure	Yes	The complete information about a product group.

get_group_list
This method allows an API user to create a product group to provide customers with effective add-on management tools
Parameters	GetProductGroupListRequest
Return Value	GetProductGroupListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetProductGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_included_products	No	int	No	If set to '1', included_products for every product group will be calculated and provided in the response.
get_total	No	int	No	Get the total number of product groups.
i_customer	No	unsignedLong	Yes	The unique ID of the Customer record.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	The name of the product group.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0

GetProductGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
groups	Yes	Array of ProductGroupInfo structure	Yes	The List of groups.
total	No	int	No	The total number of groups found.

update_group
This method allows an API user to update a product group
Parameters	AddUpdateProductGroupRequest
Return Value	AddUpdateProductGroupResponse
Realm	administrator, reseller
Standalone mode support	No

Product management

add_product
This method allows an API user to add a product
Parameters	AddProductRequest
Return Value	AddProductResponse
Realm	administrator
Standalone mode support	No

AddProductRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Flag which shows whether added record should be returned in response or not.
product_info	Yes	ProductInfo structure	No	Complete information about the product.

AddProductResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	Yes	unsignedLong	No	The unique ID of the product record.
product_info	No	ProductInfo structure	No	Complete information about the product.

delete_product
This method allows an API user to delete an existing product
Parameters	DeleteProductRequest
Return Value	DeleteProductResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteProductRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	Yes	unsignedLong	No	The unique ID of the product record.

DeleteProductResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_allowed_addons
This method that allows to get a list of allowable add-on products that are compatible with a main product
Parameters	GetAllowedAddonsRequest
Return Value	GetAllowedAddonsResponse
Realm	administrator, reseller, distributor, cc staff, representative
Standalone mode support	Yes

GetAllowedAddonsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_info	No	int	No	This flag indicates whether to fetch detailed information for add-on products.
i_product	Yes	unsignedLong	No	ID of main Product.
with_subscription	No	int	No	Flag which indicates whether the Product subscription should be returned.

GetAllowedAddonsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
product_list	Yes	Array of ProductInfo structure	Yes	List of Products.

get_priorities_list
This method that allows to get the list of product priorities
Parameters	GetProductPrioritiesListRequest
Return Value	GetProductPrioritiesListResponse
Realm	administrator, reseller, distributor, cc staff, representative
Standalone mode support	Yes

GetProductPrioritiesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetProductPrioritiesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
priorities_list	Yes	Array of ProductPriorityInfo structure	No	The list of product priority levels.

get_product_info
This method allows an API user to get a product record from the database
Parameters	GetProductInfoRequest
Return Value	GetProductInfoResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetProductInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
get_service_features	No	ArrayOfString	No	Specifies the list of service features to return.
i_product	No	unsignedLong	Yes	The unique ID of the Product Record.
name	No	string	Yes	Name of product, or part of the name. Use % sign as wildcard.
with_service_features	No	int	No	Specifies whether a list of service features will be returned for the retrieved product.

get_product_list
This method allows an API user to get the list of products
Parameters	GetProductListRequest
Return Value	GetProductListResponse
Realm	administrator, reseller, cc staff, distributor, representative
Standalone mode support	Yes

GetProductListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_roles	No	ArrayOfInt	No	An array of unique IDs of account roles; refers to the Account_Roles table. The product list will be filtered using these values.
get_total	No	int	No	Get the total number of retrieved records.
i_customer	No	unsignedLong	Yes	ID of Customer Record (managed by).
i_product_group	No	unsignedLong	Yes	The unique ID of the product group.
iso_4217	No	string	No	Product Currency.	Max value: 3
limit	No	int	No	The number of rows to retrieve.
managed_by_admin	No	string	No	Indicates that products are managed by admin only should be fetched. The option is available for the administrator only.	Possible values: Y, N
name	No	string	No	Refers to Product name.
offset	No	int	No	The number of rows to skip at the beginning of the list.
search	No	string	No	Search products by name and description.
show_inactive	No	string	No	The flag shows whether to display inactive products. Set the flag to 'A' to display all products. The UI equivalent of this field is the "Status" field on the "Product" search panel.	Possible values: Y, N, A
skip_details	No	int	No	Flag which indicates whether the only basic product info will be fetched. It makes request more lightweight.
type	No	string	No	The type of products to be fetched.	Possible values: main, addon
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.
with_subreseller_products	No	int	No	If set to '1', enables admin to retrieve product list of subordinate resellers (second-level and deeper).
with_subscription	No	int	No	Flag which indicates whether the Product subscription should be returned.

GetProductListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
product_list	Yes	Array of ProductInfo structure	Yes	Set of product data records.
total	No	int	No	The total number of found products.

get_roles_list
This method enables an API user to get the list of roles for a product
Parameters	GetProductRolesListRequest
Return Value	GetProductRolesListResponse
Realm	administrator, reseller, distributor, cc staff, representative
Standalone mode support	Yes

GetProductRolesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetProductRolesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
roles_list	Yes	Array of ProductRolesInfo structure	No	The list of roles set in the system.

get_subrealms_list
This method enables an API user to get a list of subrealms
Parameters	GetSubrealmsListRequest
Return Value	GetSubrealmsListResponse
Realm	administrator, reseller, distributor, cc staff, representative
Standalone mode support	Yes

GetSubrealmsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetSubrealmsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subrealms_list	Yes	Array of SubrealmsInfo structure	No	The list of subrealms set in the system.

unbind_addon_product
This method allows an API user to unbind an add-on product from the main product
Parameters	UnbindAddonProductRequest
Return Value	UnbindAddonProductResponse
Realm	administrator, reseller
Standalone mode support	No

UnbindAddonProductRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_addon_product	Yes	unsignedLong	No	The unique ID of the add-on product.
i_product	Yes	unsignedLong	No	The unique ID of the main product.

UnbindAddonProductResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Shows whether using of addon with current Product has been disallowed successfully.

update_product
This method allows an API user to update an existing product
Parameters	UpdateProductRequest
Return Value	UpdateProductResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateProductRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Flag which shows whether updated record should be returned in response or not.
product_info	Yes	ProductInfo structure	No	Complete information about the product.

UpdateProductResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	Yes	unsignedLong	No	The unique ID of the product record.
product_info	No	ProductInfo structure	No	Complete information about the product.

validate_addons_combination
This method allows an API user to validate a combination of add-on products. Every add-on product has a list of allowable main products that are compatible with it, and can be assigned to an account together with this main product
Parameters	ValidateAddonsCombinationRequest
Return Value	ValidateAddonsCombinationResponse
Realm	administrator, reseller, retail customer, account, cc staff
Standalone mode support	Yes

ValidateAddonsCombinationRequest
Property	Mandatory	Type	Nillable	Description	Possible values
assigned_addons	No	ArrayOfInt	Yes	The list of add-on products that you want to assign to an account and the combination of which should be validated.
i_product	Yes	unsignedLong	No	The unique ID of the main product record.
selected_products	No	Array of AddonLifeCycleInfo structure	No	The list of add-on products intended for an account, with their life cycles, to validate the combination.

ValidateAddonsCombinationResponse
Property	Mandatory	Type	Nillable	Description	Possible values
addons_combination_validation_result	No	AddonsValidationResults structure	Yes	Validation information.

Service and rating management

add_service_and_rating
This method allows an API user to add a rating entry into a product to define where users of this product can use the service, and how they will be charged for it
Parameters	AddServiceAndRatingRequest
Return Value	AddServiceAndRatingResponse
Realm	administrator
Standalone mode support	No

AddServiceAndRatingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Flag which shows whether added record should be returned in response or not.
service_and_rating_info	Yes	ServiceAndRatingInfo structure	No	Complete information about the rating entry record to be added.

AddServiceAndRatingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_accessibility	No	unsignedLong	No	The unique ID of the rating entry record that was added.
service_and_rating_info	No	ServiceAndRatingInfo structure	No	Complete information about the rating entry.

delete_service_and_rating
This method allows an API user to delete an existing rating entry from a product
Parameters	DeleteServiceAndRatingRequest
Return Value	DeleteServiceAndRatingResponse
Realm	administrator
Standalone mode support	No

DeleteServiceAndRatingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_accessibility	Yes	unsignedLong	No	The unique ID of the rating entry record to be deleted.

DeleteServiceAndRatingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 in case of success, 0 in case of failure.

get_service_and_rating_info
This method allows an API user to get a product's rating entry record from the database
Parameters	GetServiceAndRatingInfoRequest
Return Value	GetServiceAndRatingInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetServiceAndRatingInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_accessibility	Yes	unsignedLong	No	The unique ID of the rating entry record.

GetServiceAndRatingInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_and_rating_info	No	ServiceAndRatingInfo structure	Yes	Complete information about the rating entry.

get_service_and_rating_list
This method allows an API user to get the list of a product's rating entries. Rating entry is the main component of a product definition. It specifies where your customers are allowed to use a service and how they should be charged for it
Parameters	GetServiceAndRatingListRequest
Return Value	GetServiceAndRatingListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetServiceAndRatingListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cld	No	string	No	Calling line destination.
i_node	No	unsignedLong	No	The unique ID of the node.
i_product	Yes	unsignedLong	No	Product identifier.
i_service	No	unsignedLong	No	The unique ID of the service record; refers to the Services table.
limit	No	int	No	Limit for the returned Service&Ratings.
offset	No	int	No	Starting position for the Service&Ratings.
show_routing_list	No	int	No	Flag which indicates whether routing_list per Service&Rating should be included in response.

GetServiceAndRatingListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_and_rating_list	No	Array of ServiceAndRatingInfo structure	Yes	Set of rating entry data records.

update_service_and_rating
This method allows an API user to update an existing rating entry in a product
Parameters	UpdateServiceAndRatingRequest
Return Value	UpdateServiceAndRatingResponse
Realm	administrator
Standalone mode support	No

UpdateServiceAndRatingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Flag which shows whether updated record should be returned in response or not.
service_and_rating_info	Yes	ServiceAndRatingInfo structure	No	Complete information about the rating entry record to be updated.

UpdateServiceAndRatingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_accessibility	No	unsignedLong	No	The unique ID of the rating entry record that was updated.
service_and_rating_info	No	ServiceAndRatingInfo structure	No	The complete information about the rating entry.

Subscription management

add_subscription
This method allows an API user to add a subscription to the product
Parameters	AddProductSubscriptionRequest
Return Value	AddProductSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

AddProductSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
detailed_response	No	int	No	Shows whether added record should be returned in response or not.
subscription_info	Yes	ProductSubscriptionInfo structure	No	Note: i_product_subscription will be ignored; i_subscription and i_product are mandatory fields.

AddProductSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_product_subscription	Yes	unsignedLong	No	The ID of created product subscription record.
subscription_info	No	ProductSubscriptionInfo structure	No	The product subscription info.

delete_subscription
This method allows an API user to delete a subscription from the product
Parameters	DeleteProductSubscriptionRequest
Return Value	DeleteProductSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteProductSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_product_subscription	Yes	unsignedLong	No	The ID of product subscription record.

DeleteProductSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 if subscription deleted and 0 if subscription cannot be deleted.

get_subscriptions
This method allows an API user to get the subscription included in this product
Parameters	GetProductSubscriptionsRequest
Return Value	GetProductSubscriptionsResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetProductSubscriptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	Yes	unsignedLong	No	The ID of product record.
i_subscription	No	unsignedLong	No	The unique ID of the subscription associated with this product.
with_fees	No	int	No	Indicates whether the periodic fees for the subscription should be returned.

GetProductSubscriptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subscriptions	No	Array of ProductSubscriptionInfo structure	No	Set of product subscription data records.

reapply_subscriptions
This method allows an API user to update the subscription for existing accounts with this product
Parameters	ReapplyProductSubscriptionsRequest
Return Value	ReapplyProductSubscriptionsResponse
Realm	administrator, reseller
Standalone mode support	No

ReapplyProductSubscriptionsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	Yes	unsignedLong	No	The ID of product record.

ReapplyProductSubscriptionsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 in case of success, 0 in case of failure.

Quick form information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/QuickForms

Field management

get_quick_form_fields_list
This method enables an API user to get the list of fields of the quick form
Parameters	GetQFFieldsListRequest
Return Value	GetQFFieldsListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetQFFieldsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
entity_number	No	int	No	The number of the entity the fields belong to.
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.
name	No	string	No	The quick form field name pattern.

GetQFFieldsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
qf_fields_list	Yes	Array of QFFieldInfo structure	No	The quick form fields list.

set_quick_form_fields
This method enables an API user to modify the fields of the quick form
Parameters	UpdateQFFieldsRequest
Return Value	UpdateQFFieldsResponse
Realm	administrator
Standalone mode support	No

UpdateQFFieldsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
entity_number	Yes	int	No	The number of the entity the fields belong to.
i_quick_form	Yes	int	No	The unique ID of the quick form.
qf_fields_list	Yes	Array of QFFieldInfo structure	No	The quick form fields list.

UpdateQFFieldsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.

Quick form management

add_quick_form
This method enables an API user to create a quick form
Parameters	AddQFRequest
Return Value	AddQFResponse
Realm	administrator
Standalone mode support	No

AddQFRequest
Property	Mandatory	Type	Nillable	Description	Possible values
qf_info	Yes	QFAddInfo structure	No	Quick form info.

AddQFResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.

delete_quick_form
This method allows an API user to delete a quick form
Parameters	DeleteQFRequest
Return Value	DeleteQFResponse
Realm	administrator
Standalone mode support	No

DeleteQFRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.

DeleteQFResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_quick_form_info
This method enables an API user to get the data of the quick form
Parameters	GetCustomerQFInfoRequest
Return Value	GetCustomerQFInfoResponse
Realm	administrator, reseller
Standalone mode support	No

GetCustomerQFInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.

GetCustomerQFInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
qf_info	Yes	QFInfo structure	No	Quick form info.

get_quick_forms_list
This method allows an API user to obtain the list of quick forms
Parameters	GetCustomerQFListRequest
Return Value	GetCustomerQFListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetCustomerQFListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved records.	Default value: 1
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	The quick form name pattern.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property value to be specified in the API request.	Default value: 0 Max value: 4294967295

GetCustomerQFListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
qf_forms	Yes	Array of QFInfo structure	Yes	The List of quick forms.
total	No	int	No	The total number of the retrieved exchange rate data records.

update_quick_form
This method enables an API user to update the quick form
Parameters	UpdateQFRequest
Return Value	UpdateQFResponse
Realm	administrator
Standalone mode support	No

UpdateQFRequest
Property	Mandatory	Type	Nillable	Description	Possible values
qf_info	Yes	QFInfo structure	No	Quick form info.

UpdateQFResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.

Rate information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Rate

Group management

add_rate_group
This method allows an API user (administrator or reseller) to add a new rate for every destination in a destination group
Parameters	AddRateGroupRequest
Return Value	AddRateGroupResponse
Realm	administrator, reseller
Standalone mode support	No

AddRateGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group.
rate_info	Yes	RateInfo structure	No	Rate data record.

AddRateGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate_list	Yes	ArrayOfInt	No	The list of ID of the rates created.

update_rate_group
This method allows an API user to update the existing rate for every destination in a destination group
Parameters	UpdateRateGroupRequest
Return Value	UpdateRateGroupResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateRateGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest_group	Yes	unsignedLong	No	The unique ID of the destination group.
rate_info	Yes	RateInfo structure	No	Rate data record.

UpdateRateGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate_list	Yes	ArrayOfInt	No	The list of ID of the modified rates.

Rate management

add_rate
This method allows an API user (administrator or reseller) to add a new rate for a destination
Parameters	AddRateRequest
Return Value	AddRateResponse
Realm	administrator, reseller
Standalone mode support	No

AddRateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rate_info	Yes	RateInfo structure	No	Rate data record.

AddRateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate	Yes	unsignedLong	No	The unique ID of the rate record created.

batch_add_rate
This method allows an API user to add a new rates for a destination in batch mode
Parameters	BatchAddRateRequest
Return Value	BatchAddRateResponse
Realm	administrator, reseller
Standalone mode support	No

BatchAddRateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rate_list	Yes	Array of RateInfo structure	No	Rate data record.

BatchAddRateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
result_list	Yes	Array of ResultBatchAddRateInfo structure	No	List of the result about added rates.
success	Yes	int	No	1 for success, exception on failure.

cleanup_inactive_rates
This method enables an API user to clean up inactive rates
Parameters	CleanUpInactiveRatesRequest
Return Value	CleanUpInactiveRatesResponse
Realm	administrator
Standalone mode support	No

CleanUpInactiveRatesRequest
Property	Mandatory	Type	Nillable	Description	Possible values
effective_from	Yes	dateTime	No	Defines when the rate starts to be used. Only unused rates can be cleaned up.	Min value: current date and time
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff record.

CleanUpInactiveRatesResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if the operation is successful, 0 if not.

delete_rate
This method allows an API user to delete an existing rate for a destination
Parameters	DeleteRateRequest
Return Value	DeleteRateResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteRateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate	Yes	unsignedLong	No	The unique ID of the rate record to be deleted.

DeleteRateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_rate_info
This method allows an API user to get information about a rate
Parameters	GetRateInfoRequest
Return Value	GetRateInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRateInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate	Yes	unsignedLong	No	The unique ID of the rate record.

GetRateInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rate_info	No	RateInfo structure	No	Complete information about the rate; for more information, see RateInfo.

get_rate_list

This method allows an API user to retrieve the list of rates

Parameters

GetRateListRequest

Return Value

GetRateListResponse

Realm

administrator, reseller

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv, xlsx, xls
Mandatory	No

GetRateListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
combined_status	No	int	No	Indicates that combined status is used for lookup. When enabled, the 'y' and 'n' values are allowed for the 'discontinued', 'forbidden' and 'hidden' filters. These specify that the logical OR operator is used for the corresponding field when the combined status filter is prepared .
complex_ordering	No	Array of ComplexOrderingInfo structure	No	Order response by multiple fields. Field "order_by" has higher priority.
country	No	string	No	Country name.	Max value: 64
destination	No	string	No	The pattern of the destination prefix.
destination_list	No	Array of RequestDestinationPrefixInfo structure	No	Set of destination records.
discontinued	No	string	No	Indicates that rate is discontinued.	Possible values: Y, N
effective_at	No	dateTime	No	The filter enables viewing rates that were, are or will be effective at any date and time. It can work in pair with the 'effective_from' filter to view rates effective before/after the given date and time.
effective_from	No	string	No	The filter that allows viewing rates depending on their Effective From date. One of the following: 'before', 'after', 'now', 'all'.	Default value: now Possible values: after, now, all, before
effective_from_datetime	No	dateTime	No	Return rates with the effective_from value later than the value in the field.
extended_info	No	int	No	Specifies whether to get extended information like destination group for the rates.
file_format	No	string	No	This parameter enables the user to get rates in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'.	Possible values: csv, xlsx, xls
forbidden	No	string	No	Indicates that no calls are authorized for the particular destination.	Possible values: Y, N
get_simple_info	No	int	No	Specifies whether to get simple information for the rates. Filtering and ordering is limited in 'simple' mode.
get_total	No	int	No	Get the total number of the retrieved rate data records.
hidden	No	string	No	Indicates that the rate is excessive and may be omitted when making the list of rates.	Possible values: Y, N
i_dest_group	No	unsignedLong	No	The unique ID of the destination group DB record.
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff; refers to Tariffs table.
i_template	No	unsignedLong	No	The unique ID of the rate download template.
iso_3166_1_a2	No	string	No	The ISO 3166 two-letter country code.	Max value: 2 Min value: 2
limit	Yes	int	No	The number of rows to retrieve.
network	No	string	No	The name of the mobile network.	Max value: 255
offset	Yes	int	No	The number of rows to skip at the beginning of the list. Requires the limit property value defined.	Max value: 4294967295
order_by	No	string	Yes	Allows to sort the resulting rate list by a specific field.	Possible values: null, discontinued, country, price_n, destination, effective_from, destination_group, forbidden, interval_n
order_direction	No	string	No	Specifies whether to sort the records in a descending or ascending order.	Possible values: DESC, ASC
reverse_rating	No	string	No	Indicates whether rate is marked reverse or not.	Possible values: Y, N
type	No	string	No	The type of search. One of the following: number, prefix. Default: "prefix".	Possible values: country, network, group, number, mcc, prefix

GetRateListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rate_list	No	Array of RateInfo structure	No	Set of rate data records.
total	No	int	No	The number of the retrieved rate data records.

search_rate_list
This method enables an API user to retrieve the list of rates selected by specific criteria
Parameters	SearchRateListRequest
Return Value	SearchRateListResponse
Realm	administrator, reseller
Standalone mode support	Yes

SearchRateListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
country	No	string	No	The country name related to the rate.
description	No	string	No	The description of the rate.
destination	No	string	No	The destination number pattern related to the rate.
get_total	No	int	No	Get the total number of the retrieved rate data records.
i_product	No	unsignedLong	No	The unique ID of the product DB record.
i_tariff	No	unsignedLong	No	The unique ID of the tariff DB record.
iso_3166_1_a2	No	string	No	The ISO country code related to the rate.
limit	No	int	No	The number of rows to retrieve.	Default value: 50
number	No	string	No	The destination number. Returns only the rates that match the destination number.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property value defined.	Default value: 0

SearchRateListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rate_list	No	Array of RateInfo structure	No	Set of rate data records.
total	No	int	No	The number of the retrieved rate data records.

update_rate
This method allows an API user to update an existing rate for a destination
Parameters	UpdateRateRequest
Return Value	UpdateRateResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateRateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rate_info	No	RateInfo structure	No	Rate data record.

UpdateRateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate	Yes	unsignedLong	No	ID of the modified rate record.

Reports information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Report

ASR report management

get_asr_file

This method enables an API user to download the ASR file

Parameters

GetASRFileRequest

Return Value

GetASRFileResponse

Realm

administrator

Standalone mode support

Yes

Attachments

Type	Download
Formats	zip, csv
Mandatory	No

GetASRFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
compress	No	string	No	If specified, describes the compression used for the returned attachment.	Default value: zip Possible values: none, zip
file_name	Yes	string	No	The file name.
i_vendor	Yes	unsignedLong	No	The unique ID of the vendor record.

GetASRFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

get_asr_file_list
This method enables an API user to obtain the list of ASR files
Parameters	GetASRFileListRequest
Return Value	GetASRFileListResponse
Realm	administrator
Standalone mode support	Yes

GetASRFileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor	Yes	unsignedLong	No	The unique ID of the vendor record.
period_from	Yes	date	No	Get vendor ASR files dated starting from this date.	Max value: period_to value
period_to	Yes	date	No	Get vendor ASR files dated before this date.	Max value: current date

GetASRFileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
file_list	No	Array of ReportFileInfo structure	No	A list of vendor ASR files.

Cost/Revenue report management

get_cost_revenue_file

This method enables an API user to download the Cost/Revenue report file

Parameters

GetCostRevenueFileRequest

Return Value

GetCostRevenueFileResponse

Realm

administrator

Standalone mode support

Yes

Attachments

Type	Download
Formats	zip, csv
Mandatory	No

GetCostRevenueFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
compress	No	string	No	If specified, describes the compression used for the returned attachment.	Default value: zip Possible values: none, zip
file_name	Yes	string	No	The file name.
type	Yes	int	No	The type of the Cost/Revenue report.	Possible values: 1, 2, 3, 4, 5

GetCostRevenueFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

get_cost_revenue_file_list
This method enables an API user to obtain the list of Cost/Revenue report files
Parameters	GetCostRevenueFileListRequest
Return Value	GetCostRevenueFileListResponse
Realm	administrator
Standalone mode support	Yes

GetCostRevenueFileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
period_from	Yes	date	No	Get the Cost/Revenue report files dated starting from this date.	Max value: period_to value
period_to	Yes	date	No	Get the Cost/Revenue report files dated before this date.	Max value: current date
type	Yes	int	No	The type of the Cost/Revenue report.	Possible values: 1, 2, 3, 4, 5

GetCostRevenueFileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
file_list	No	Array of ReportFileInfo structure	No	A list of the Cost/Revenue report files.

Representative information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Representative

Information and statistics management

get_xdr_list

The method enables an API user to retrieve representative's XDR records

Parameters

GetRepresentativeXDRListRequest

Return Value

GetRepresentativeXDRListResponse

Realm

administrator, reseller

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv
Mandatory	No

GetRepresentativeXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
connect_time_after	No	dateTime	No	Get xDRs with connect_time after this date.
connect_time_before	No	dateTime	No	Get xDRs with connect_time before this date.
format	No	string	No	This parameter enables the user to get xDRs in other formats via a SOAP attachment. Currently only the "csv" format is supported.	Possible values: csv
from_date	Yes	dateTime	No	Get information recorded starting from this date.
get_total	No	int	No	Get the total number of the retrieved xDRs.
i_customer	No	unsignedLong	No	The unique ID of customer record.
i_rep	Yes	unsignedLong	No	The unique ID of the representative record.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
to_date	Yes	dateTime	No	Get information recorded before this date.
transaction_type	No	string	No	One of the following: commission, ot_commission, payout, bonus.	Possible values: payout, ot_commission, bonus, commission

GetRepresentativeXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved xDRs.
xdr_list	No	Array of RepresentativeXDRInfo structure	No	The list of the retrieved XDRs.

Representative management

add_representative
This method allows an API user to add representatives to the system
Parameters	AddRepresentativeRequest
Return Value	AddUpdateRepresentativeResponse
Realm	administrator, reseller
Standalone mode support	No

AddRepresentativeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
generate_web_password	No	int	No	Auto Generate Representative's password.
representative_info	No	RepresentativeInfo structure	No	Note: i_rep will be ignored; most fields may be omitted.

AddUpdateRepresentativeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rep	No	unsignedLong	No	The unique ID of the created/modified representative record.

delete_representative
This method allows an API user to delete representatives from the system
Parameters	DeleteRepresentativeRequest
Return Value	DeleteRepresentativeResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteRepresentativeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rep	Yes	unsignedLong	No	The unique ID of the representative record.

DeleteRepresentativeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_representative_info
This method allows an API user (administrator or reseller) to get a representative record from the database
Parameters	GetRepresentativeInfoRequest
Return Value	GetRepresentativeInfoResponse
Realm	administrator, reseller, representative
Standalone mode support	Yes

GetRepresentativeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_customers_total	No	int	No	Get the total number of the customers that are related to the representative.
get_distributors_total	No	int	No	Get the total number of the distributors that are related to the representative.
get_resellers_total	No	int	No	Get the total number of the resellers that are related to the representative.
i_rep	No	unsignedLong	No	The unique ID of the representative record.
name	No	string	No	Name of the representative on the PortaBilling interface, unique in the environment.

GetRepresentativeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
representative_info	No	RepresentativeInfo structure	Yes	Complete information about a representative.

get_representative_list
This method allows an API user to get a list of representative records
Parameters	GetRepresentativeListRequest
Return Value	GetRepresentativeListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRepresentativeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the representatives are in use.
email	No	string	No	Email address.
get_customers_total	No	int	No	Get the total number of the customers that are related to every representative.
get_distributors_total	No	int	No	Get the total number of the distributors that are related to every representative.
get_resellers_total	No	int	No	Get the total number of the resellers that are related to every representative.
get_total	No	int	No	Get the total number of the retrieved representatives.
hidden	No	string	No	Shows whether the representative is hidden. Possible values: 'Y' - hidden; 'N' - visible.	Possible values: Y, N
i_customer	No	unsignedLong	Yes	ID of the reseller who manage the representative.
iso_4217	No	string	No	ISO4217 code of the currency.
limit	Yes	int	No	Limit of representatives(maximum quantity of representatives). Mandatory for an API request with the offset property specified.
name	No	string	No	Refers to the name of the representative.
offset	No	int	No	Starting position for the representative list (number of rows to skip at the beginning of the list). Requires the limit property specified in the API request.	Default value: 0

GetRepresentativeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
representative_list	No	Array of RepresentativeInfo structure	No	The list of representatives.
total	No	int	No	The total number of retrieved representatives.

update_representative
This method allows an API user to update representatives in the system
Parameters	UpdateRepresentativeRequest
Return Value	AddUpdateRepresentativeResponse
Realm	administrator, reseller, representative
Standalone mode support	No

UpdateRepresentativeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
representative_info	No	RepresentativeInfo structure	No	Note: i_rep is a mandatory field; i_customer and iso_4217 will be ignored; only fields requiring modification should be provided.

Transaction management

get_transactions_total_info
This method enables an API user to get the list of a representative's transactions
Parameters	GetRepresentativeTransactionsTotalInfoRequest
Return Value	GetRepresentativeTransactionsTotalInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRepresentativeTransactionsTotalInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	Yes	dateTime	No	Get information recorded starting from this date.
i_rep	Yes	unsignedLong	No	The unique ID of the representative record.
to_date	Yes	dateTime	No	Get information recorded before this date.
transaction_type	No	string	No	One of the following: commission, ot_commission, payout, bonus.	Possible values: payout, ot_commission, bonus, commission

GetRepresentativeTransactionsTotalInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
count	No	int	No	The total number of transactions.
iso_4217	No	string	No	Transactions currency.
total_commission	No	float	No	Total commission transactions amount.
total_payout	No	float	No	Total payout transactions amount.

make_transaction
This method allows an API user to correct a representative's balance
Parameters	MakeRepresentativeTransactionRequest
Return Value	MakeRepresentativeTransactionResponse
Realm	administrator, reseller
Standalone mode support	No

MakeRepresentativeTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	One of the following: manual charge, manual payment.	Possible values: Manual Charge, Manual Payment
amount	Yes	float	No	The amount the representative's balance will be increased/decreased by.	Min value: 0 Precision: 15, Scale: 5
i_customer	No	unsignedLong	No	The ID of the customer to whom the representative is assigned.
i_rep	Yes	unsignedLong	No	The unique ID of the representative record.
i_service	No	unsignedLong	No	The service for which the manual charge is made.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser and accessible only directly from the database.	Max value: 200
transaction_date	No	dateTime	No	A date and time associated with the transaction. For example, you can specify a date for transaction action for when an item is charged.
visible_comment	No	string	No	A comment on this transaction that is visible in the xDR browser.	Max value: 100

MakeRepresentativeTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
balance	Yes	float	No	The modified balance of the representative.
i_xdr	Yes	unsignedLong	No	The unique ID of the xDR record.

Route categories information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/RouteCategories

Route category management

add_route_category
This method enables an API user to add a new route category record
Parameters	AddRouteCategoryRequest
Return Value	AddRouteCategoryResponse
Realm	administrator
Standalone mode support	No

AddRouteCategoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
route_category_info	Yes	RouteCategoryInfo structure	No	The information about the route category.

AddRouteCategoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_route_category	Yes	unsignedLong	No	The unique ID of the route category DB record.

delete_route_category
This method enables an API user to delete a route category record
Parameters	DeleteRouteCategoryRequest
Return Value	DeleteRouteCategoryResponse
Realm	administrator
Standalone mode support	No

DeleteRouteCategoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_route_category	Yes	unsignedLong	No	The unique ID of the route category DB record.

DeleteRouteCategoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success.

get_route_category_info
This method enables an API user to get information about a route category record
Parameters	GetRouteCategoryInfoRequest
Return Value	GetRouteCategoryInfoResponse
Realm	administrator
Standalone mode support	No

GetRouteCategoryInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Checks whether the route category is in use.
i_route_category	Yes	unsignedLong	No	The unique ID of the route category DB record.

GetRouteCategoryInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
route_category_info	No	RouteCategoryInfo structure	No	The information about the route category.

get_route_category_list
This method enables an API user to get a list of route category records
Parameters	GetRouteCategoryListRequest
Return Value	GetRouteCategoryListResponse
Realm	administrator
Standalone mode support	No

GetRouteCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Checks whether the route categories are in use.
default	No	string	No	Filter by the 'default' field. Possible values: 'Y', 'N'.	Possible values: Y, N
description	No	string	No	A route category description.
get_total	No	int	No	1 to return 'total' field in the method response.
limit	No	int	No	Number of rows to retrieve.
name	No	string	No	A route category name.
offset	No	int	No	Number of rows to skip at the beginning of the response list.	Default value: 0

GetRouteCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
route_category_list	No	Array of RouteCategoryInfo structure	No	Set of route category data records.
total	No	int	No	The total number of the retrieved route category records.

update_route_category
This method enables an API user to update a route category record
Parameters	UpdateRouteCategoryRequest
Return Value	UpdateRouteCategoryResponse
Realm	administrator
Standalone mode support	No

UpdateRouteCategoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
route_category_info	Yes	RouteCategoryInfo structure	No	The information about the route category.

UpdateRouteCategoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_route_category	Yes	unsignedLong	No	The unique ID of the route category DB record.

Routing criteria information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/RoutingCriteria

Destination group management

add_routing_criteria_dest_group
This method enables an API user to add a new destination group to a routing criteria record
Parameters	AddRoutingCriteriaDestGroupRequest
Return Value	AddRoutingCriteriaDestGroupResponse
Realm	administrator
Standalone mode support	No

AddRoutingCriteriaDestGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
routing_criteria_dest_group_info	Yes	RoutingCriteriaDestGroupInfo structure	No	The information about the routing criteria destination group.

AddRoutingCriteriaDestGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria_dest_group	Yes	unsignedLong	No	The unique ID of the routing criteria destination group DB record.

delete_routing_criteria_dest_group
This method enables an API user to delete a destination group for a routing criteria record
Parameters	DeleteRoutingCriteriaDestGroupRequest
Return Value	DeleteRoutingCriteriaDestGroupResponse
Realm	administrator
Standalone mode support	No

DeleteRoutingCriteriaDestGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria_dest_group	Yes	unsignedLong	No	The unique ID of the routing criteria destination group DB record.

DeleteRoutingCriteriaDestGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success.

get_routing_criteria_dest_group_info
This method enables an API user to get information about a destination group for a routing criteria record
Parameters	GetRoutingCriteriaDestGroupInfoRequest
Return Value	GetRoutingCriteriaDestGroupInfoResponse
Realm	administrator
Standalone mode support	Yes

GetRoutingCriteriaDestGroupInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria_dest_group	Yes	unsignedLong	No	The unique ID of the routing criteria destination group DB record.

GetRoutingCriteriaDestGroupInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
routing_criteria_dest_group_info	No	RoutingCriteriaDestGroupInfo structure	No	The information about the routing criteria destination group.

update_routing_criteria_dest_group
This method enables an API user to update a routing criteria destination group record
Parameters	UpdateRoutingCriteriaDestGroupRequest
Return Value	UpdateRoutingCriteriaDestGroupResponse
Realm	administrator
Standalone mode support	No

UpdateRoutingCriteriaDestGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
routing_criteria_dest_group_info	Yes	RoutingCriteriaDestGroupInfo structure	No	The information about the routing criteria destination group.

UpdateRoutingCriteriaDestGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria_dest_group	Yes	unsignedLong	No	The unique ID of the routing criteria destination group DB record.

Routing criteria management

add_routing_criteria
This method enables an API user to add a new routing criteria record
Parameters	AddRoutingCriteriaRequest
Return Value	AddRoutingCriteriaResponse
Realm	administrator
Standalone mode support	No

AddRoutingCriteriaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
routing_criteria_info	Yes	RoutingCriteriaInfo structure	No	The information about the routing criteria.

AddRoutingCriteriaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria	Yes	unsignedLong	No	The unique ID of the routing criteria DB record.

delete_routing_criteria
This method enables an API user to delete a routing criteria record
Parameters	DeleteRoutingCriteriaRequest
Return Value	DeleteRoutingCriteriaResponse
Realm	administrator
Standalone mode support	No

DeleteRoutingCriteriaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria	Yes	unsignedLong	No	The unique ID of the routing criteria DB record.

DeleteRoutingCriteriaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success.

get_routing_criteria_info
This method enables an API user to get information about a routing criteria record
Parameters	GetRoutingCriteriaInfoRequest
Return Value	GetRoutingCriteriaInfoResponse
Realm	administrator
Standalone mode support	Yes

GetRoutingCriteriaInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria	Yes	unsignedLong	No	The unique ID of the routing criteria DB record.
with_destination_group_list	No	int	No	If with_destination_group_list = 1 then return information about the routing criteria destination groups.

GetRoutingCriteriaInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
destination_group_list	No	Array of RoutingCriteriaDestGroupInfo structure	No	The information about the routing criteria destination groups.
routing_criteria_info	No	RoutingCriteriaInfo structure	No	The information about the routing criteria.

get_routing_criteria_list
This method enables an API user to get a list of routing criteria records
Parameters	GetRoutingCriteriaListRequest
Return Value	GetRoutingCriteriaListResponse
Realm	administrator
Standalone mode support	Yes

GetRoutingCriteriaListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the routing criteria is used.
description	No	string	No	Routing criteria description.
get_total	No	int	No	Get the total number of the retrieved routing criterias.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	Routing criteria name.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetRoutingCriteriaListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
routing_criteria_list	No	Array of RoutingCriteriaInfo structure	No	Set of routing criteria data records.
total	No	int	No	The total number of the retrieved records.

update_routing_criteria
This method enables an API user to update a routing criteria record
Parameters	UpdateRoutingCriteriaRequest
Return Value	UpdateRoutingCriteriaResponse
Realm	administrator
Standalone mode support	No

UpdateRoutingCriteriaRequest
Property	Mandatory	Type	Nillable	Description	Possible values
routing_criteria_info	Yes	RoutingCriteriaInfo structure	No	The information about the routing criteria.

UpdateRoutingCriteriaResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_criteria	Yes	unsignedLong	No	The unique ID of the routing criteria DB record.

Routing plan information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/RoutingPlan

Custom routing management

add_rp_connection
This method allows an API user to define custom routing per destination group
Parameters	AddUpdateRPConnectionRequest
Return Value	AddUpdateRPConnectionResponse
Realm	administrator
Standalone mode support	No

AddUpdateRPConnectionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rp_connection_info	Yes	RPConnectionInfo structure	No	Complete information about custom routing configured for a particular destination group.

AddUpdateRPConnectionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_rp_connection	No	unsignedLong	No	The unique ID of the added/updated custom routing.

delete_rp_connection
This method allows an API user to remove custom routing per destination group
Parameters	DeleteRPConnectionRequest
Return Value	DeleteRPConnectionResponse
Realm	administrator
Standalone mode support	No

DeleteRPConnectionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rp_connection	Yes	unsignedLong	No	The unique ID of the custom routing configured for a particular destination group.

DeleteRPConnectionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 if operation is successful, 0 if not.

get_rp_connection_info
This method allows an API user to get a custom routing record from the database
Parameters	GetRPConnectionInfoRequest
Return Value	GetRPConnectionInfoResponse
Realm	administrator
Standalone mode support	Yes

GetRPConnectionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_rp_connection	Yes	unsignedLong	No	The unique ID of a custom routing record.

GetRPConnectionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rp_connection_info	No	RPConnectionInfo structure	No	Complete information about custom routing configured for a particular destination group.

get_rp_connection_list
This method allows an API user to get a list of custom routing records from the database
Parameters	GetRPConnectionListRequest
Return Value	GetRPConnectionListResponse
Realm	administrator
Standalone mode support	Yes

GetRPConnectionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan	Yes	unsignedLong	No	The unique ID of the Routing Plan record.

GetRPConnectionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rp_connection_list	No	Array of RPConnectionInfo structure	No	A list of custom routing records.

update_rp_connection
This method allows an API user to change custom routing per destination group
Parameters	AddUpdateRPConnectionRequest
Return Value	AddUpdateRPConnectionResponse
Realm	administrator
Standalone mode support	No

Route category management

add_rp_category
This method enables an API user to add a route category to a routing plan
Parameters	AddUpdateRPCategoryRequest
Return Value	AddUpdateRPCategoryResponse
Realm	administrator
Standalone mode support	No

AddUpdateRPCategoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
rp_category_info	Yes	RoutingPlanCategoryInfo structure	No	Complete information about the route category of a routing plan.

AddUpdateRPCategoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan_cat	No	unsignedLong	No	The unique ID of the routing plan route category record.

delete_rp_category
This method enables an API user to delete a route category from a routing plan
Parameters	DeleteRPCategoryRequest
Return Value	DeleteRPCategoryResponse
Realm	administrator
Standalone mode support	No

DeleteRPCategoryRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan_cat	Yes	unsignedLong	No	The unique ID of the routing plan route category record.

DeleteRPCategoryResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, 0 for failure.

get_rp_category_list
This method enables an API user to get the route categories assigned to a routing plan
Parameters	GetRPCategoryListRequest
Return Value	GetRPCategoryListResponse
Realm	administrator
Standalone mode support	Yes

GetRPCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan	Yes	unsignedLong	No	The unique ID of the routing plan record.

GetRPCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
routing_plan_category_list	No	Array of RoutingPlanCategoryInfo structure	No	The list of the route categories assigned to the routing plan.

update_rp_category
This method enables an API user to update a route category from a routing plan
Parameters	AddUpdateRPCategoryRequest
Return Value	AddUpdateRPCategoryResponse
Realm	administrator
Standalone mode support	No

Routing plan management

add_routing_plan
This method allows an API user to create a new routing plan using the supplied data
Parameters	AddUpdateRoutingPlanRequest
Return Value	AddUpdateRoutingPlanResponse
Realm	administrator
Standalone mode support	No

AddUpdateRoutingPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
routing_plan_info	Yes	RoutingPlanInfo structure	No	Complete information about the routing plan.

AddUpdateRoutingPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan	No	unsignedLong	No	The unique ID of the created routing plan record.

delete_routing_plan
This method allows an API user to delete a routing plan record from the database
Parameters	DeleteRoutingPlanRequest
Return Value	DeleteRoutingPlanResponse
Realm	administrator
Standalone mode support	No

DeleteRoutingPlanRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan	Yes	unsignedLong	No	The unique ID of the created routing plan record.

DeleteRoutingPlanResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 if operation is successful, 0 if not.

get_route_list
This method allows an API user to test a dialplan for a specific telephone number or certain destinations at any moment in time
Parameters	GetRouteListRequest
Return Value	GetRouteListResponse
Realm	administrator
Standalone mode support	Yes

GetRouteListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
apply_penalties	No	int	No	Allows to see the resulting list of routes regardless of the currently applied adaptive routing penalties.
effective_time	No	dateTime	No	The search can be performed in real time or simulate any date and time.	Min value: current date and time
i_node	No	unsignedLong	No	The unique ID of a node record. You may select either Generic Routing (to see all the routes outside of the network) by skipping this property in a request or a specific node (to see the routes available when a call is handled by this node).
i_routing_plan	No	unsignedLong	No	The unique ID of a routing plan to be used for a dialplan test. The system will offer a different set of routes depending on the routing plan. Skip this property in a request to test dialplan for all available routes.
i_service_type	No	unsignedLong	No	The unique ID of the service type.	Default value: 3 Possible values: 3, 10
number	Yes	string	No	Type either a full number or a prefix into this field to see the resulting list of routes for this number.	Max value: 128
transport_protocol	No	string	No	A transport protocol to be used in the simulation. Posible values: 'SIP', 'SMPP' .	Possible values: SIP, SMPP

GetRouteListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
route_list	No	Array of RouteInfo structure	No	The list of routes.

get_routing_plan_info
This method allows an API user to get a routing plan record from the database
Parameters	GetRoutingPlanInfoRequest
Return Value	GetRoutingPlanInfoResponse
Realm	administrator
Standalone mode support	Yes

GetRoutingPlanInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_routing_plan	Yes	unsignedLong	No	The unique ID of the routing plan record.
with_route_categories	No	int	No	If set to '1', route categories assigned to the routing plan will be added to the response.
with_rp_connections	No	int	No	If set to '1', the routing plan connections assigned to the routing plan will be added to the response.

GetRoutingPlanInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
routing_plan_info	No	RoutingPlanInfo structure	No	Complete information about the routing plan.

get_routing_plan_list
This method allows an API user to get the list of routing plans
Parameters	GetRoutingPlanListRequest
Return Value	GetRoutingPlanListResponse
Realm	administrator
Standalone mode support	Yes

GetRoutingPlanListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of a routing plan.
get_total	No	int	No	1 to return 'total' field in the method response.
limit	No	int	No	Number of rows to retrieve.
name	No	string	No	Name pattern for Routing Plans search.
no_usage_check	No	int	No	Do not perform Routing Plan usage check.
offset	No	int	No	Number of rows to skip at the beginning of the response list.	Default value: 0
with_route_categories	No	int	No	If set to '1', route categories assigned to the routing plan will be added to the response.
with_rp_connections	No	int	No	If set to '1', the routing plan connections assigned to the routing plan will be added to the response.

GetRoutingPlanListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
routing_plan_list	No	Array of RoutingPlanInfo structure	No	A list of routing plans.
total	No	int	No	The total number of routing plans in the database.

update_routing_plan
This method allows an API user to update a routing plan using the supplied data
Parameters	AddUpdateRoutingPlanRequest
Return Value	AddUpdateRoutingPlanResponse
Realm	administrator
Standalone mode support	No

Service features

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/ServiceFeatures

Service feature management

get_service_features_list
This method allows an administrator to get the list of service features
Parameters	GetServiceFeaturesListRequest
Return Value	GetServiceFeaturesListResponse
Realm	administrator
Standalone mode support	Yes

GetServiceFeaturesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_raw_info	No	int	No	The flag that indicates whether the internal fixups will be applied to the output: 1 (not applied, default), 0 (applied). This operation includes removal of deprecated features and transformation of service feature attributes.	Default value: 1
level	No	string	No	One of the following: Customers – show customers' service features, Accounts – show account's service features, Customer Sites – show service features defined in customer sites, Products – show service features defined in products, All – show all service features in the system.	Default value: All Possible values: Customers, Accounts, Products, CustomerSites, All
show_attributes	No	int	No	Flag that indicates whether the service feature attributes will be shown: 1 (show), 0 (do not show).

GetServiceFeaturesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_features_list	No	ServiceFeaturesList structure	Yes	Complete information about the service features.

Service information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Service

Service management

add_service
This method enables an API user to create a new service record using the supplied data
Parameters	AddServiceRequest
Return Value	AddUpdateServiceResponse
Realm	administrator
Standalone mode support	No

AddServiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
service_info	No	ServiceInfo structure	No	The information about the service.

AddUpdateServiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_service	No	unsignedLong	No	The unique ID of the service record.

delete_service
This method enables an API user to delete the service record from the database
Parameters	DeleteServiceRequest
Return Value	DeleteServiceResponse
Realm	administrator
Standalone mode support	No

DeleteServiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_service	Yes	unsignedLong	No	The unique ID of the service record.

DeleteServiceResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_service_info
This method enables an API user to get the service record from the database
Parameters	GetServiceInfoRequest
Return Value	GetServiceInfoResponse
Realm	administrator, reseller, retail customer, account, cc staff
Standalone mode support	Yes

GetServiceInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_service	No	unsignedLong	No	The unique ID of the service record.

GetServiceInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_info	No	ServiceInfo structure	No	The information about the service.

get_service_list
This method allows an API user to get the list of services
Parameters	GetServiceListRequest
Return Value	GetServiceListResponse
Realm	administrator, reseller, retail customer, account, cc staff, distributor, representative
Standalone mode support	Yes

GetServiceListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	string	No	Get the total number of the retrieved services.
get_usage	No	int	No	Get information about usage of the services.
i_service_type	No	string	No	The unique ID of the Service Type.
i_st_charge_unit	No	unsignedLong	No	The unique ID of the related service type charge unit.
i_tax_transaction_code	No	unsignedLong	No	The identifier of the tax transaction code.
internal	No	string	No	Indicates whether the service is considered for internal usage.	Possible values: Y, N
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Name pattern of a service.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Min value: 0
order_by	No	string	No	Sorting criteria (enum 'i_service', 'name'), the default value is 'i_service'.	Possible values: i_service, name
order_direction	No	string	No	Sorting direction (enum 'ASC', 'DESC'), the default value is 'ASC'.	Possible values: DESC, ASC
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges. You will use these units to specify your rating prices, and the usage details in xDRs will be shown in these units.
rating_base	No	string	No	Specification of which particular parameter is used to calculate charges, e.g. "session time", "amount of data transferred" and the like. Where applicable, the rating base selection also defines what is to be used as the base unit; e.g. for the Internet Access service you could use bytes, kilobytes or megabytes as the base unit.
ratio	No	int	No	If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration.	Min value: 1
unit	No	string	No	A customer-visible name for the units in which service use is measured; this also would be the smallest possible unit you can use in the rating configuration.
usage_rating	No	string	No	Shows whether usage charging is mandatory for the Service.	Possible values: Y, N

GetServiceListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_list	No	Array of ServiceInfo structure	Yes	The list of services.
total	No	int	No	The number of the retrieved services.

update_service
This method enables an API user to update the service record using the supplied data
Parameters	UpdateServiceRequest
Return Value	AddUpdateServiceResponse
Realm	administrator
Standalone mode support	No

UpdateServiceRequest
Property	Mandatory	Type	Nillable	Description	Possible values
service_info	No	ServiceInfo structure	No	The information about service.

Service pool management

add_service_pool
This method enables an API user to create a new service pool record using the supplied data
Parameters	AddUpdateServicePoolRequest
Return Value	AddUpdateServicePoolResponse
Realm	administrator
Standalone mode support	No

AddUpdateServicePoolRequest
Property	Mandatory	Type	Nillable	Description	Possible values
service_pool_info	Yes	ServiceInfo structure	No	Information about the service pool.

AddUpdateServicePoolResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_service	No	unsignedLong	No	The unique ID of the service pool record.

get_service_pool_info
This method enables an API user to get the service pool info
Parameters	GetServicePoolInfoRequest
Return Value	GetServicePoolInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetServicePoolInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_pooling_service	Yes	unsignedLong	No	The ID of the service pool.

GetServicePoolInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_pool_info	No	ServiceInfo structure	Yes	The service pool information.

get_service_pool_list
This method enables an API user to get the list of all configured service pools for the current environment
Parameters	GetServicePoolListRequest
Return Value	GetServicePoolListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetServicePoolListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetServicePoolListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_pool_list	No	Array of ServiceInfo structure	Yes	The list of the service pools.

update_service_pool
This method enables an API user to update the service pool record using the supplied data
Parameters	AddUpdateServicePoolRequest
Return Value	AddUpdateServicePoolResponse
Realm	administrator
Standalone mode support	No

Type management

get_service_type_info
This method allows an API user to get a service type record from the database
Parameters	GetServiceTypeInfoRequest
Return Value	GetServiceTypeInfoResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetServiceTypeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_type	No	unsignedLong	No	Unique ID of the Service Type.

GetServiceTypeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_type_info	No	ServiceTypeInfo structure	No	Set of service type records.

get_service_type_list
This method allows an API user to get the list of service types
Parameters	GetServiceTypeListRequest
Return Value	GetServiceTypeListResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetServiceTypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_charge_unit_info	No	int	No	Get information about the service type charge units.
name	No	string	No	Enables retrieving the service types list by name.
with_internal	No	int	No	If set to '1', the internal service types will be provided in the response.

GetServiceTypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_type_list	Yes	Array of ServiceTypeInfo structure	No	Set of service type records.

Service policy information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/ServicePolicy

Service policy management

add_service_policy
This method enables an API user to create a new service policy
Parameters	AddServicePolicyRequest
Return Value	AddServicePolicyResponse
Realm	administrator
Standalone mode support	No

AddServicePolicyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
service_policy_info	Yes	ServicePolicyInfo structure	No	The service policy info.

AddServicePolicyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_policy	Yes	unsignedLong	No	The unique identifier of the service policy.

delete_service_policy
This method enables an API user to delete the service policy
Parameters	DeleteServicePolicyRequest
Return Value	DeleteServicePolicyResponse
Realm	administrator
Standalone mode support	No

DeleteServicePolicyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_policy	Yes	unsignedLong	No	The unique identifier of the service policy.

DeleteServicePolicyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_attribute_list
This method enables an API user to get a list of service policy attributes
Parameters	GetServicePolicyAttributeListRequest
Return Value	GetServicePolicyAttributeListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetServicePolicyAttributeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_type	Yes	unsignedLong	No	The unique ID of the service type.

GetServicePolicyAttributeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
attribute_list	No	Array of ServicePolicyAttributeInfo structure	No	The list of the retrieved service policy attributes.

get_service_policy_info
This method enables an API user to get a service policy and its attribute values
Parameters	GetServicePolicyInfoRequest
Return Value	GetServicePolicyInfoResponse
Realm	administrator, representative
Standalone mode support	Yes

GetServicePolicyInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_policy	Yes	unsignedLong	No	The unique identifier of the service policy.

GetServicePolicyInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_policy_info	No	ServicePolicyInfo structure	No	The service policy info.

get_service_policy_list
This method enables an API user to get a list of service policy records
Parameters	GetServicePolicyListRequest
Return Value	GetServicePolicyListResponse
Realm	administrator
Standalone mode support	Yes

GetServicePolicyListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the service policy is in use.
description	No	string	No	The description of the service policy.
get_total	No	int	No	Get the total number of service policies.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
match_pattern	No	string	No	If this field is not empty the service policy is considered dynamically matched and will be attempted for every new call initiated by internal accounts.
match_priority	No	int	No	This is only used for policies that match dynamically. If more than one service policy corresponds to the caller’s user agent name, the one with the highest priority will be used.
name	No	string	No	The name of the service policy.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0

GetServicePolicyListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
service_policy_list	No	Array of ServicePolicyInfo structure	No	The list of the retrieved service policies.
total	No	int	No	The number of the retrieved records.

update_service_policy
This method enables an API user to update the service policy and its attribute values
Parameters	UpdateServicePolicyRequest
Return Value	UpdateServicePolicyResponse
Realm	administrator
Standalone mode support	No

UpdateServicePolicyRequest
Property	Mandatory	Type	Nillable	Description	Possible values
service_policy_info	Yes	ServicePolicyInfo structure	No	The service policy info.

UpdateServicePolicyResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_policy	Yes	unsignedLong	No	The unique identifier of the service policy.

SIM card information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/SIMCard

SIM card management

add_sim_card
This method enables an API user to create a new sim card record using the supplied data
Parameters	AddSIMCardRequest
Return Value	AddUpdateSIMCardResponse
Realm	administrator, reseller
Standalone mode support	No

AddSIMCardRequest
Property	Mandatory	Type	Nillable	Description	Possible values
card_info	Yes	SIMCardInfo structure	No	The information about a sim card. Note: i_sim_card will be ignored.

AddUpdateSIMCardResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_sim_card	Yes	unsignedLong	No	The unique ID of a sim card record.

delete_sim_card
This method enables an API user to delete a sim card record
Parameters	DeleteSIMCardRequest
Return Value	DeleteSIMCardResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteSIMCardRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_sim_card	Yes	unsignedLong	No	The unique ID of a sim card record.

DeleteSIMCardResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_card_info
This method enables an API user to get a sim card record from the database
Parameters	GetSIMCardInfoRequest
Return Value	GetSIMCardInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetSIMCardInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The ID of the account record.
i_sim_card	No	unsignedLong	No	The ID of the SIM card record.
iccid	No	string	No	The Integrated Circuit Card Identifier of the SIM card record.
imsi	No	string	No	The International Mobile Subscriber Identity of the SIM card record.
with_effective_hlr	No	int	No	Get the effective home location register (hlr).

GetSIMCardInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
card_info	No	SIMCardInfo structure	Yes	Complete information about the SIM card.

get_card_list

This method enables an API user to get the list of sim card records

Parameters

GetSIMCardListRequest

Return Value

GetSIMCardListResponse

Realm

administrator, reseller

Standalone mode support

Yes

Attachments

Type	Download
Formats	csv, xlsx, xls
Mandatory	No

GetSIMCardListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
file_format	No	string	No	This parameter enables the user to get sim cards in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'.	Possible values: csv, xlsx, xls
get_total	No	int	No	Get the total number of all retrieved SIM card records.
i_account	No	unsignedLong	No	The ID of the account record.
iccid	No	string	No	The search pattern for the Integrated Circuit Card Id.
imsi	No	string	No	The search pattern for the International Mobile Subscriber Identity.
limit	No	int	No	The number of rows to retrieve.
managed_by	No	int	Yes	The unique ID of the reseller who owns the SIM card.
msisdn	No	string	No	The search pattern for the Mobile Subscriber Integrated Services Digital Number.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
start_imsi	No	string	No	Starting International Mobile Subscriber Identity. This field is used to get a list starting with a specific template or a specific IMSI. For example: to get a list starting from number 380930000010777 for list (..., 380930000009777, 380930000010777, 380930000011777, ...), enter 380930000010777 in this field.
status	No	string	No	Search for SIM cards based on their status. Possible values: free; used.	Possible values: free, used
with_effective_hlr	No	int	No	Get the effective home location register (hlr).

GetSIMCardListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
card_list	No	Array of SIMCardInfo structure	No	Set of SIM card data records.
total	No	int	No	The total number of retrieved SIM card data records.

update_sim_card
This method enables an API user to update a sim card record using the supplied data
Parameters	UpdateSIMCardRequest
Return Value	AddUpdateSIMCardResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateSIMCardRequest
Property	Mandatory	Type	Nillable	Description	Possible values
card_info	Yes	SIMCardInfo structure	No	The information about a sim card.

update_sim_card_list
This method enables an API user to update a list of sim card records
Parameters	UpdateSIMCardListRequest
Return Value	UpdateSIMCardListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateSIMCardListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
card_list	Yes	Array of SIMCardInfo structure	No	Set of SIM card data records.	Min value: 1

UpdateSIMCardListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

upload_sim_cards

This method enables an API user to upload sim cards into the system

Parameters

UploadSIMCardsRequest

Return Value

UploadSIMCardsResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	csv, xlsx, xls
Mandatory	Yes

UploadSIMCardsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

UploadSIMCardsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, exception on failure.

Subscription information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Subscription

Subscription management

add_subscription
This method enables an API user to add a subscription
Parameters	AddSubscriptionRequest
Return Value	AddSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

AddSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
subscription_info	No	SubscriptionInfo structure	No	Complete information about a new subscription plan.

AddSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_subscription	Yes	unsignedLong	No	The unique ID of the Subscription Plan.

delete_subscription
This method enables an API user to delete a subscription
Parameters	DeleteSubscriptionRequest
Return Value	DeleteSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_subscription	Yes	unsignedLong	No	The unique ID of the Subscription Plan.

DeleteSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful.

estimate_subscription_price_for_first_billing_period
The method enables an API user to estimate the cost of the subscription in the first billing period
Parameters	EstimateSubscriptionPriceForFirstBillingPeriodRequest
Return Value	EstimateSubscriptionPriceForFirstBillingPeriodResponse
Realm	administrator
Standalone mode support	No

EstimateSubscriptionPriceForFirstBillingPeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
discount_amount	No	float	No	The fixed discount amount.	Precision: 15, Scale: 5
i_billing_period	No	unsignedLong	No	The ID of the customer's billing period; refers to Billing_Period table.	Default value: 4 Possible values: 1, 2, 3, 4
i_subscription	Yes	unsignedLong	No	The identifier of the subscription.
no_activation_charge	No	int	No	The flag specifies if the activation fee should be excluded from the estimated price.

EstimateSubscriptionPriceForFirstBillingPeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
amount	No	float	No	The full price the user has to pay for the first billing period of the commitment usage.
iso_4217	No	string	No	The currency.

get_subscription_info
This method allows an API user (administrator or reseller) to get information about a subscription
Parameters	GetSubscriptionInfoRequest
Return Value	GetSubscriptionInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetSubscriptionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
i_subscription	Yes	unsignedLong	No	The unique ID of the Subscription Plan record.
with_discounts	No	int	No	Indicates whether a list of periodic fees will be returned for the retrieved subscription.
with_fees	No	int	No	Flag which indicates whether the periodic fees for the Subscription should be returned.

GetSubscriptionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subscription_info	No	SubscriptionInfo structure	No	Complete information about the retrieved subscription.

get_subscription_list
This method allows an API user (administrator or reseller) to get a list of subscriptions
Parameters	GetSubscriptionListRequest
Return Value	GetSubscriptionListResponse
Realm	administrator, reseller, cc staff
Standalone mode support	Yes

GetSubscriptionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
charge_model	No	int	No	Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance.	Possible values: 0, 1, 2
check_usage	No	int	No	Check whether the subscription plan is in use.
description	No	string	No	The description of the subscription plan.
get_total	No	int	No	Get the total number of the retrieved subscriptions.
i_customer	No	unsignedLong	No	The ID of the reseller who manages the Subscription.
iso_4217	No	string	No	Currency for the Subscription.	Max value: 3
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
managed_by_admin	No	string	No	Indicates that only managed by admin Subscriptions should be fetched.	Possible values: Y, N
multiple	No	string	No	Specifies whether the same subscription can be applied multiple times to one account. Possible values: N - subscription can be applied only once, Y - subscription can be applied multiple times.	Possible values: Y, N
name	No	string	No	The name of the subscription plan.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
search	No	string	No	Search pattern in the name, description and invoice description of the subscription plan.
with_discounts	No	int	No	Specifies whether a list of discounts will be returned for the retrieved subscriptions.
with_fees	No	int	No	Specifies whether a list of periodic fees will be returned for the retrieved subscriptions.
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.

GetSubscriptionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
subscriptions	No	Array of SubscriptionInfo structure	No	The list of subscriptions.
total	No	int	No	The number of the retrieved subscription data records.

update_subscription
This method enables an API user to update a subscription
Parameters	UpdateSubscriptionRequest
Return Value	UpdateSubscriptionResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateSubscriptionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
subscription_info	Yes	SubscriptionInfo structure	No	Subscription plan information.

UpdateSubscriptionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_subscription	Yes	unsignedLong	No	The unique ID of the Subscription Plan.

Tariff information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Tariff

Information and statistics management

rerate_xdrs
The method enables an API user to re-rate xDRs. It helps the API user to fix incorrect pricing information entered into a tariff Asynchronous only
Parameters	RerateXDRsRequest
Return Value	RerateXDRsResponse
Realm	administrator
Standalone mode support	No
Mode	Asyncronous only

RerateXDRsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date_from	Yes	dateTime	No	The start of the date-time interval for xDRs to be re-rated.
date_to	No	dateTime	No	The end of the date-time interval for xDRs to be re-rated (current date-time is picked if the field is left empty).	Default value: current date and time
effective_time	No	dateTime	No	The date and the time when the rates associated with the correct tariff become effective.
i_owner	No	unsignedLong	No	The unique ID of the specific xDR owner (i_customer or i_vendor) whose xDRs should be re-rated.
i_service	No	unsignedLong	No	The unique ID of the service for which xDRs should be re-rated.
i_tariff_correct	No	unsignedLong	No	The unique ID of the tariff with correct pricing information entered.
i_tariff_wrong	No	unsignedLong	No	The unique ID of the “original” tariff with incorrect pricing information entered (all tariffs are marked as wrong if the field is left empty).
owner	Yes	string	No	The xDR owner type. Possible values: 'customer', 'vendor' and 'reseller'.	Possible values: customer, vendor, reseller
process_imported_charges	No	int	No	Shows how the imported xDRs would be re-rated. Possible values: 0 - do not re-rate imported xDRs, 1 - apply charges from the correct tariff in addition to the external charges, 2 - drop external charges.	Default value: 0 Possible values: 0, 1, 2
use_override_tariffs	No	string	No	The flag is needed to check whether the customer/reseller has an override tariff defined, and if such tariff is present, apply its rates instead of the corresponding correct tariff rates. Possible values: 'Y', 'N'.	Default value: Y Possible values: Y, N

RerateXDRsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
xdrs_rerated	Yes	int	No	The total number of XDRs that were re-rated.

Override tariff rule management

add_override_tariff
This method allows an API user to add an override tariff rule
Parameters	AddUpdateOverrideTariffRequest
Return Value	AddUpdateOverrideTariffResponse
Realm	administrator, reseller
Standalone mode support	No

AddUpdateOverrideTariffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
override_tariff_info	No	OverrideTariffInfo structure	No	Complete information about the override tariff rule.

AddUpdateOverrideTariffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_override_tariff	No	unsignedLong	No	The unique override tariff rule ID.

delete_override_tariff
This method allows an API user to delete an existing override tariff rule
Parameters	DeleteOverrideTariffRequest
Return Value	DeleteOverrideTariffResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteOverrideTariffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_override_tariff	No	unsignedLong	No	The unique ID of an override tariff rule to be deleted.

DeleteOverrideTariffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
override_tariff_deleted	No	int	No	Specifies whether the override tariff was deleted: 1 - one tariff was deleted, 0 - nothing was deleted.

get_override_tariff
This method allows an API user to retrieve the override tariff
Parameters	GetOverrideTariffRequest
Return Value	GetOverrideTariffResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetOverrideTariffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer_override_tariff	No	unsignedLong	No	The unique override tariff rule ID.
i_original_tariff	No	unsignedLong	No	The unique ID of the original tariff.

GetOverrideTariffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
override_tariff	No	OverrideTariffInfo structure	No	Complete information about the override tariff rule.

get_override_tariff_list
This method allows an API user to retrieve the list of override tariffs for a customer
Parameters	GetOverrideTariffListRequest
Return Value	GetOverrideTariffListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetOverrideTariffListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	Yes	unsignedLong	No	The unique ID of the customer record for retrieving the override tariff list.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Default value: 50
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0

GetOverrideTariffListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
override_tariff_list	No	Array of OverrideTariffInfo structure	No	Complete information about the override tariff list.

update_override_tariff
This method allows an API user to update an existing override tariff rule
Parameters	AddUpdateOverrideTariffRequest
Return Value	AddUpdateOverrideTariffResponse
Realm	administrator, reseller
Standalone mode support	No

Reseller tariff management

add_resale_tariff_mappings
This method enables your resellers to define the usage charges for their subresellers. This is the tariff according to which the subreseller pays their reseller for reselling the service. It is derived from the reseller's buying tariff, i.e. the tariff the administrator uses to charge the reseller. Thus, the usage charges list is the mapping between the reseller's buying tariff (i_tariff_buy) and the selling tariff (i_tariff_sell)
Parameters	AddResaleTariffMappingsRequest
Return Value	AddResaleTariffMappingsResponse
Realm	administrator, reseller
Standalone mode support	No

AddResaleTariffMappingsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the reseller record to apply the tariff mapping to.
resale_map_list	No	Array of ResaleMapRecordInfo structure	No	The list of mappings between all of the reseller's wholesale and resale tariffs.

AddResaleTariffMappingsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_resale_map_list
This method enables an API user to retrieve the list of mappings between a reseller's wholesale and resale tariffs
Parameters	GetResaleMapListRequest
Return Value	GetResaleMapListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetResaleMapListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the reseller record: If this field is provided, then the list of mappings between the reseller's wholesale and resale tariffs is retrieved; If this field is not provided, then the list of wholesale tariffs (which should be mapped onto resale tariffs) will be retrieved.
i_tariff_buy	No	unsignedLong	No	The unique ID of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider).

GetResaleMapListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
resale_map_list	No	Array of ResaleMapRecordInfo structure	No	The list of mappings between the reseller's wholesale and resale tariffs.

get_resale_map_record
This method allows an API user (reseller) to retrieve mapping between a reseller's wholesale and resale tariffs
Parameters	GetResaleMapRecordRequest
Return Value	GetResaleMapRecordResponse
Realm	reseller
Standalone mode support	Yes

GetResaleMapRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_resale_tariff_mapping	Yes	unsignedLong	No	The unique ID of the tariff mapping record.

GetResaleMapRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
resale_map_record_info	No	ResaleMapRecordInfo structure	No	Complete information about the mapping between reseller's wholesale and resale tariffs.

update_resale_map_record
This method allows an API user (reseller) to update mapping between a reseller's wholesale and resale tariffs
Parameters	UpdateResaleMapRecordRequest
Return Value	UpdateResaleMapRecordResponse
Realm	reseller
Standalone mode support	No

UpdateResaleMapRecordRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_resale_tariff_mapping	Yes	unsignedLong	No	The unique ID of the tariff mapping record.
i_tariff_sell	No	unsignedLong	No	The unique ID of the resale tariff record (the one that the reseller charges their subresellers).

UpdateResaleMapRecordResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_resale_tariff_mapping	No	unsignedLong	No	The unique ID of the tariff mapping record.

Tariff management

add_tariff
This method allows an API user to add a tariff
Parameters	AddTariffRequest
Return Value	AddTariffResponse
Realm	administrator
Standalone mode support	No

AddTariffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
tariff_info	Yes	TariffInfo structure	No	Complete information about the tariff; for more information, see below.

AddTariffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff record.

delete_tariff
This method allows an API user to delete an existing tariff
Parameters	DeleteTariffRequest
Return Value	DeleteTariffResponse
Realm	administrator
Standalone mode support	No

DeleteTariffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff record.

DeleteTariffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

get_tariff_info
This method allows an API user to get information about a tariff
Parameters	GetTariffInfoRequest
Return Value	GetTariffInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTariffInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
i_tariff	No	unsignedLong	No	The unique ID of the tariff record.
name	No	string	No	The tariff name .	Max value: 100 Min value: 0

GetTariffInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
tariff_info	No	TariffInfo structure	No	Complete information about the tariff.

get_tariff_list
This method allows an API user to retrieve the list of tariffs
Parameters	GetTariffListRequest
Return Value	GetTariffListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTariffListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
applied_to	No	string	No	One of the following: customer, vendor, reseller, subcustomer, subreseller.	Possible values: customer, vendor, reseller, subcustomer, subreseller
check_usage	No	int	No	Check whether the tariff is in use.
get_total	No	int	No	Get the total number of the retrieved tariffs.
i_customer	No	unsignedLong	Yes	The unique ID of the customer record (managed by).
i_product	No	unsignedLong	No	The unique ID of the product.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_service_type	No	unsignedLong	No	The unique ID of the related service type.
iso_4217	No	string	No	Currency for the Tariff.	Max value: 3
limit	Yes	int	No	The number of rows to retrieve.
offset	Yes	int	No	The number of rows to retrieve.	Default value: 0
routing_ext	No	string	No	Flag that inform if the tariff contains information about the carrier's routing preferences.	Possible values: Y, N
search	No	string	No	Search pattern in the name and description of the tariff.
with_authorized_emails	No	int	No	Specifies whether to include information about authorized email addresses into the list. Possible values: 1 - Include information about authorized email addresses into the list; 0 - Do not include information about authorized email addresses into the list.
with_buying_tariffs	No	int	No	The flag that indicates whether to include buying tariffs.
with_obsolete	No	int	No	The flag that indicates whether to include outdated tariffs.
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.

GetTariffListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
tariff_list	No	Array of TariffInfo structure	No	Set of tariff data records.
total	No	int	No	The total number of the retrieved tariffs.

schedule_tariff_cloning
This method enables an API user to schedule tariff cloning
Parameters	ScheduleTariffCloningRequest
Return Value	ScheduleTariffCloningResponse
Realm	administrator
Standalone mode support	No

ScheduleTariffCloningRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff that will be cloned.
managed_by	No	int	No	The unique ID of the reseller who will own the cloned tariff. Leave the field empty for an admin tariff.
name	Yes	string	No	The name of the cloned tariff.	Min value: 1

ScheduleTariffCloningResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 in case of success, exception error message in case of failure.

test_tariff_rating
This method enables an API user to test the rating formula of the tariff
Parameters	TestTariffRatingRequest
Return Value	TestTariffRatingResponse
Realm	administrator
Standalone mode support	Yes

TestTariffRatingRequest
Property	Mandatory	Type	Nillable	Description	Possible values
available_funds	No	float	No	Simulate authorization for a situation when the user has the entered amount of available funds.
date_time	No	dateTime	No	The date and the time when the test session is initiated.	Default value: current date and time
destination	Yes	string	No	The phone number to initiate the test session.
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff DB record.
mode	Yes	int	No	1 - initiate the test based on "unit_quantity"; 2 - initiate the test based on "available_funds".	Default value: 1 Possible values: 1, 2
unit_quantity	No	int	No	The amount of the tariff service units for which the tariff rate would be tested.

TestTariffRatingResponse
Property	Mandatory	Type	Nillable	Description	Possible values
announced_charge_history	No	string	No	A short description of how the announced result values were calculated. Works only for test mode "2".
announced_credit_quantity	No	string	No	The announced calculated amount of service units that can be used for the entered "available_funds". Works only for test mode "2".
charge_history	No	string	No	A short description of how the result values were calculated.
charged_amount	No	float	No	The amount of money that would be charged for the entered "unit_quantity". Works only for test mode "1".
credit_quantity	No	string	No	The calculated amount of service units that can be used for the entered "available_funds". Works only for test mode "2".
expanded_formula	No	string	No	The rating formula with the real interval and price values.
formula	No	string	No	The rating formula used for the given destination.
unit_amount	No	float	No	The amount of service units for which the charged amount was calculated. Works only for test mode "1".

update_tariff
This method allows an API user to update an existing tariff
Parameters	UpdateTariffRequest
Return Value	UpdateTariffResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTariffRequest
Property	Mandatory	Type	Nillable	Description	Possible values
tariff_info	Yes	TariffInfo structure	No	Complete information about the tariff.

UpdateTariffResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_tariff	Yes	unsignedLong	No	The unique ID of the tariff record.

Taxation plugin information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/TaxationPlugin

Code management

add_tax_transaction_code
This method allows an API user to add a taxation code
Parameters	AddTaxTransactionCodeRequest
Return Value	AddTaxTransactionCodeResponse
Realm	administrator, reseller
Standalone mode support	No

AddTaxTransactionCodeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
tax_transaction_code_info	Yes	TaxTransactionCode structure	No	The taxation code information.

AddTaxTransactionCodeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_tax_transaction_code	Yes	unsignedLong	No	The unique ID of the taxation code database record.

delete_tax_transaction_code
This method allows an API user to delete a taxation code
Parameters	DeleteTaxTransactionCodeRequest
Return Value	DeleteTaxTransactionCodeResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteTaxTransactionCodeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_tax_transaction_code	Yes	unsignedLong	No	The unique ID of the taxation code database record.

DeleteTaxTransactionCodeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

get_tax_plugin_codes_list
This method allows an API user to get the list of all taxation codes for the specified taxation plugin
Parameters	GetTaxPluginCodesListRequest
Return Value	GetTaxPluginCodesListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTaxPluginCodesListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_billing_processor	Yes	unsignedLong	No	The ID of the billing processor.
object	No	string	No	The name of the entity to return taxation plugin codes for. Possible values: "customer" and "env".	Default value: env Possible values: env, customer

GetTaxPluginCodesListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
transaction_codes	No	Array of TaxationCode structure	No	The list of taxation codes for the specified billing processor.

get_tax_transaction_code_info
This method enables an API user to get information about a taxation code
Parameters	GetTaxTransactionCodeInfoRequest
Return Value	GetTaxTransactionCodeInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTaxTransactionCodeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_tax_transaction_code	Yes	unsignedLong	No	The unique ID of the taxation code database record.
with_plugin_codes	No	int	No	The flag shows whether to include plugin specific codes into the response.	Max value: 1 Min value: 0

GetTaxTransactionCodeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
tax_transaction_code_info	No	TaxTransactionCode structure	No	The taxation code information.

get_tax_transaction_code_list
The method enables an API user to obtain tax transaction codes
Parameters	GetTaxTransactionCodeListRequest
Return Value	GetTaxTransactionCodeListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTaxTransactionCodeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the tax transaction code is in use.
code	No	string	No	The code pattern.
description	No	string	No	The description pattern.
get_total	No	int	No	Get the total number of the retrieved taxation codes.
i_billing_processor	No	unsignedLong	No	The ID of the billing processor.
i_customer	No	unsignedLong	No	The unique ID of the customer.
limit	No	int	No	The number of rows to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
plugin_code	No	string	No	The taxation plugin code pattern.
with_plugin_codes	No	int	No	The flag shows whether to include plugin specific codes into the response.

GetTaxTransactionCodeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
tax_transaction_codes	No	Array of TaxTransactionCode structure	No	The list of tax transaction codes.
total	No	int	No	The total number of the retrieved transaction codes.

update_tax_transaction_code
This method allows an API user to update a taxation code
Parameters	UpdateTaxTransactionCodeRequest
Return Value	UpdateTaxTransactionCodeResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTaxTransactionCodeRequest
Property	Mandatory	Type	Nillable	Description	Possible values
tax_transaction_code_info	Yes	TaxTransactionCode structure	No	The taxation code information.

UpdateTaxTransactionCodeResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_tax_transaction_code	Yes	unsignedLong	No	The unique ID of the taxation code database record.

Taxation plugin management

get_suretax_exemption_code_list
This method allows an API user to get the list of SureTax exemption codes
Parameters	GetSuretaxExemptionListRequest
Return Value	GetSuretaxExemptionListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetSuretaxExemptionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetSuretaxExemptionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
exemption_code_list	No	Array of ExemptionCodeInfo structure	No	The set of exemption codes available for this taxation plug-in.

get_tax_plugin
This method allows an API user to obtain the taxation plugin record from the database
Parameters	GetTaxPluginRequest
Return Value	GetTaxPluginResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTaxPluginRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the taxation plugin was assigned to any entity.
i_billing_processor	Yes	unsignedLong	No	The unique ID of the taxation plugin database record.
with_parameters	No	int	No	If set to '1', the list of the taxation plugin parameters will be provided in the response.

GetTaxPluginResponse
Property	Mandatory	Type	Nillable	Description	Possible values
can_process_prepaid_taxes	No	int	No	Defines if the taxation plugin can make estimates and handle taxes for prepaid customers and debit accounts.
catalog_based	No	int	No	Defines if the taxation plugin requires special codes for any transaction (0 - no, 1 - yes).
i_billing_processor	No	unsignedLong	No	The unique ID of the taxation plugin database record.
is_configured	No	int	No	Shows whether the taxation plugin is configured. This field is only applicable if the "catalog_based" option is set to 1.
is_used	No	int	No	Shows whether the taxation plugin has been assigned.
name	No	string	No	The name of the taxation plugin that is displayed on the WI.
plugin	No	string	No	The name of the module responsible for handling tax calculations.
requires_configuration	No	int	No	Shows whether the taxation plugin requires configuration. This field is only applicable if the "catalog_based" option is set to 1.
tax_plugin_parameters	No	Array of TaxPluginParameterInfo structure	No	The list of taxation plugin parameters.

get_tax_plugins_list
This method allows an API user to get the list of all configured taxation plugins
Parameters	GetTaxPluginsListRequest
Return Value	GetTaxPluginsListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTaxPluginsListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the taxation plugin was assigned to any entity.
i_customer	No	unsignedLong	No	The unique ID of the reseller record.
mode	No	string	No	Defines which taxation plugins will be shown. Possible values: C – Show only configured taxation plugins (default), A – Show all taxation plugins.	Default value: C Possible values: C, A
with_parameters	No	int	No	If set to '1', the list of the taxation plugin parameters will be provided in the response.

GetTaxPluginsListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
tax_plugins	Yes	Array of TaxPluginInfo structure	No	The list of all configured taxation plugins for the specified environment.

set_tax_plugin_parameters
This method enables an API user to configure the taxation plugin parameters
Parameters	SetTaxPluginParametersRequest
Return Value	SetTaxPluginParametersResponse
Realm	administrator, reseller
Standalone mode support	No

SetTaxPluginParametersRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_plugin	Yes	unsignedLong	No	The unique ID of the taxation plugin database record.
tax_plugin_parameters	Yes	Array of TaxPluginParameterInfo structure	No	The list of taxation plugin parameters.	Min value: 1

SetTaxPluginParametersResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

Template information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Template

Template management

add_external_invoice_template

Use this method to create your custom invoice template in the system. Such custom templates are called external invoice templates. You will need to upload an external template file (e.g. an HTML+CSS file) and, optionally, images

Parameters

AddExternalTemplateRequest

Return Value

AddExternalTemplateResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	tt, tmpl, html, htm, gif, png, jpg, jpeg, jpe, bmp
Mandatory	Yes

AddExternalTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_description	No	string	No	Template description.	Max value: 255
i_customer	No	unsignedLong	Yes	The unique ID of the reseller.
name	Yes	string	No	Template name.	Max value: 64 Min value: 1

AddExternalTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.

add_tariff_download_template
Use this method to create a template for tariff download
Parameters	AddTariffDownloadTemplateRequest
Return Value	AddTariffDownloadTemplateResponse
Realm	administrator
Standalone mode support	No

AddTariffDownloadTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
custom_description	No	string	No	Template description.	Max value: 255
i_media_type	No	unsignedLong	No	The unique ID of the media type record.	Default value: 1 Possible values: 1, 2
i_time_zone	Yes	unsignedLong	No	The unique ID of the time zone.
name	Yes	string	No	Template name.	Max value: 64 Min value: 1
type	No	string	No	The name of the template type.	Default value: normal Possible values: normal, quantity_based, routing

AddTariffDownloadTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.

clone_template
Use this method to clone existing template
Parameters	CloneTemplateRequest
Return Value	CloneTemplateResponse
Realm	administrator, reseller
Standalone mode support	No

CloneTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	Yes	The unique ID of the reseller.
i_template	Yes	unsignedLong	No	The unique ID of the template.
name	Yes	string	No	Template name.	Max value: 64 Min value: 1

CloneTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.

delete_external_invoice_template_image
Use this method to delete an image from an external invoice template
Parameters	DeleteExternalTemplateImageRequest
Return Value	DeleteExternalTemplateImageResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteExternalTemplateImageRequest
Property	Mandatory	Type	Nillable	Description	Possible values
body_name	Yes	string	No	The name of the file.
i_template	Yes	unsignedLong	No	The unique ID of the template.

DeleteExternalTemplateImageResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

delete_template
Use this method to delete a template record
Parameters	DeleteTemplateRequest
Return Value	DeleteTemplateResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The ID of the template.

DeleteTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success.

get_template_component_list
Use this method to receive the list of components of the template. These are the groups into which data is split within the template (e.g. Header, Footer, Fields, etc.)
Parameters	GetTemplateComponentListRequest
Return Value	GetTemplateComponentListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTemplateComponentListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.

GetTemplateComponentListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
template_component_list	No	Array of TemplateComponentInfo structure	No	The list of the components of the template.

get_template_data_field_list
Use this method to receive the list of the template data fields. Data fields describe a single element of data, such as "invoice number", "price" or "company name". They describe how to show the data element in the output file (e.g. to what format to convert it, what post-processing rule to apply to it, etc.)
Parameters	GetTemplateDataFieldListRequest
Return Value	GetTemplateDataFieldListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTemplateDataFieldListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_component_type	No	unsignedLong	No	The unique ID of the template component type.
i_template	Yes	unsignedLong	No	The unique ID of the template.

GetTemplateDataFieldListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
template_data_field_list	No	Array of TemplateDataFieldInfo structure	No	The list of the data fields of the template.

get_template_info

Use this method to receive information about a template record (e.g. a name, a template type, the output file format, etc.)

Parameters

GetTemplateInfoRequest

Return Value

GetTemplateInfoResponse

Realm

administrator, reseller

Standalone mode support

Yes

Attachments

Type	Download
Formats	pdf
Mandatory	No

GetTemplateInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the template is in use.
generate_preview	No	int	No	If set, the template preview file will be added to the response.
i_template	Yes	unsignedLong	No	The unique ID of the template.
with_body	No	int	No	If set, the bodies of the template will be added to the response.
with_body_content	No	int	No	If 'with_body' is not set, this parameter is ignored. Otherwise, if it is set, body content will be added to the response.

GetTemplateInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
template_info	No	TemplateInfo structure	No	The template data.

get_template_list
This method enables an API user to get the list of template records
Parameters	GetTemplateListRequest
Return Value	GetTemplateListResponse
Realm	administrator
Standalone mode support	Yes

GetTemplateListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the template is in use.
get_total	No	int	No	Get the total number of templates.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller.
i_template_type	No	unsignedLong	No	The unique ID of the template type.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	The name of the template.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0

GetTemplateListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
template_list	No	Array of TemplateInfo structure	No	The list of the retrieved templates.
total	No	int	No	The number of the retrieved templates.

get_template_media_attribute_list
Use this method to receive the list of the template media attributes. These are the parameters which define data layout within the file (e.g. what separator to use in CSV files, where the data for components should be located in the file, etc.) and depend on the output file format (e.g. .csv, .xls or .pdf)
Parameters	GetTemplateMediaAttributeListRequest
Return Value	GetTemplateMediaAttributeListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTemplateMediaAttributeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.
only_visible	No	int	No	If set, attributes not shown on the Web Interface will be excluded from response.

GetTemplateMediaAttributeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
template_media_attribute_list	No	Array of TemplateMediaAttributeInfo structure	No	The list of the media attributes of the template.

update_template
Use this method to update the values of the template parameters such as the name, the description, the time zone
Parameters	UpdateTemplateRequest
Return Value	UpdateTemplateResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTemplateRequest
Property	Mandatory	Type	Nillable	Description	Possible values
template_info	Yes	TemplateInfo structure	No	The template data.

UpdateTemplateResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.

update_template_data_field_list
Use this method to update the values of the template data fields
Parameters	UpdateTemplateDataFieldListRequest
Return Value	UpdateTemplateDataFieldListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTemplateDataFieldListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.
template_data_field_list	Yes	Array of TemplateDataFieldInfo structure	No	The list of the updated data fields.

UpdateTemplateDataFieldListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

update_template_media_attribute_list
Use this method to update the values of the template media attributes
Parameters	UpdateTemplateMediaAttributeListRequest
Return Value	UpdateTemplateMediaAttributeListResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTemplateMediaAttributeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.
template_media_attribute_list	Yes	Array of TemplateMediaAttributeInfo structure	No	The list of the updated media attributes.

UpdateTemplateMediaAttributeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, exception in case of failure.

upload_external_invoice_template_body

Use this method to replace the template file of the external invoice template

Parameters

UploadExternalInvoiceFileRequest

Return Value

UploadExternalInvoiceFileResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	tt, tmpl, html, htm
Mandatory	Yes

UploadExternalInvoiceFileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_template	Yes	unsignedLong	No	The unique ID of the template.

UploadExternalInvoiceFileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

upload_external_invoice_template_image

Use this method to upload images (e.g. logos, pictures) required for an external invoice template. Supported file formats are .gif, .png, .jpg, .jpeg, .jpe, .bmp

Parameters

UploadExternalInvoiceFileRequest

Return Value

UploadExternalInvoiceFileResponse

Realm

administrator, reseller

Standalone mode support

Attachments

Type	Upload
Formats	gif, png, jpg, jpeg, jpe, bmp
Mandatory	Yes

Time period information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/TimePeriod

Time period management

add_time_period
This method enables an API user to create a new time period record using the supplied data
Parameters	AddTimePeriodRequest
Return Value	AddTimePeriodResponse
Realm	administrator, reseller
Standalone mode support	No

AddTimePeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
time_period_info	Yes	TimePeriodInfo structure	No	The information about the time period.

AddTimePeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_offpeak	Yes	unsignedLong	No	The unique ID of the time period.

delete_time_period
This method enables an API user to delete the time period record
Parameters	DeleteTimePeriodRequest
Return Value	DeleteTimePeriodResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteTimePeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_offpeak	Yes	unsignedLong	No	The unique ID of the time period.

DeleteTimePeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case os success, exception in case of failure.

get_time_period_info
This method enables an API user to retrieve the information about the time period
Parameters	GetTimePeriodInfoRequest
Return Value	GetTimePeriodInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTimePeriodInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the time period is in use.
i_offpeak	Yes	unsignedLong	No	The unique ID of the time period.

GetTimePeriodInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
time_period_info	No	TimePeriodInfo structure	No	The information about the time period.

get_time_period_list
This method enables an API user to retrieve the list of time periods
Parameters	GetTimePeriodListRequest
Return Value	GetTimePeriodListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTimePeriodListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the time period is in use.
get_total	No	int	No	Get the total number of the retrieved time periods.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller record (managed by).
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The name of the time period.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0
period_type	No	string	No	The type of the time period. Possible values: 'offpeak', 'access_policy', 'intrazone'.

GetTimePeriodListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
time_period_list	No	Array of TimePeriodInfo structure	No	A set of time period data records.
total	No	int	No	The number of the retrieved time period data records.

test_time_period
This method enables an API user to test the time period
Parameters	TestTimePeriodRequest
Return Value	TestTimePeriodResponse
Realm	administrator, reseller
Standalone mode support	Yes

TestTimePeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
date	Yes	date	No	The date to test the period definitions.
definition_list	Yes	A 2-dimensional array of the SubPeriodInfo structure	No	The list of definitions for every part (sub-period) of the period.	Max value: 1
time	Yes	time	No	The time to test the period definitions.

TestTimePeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
matched_subperiod	Yes	int	No	The number of the matched subperiod.

update_time_period
This method enables an API user to update the time period record using the supplied data
Parameters	UpdateTimePeriodRequest
Return Value	UpdateTimePeriodResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTimePeriodRequest
Property	Mandatory	Type	Nillable	Description	Possible values
time_period_info	Yes	TimePeriodInfo structure	No	The information about the time period.

UpdateTimePeriodResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_offpeak	Yes	unsignedLong	No	The unique ID of the time period.

Trace session information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/TraceSession

Session information management

get_log_info
This method enables an API user to fetch the log of the sessions
Parameters	GetSessionLogInfoRequest
Return Value	GetSessionLogInfoResponse
Realm	administrator
Standalone mode support	Yes

GetSessionLogInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
from_date	No	dateTime	No	Beginning of the search interval.
merged_session_id_list	No	Array of SessionLogIdInfo structure	No	The h323-conf-id or call-id of the session list.
session_id	Yes	string	No	The h323-conf-id or call-id of the session.
to_date	No	dateTime	No	Ending of the search interval.
with_related_sessions	No	int	No	Retrieve all related sessions with the given session id.

GetSessionLogInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
session_log	No	SessionLogInfo structure	No	The session log.

get_trace_session_list
This method enables an API user to fetch the list of the sessions
Parameters	GetTraceSessionListRequest
Return Value	GetTraceSessionListResponse
Realm	administrator
Standalone mode support	Yes

GetTraceSessionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID of the account the extension is assigned to.
cld	No	string	No	The called line phone number.
cli	No	string	No	The calling line phone number.
from_date	No	dateTime	No	Beginning of the search interval.
get_total	No	int	No	Get the total number of retrieved records.
i_connection	No	unsignedLong	No	The unique ID of the connection.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 1
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Max value: 4294967295
session_type	No	int	No	The unique ID of the session type.
source	No	string	No	Fetch sessions from a specific source. Possible values: sip, db, es (optional).	Possible values: db, sip
source_ip	No	string	No	The IP address of the entity.
status	No	string	No	Request only sessions with a certain status. Possible values: complete, failed.	Possible values: complete, failed
to_date	No	dateTime	No	Ending of the search interval.

GetTraceSessionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of retrieved records.
trace_session_list	No	Array of TraceSessionInfo structure	No	The list of the sessions.

send_to_rt

This method enables an API user to send session log to RT

Parameters

SendLogToRTRequest

Return Value

SendLogToRTResponse

Realm

administrator

Standalone mode support

Attachments

Type	Upload
Formats
Mandatory	Yes

SendLogToRTRequest
Property	Mandatory	Type	Nillable	Description	Possible values
comment	No	string	No	Comment text.
session_log_info	Yes	SessionLogInfoForRT structure	No	Meta information of the session log.
ticket_number	Yes	string	No	The issue ticket number on the Request Tracker.

SendLogToRTResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 on success, exception on failure.

Traffic profile information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/TrafficProfile

Alert management

get_fraud_traffic_alert_list
This method enables an API user to get the list of fraud traffic alerts
Parameters	GetFraudTrafficAlertListRequest
Return Value	GetFraudTrafficAlertListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetFraudTrafficAlertListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved records.
i_customer	No	unsignedLong	No	The identifier of the customer.
i_customer_class	No	unsignedLong	No	The identifier of the customer class.
i_customer_type	No	unsignedLong	No	The type of the customer. Possible values: 1 - Retail customer or subcustomer, 2 - Reseller.
i_dest_group	No	unsignedLong	No	The identifier of the destination group.
i_dest_group_set	No	unsignedLong	No	The identifier of the destination group set.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
limit	No	int	No	The number of rows to retrieve.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Min value: 0
period_from	No	dateTime	No	Get traffic alerts dated starting from this date and time.
period_to	No	dateTime	No	Get traffic alerts dated before this date and time.

GetFraudTrafficAlertListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
fraud_traffic_alert_list	No	Array of FraudTrafficAlertInfo structure	No	The list of available fraud traffic alerts.
total	No	int	No	The total number of retrieved records.

Constraint management

add_fraud_constraint
This method enables an API user to create a traffic profile fraud constraint
Parameters	AddFraudConstraintRequest
Return Value	AddFraudConstraintResponse
Realm	administrator
Standalone mode support	No

AddFraudConstraintRequest
Property	Mandatory	Type	Nillable	Description	Possible values
fraud_constraint_info	Yes	FraudConstraintInfo structure	No	Information about the traffic profile fraud constraint.

AddFraudConstraintResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ft_constraint	Yes	unsignedLong	No	The identifier of the fraud constraint.

add_spending_constraint
This method enables an API user to create a traffic profile spending constraint
Parameters	AddSpendingConstraintRequest
Return Value	AddSpendingConstraintResponse
Realm	administrator, reseller
Standalone mode support	No

AddSpendingConstraintRequest
Property	Mandatory	Type	Nillable	Description	Possible values
spending_constraint_info	Yes	SpendingConstraintInfo structure	No	Information about the traffic profile spending constraint.

AddSpendingConstraintResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_sp_constraint	Yes	unsignedLong	No	The identifier of the spending constraint.

delete_fraud_constraint
This method enables an API user to delete a traffic profile fraud constraint
Parameters	DeleteFraudConstraintRequest
Return Value	DeleteFraudConstraintResponse
Realm	administrator
Standalone mode support	No

DeleteFraudConstraintRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ft_constraint	Yes	unsignedLong	No	The identifier of the fraud constraint.

DeleteFraudConstraintResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

delete_spending_constraint
This method enables an API user to delete a traffic profile spending constraint
Parameters	DeleteSpendingConstraintRequest
Return Value	DeleteSpendingConstraintResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteSpendingConstraintRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_sp_constraint	Yes	unsignedLong	No	The identifier of the spending constraint.

DeleteSpendingConstraintResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

get_fraud_constraint_list
This method enables an API user to get the list of traffic profile fraud constraint records
Parameters	GetFraudConstraintListRequest
Return Value	GetFraudConstraintListResponse
Realm	administrator
Standalone mode support	Yes

GetFraudConstraintListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
accumulation_period	No	string	No	The name of the accumulation period.	Possible values: hour, day
check_usage	No	int	No	Check whether the traffic profile fraud constraints are in use.
get_total	No	int	No	Get the total number of retrieved records.
i_customer	No	unsignedLong	No	The identifier of the customer.
i_dest_group	No	unsignedLong	No	The identifier of the destination group.
i_traffic_profile	Yes	unsignedLong	No	The identifier of the traffic profile.
limit	No	int	No	The number of rows to retrieve.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Min value: 0
with_fraud_traffic_info	No	int	No	If the field is equal to 1, the method returns additionally fraud traffic information for each fraud constraint.

GetFraudConstraintListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
fraud_constraint_list	No	Array of FraudConstraintInfo structure	No	The list of traffic profile fraud constraints.
total	No	int	No	The total number of retrieved records.

get_spending_constraint_info
This method enables an API user to get the information about a traffic profile spending constraint
Parameters	GetSpendingConstraintInfoRequest
Return Value	GetSpendingConstraintInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetSpendingConstraintInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_sp_constraint	Yes	unsignedLong	No	The identifier of the spending constraint.

GetSpendingConstraintInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
spending_constraint_info	No	SpendingConstraintInfo structure	No	Information about the traffic profile spending constraint.

update_fraud_constraint
This method enables an API user to update a traffic profile fraud constraint
Parameters	UpdateFraudConstraintRequest
Return Value	UpdateFraudConstraintResponse
Realm	administrator
Standalone mode support	No

UpdateFraudConstraintRequest
Property	Mandatory	Type	Nillable	Description	Possible values
fraud_constraint_info	Yes	FraudConstraintInfo structure	No	Information about the traffic profile fraud constraint.

UpdateFraudConstraintResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ft_constraint	Yes	unsignedLong	No	The identifier of the fraud constraint.

update_spending_constraint
This method enables an API user to update a traffic profile spending constraint
Parameters	UpdateSpendingConstraintRequest
Return Value	UpdateSpendingConstraintResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateSpendingConstraintRequest
Property	Mandatory	Type	Nillable	Description	Possible values
spending_constraint_info	Yes	SpendingConstraintInfo structure	No	Information about the traffic profile spending constraint.

UpdateSpendingConstraintResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_sp_constraint	Yes	unsignedLong	No	The identifier of the spending constraint.

Fraud traffic management

assess_fraud_traffic
This method enables an API user to assess fraud traffic
Parameters	AssessFraudTrafficRequest
Return Value	AssessFraudTrafficResponse
Realm	administrator
Standalone mode support	No

AssessFraudTrafficRequest
Property	Mandatory	Type	Nillable	Description	Possible values
accumulation_period	Yes	string	No	The name of the accumulation period. Possible periods: [hour, day].	Possible values: hour, day
i_customer	No	unsignedLong	No	The identifier of the customer.
i_dest_group	Yes	unsignedLong	No	The identifier of the destination group.

AssessFraudTrafficResponse
Property	Mandatory	Type	Nillable	Description	Possible values
fraud_traffic_info	No	FraudTrafficInfo structure	No	Information about the fraud traffic.

Profile management

add_traffic_profile
This method enables an API user to create a traffic profile
Parameters	AddTrafficProfileRequest
Return Value	AddTrafficProfileResponse
Realm	administrator, reseller
Standalone mode support	No

AddTrafficProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
traffic_profile_info	Yes	TrafficProfileInfo structure	No	Information about the traffic profile.

AddTrafficProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_traffic_profile	Yes	unsignedLong	No	The identifier of the traffic profile.

delete_traffic_profile
This method enables an API user to delete a traffic profile
Parameters	DeleteTrafficProfileRequest
Return Value	DeleteTrafficProfileResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteTrafficProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_traffic_profile	Yes	unsignedLong	No	The identifier of the traffic profile.

DeleteTrafficProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

get_traffic_profile_info
This method enables an API user to get the information about a traffic profile
Parameters	GetTrafficProfileInfoRequest
Return Value	GetTrafficProfileInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTrafficProfileInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the traffic profile is in use.
i_traffic_profile	Yes	unsignedLong	No	The identifier of the traffic profile.
with_spending_constraint	No	int	No	If the field is equal to 1, the method returns additionally spending constraint info for each traffic profile.

GetTrafficProfileInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
traffic_profile_info	No	TrafficProfileInfo structure	No	Information about the traffic profile.

get_traffic_profile_list
This method enables an API user to get the list of traffic profile records
Parameters	GetTrafficProfileListRequest
Return Value	GetTrafficProfileListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetTrafficProfileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_draft	No	int	No	A flag that specifies whether it needs to be checked if the traffic profiles are configured. If true - the 'is_draft' flag will be returned for each retrieved record.
check_usage	No	int	No	Check whether the traffic profiles are in use.
get_total	No	int	No	Get the total number of retrieved records.
i_customer	No	unsignedLong	Yes	The identifier of the traffic profile owner to search by.
i_dest_group_set	No	unsignedLong	No	The identifier of the destination group set to search traffic profiles by.
iso_4217	No	string	No	The currency of the traffic profile to search by.
limit	No	int	No	The number of rows to retrieve.	Min value: 0
name	No	string	No	The name of the traffic profile to search by.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Min value: 0
with_extended_info	No	int	No	If the field is equal to 1, the method returns the following additional fields in the response: customer_name, dest_group_set_name.
with_spending_constraint	No	int	No	If the field is equal to 1, the method returns additionally spending constraint info for each traffic profile.

GetTrafficProfileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of retrieved records.
traffic_profile_list	Yes	Array of TrafficProfileInfo structure	No	The list of traffic profiles.

update_traffic_profile
This method enables an API user to update a traffic profile
Parameters	UpdateTrafficProfileRequest
Return Value	UpdateTrafficProfileResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateTrafficProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
traffic_profile_info	Yes	TrafficProfileInfo structure	No	Information about the traffic profile.

UpdateTrafficProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_traffic_profile	Yes	unsignedLong	No	The identifier of the traffic profile.

Transfer-to interface

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/TransferTo

Mobile remittance transaction management

get_destination_info
This method allows an API user to get a predefined set of allowed values for the specified mobile network (configured by PortaSwitch administrator in a special "mapping" tariff)
Parameters	GetDestinationInfoRequest
Return Value	GetDestinationInfoResponse
Realm	administrator, account
Standalone mode support	Yes

GetDestinationInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
destination	Yes	string	No	The destination number.
i_account	Yes	unsignedLong	No	The unique ID of the account. Not mandatory when the method that requires this structure is executed from the account realm.
operator_id	No	int	No	The unique ID of the destination mobile network.	Min value: 1

GetDestinationInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
country	No	string	No	The country of the payment receiver.
destination	No	string	No	The destination number.
error_code	Yes	int	No	Error codes (see their description above).
error_description	Yes	string	No	A brief error description.
input_currency	No	string	No	The account's currency.
operator	No	string	No	The mobile operator of the payment receiver.
operator_id	No	int	No	The unique ID of the destination mobile network.
output_currency	No	string	No	The currency in the destination country.
price_list	No	Array of PriceListInfo structure	No	The list of a predefined set of allowed values for the mobile network.

get_transfer_info
This method allows an API user to get a transaction status.
Parameters	GetTransferInfoRequest
Return Value	GetTransferInfoResponse
Realm	administrator, account
Standalone mode support	Yes

GetTransferInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	Yes	unsignedLong	No	The unique ID of the account. Not mandatory when the method that requires this structure is executed from the account realm.
transaction_id	Yes	int	No	The unique ID of the remittance transaction.

GetTransferInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
denomination	No	float	No	Transfer amount.
description	Yes	string	No	The description of the status code. Can take one of the following values: CANNOT_FIND, COMPLETED, STARTED, FAILED (corresponds to 0, 1, 2, 3 in status_code).
destination	No	string	No	The destination number.
output_currency	No	string	No	The currency in the destination country.
status_code	Yes	int	No	The status code of the transaction. Can take one of the following values: 0, 1, 2, 3.

make_transfer
This method allows an API user to initiate a mobile remittance transaction. Funds are withdrawn from the account in PortaSwitch and the remittance processor is instructed to transfer the funds to B's mobile phone
Parameters	MakeTransferRequest
Return Value	MakeTransferResponse
Realm	administrator, account
Standalone mode support	No

MakeTransferRequest
Property	Mandatory	Type	Nillable	Description	Possible values
destination	Yes	string	No	The destination number.
i_account	Yes	unsignedLong	No	The unique ID of the account. Not mandatory when the method that requires this structure is executed from the account realm.
operator_id	No	int	No	The unique ID of the destination mobile network.	Min value: 1
output_currency	Yes	string	No	The currency in the destination country.	Max value: 3 Min value: 3
product	Yes	string	No	The amount to be added to the balance of the mobile recipient for this remittance transaction.	Min value: 1

MakeTransferResponse
Property	Mandatory	Type	Nillable	Description	Possible values
error_code	Yes	int	No	Error codes: 1001 – Empty price list for the destination requested from the remittance processor API. 1002 – Empty price list was formed on the PortaBilling side. Check your configuration and account or customer balance. 1003 – Account or customer status is blocked or inactive. 1004 – Error in the remittance processor back-end. 1005 – A remittance processor was not configured for the Account's or Customer's currency. 9999 – Another Internal error. 1..100 – Errors from the remittance processor back-end (internal processing error). 101..999 – Errors from external remittance processor API.
error_description	Yes	string	No	A brief error description.
transaction_id	No	int	No	The unique ID of the remittance transaction.

UA profiles generation inventory

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/UAProfileGenerator

UA profile management

generate_ua_profile
This method allows an API user (administrator or reseller) to generate an IP device (also known as UA) profile
Parameters	GenerateUaProfileRequest
Return Value	GenerateUaProfileResponse
Realm	administrator, reseller
Standalone mode support	No

GenerateUaProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_url	No	int	No	The URL of the generated profile.
i_account	No	unsignedLong	No	The unique ID of an account record for which the profile will be generated.
i_ua	No	unsignedLong	No	The unique ID of a UA record; refers to the UA table.
phone_type	No	string	No	Deprecated: the option is deprecated in MR73-0 and will be removed in MR76-0. Type of the phone for which profile should be generated. Possible values: Onenetuno, Sipura, Linksys, Cisco, Yealink, Grandmaster, Thompson, PortaPhone(default), Polycom, Gigaset, ATA, etc.
ua_profile_id	No	unsignedLong	No	The ID of the UA profile.

GenerateUaProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
filename	Yes	string	Yes	The name for the new generated UA profile.
profile_string_list	No	ArrayOfString	Yes	The UA profile content.
remote_url	Yes	string	Yes	The URL for a new generated UA profile ( server name + file name ).

User agent inventory

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/UA

Inventory management

get_ua_inventory_usage_statistics
This method enables an API user to get the UA device (IP phone) usage statistics summary
Parameters	GetUAInventoryUsageStatisticsRequest
Return Value	GetUAInventoryUsageStatisticsResponse
Realm	administrator
Standalone mode support	Yes

GetUAInventoryUsageStatisticsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetUAInventoryUsageStatisticsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total_free	Yes	int	No	The total number of available UA devices.
total_used	Yes	int	No	The total number of the UA devices in use.

get_ua_type_usage_statistics
This method enables an API user to get the UA device (IP phone) usage statistics grouped by type
Parameters	GetUATypeUsageStatisticsRequest
Return Value	GetUATypeUsageStatisticsResponse
Realm	administrator
Standalone mode support	Yes

GetUATypeUsageStatisticsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
Does not include any properties

GetUATypeUsageStatisticsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ua_type_usage_statistics_list	No	Array of UATypeUsageInfo structure	No	The list of UA type usage records.

Profile management

add_ua_profile
This method enables an API user to add a new UA device (IP phone) profile
Parameters	AddUAProfileRequest
Return Value	AddUAProfileResponse
Realm	administrator, reseller
Standalone mode support	Yes

AddUAProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ua_profile_info	Yes	UAProfileInfo structure	No	UA Profile information.

AddUAProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua_profile	Yes	unsignedLong	No	The unique ID of the UA Profile record.
ua_profile_id	No	int	No	The ID of the UA profile.

clone_ua_profile
This method enables an API user to clone an UA device (IP phone) profile
Parameters	CloneUAProfileRequest
Return Value	CloneUAProfileResponse
Realm	administrator, reseller
Standalone mode support	No

CloneUAProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
effective_from	No	dateTime	No	UA Profile effective from date.	Min value: current date and time
i_customer	No	unsignedLong	Yes	The unique ID of the reseller.
i_ua_profile	Yes	unsignedLong	No	The unique ID of the original UA Profile record.
name	Yes	string	No	New UA Profile name.	Max value: 32 Min value: 1

CloneUAProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua_profile	Yes	unsignedLong	No	The unique ID of the UA Profile record.

delete_ua_profile
This method enables an API user to delete а UA device (IP phone) profile
Parameters	DeleteUAProfileRequest
Return Value	DeleteUAProfileResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteUAProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua_profile	Yes	unsignedLong	No	The unique ID of the UA Profile record.

DeleteUAProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_ua_profile_info
This method enables an API user to get the information of UA device (IP phone) profile
Parameters	GetUAProfileInfoRequest
Return Value	GetUAProfileInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUAProfileInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
get_parameters	No	int	No	Include UA profile parameters into the response.
i_ua_profile	Yes	unsignedLong	No	The unique ID of the UA Profile record.

GetUAProfileInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ua_profile_info	No	UAProfileInfo structure	No	The information about the UA Profile.

get_ua_profile_list
This method enables an API user to get the list of UA device (IP phone) profiles
Parameters	GetUAProfileListRequest
Return Value	GetUAProfileListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUAProfileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Check whether the UA profile is used or not.
effective_at	No	dateTime	No	The filter enables viewing the UA profiles that were, are or will be effective at any date and time. It can work in pair with the 'effective_from' filter to view the UA profiles effective before/after/at the given date and time.
effective_from	No	string	No	The filter that enables viewing UA profiles depending on their Effective From date.	Default value: all Possible values: all, now, before, after, outdated, upcoming
get_total	No	int	No	Get the total number of the retrieved profiles.
i_customer	No	unsignedLong	No	Managed by.
i_ua_type	No	unsignedLong	No	The unique ID of the UA type.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
name	No	string	No	Pattern of the UA profile name.	Max value: 50
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.
ua_profile_id	No	int	No	ID of UA profile.
used	No	string	No	The filter that enables viewing UA profiles depending on their usage information. Works only when the 'check_usage' parameter is passed.	Possible values: Y, N
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.

GetUAProfileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved UA profiles.
ua_profile_list	No	Array of UAProfileInfo structure	No	Set of UA profile data records.

update_ua_profile
This method enables an API user to update а UA device (IP phone) profile
Parameters	UpdateUAProfileRequest
Return Value	UpdateUAProfileResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateUAProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ua_profile_info	Yes	UAProfileInfo structure	No	UA Profile information.

UpdateUAProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua_profile	Yes	unsignedLong	No	The unique ID of the UA Profile record.
ua_profile_id	No	int	No	The ID of the UA profile.

UA device management

add_ua
This method allows an API user to add a new UA device (IP phone) to the IP phone inventory
Parameters	AddUARequest
Return Value	AddUAResponse
Realm	administrator, reseller
Standalone mode support	No

AddUARequest
Property	Mandatory	Type	Nillable	Description	Possible values
ua_info	Yes	UAInfo structure	No	UA record.

AddUAResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua	Yes	unsignedLong	No	ID of UA record.

delete_ua
This method allows an API user to delete a UA device, provided that it is not being used by any account
Parameters	DeleteUARequest
Return Value	DeleteUAResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteUARequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua	Yes	unsignedLong	No	ID of UA record.

DeleteUAResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 if operation is successful, 0 if not.

get_ua_info
This method enables an API user (administrator or reseller) to get the information about a UA device (IP phone) in the IP phone inventory
Parameters	GetUAInfoRequest
Return Value	GetUAInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUAInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage_by_resellers	No	int	No	If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response.
get_effective_values	No	int	No	The flag shows whether to fetch effective values.
i_account	No	unsignedLong	No	The unique ID of the account record. This field will be ignored if 'i_ua' is provided.
i_ua	No	unsignedLong	No	ID of UA record.

GetUAInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ua_info	No	UAInfo structure	No	The information about the UA.

get_ua_list
This method allows an API user (administrator or reseller) to get the list of UA devices (IP phones) in the IP phone inventory, filtered by various parameters
Parameters	GetUAListRequest
Return Value	GetUAListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUAListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	Search pattern for UA description.
get_effective_values	No	int	No	The flag shows whether to fetch effective values.
get_total	No	int	No	Get the total number of the retrieved records.
i_customer	No	unsignedLong	No	The unique ID of the reseller record (specify 0 or empty field value to return only admin's records).
i_ua_type	No	unsignedLong	No	The unique ID of the UA type record.
inventory_id	No	string	No	Search pattern for UA inventory ID.
limit	No	int	No	The number of rows to retrieve.
mac	No	string	No	Search pattern for UA MAC address.
name	No	string	No	Search pattern for UA name.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Max value: 4294967295
profile	No	string	No	Search pattern for UA profile .
type	No	string	No	Search pattern for UA type.
usage	No	string	No	U - used (at least one port), C - completely used (all ports), F - not used, A - any state (default value).	Default value: A Possible values: A, U, F, C
with_available_ports	No	int	No	Specifies if available ports are included into the list. Possible values: 1 - include available ports into the list; 0 - don't include available ports into the list.
with_busy_ports	No	int	No	Specifies if busy ports are included into the list. Possible values: 1 - include busy ports into the list; 0 - don't include busy ports into the list.
with_shared	No	int	No	If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response.

GetUAListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved records.
ua_list	No	Array of UAInfo structure	No	Set of UA records.

update_ua
This method allows an API user to update a UA device (IP phone) in the IP phone inventory
Parameters	UpdateUARequest
Return Value	UpdateUAResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateUARequest
Property	Mandatory	Type	Nillable	Description	Possible values
ua_info	Yes	UAInfo structure	No	UA record.

UpdateUAResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua	Yes	unsignedLong	No	ID of UA record.

UA device type management

get_ua_type_list
This method enables an API user (administrator or reseller) to get the list of UA device (IP phone) types
Parameters	GetUATypeListRequest
Return Value	GetUATypeListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetUATypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Get the total number of retrieved UA types.
i_customer	No	unsignedLong	Yes	Returns UA types with configured UAs that have free ports and belong to the reseller (i_customer). The filter is applicable only if 'only_available' flag is active.
only_available	No	int	No	Return only UA types with configured UAs that have free ports.
with_hidden	No	int	No	The flag shows whether to include hidden UA types into the response.
with_shared	No	int	No	If set to '1' and the reseller's data is requested, available shared entities managed by the administrator will be added to the response. The filter is applicable only if the 'only_available' flag is active.

GetUATypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved UA types.
ua_type_list	No	Array of UATypeInfo structure	No	Set of UA type data records.

User information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/User

Generic information management

get_ui_config_list
This method is obsolete. Use the new get_ui_config_list method of the Generic service instead. This method enables an API user to get the list of the UI configs
Parameters	GetUserUIConfigListRequest
Return Value	GetUserUIConfigListResponse
Realm	administrator
Standalone mode support	Yes

GetUserUIConfigListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
section_name	No	string	No	The name of the config section to filter the response by.

GetUserUIConfigListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ui_config_list	Yes	Array of UIConfigInfo structure	No	The list of the UI configs.

update_ui_config_list
This method is obsolete. Use the new update_ui_config_list method of the Generic service instead. This method enables an API user to update the list of the UI configs
Parameters	UpdateUserUIConfigListRequest
Return Value	UpdateUserUIConfigListResponse
Realm	administrator
Standalone mode support	No

UpdateUserUIConfigListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
ui_config_list	Yes	Array of UIConfigInfo structure	No	The list of the UI configs.	Min value: 1

UpdateUserUIConfigListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 is case of success, 0 in case of failure.

Notification template management

get_notification_category_list
This method enables an API user to get the list of notification categories of the administrative user
Parameters	GetUserNotificationCategoryListRequest
Return Value	GetUserNotificationCategoryListResponse
Realm	administrator
Standalone mode support	Yes

GetUserNotificationCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	No	unsignedLong	No	The unique ID of the user record.

GetUserNotificationCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_category_list	No	Array of UserNotificationCategoryInfo structure	No	The list of notification categories with their properties.

get_notification_list
This method enables an API user to get the list of notifications of the administrative user
Parameters	GetUserNotificationListRequest
Return Value	GetUserNotificationListResponse
Realm	administrator
Standalone mode support	Yes

GetUserNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	No	unsignedLong	No	The unique ID of the user record.

GetUserNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
notification_list	No	Array of NotificationInfo structure	No	The list of notifications with their properties.
total	Yes	int	No	The total number of the retrieved notification records.

update_notification_category_list
This method is obsolete. Use the new update_notification_list method of the CustomerClass service instead. This method enables an API user to update the list of notification categories of the administrative user
Parameters	UpdateUserNotificationCategoryListRequest
Return Value	UpdateUserNotificationCategoryListResponse
Realm	administrator
Standalone mode support	No

UpdateUserNotificationCategoryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	Yes	unsignedLong	No	The unique ID of the user record.
notification_category_list	Yes	Array of UserNotificationCategoryInfo structure	No	The list of notification categories with their properties.	Min value: 1

UpdateUserNotificationCategoryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

update_notification_list
This method enables an API user to update the list of notifications of the administrative user
Parameters	UpdateUserNotificationListRequest
Return Value	UpdateUserNotificationListResponse
Realm	administrator
Standalone mode support	No

UpdateUserNotificationListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	Yes	unsignedLong	No	The ID of the user record.
notification_list	Yes	Array of UserNotificationInfo structure	No	The list of notifications with their properties.	Min value: 1

UpdateUserNotificationListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	A non-zero value means that the operation was completed.

User management

add_user
This method allows an API user to add an administrative user
Parameters	AddUserRequest
Return Value	AddUserResponse
Realm	administrator
Standalone mode support	No

AddUserRequest
Property	Mandatory	Type	Nillable	Description	Possible values
user_info	Yes	UserInfo structure	No	Complete information about the user.

AddUserResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	No	unsignedLong	No	The unique ID of the user record.

delete_user
This method allows an API user to delete an existing administrative user
Parameters	DeleteUserRequest
Return Value	DeleteUserResponse
Realm	administrator
Standalone mode support	No

DeleteUserRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	No	unsignedLong	No	The unique ID of the user record.

DeleteUserResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 for success, 0 for failure.

get_rt_requestor_list
This method allows to obtain a list of RT requestors
Parameters	GetUserRTRequestorListRequest
Return Value	GetUserRTRequestorListResponse
Realm	administrator
Standalone mode support	Yes

GetUserRTRequestorListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_total	No	int	No	Flag shows whether to include the total number of found items.
limit	No	int	No	The number of rows to retrieve.
name	No	string	No	The pattern to search requestors by in the 'name' field.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0

GetUserRTRequestorListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
rt_requestor_list	No	Array of RTRequestorInfo structure	No	The list of the RT requestors.
total	No	int	No	The number of the records found.

get_rt_ticket_list
This method allows to obtain tickets for a user from the RT server
Parameters	GetUserRTTicketListRequest
Return Value	GetUserRTTicketListResponse
Realm	administrator
Standalone mode support	Yes

GetUserRTTicketListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
created	No	date	No	Ticket creation date.
get_total	No	int	No	Get the total number of retrieved tickets.
i_user	No	unsignedLong	No	The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
id	No	int	No	Ticket number.
last_updated	No	date	No	Last date when ticket has been updated.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
priority	No	int	No	Ticket priority.
role	No	string	No	User role regarding RT tickets.	Default value: requestor Possible values: owner, requestor
status	No	string	No	Ticket status.
subject	No	string	No	Ticket subject.

GetUserRTTicketListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
ticket_list	Yes	Array of TicketInfo structure	No	The list of tickets.
total	No	int	No	The number of retrieved tickets.

get_user_info
This method allows an API user to get information about an administrative user
Parameters	GetUserInfoRequest
Return Value	GetUserInfoResponse
Realm	administrator
Standalone mode support	Yes

GetUserInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
get_rt_auth_info	No	int	No	If set to '1', the user's RT information will be provided in the response.
i_user	Yes	unsignedLong	No	The unique ID of the user record.

GetUserInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
user_info	Yes	UserInfo structure	No	Complete information about the user.

get_user_list
This method allows an API user to retrieve the list of administrative users
Parameters	GetUserInfoListRequest
Return Value	GetUserInfoListResponse
Realm	administrator
Standalone mode support	Yes

GetUserInfoListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
email	No	string	No	An email contact for the user.
get_total	No	int	No	Get the total number of the retrieved users.
hide_personal_info	No	int	No	Filter users by their ability to access personal information.
i_acl	No	unsignedLong	No	The privilege level or role assigned to the user .
i_role	No	unsignedLong	No	The identifier of the access role.
limit	No	int	No	The number of rows to retrieve.
login	No	string	No	The username for login and user identification.
offset	No	int	No	The number of rows to skip at the beginning of the list.	Max value: 4294967295
search	No	string	No	A pattern that allows searching by user's personal information (login, company name, first name, last name, baddr1, address_line_2, city, zip, cont1, cont2, phone1, phone2, email, description). Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character.
status	No	string	No	Search by the user's status.	Possible values: active, inactive, exceeded, expired

GetUserInfoListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved users.
user_list	No	Array of UserInfo structure	Yes	Set of user data records.

update_user
This method allows an API user to update an existing administrative user
Parameters	UpdateUserRequest
Return Value	UpdateUserResponse
Realm	administrator
Standalone mode support	No

UpdateUserRequest
Property	Mandatory	Type	Nillable	Description	Possible values
user_info	Yes	UserInfo structure	No	Complete information about the user.

UpdateUserResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_user	No	unsignedLong	No	The unique ID of the user record.

Vendor information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/Vendor

Connection management

add_connection
This method allows an API user to create a new vendor connection record using the supplied data
Parameters	AddConnectionRequest
Return Value	AddConnectionResponse
Realm	administrator
Standalone mode support	No

AddConnectionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
connection_info	Yes	ConnectionInfo structure	No	Vendor connection data.

AddConnectionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection	Yes	unsignedLong	No	The unique ID of the vendor connection record.

delete_connection
This method allows an API user to delete an existing vendor connection, provided it has no CDRs
Parameters	DeleteConnectionRequest
Return Value	DeleteConnectionResponse
Realm	administrator
Standalone mode support	No

DeleteConnectionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection	Yes	unsignedLong	No	The unique ID of the vendor connection record.

DeleteConnectionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 in case of success, 0 in case of failure.

get_connection_destination_group_list
This method enables an API user to get the list of connection destination groups
Parameters	GetConnectionDestinationGroupListRequest
Return Value	GetConnectionDestinationGroupListResponse
Realm	administrator
Standalone mode support	Yes

GetConnectionDestinationGroupListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection	Yes	unsignedLong	No	The unique identifier of the connection.

GetConnectionDestinationGroupListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
connection_destination_group_list	No	Array of ConnectionDestinationGroupInfo structure	No	The list of records with information about the destination group of the connection.

get_connection_info
This method allows an API user to get a connection record from the database
Parameters	GetConnectionInfoRequest
Return Value	GetConnectionInfoResponse
Realm	administrator
Standalone mode support	Yes

GetConnectionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection	Yes	unsignedLong	No	The unique ID of the vendor connection record.

GetConnectionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
connection_info	Yes	ConnectionInfo structure	Yes	Vendor connection data.

get_connection_list
This method allows an API user to obtain a list of connections that satisfy search criteria
Parameters	GetConnectionListRequest
Return Value	GetConnectionListResponse
Realm	administrator
Standalone mode support	Yes

GetConnectionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	The access number the customer dialed to reach your network.
active	No	string	No	The flag shows whether the connection is active. Possible values: 'Y' - active, 'N' - not active, 'I' - internal.	Possible values: Y, N, I
conn_type_leg_origin	No	int	No	The numeric identification of the connection type origin (the meaning depends on the service type: for VOICE CALLS, 0 - originate, 1 - answer; for messaging, 0 - outgoing message, 1 - incoming message).	Possible values: 1, 0
conn_type_technology	No	string	No	The technology used by the connection type to perform the transport.
description	No	string	No	Description of the connection.
get_total	No	string	No	Get the total number of the retrieved connections.
i_connection_type	No	unsignedLong	No	The unique ID of the connection type record.
i_node	No	unsignedLong	No	The ID of the node used for this connection.
i_service_type	No	unsignedLong	No	The type of service transported via this connection (voice calls, Internet connectivity, etc.).
i_tariff	No	unsignedLong	No	The ID of the tariff used to calculate the cost of terminating calls via this connection.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
i_vendor_acc	No	unsignedLong	No	Defines the username/password used for authorization of calls via this connection.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Works if the API request has the limit property specified.	Default value: 0
remote_ip	No	string	No	The IP of the remote gateway, e.g. 23.45.67.89.
search	No	string	No	A pattern that allows to search by vendor’s personal information (name, companyname, firstname, lastname, baddr1, address_line_2, city, zip, cont1, cont2, phone1, phone2, email, note). Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character.

GetConnectionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
connection_list	Yes	Array of ConnectionInfo structure	Yes	The list of found vendor connections.
total	No	int	No	The total number of the retrieved connections.

unblock_connection_destination_group
The method enables an API user to unblock a blocked destination group of the connection
Parameters	UnblockConnectionDestinationGroupRequest
Return Value	UnblockConnectionDestinationGroupResponse
Realm	administrator
Standalone mode support	No

UnblockConnectionDestinationGroupRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection	Yes	unsignedLong	No	The unique identifier of the connection.
i_dest_group	Yes	unsignedLong	No	The unique identifier of the destination group.

UnblockConnectionDestinationGroupResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception in case of failure.

update_connection
This method allows an API user to update an existing vendor connection record using the supplied data
Parameters	UpdateConnectionRequest
Return Value	UpdateConnectionResponse
Realm	administrator
Standalone mode support	No

UpdateConnectionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
connection_info	Yes	ConnectionInfo structure	No	Vendor connection data.

UpdateConnectionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection	Yes	unsignedLong	No	The unique ID of the vendor connection record.

Connection type management

get_connection_type_info
This method enables an API user to obtain information about a connection type
Parameters	GetConnectionTypeInfoRequest
Return Value	GetConnectionTypeInfoResponse
Realm	administrator
Standalone mode support	Yes

GetConnectionTypeInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection_type	Yes	unsignedLong	No	The unique ID of the connection type.

GetConnectionTypeInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
connection_type_info	No	ConnectionTypeInfo structure	No	The information about the connection type.

get_connection_type_list
This method enables an API user to obtain the list of connection types
Parameters	GetConnectionTypeListRequest
Return Value	GetConnectionTypeListResponse
Realm	administrator
Standalone mode support	Yes

GetConnectionTypeListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	The name of the connection type.

GetConnectionTypeListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
connection_type_list	Yes	Array of ConnectionTypeInfo structure	No	The list of fetched connection types.

DID provider account management

add_did_provider_account
This method allows an API user to create a DID provider account and connections with the specified DID provider to enable on-demand DID provisionong
Parameters	AddVendorDIDProviderAccountRequest
Return Value	AddVendorDIDProviderAccountResponse
Realm	administrator
Standalone mode support	No

AddVendorDIDProviderAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_account_info	Yes	DIDProviderAccountInfo structure	No	DID provider account info.

AddVendorDIDProviderAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_provider_acc	Yes	unsignedLong	No	The unique ID of the DID provider account.

delete_did_provider_account
This method allows an API user to delete a DID provider account and the associated connections with the DID provider
Parameters	DeleteVendorDIDProviderAccountRequest
Return Value	DeleteVendorDIDProviderAccountResponse
Realm	administrator
Standalone mode support	No

DeleteVendorDIDProviderAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_provider_acc	Yes	unsignedLong	No	The unique ID of the DID provider account.

DeleteVendorDIDProviderAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, 0 for failure.

get_did_provider_account_list
This method enables an API user to obtain the list of DID provider accounts
Parameters	GetVendorDIDProviderAccountListRequest
Return Value	GetVendorDIDProviderAccountListResponse
Realm	administrator
Standalone mode support	Yes

GetVendorDIDProviderAccountListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_provider_acc	No	unsignedLong	No	The unique ID of the DID provider account.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.

GetVendorDIDProviderAccountListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_account_list	No	Array of DIDProviderAccountInfo structure	No	The list of accounts for the DID provider.

update_did_provider_account
This method enables an API user to update a DID provider account
Parameters	UpdateVendorDIDProviderAccountRequest
Return Value	UpdateVendorDIDProviderAccountResponse
Realm	administrator
Standalone mode support	No

UpdateVendorDIDProviderAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
did_provider_account_info	Yes	DIDProviderAccountInfo structure	No	DID provider account info.

UpdateVendorDIDProviderAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_provider_acc	Yes	unsignedLong	No	The unique ID of the DID provider account.

Information and statistics management

get_xdr_list

The method enables an API user to retrieve vendor XDR records

Parameters

GetVendorXDRListRequest

Return Value

GetVendorXDRListResponse

Realm

administrator

Standalone mode support

Attachments

Type	Download
Formats	csv
Mandatory	No

GetVendorXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
call_id	No	string	No	The unique identifier of the call.
cld	No	string	No	The called line phone number.
cli	No	string	No	The calling line phone number.
connect_time_after	No	dateTime	No	Get xDRs with connect_time after this date.
connect_time_before	No	dateTime	No	Get xDRs with connect_time before this date.
format	No	string	No	This parameter enables the user to get xDRs in other formats via a SOAP attachment. Currently only the "csv" format is supported.	Possible values: csv
from_date	No	dateTime	No	Get xDRs with bill_time starting from this date.
get_total	No	int	No	Get the total number of the retrieved xDRs.
h323_conf_id	No	string	No	The unique identifier of the session.
history	No	string	No	Specifies, whether to show xDRs with 'history' that matches the pattern.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_service	No	unsignedLong	No	The unique ID of service, refers to the Services table.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
limit	No	int	No	The number of rows to retrieve.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list.	Default value: 0 Min value: 0
show_hidden	No	int	No	If set to 1, the list of hidden xDRs will be provided in the response.	Default value: 0
show_unsuccessful	No	int	No	If set to 1, the list of unsuccessful attempt xDRs will be provided in the response.	Default value: 0
to_date	No	dateTime	No	Get xDRs with bill_time before this date.

GetVendorXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The number of the retrieved xDRs.
xdr_list	No	Array of VendorXDRInfo structure	No	The list of the retrieved XDRs.

Transaction management

get_transactions_total_info
This method enables an API user to get the list of a vendor's transactions
Parameters	GetVendorTransactionsTotalInfoRequest
Return Value	GetVendorTransactionsTotalInfoResponse
Realm	administrator
Standalone mode support	Yes

GetVendorTransactionsTotalInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cld	No	string	No	The called party phone number.
cli	No	string	No	The calling party phone number.
from_date	Yes	dateTime	No	Get information recorded starting from this date.
i_service	No	unsignedLong	No	The unique ID of a service for which to show transactions; refers to the Services table.
i_vendor	Yes	unsignedLong	No	The unique ID of the vendor record.
show_unsuccessful	No	int	No	Show the records of unsuccessful attempts.
to_date	Yes	dateTime	No	Get information recorded before this date.

GetVendorTransactionsTotalInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
count	No	int	No	The total number of transactions.
iso_4217	No	string	No	Transactions currency.
per_service_info	No	Array of VendorPerServiceInfo structure	Yes	The list of objects containing information on per-service basis.
sessions_count	No	int	No	The total number of sessions.
total_amount	No	float	No	Total transactions amount.
total_info	No	Array of TotalTransInfo structure	No	The list of per-service total values.

Vendor account management

add_vendor_account
A vendor account can be used for digest authentication to secure the connection so that no one else can send traffic to the vendor, as this would then be billed to your account. Using this API method you can enter information about such accounts, so that they can be provided automatically by PortaBilling to the SIP server
Parameters	AddVendorAccountRequest
Return Value	AddVendorAccountResponse
Realm	administrator
Standalone mode support	No

AddVendorAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_account_info	Yes	VendorAccountInfo structure	No	Vendor account data.

AddVendorAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor_acc	No	unsignedLong	No	The unique ID of the vendor account record.

delete_vendor_account
This method allows an API user to delete a vendor account used for digest authentication
Parameters	DeleteVendorAccountRequest
Return Value	DeleteVendorAccountResponse
Realm	administrator
Standalone mode support	No

DeleteVendorAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor_acc	Yes	unsignedLong	No	The unique ID of the vendor account record.

DeleteVendorAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 in case of success, 0 in case of failure.

get_vendor_account_info
This method allows an API user to get a vendor account record from the database
Parameters	GetVendorAccountInfoRequest
Return Value	GetVendorAccountInfoResponse
Realm	administrator
Standalone mode support	Yes

GetVendorAccountInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor_acc	Yes	unsignedLong	No	The unique ID of the vendor account record.

GetVendorAccountInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_account_info	No	VendorAccountInfo structure	No	Vendor account data.

get_vendor_account_list
This method allows an API user to obtain a list of specific vendor's accounts used for digest authentication
Parameters	GetVendorAccountListRequest
Return Value	GetVendorAccountListResponse
Realm	administrator
Standalone mode support	Yes

GetVendorAccountListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor	No	unsignedLong	No	The unique ID of the vendor record this account belongs to.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.
offset	No	int	No	The number of rows to skip at the beginning of the list. Works if the API request has the limit property specified.	Default value: 0

GetVendorAccountListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_account_list	No	Array of VendorAccountInfo structure	No	A set of vendor account data records.

update_vendor_account
This method allows an API user to update a vendor account used for digest authentication
Parameters	UpdateVendorAccountRequest
Return Value	UpdateVendorAccountResponse
Realm	administrator
Standalone mode support	No

UpdateVendorAccountRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_account_info	Yes	VendorAccountInfo structure	No	Vendor account data.

UpdateVendorAccountResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor_acc	No	unsignedLong	No	The unique ID of the vendor account record.

Vendor management

add_vendor
This method allows an API user to create a new vendor record using the supplied data
Parameters	AddVendorRequest
Return Value	AddVendorResponse
Realm	administrator
Standalone mode support	No

AddVendorRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_info	Yes	VendorInfo structure	No	Vendor data.

AddVendorResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor	No	unsignedLong	No	The unique identifier of the created vendor.

delete_vendor
This method allows an API user to delete an existing vendor, provided it has no connections or CDRs
Parameters	DeleteVendorRequest
Return Value	DeleteVendorResponse
Realm	administrator
Standalone mode support	No

DeleteVendorRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor	Yes	unsignedLong	No	The unique ID of vendor record.

DeleteVendorResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	No	int	No	1 if operation is successful, 0 if not.

get_vendor_info
This method allows an API user to get a vendor record from the database
Parameters	GetVendorInfoRequest
Return Value	GetVendorInfoResponse
Realm	administrator
Standalone mode support	Yes

GetVendorInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
name	No	string	No	The name of the vendor.	Max value: 41

GetVendorInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_info	No	VendorInfo structure	No	Vendor data.

get_vendor_list
This method allows an API user to obtain a list of vendors that satisfy search criteria
Parameters	GetVendorListRequest
Return Value	GetVendorListResponse
Realm	administrator
Standalone mode support	Yes

GetVendorListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
companyname	No	string	No	Vendor's company name.
conn_type_leg_origin	No	int	No	The numeric identification of the vendor's connection origin (the meaning depends on the service type, e.g. for VOICE CALLS, 0 - originate, 1 - answer).
conn_type_technology	No	string	No	The technology used to perform the vendor's connection transport.
email	No	string	No	Vendor's email address.
get_connections_total	No	string	No	Get the total number of the connections configured for every vendor.
get_total	No	string	No	Get the total number of the retrieved vendors.
i_service_type	No	unsignedLong	No	The type of service the connection is used to transport (voice calls, internet connectivity, etc.).
iso_4217	No	string	No	The ISO4217 code for the currency in which the vendor is billed.
limit	No	int	No	Limit for the number of returned vendors. Mandatory for an API request with the offset property specified. The default value is read from the 'Vendors.Pager' configuration parameter.
name	No	string	No	Search pattern for vendor.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0
search	No	string	No	Pattern that allows to search by vendor's personal information (name, companyname, firstname, lastname, baddr1, address_line_2, city, zip, cont1, cont2, phone1, phone2, email, note). Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character.

GetVendorListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved vendors.
vendor_list	No	Array of VendorInfo structure	Yes	The list of found vendors.

make_transaction
This method allows an administrator to correct a vendor's balance
Parameters	MakeVendorTransactionRequest
Return Value	MakeVendorTransactionResponse
Realm	administrator
Standalone mode support	No

MakeVendorTransactionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	One of the following: Manual Charge, Manual Credit, Manual Payment, Refund.	Possible values: Manual Charge, Manual Credit, Manual Payment, Refund
amount	Yes	float	No	The amount the vendor's balance will be increased/decreased by.	Min value: 0
date_inside_billing_period	No	date	No	A date associated with the manual charge/credit. For example, you can specify a date for the manual credit action when an item is credited.
datetime_inside_billing_period	No	dateTime	No	A date and time associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited.
i_service	No	unsignedLong	No	The service for which the manual charge/credit is made.
i_vendor	Yes	unsignedLong	No	The unique ID of the vendor record.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser, and accessible only directly from the database .	Max value: 200
visible_comment	No	string	No	A comment on this transaction, visible to the vendor in the xDR browser.	Max value: 100

MakeVendorTransactionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
balance	Yes	float	No	Vendor's modified balance.
i_xdr	Yes	unsignedLong	No	The unique ID of the xDR record.

update_vendor
This method allows an API user to update an existing vendor record using the supplied data
Parameters	UpdateVendorRequest
Return Value	UpdateVendorResponse
Realm	administrator
Standalone mode support	No

UpdateVendorRequest
Property	Mandatory	Type	Nillable	Description	Possible values
vendor_info	Yes	VendorInfo structure	No	Vendor data.

UpdateVendorResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vendor	No	unsignedLong	No	The unique ID of the created vendor.

Voice quality profile information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/VoiceQualityProfile

Voice quality profile management

add_profile
This method enables an API user to add a new voice quality profile
Parameters	AddVoiceQualityProfileRequest
Return Value	AddUpdateVoiceQualityProfileResponse
Realm	administrator, reseller
Standalone mode support	No

AddVoiceQualityProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
profile_info	Yes	VoiceQualityProfileInfo structure	No	The information about a voice quality profile.

AddUpdateVoiceQualityProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_vq_profile	Yes	unsignedLong	No	The ID of the voice quality profile.

delete_profile
This method enables an API user to delete a voice quality profile
Parameters	DeleteVoiceQualityProfileRequest
Return Value	DeleteVoiceQualityProfileResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteVoiceQualityProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_vq_profile	Yes	unsignedLong	No	The ID of the voice quality profile.

DeleteVoiceQualityProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 if the voice quality profile was deleted.

get_profile_info
This method enables an API user to get the voice quality profile information
Parameters	GetVoiceQualityProfileInfoRequest
Return Value	GetVoiceQualityProfileInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVoiceQualityProfileInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Checks whether the voice quality profile is in use.
i_vq_profile	Yes	unsignedLong	No	The ID of the voice quality profile.

GetVoiceQualityProfileInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
profile_info	No	VoiceQualityProfileInfo structure	No	The voice quality profile information.

get_profile_list
This method enables an API user to get the list of voice quality profiles
Parameters	GetVoiceQualityProfileListRequest
Return Value	GetVoiceQualityProfileListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetVoiceQualityProfileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Checks whether the voice quality profiles are in use.
get_total	No	int	No	Gets the total number of the retrieved records.
limit	No	int	No	The number of rows to retrieve. Mandatory if the offset property is specified.	Min value: 0
managed_by	No	unsignedLong	Yes	The ID of the reseller who manages the required voice quality profiles. If undefined, only profiles managed by the administrator will be returned.
name	No	string	No	The name pattern of the voice quality profiles to retrieve.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property value defined.	Default value: 0 Min value: 0

GetVoiceQualityProfileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
profile_list	Yes	Array of VoiceQualityProfileInfo structure	Yes	The list of voice quality profiles.
total	No	int	No	The total number of voice quality profiles found.

update_profile
This method enables an API user to update a voice quality profile information
Parameters	UpdateVoiceQualityProfileRequest
Return Value	AddUpdateVoiceQualityProfileResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateVoiceQualityProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
profile_info	Yes	VoiceQualityProfileInfo structure	No	The information about a voice quality profile. Only fields requiring modification should be provided. The i_vq_profile parameter of the structure is mandatory.

Voice roaming profile information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/RoamingProfile

Roaming profile management

add_roaming_profile
This method enables an API user to add a new roaming profile
Parameters	AddRoamingProfileRequest
Return Value	AddUpdateRoamingProfileResponse
Realm	administrator, reseller
Standalone mode support	No

AddRoamingProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
roaming_profile_info	Yes	RoamingProfileInfo structure	No	The information about the roaming profile. Note that the name and policy parameters of the RoamingProfileInfo structure are mandatory in this case.

AddUpdateRoamingProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_roaming_profile	Yes	unsignedLong	No	The unique ID of the roaming profile.

clone_roaming_profile
This method enables an API user to clone a roaming profile
Parameters	CloneRoamingProfileRequest
Return Value	CloneRoamingProfileResponse
Realm	administrator, reseller
Standalone mode support	No

CloneRoamingProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_roaming_profile	Yes	unsignedLong	No	The unique ID of the roaming profile to be cloned.
managed_by	No	unsignedLong	No	The ID of the roaming profile owner record.
name	Yes	string	No	The name of the roaming profile clone.	Max value: 32 Min value: 1

CloneRoamingProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
i_roaming_profile	Yes	unsignedLong	No	The unique ID of the roaming profile clone.

delete_roaming_profile
This method enables an API user to delete the roaming profile
Parameters	DeleteRoamingProfileRequest
Return Value	DeleteRoamingProfileResponse
Realm	administrator, reseller
Standalone mode support	No

DeleteRoamingProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_roaming_profile	Yes	unsignedLong	No	The unique ID of the roaming profile.

DeleteRoamingProfileResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Possible values: 1 – The roaming profile was deleted. 0 – The roaming profile was not deleted.

get_roaming_country_list
This method enables an API user to get the list of roaming countries
Parameters	GetRoamingCountryListRequest
Return Value	GetRoamingCountryListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRoamingCountryListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request.	Default value: 0 Min value: 0

GetRoamingCountryListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
roaming_country_list	Yes	Array of RoamingCountryInfo structure	Yes	The list of roaming countries.
total	No	int	No	The total number of roaming countries found.

get_roaming_profile_info
This method enables an API user to get the roaming profile information
Parameters	GetRoamingProfileInfoRequest
Return Value	GetRoamingProfileInfoResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRoamingProfileInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
i_roaming_profile	Yes	unsignedLong	No	The unique ID of the roaming profile.
with_countries	No	int	No	Specifies whether the lists of roaming countries for each restriction level will be returned for the retrieved roaming profile.
with_policy	No	int	No	Specifies whether the fraud policy for each restriction level will be returned for the retrieved roaming profile.

GetRoamingProfileInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
roaming_profile_info	No	RoamingProfileInfo structure	No	The roaming profile information.

get_roaming_profile_list
This method enables an API user to get the list of roaming profiles
Parameters	GetRoamingProfileListRequest
Return Value	GetRoamingProfileListResponse
Realm	administrator, reseller
Standalone mode support	Yes

GetRoamingProfileListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
check_usage	No	int	No	Checks whether the roaming profiles are in use.
filter	No	string	No	Allows retrieving roaming profiles by the name or part of the name.
get_total	No	int	No	Specifies whether to show the total number of roaming profiles found. Then, even if, e.g. the limit property is specified, the total number of roaming profiles that satisfy other conditions will be shown.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
managed_by	No	unsignedLong	Yes	The unique ID of the reseller who manages the required roaming profiles.
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request.	Default value: 0 Min value: 0
with_countries	No	int	No	Specifies whether the lists of roaming countries for each restriction level will be returned for each item in the list of roaming profiles.

GetRoamingProfileListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
roaming_profile_list	Yes	Array of RoamingProfileInfo structure	Yes	The list of roaming profiles.
total	No	int	No	The total number of roaming profiles found.

update_roaming_profile
This method enables an API user to update the roaming profile information
Parameters	UpdateRoamingProfileRequest
Return Value	AddUpdateRoamingProfileResponse
Realm	administrator, reseller
Standalone mode support	No

UpdateRoamingProfileRequest
Property	Mandatory	Type	Nillable	Description	Possible values
roaming_profile_info	Yes	RoamingProfileInfo structure	No	The information about the roaming profile.

Web log information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/WebLog

Web log management

add_note
This method enables an API user to manually add an entry into an entity's web log
Parameters	AddNoteRequest
Return Value	AddNoteResponse
Realm	administrator
Standalone mode support	No

AddNoteRequest
Property	Mandatory	Type	Nillable	Description	Possible values
description	Yes	string	No	The contents of the note.
detailed_response	No	int	No	Specifies whether the added record will be returned in the response.
entity_type	Yes	string	No	The type of the entity (e.g. Accounts, Customers, etc.).	Max value: 50
i_entity	Yes	string	No	The unique ID of the entity for which the note will be created.

AddNoteResponse
Property	Mandatory	Type	Nillable	Description	Possible values
note_info	No	WebLogInfo structure	No	The complete information about the note.
success	Yes	int	No	1 for success, 0 for failure.

get_web_log_list
This method enables an API user to get the list of web log records
Parameters	GetWebLogListRequest
Return Value	GetWebLogListResponse
Realm	administrator
Standalone mode support	Yes

GetWebLogListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
action_type	No	string	No	The type of the action (e.g. modify or read) that was applied to the entity.	Default value: modification Possible values: modification, read
description	No	string	No	The description of the web log record.
entity_name	No	string	No	The name of the entity to which the changes were applied.	Max value: 128
entity_type	No	string	No	The type of the entity (e.g. Accounts, Customers, etc.). Mandatory for an API request with the i_entity/entity_name property specified.	Max value: 50
fields	No	Array of WebLogFieldInfo structure	No	The list of fields affected by the change.	Min value: 1
from_time	No	dateTime	No	Get web log records dated on or after this date and time.
i_entity	No	unsignedLong	No	The unique ID of the entity to which the changes were applied.
i_user	No	unsignedLong	No	The unique ID of the user.
ip	No	string	No	The IP address of the user.	Max value: 64
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Default value: 50 Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Min value: 0
realm	No	string	No	The unique name of the realm (e.g. admin, accounts, customer, etc.). Mandatory for an API request with the i_user property specified.	Possible values: admin, cc_staff, online, customer, offline, representative, accounts, reseller, vendor
to_time	No	dateTime	No	Get web log records dated before or on this date and time.

GetWebLogListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of web log records.
web_log_list	Yes	Array of WebLogInfo structure	Yes	The list of web log records.

XDR Mediator information

SOAP URI (namespace): https://portabilling-web.yourdomain.com/Porta/SOAP/XDRMediator

XDR Mediator management

batch_process_collection
This method enables an API user to launch the reprocessing of the collection that contains rejected xDRs
Parameters	ProcessCollectionRequest
Return Value	ProcessCollectionResponse
Realm	administrator
Standalone mode support	No

ProcessCollectionRequest
Property	Mandatory	Type	Nillable	Description	Possible values
collection_list	Yes	Array of XDRCollectionInfo structure	No	The list of the xDR collection names.	Min value: 1

ProcessCollectionResponse
Property	Mandatory	Type	Nillable	Description	Possible values
result_list	Yes	Array of XDRCollectionInfo structure	No	The list of xDR collection names that successfully scheduled for reprocessing.
success	Yes	int	No	1 on success, exception on failure.

download_collection_skipped_xdrs

This method enables an API user to get a file with the list of xDRs rejected due to parsing errors

Parameters

DownloadCollectionSkippedXDRsRequest

Return Value

DownloadCollectionSkippedXDRsResponse

Realm

administrator

Standalone mode support

Yes

Attachments

Type	Download
Formats
Mandatory	No

DownloadCollectionSkippedXDRsRequest
Property	Mandatory	Type	Nillable	Description	Possible values
collection_name	Yes	string	No	The name of the xDR collection.

DownloadCollectionSkippedXDRsResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	Returns 1 in case of success, 0 in case of failure.

get_xdr_collection_info
This method enables an API user to get the information about the xDR collection
Parameters	GetXDRCollectionInfoRequest
Return Value	GetXDRCollectionInfoResponse
Realm	administrator
Standalone mode support	Yes

GetXDRCollectionInfoRequest
Property	Mandatory	Type	Nillable	Description	Possible values
collection_name	Yes	string	No	The name of the xDR collection.

GetXDRCollectionInfoResponse
Property	Mandatory	Type	Nillable	Description	Possible values
xdr_collection_info	No	XDRCollectionInfo structure	No	The xDR collection information.

get_xdr_collection_list
This method enables an API user to get the list of xDR collections
Parameters	GetXDRCollectionListRequest
Return Value	GetXDRCollectionListResponse
Realm	administrator
Standalone mode support	Yes

GetXDRCollectionListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
collection_name	No	string	No	The name of the xDR collection.
from_date	No	dateTime	No	Beginning of the search interval.
get_total	No	int	No	Get the total number of retrieved records.	Default value: 0
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Max value: 4294967295
status	No	string	No	The status of the xDR collection.	Possible values: new, processing, finished
to_date	No	dateTime	No	Ending of the search interval.
with_errors_only	No	string	No	Get xDR collections with errors only. (enum: Y - with errors only, N - without errors only). Get any collection if the flag is not specified.	Possible values: Y, N

GetXDRCollectionListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
total	No	int	No	The total number of the retrieved records.
xdr_collection_list	No	Array of XDRCollectionInfo structure	No	The list of the xDR collections.

get_xdr_info
This method enables an API user to get the information about the xDR in the collection
Parameters	GetMediatorXDRInfoDetailedRequest
Return Value	GetMediatorXDRInfoDetailedResponse
Realm	administrator
Standalone mode support	Yes

GetMediatorXDRInfoDetailedRequest
Property	Mandatory	Type	Nillable	Description	Possible values
collection_name	Yes	string	No	The name of the xDR collection.
xdr_id	Yes	string	No	The ID of the xDR record.

GetMediatorXDRInfoDetailedResponse
Property	Mandatory	Type	Nillable	Description	Possible values
xdr_info	No	MediatorXDRInfoDetailed structure	No	The detailed xDR record information.

get_xdr_list
This method enables an API user to get the list of xDRs in the collection
Parameters	GetXDRListRequest
Return Value	GetXDRListResponse
Realm	administrator
Standalone mode support	Yes

GetXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
cld	No	string	No	The CLD match pattern.
collection_name	Yes	string	No	The name of the xDR collection.
connect_time_from	No	dateTime	No	Beginning of the search interval.
connect_time_to	No	dateTime	No	Ending of the search interval.
error_type	No	string	No	The xDR processing error type.	Possible values: account_charge_error, vendor_charge_error, radius_error, other_error
get_total	No	int	No	Get the total number of retrieved records.	Default value: 0
i_customer	No	unsignedLong	No	The ID of the customer.
i_service	No	unsignedLong	No	The ID of the service.
i_service_type	No	unsignedLong	No	The ID of the service type.
i_vendor	No	unsignedLong	No	The ID of the vendor.
limit	No	int	No	The number of rows to retrieve. Mandatory for an API request with the offset property specified.	Min value: 0
offset	No	int	No	The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request.	Default value: 0 Max value: 4294967295
status	No	string	No	The status of the xDR record.	Possible values: todo, incomplete, skipped, rejected, imported
user_name	No	string	No	The name of the user.

GetXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
collection_stat_info	No	XDRCollectionDetailedInfo structure	No	An information about xDR records within the collection grouped by status and error type.
total	No	int	No	The total number of the retrieved records.
xdr_list	No	Array of MediatorXDRInfo structure	No	The list of the xDR records in the collection.

reprocess_xdr_list
This method enables an API user to reprocess specific xdr list in the collection
Parameters	ReprocessMediatorXDRListRequest
Return Value	ReprocessMediatorXDRListResponse
Realm	administrator
Standalone mode support	No

ReprocessMediatorXDRListRequest
Property	Mandatory	Type	Nillable	Description	Possible values
collection_name	Yes	string	No	The name of the xDR collection.
xdr_id_list	Yes	Array of MediatorXDRId structure	No	The list of the xDR ids to reprocess.	Min value: 1

ReprocessMediatorXDRListResponse
Property	Mandatory	Type	Nillable	Description	Possible values
success	Yes	int	No	1 for success, exception on failure.

Common API structures

AuthInfoStructure
Property	Mandatory	Type	Nillable	Description	Possible values
csrf_token	No	string	No	The CSRF token.
login	No	string	No	The user login for the PortaBilling web interface. Should be used together with one of the following: password, token.
password	No	string	No	The user password for the PortaBilling web interface.
session_id	No	string	No	The unique ID of a previously opened SOAP session (used without a login).
token	No	string	No	The API access token of a user. Сan be used instead of a password to set up the session.

AccessPolicyInfo
Property	Mandatory	Type	Nillable	Description	Possible values
access_phases	No	Array of AccessPolicyPhaseInfo structure	No	The list of access policy phases related to the access policy.
attributes	No	Array of ServicePolicyAttributeValues structure	No	The list of related service policy attribute values.
description	No	string	No	The Access Policy description.
hotline_condition	No	string	No	In what case user should be redirected to the 'hotline_url' or 'hotline_ip'. Possible values: Off, Funds, Denied, Always.
hotline_ip	No	string	No	Redirect user to this IP if 'hotline condition' is true.
hotline_url	No	string	No	Redirect user to this URL if 'hotline condition' is true.
i_access_policy	No	unsignedLong	No	The unique ID of the Access Policy.
i_service_policy	No	unsignedLong	No	The unique ID of the Service Policy. The field is applicable only to the get_access_policy_info() and get_access_policy_list() methods.
i_service_type	No	unsignedLong	No	The unique ID of the related service type. The field is applicable only to the get_access_policy_info() and get_access_policy_list() methods.
is_used	No	int	No	Shows whether the access policy is used. The field is applicable only to the get_access_policy_info() and get_access_policy_list() methods.
managed_by	No	unsignedLong	Yes	The unique ID of the reseller who owns the Access Policy.
name	No	string	No	The name of the Access Policy.

AccessRoleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_role	No	unsignedLong	No	The identifier of the access role.
i_role_type	No	int	No	The type of the access role.
is_system	No	int	No	Shows if the access role is system or not.
is_used	No	int	No	Shows if the access role is used or not.
name	No	string	No	The name of the access role.
permissions	No	AccessComponentPermission structure	No	The permissions for the access role.

ComplexOrderingInfo
Property	Mandatory	Type	Nillable	Description	Possible values
direction	No	string	No	Specifies order direction Possible vaues: ASC, DESC.
field	No	string	No	Specifies the name of a field to order by.

AccessRoleTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_role_type	No	unsignedLong	No	The identifier of the access role type.
metadata	No	AccessComponentPermission structure	No	The components tree of the access role type.
name	No	string	No	The name of the access role type.

AccountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_expired	No	int	No	Shows whether the account has expired or not.
account_inactive	No	int	No	Shows whether the account has been already activated (i.e. its activation date came).
activation_date	No	date	No	Date from which the account is usable.
address_line_2	No	string	No	The 2nd line of the account owner's address.
assigned_addons	No	Array of ProductInfo structure	Yes	The list of account's add-on products Note that if the main product is changed via the update_account method and the list of add-on products is not provided, the existing add-on products will be removed from the account.
aux_fields	No	Array of AccountAuxFieldInfo structure	No	The data for the account's additional fields.
baddr1	No	string	No	1st line of account owner's address.
balance	No	float	No	The account's current balance.
batch_name	No	string	No	The name of the batch to which the account belongs; this may be passed as a parameter to the add_account method instead of i_batch value; if there is no batch record in the database with the same name, a new record will be created.
bcc	No	string	No	BCC email address.
bill_status	No	string	No	The status of the user's account: O – The account is open; I – The account is inactive; C – The account is terminated. Note that this value cannot be set via the add_account or update_account methods. If you need to terminate the account, use the terminate_account method instead.
billing_model	No	int	No	The account type; one of the following: -1 – Debit account; 0 – Recharge voucher; 1 – Credit account; 2 – Alias; 4 – Beneficiary. Debit is usually associated with prepaid cards. Credit is an account that will be invoiced for incurred costs. Voucher accounts are "refill coupons" for other types of accounts. Alias provides an alternative ID for an account. Beneficiary is dependent on a sponsor and uses their funds. This property is mandatory for the add_account, add_account_with_topup and validate_account_info methods.
blocked	No	string	No	Block account's calls.
city	No	string	No	City of account owner's address.
companyname	No	string	No	Account owner's company name.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
control_number	No	int	No	The sequential number of the account in the batch.
country	No	string	No	The code of the country in the ISO 3166-1 alpha-2 format.
credit_exceed	No	string	No	Shows whether the account has exceeded its credit limit.
credit_limit	No	float	Yes	Only available when the account type is set to "Credit". Defines the credit allowance in the account’s currency.
cust_bill_suspension_delayed	No	int	No	Specifies whether suspension of the customer that owns this account has been delayed.
customer_bill_status	No	string	No	O - the customer is open, S - the customer is suspended due to an overdue invoice, C - the customer is closed due to an unpaid invoice, E - the customer is exported.
customer_bill_suspended	No	int	No	Specifies whether the customer that owns this account has been suspended.
customer_blocked	No	string	No	Shows whether the customer that owns this account has been blocked.
customer_credit_exceed	No	string	No	Shows whether the customer that owns this account has exceeded his credit limit.
customer_name	No	string	No	The name of the customer that the account belongs to.
customer_status	No	string	No	Shows the status of the customer that owns this account.
ecommerce_enabled	No	string	No	Allow the account's owner to make online payments or set up periodical payments on the account's self-care page.
email	No	string	No	Email address associated with the account. This allows the owner of the account to reset the password for self-care access, and the new password will be sent to this email address.
expiration_date	No	date	Yes	Date from which the account will become unusable.
extension_id	No	string	No	The account's extension number.
extension_name	No	string	No	The name of the account's extension.
faxnum	No	string	No	Fax number.
first_usage	No	date	No	Date on which the account was used for the first time.
first_usage_time	No	dateTime	No	Date and time when the account was used for the first time.
firstname	No	string	No	Account owner's first name.
h323_password	No	string	No	The VoIP password used to authenticate calls made using the account.
has_custom_fields	No	int	No	Specifies that account has additional information stored in custom fields.
i_account	No	unsignedLong	No	The unique ID of the account.
i_account_balance_control_type	No	unsignedLong	No	Account balance control type.
i_account_role	No	unsignedLong	No	The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID.
i_acl	No	unsignedLong	No	The unique ID for the account's access level; refers to the Access_Levels table.
i_batch	No	unsignedLong	No	The unique ID of the batch to which the account belongs.
i_credit_card	No	unsignedLong	No	The unique ID of the account's credit card.
i_customer	No	unsignedLong	No	The unique ID of the customer record to which the account belongs.
i_customer_site	No	unsignedLong	No	The unique ID of the customer site the account belongs to.
i_did_number	No	unsignedLong	No	The unique identifier of the assigned DID number.
i_distributor	No	unsignedLong	No	The unique ID of the distributer associated with the account.
i_lang	No	string	No	The code for the account's web language; refers to Languages table.
i_master_account	No	unsignedLong	No	Applicable only to the alias and beneficiary account types; the main account this alias is associated with or the sponsor account for a beneficiary.
i_parent	No	unsignedLong	No	The unique ID of the reseller (for accounts under subcustomers). Possible values: 0 – if account is under direct customer, Otherwise – equal to reseller's ID. This field is only present in "get" responses. In "add"/"update" responses it is ignored.
i_product	No	unsignedLong	No	The unique ID for the account's product; refers to Products table.
i_role	No	unsignedLong	No	The unique ID of the account's access role; refers to the Roles table.
i_subscriber	No	unsignedLong	No	The unique ID of the account's subscriber record. Refers to the Subscribers table.
i_time_zone	No	unsignedLong	No	The unique ID for the account's time zone; refers to Time_Zones table.
i_vd_plan	No	unsignedLong	No	The unique ID for the account's discount plan; refers to the Volume_Discount_Plans table .
id	No	string	No	ID (PIN) of the account on the PortaBilling interface, unique in the environment.
idle_days	No	int	No	The number of days account has been idle for.
in_date_format	No	string	No	Input format for date indication.
in_time_format	No	string	No	Input format for time indication.
inactivity_expire_time	No	int	Yes	Specifies the number of days the account remains active after its last use or recharge.
included_services	No	Array of ServiceInfo structure	Yes	List of services available for use by the account.
is_active	No	int	No	Shows whether the account is currently usable or not: 1 – the account is now usable; 0 – the account is not usable, e.g. blocked, terminated, expired, hasn’t been activated yet, etc.
iso_4217	No	string	No	ISO4217 code for currency in which the account is billed.
iso_639_1	No	string	No	The language the user prefers when interacting with an IVR application.
issue_date	No	date	No	Date of issue of the account.
last_recharge	No	dateTime	No	Date on which the account was last recharged using IVR, web self-care, SMS, etc.
last_usage	No	dateTime	No	Date on which the account was last used.
lastname	No	string	No	Account owner's last name.
life_time	No	int	Yes	Defines the number of days the account remains active after the date of its first use. The account will expire on the first usage date + life time days.
login	No	string	No	User login for self-care web interface. Can only include digits, letters and the following symbols: "@", "-", "_", ".". Minimum value length is 4; maximum is 64 symbols.
login_to_um_is_available	No	int	No	Specifies whether the user is allowed to access the unified messaging system.
mac	No	string	No	MAC address of the CPE associated with this account.
management_number	No	string	No	A custom identifier of the account (optional).
master_account_id	No	string	No	The ID of the master account.
master_billing_model	No	int	No	The type of the master account.
midinit	No	string	No	Account owner's middle initial(s).
note	No	string	No	Short note (description).
notepad	No	string	No	When making changes in the account record, the administrator can use the Notepad tab to provide a comment detailing the reason for these changes (for example, "product changed, credited $50").
opening_balance	No	float	No	The initial balance of the account.
out_date_format	No	string	No	Output format for date indication.
out_date_time_format	No	string	No	Output format for full date/time indication.
out_time_format	No	string	No	Output format for time indication.
password	No	string	No	User password for the self-care web interface.
password_lifetime	No	int	No	Accounts's self-care WI password life time (in seconds).
password_timestamp	No	dateTime	No	Date when the password was last changed.
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
product_name	No	string	No	The name of the account's product.
product_visible_name	No	string	No	Product name visible to end user.
realm	No	string	No	A custom string. An account realm allows administrators to impose a scope of uniqueness for an account ID.
redirect_number	No	string	No	Associated number specifies the number to be sent back to the IVR in an authorization confirmation. For example, this might be a redirect to a technical support number in an IVR application.
salutation	No	string	No	Account owner's salutation.
service_features	No	Array of ServiceFeatureInfo structure	Yes	Contains values for account's service attributes.
service_flags	No	string	No	Account's service features settings; allow to see what features of the services provided are available to end users. Service flags at the product level show the default values of service attributes for all accounts which this product is assigned to. Service flags at the customer level show the default values of service attributes for all accounts of this customer. Service flags at the account level show service attributes that override the ones defined at the product and customer levels. Note that the add_account method ignores this property and the update_account method uses it only if the service_features property is absent.
sip_agent	No	string	No	If this account is currently used by a SIP phone to register with the PortaSIP server, the SIP phone identification info is displayed.
sip_contact	No	string	No	The URI of the IP phone used by the SIP Proxy to contact the IP phone.
sip_status	No	int	No	Indicates whether the account is used by a SIP phone to register with a PortaSIP server: 1 – online (the account is used by a SIP phone to register with a PortaSIP server) 0 – offline.
site_name	No	string	No	The name of the customer site the account belongs to.
state	No	string	No	Province or state.
status	No	string	No	The status of the account.
subscriber_email	No	string	No	Subscriber's email address.
time_zone_name	No	string	No	The name of the account's time zone.
timer	No	dateTime	No	Booth timer (for accounts of a callshop reseller).
ua_profile_id	No	unsignedLong	No	The unique ID for UA profile; Indicates the IP phone assigned to the account.
um_domain	No	string	No	The domain name of the PortaUM node serving the account.
um_h323_id	No	string	No	The node ID (a descriptive, human-readable name used for identification purposes) of PortaUM node serving the account.
um_ip	No	string	No	The IP address of the PortaUM node handling the account.
um_url	No	string	No	The URL to access the voicemail web interface. PortaSIP Media Server is compatible with the following formats: https://1.1.1.1:8943/src/redirect.php, https://mydomain.com:8943/src/redirect.php.
um_url_valid	No	int	No	Indicates whether the URL to access the Voicemail web interface is valid.
voucher_info	No	VoucherInfo structure	No	Voucher is used to recharge the account, used in the add_account/update_account methods.
zero_balance	No	int	No	Applicable only to debit accounts; specifies whether the account has used up all of its available funds.
zero_balance_date	No	date	No	Applicable only to debit accounts; specifies when the account has used up all of its available funds.
zip	No	string	No	Postal (zip) code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).

ChangePasswordResponseErrMessages
Property	Mandatory	Type	Nillable	Description	Possible values
new_password	No	string	No	New password error.
old_password	No	string	No	Old password error.

CustomerInfo
Property	Mandatory	Type	Nillable	Description	Possible values
address_line_2	No	string	No	The 2nd line of the customer's address.
api_token	No	string	No	The API token of the customer. You can use tokens instead of the standard login-password pairs for authenticating your applications integrated with PortaBilling via API. It is a string of 36 symbols containing the '0-9','a-f','-' characters.
aux_fields	No	Array of CustomerAuxFieldInfo structure	No	The data for the customer's additional fields.
baddr1	No	string	No	1st line of customer's address.
balance	No	float	No	Customer's balance.
balance_transfer_allowed	No	string	No	Defines if balance transfer is enabled for a Customer (Y, N).
bcc	No	string	No	BCC email address.
bill_status	No	string	No	O - the customer is open, S - the customer is suspended due to an overdue invoice, C - the customer is closed due to an unpaid invoice, E - the customer is exported.
bill_suspension_delayed	No	int	No	Shows whether suspension of customer's services has been delayed.
billed_to	No	dateTime	No	The customer's "billed to" date.
billing_lock	No	string	No	The advisory billing period closure lock. Possible values: N - vacant; C - engaged, billing period closure is restricted; F - engaged, both billing period closure and any fixups are restricted.
blocked	No	string	No	Block customer's calls.
bp_charge_cc	No	string	No	Automatically charge customer's credit card when billing period is closed. "As defined by the Customer Class" is used if empty.
bp_closure_delayed_info	No	BillingPeriodClosureDelayedInfo structure	No	The information about the customer's billing period delayed closure.
bundle_billed_to	No	dateTime	No	Any bundles earlier than this date and time are already calculated.
callshop_enabled	No	string	No	Enable callshop features on customer's self-care interface.
city	No	string	No	City of customer's address.
commission_plan_effective_from	No	dateTime	No	The date and time when the commission plan was assigned.
companyname	No	string	No	Customer's company name.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
country	No	string	No	The code of the country in the ISO 3166-1 alpha-2 format.
creation_date	No	dateTime	No	Date and time when the customer was created.
credit_exceed	No	int	No	Specifies if customer's credit limit has been exceeded.
credit_limit	No	float	Yes	Customer's credit limit value. Note that this property may be used with the nil attribute set to true, in which case the credit limit will not be enforced.
credit_limit_until	No	dateTime	No	Date and time when the temporarily extended credit limit will be automatically reverted to the original value.
credit_limit_warning	No	Array of BalanceWarningThreshold structure	No	The list of balance warning thresholds. You can send your customers multiple reminders that will contain updated information as their balance approaches the credit limit.
deactivate_on	No	dateTime	Yes	The date when the customer will be deactivated.
discount_rate	No	float	No	The value of customer's subscription discount; a percentage.
email	No	string	No	Email address.
email_from	No	string	No	Email Address for Reseller to use as Sender Email for Customer Notifications.
estimate_taxes	No	int	No	Marks that Customer configured taxes to apply at the moment of payment.
euuid	No	string	No	The unique identifier of the environment.
faxnum	No	string	No	Fax number.
firstname	No	string	No	Customer's first name.
generate_invoice_earlier	No	string	No	Defines whether an invoice will be generated before the end of the billing period (Y, N).
has_custom_fields	No	int	No	Shows that the customer has additional information stored in custom fields.
i_acl	No	unsignedLong	No	The unique ID of the customer's access level; refers to the Access_Levels table.
i_balance_control_type	No	unsignedLong	No	Customer balance control type. Possible values: 1 - Postpaid (default); 2 - Prepaid.
i_billing_period	No	unsignedLong	No	The unique ID of the customer's billing period; refers to Billing_Period table.
i_billing_processor	No	unsignedLong	No	The unique ID of the taxation method. If blank then the taxation method defined for the customer class is used. 0 means that taxes are included in the rate.
i_commission_plan	No	unsignedLong	Yes	The ID of the overridden commission plan for this customer.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_customer_class	No	unsignedLong	No	The unique ID of the customer class; refers to Customer_Classes table.
i_customer_type	No	unsignedLong	No	Customer type: 1 (retail customer or subcustomer), 2 (reseller), 3 (distributor).
i_distributor	No	unsignedLong	No	The unique ID of the distributor record associated with the customer.
i_do_batch	No	unsignedLong	No	The unique ID of the Owner DID Batch used for DID numbers auto-provisioning.
i_lang	No	string	No	Code for customer's web language; refers to Languages table.
i_main_office	No	unsignedLong	No	The unique ID of the main office (customer record with office type 3).
i_number_scope	No	unsignedLong	No	PortaBilling can generate invoices for all customers with sequential invoice numbering distributed throughout the environment. In some cases, you may want to have more than one sequence of numbers. One of the following: 1 – Individual for Environment, 2 – Individual for Reseller, 3 – Individual for Customer.
i_number_scope_reseller	No	unsignedLong	No	The identifier of the invoice sequence numbers scope for the reseller.
i_office_type	No	unsignedLong	No	The unique ID of the Office_Types record. Possible values: 1 – none; 2 – branch_office; 3 – main_office.
i_parent	No	unsignedLong	No	Omit for a direct customer; i_customer of the reseller for a subcustomer.
i_rep	No	unsignedLong	No	The unique ID of the customer's representative; refers to Representatives table .
i_role	No	unsignedLong	No	The unique ID of the customer's access role; refers to the Roles table.
i_tariff	No	unsignedLong	No	The unique ID of the customer's tariff; refers to Tariffs table; applies to resellers only.
i_tariff_incoming	No	unsignedLong	No	The unique ID of the customer's incoming tariff; refers to Tariffs table; applies to resellers only.
i_template	No	unsignedLong	Yes	The unique ID of the customer's regular invoice template; refers to the Templates table. If undefined, the template defined in the customer class is used; if 0, invoices are not created.
i_time_zone	No	unsignedLong	No	The unique ID of the customer's time zone; refers to Time_Zones table.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
i_ui_time_zone	No	unsignedLong	Yes	The unique ID of the customer's user interface time zone; refers to the Time_Zones table.
i_vd_plan	No	unsignedLong	No	The unique ID of the customer's discount plan; refers to Volume_Discount_Plans table.
in_date_format	No	string	No	Input format for date indication.
in_time_format	No	string	No	Input format for time indication.
inclusive_taxation	No	string	No	Identifies that taxes are included in rates for a Customer (Y, N).
invoice_generation_enabled	No	int	No	Specifies whether invoice generation is enabled.
ip_filter	No	string	No	The list of IP addresses the customer can log into PortaBilling from.
is_used	No	int	No	Shows whether the customer has entities assigned.
iso_4217	No	string	No	ISO4217 code for currency in which the customer is billed.
lastname	No	string	No	Customer's last name.
login	No	string	No	Customer's login for self-care web interface.
login_allowed_ip_list	No	ArrayOfString	No	The list of IP addresses the customer can log into self-care web interface from.
max_abbreviated_length	No	int	No	Maximum allowed length of customer's abbreviated numbers; applies to retail customers only.
midinit	No	string	No	Customer's middle initial(s).
name	No	string	No	The ID of the customer on the PortaBilling® interface, unique in the billing environment.
new_i_billing_period	No	unsignedLong	No	The unique ID of the customer's future billing period; refers to the Billing_Period table.
new_i_time_zone	No	unsignedLong	No	The unique ID of the customer's future time zone; refers to the Time_Zones table.
next_billed_to	No	dateTime	No	The date of the end of the current billing period for the customer.
note	No	string	No	Short note (description).
notepad	No	string	No	When making changes in the customer record, the administrator can use the Notepad tab to provide a comment detailing the reason for these changes (for example, "product changed, credited $50").
onetime_invoice_generation_enabled	No	int	No	Specfies whether out-ofturn invoice generation is enabled. Possible values: 1 - Out-of-turn invoice generation is enabled; 0 - Out-of-turn invoice generation is disabled.
opening_balance	No	float	No	Customer's initial balance.
ot_i_template	No	unsignedLong	Yes	The unique ID of the template for the out-of-turn invoice.
ot_send_invoices	No	string	No	Defines whether an out-of-turn invoice should be automatically sent to the customer as soon as it is created. Possible values: Y – Send invoice, N – Do not send invoice. The default value is Y.
out_date_format	No	string	No	Output format for date indication on customer's self-care interface.
out_date_time_format	No	string	No	Output format for full date/time indication.
out_time_format	No	string	No	Output format for time indication.
override_tariffs_enabled	No	string	No	Specifies whether the Override Tariffs feature is enabled: Y - enabled, N - disabled.
password	No	string	No	Customer's password for self-care web interface.
password_lifetime	No	int	No	Customer's self-care WI password life time (in seconds).
password_timestamp	No	dateTime	No	Date when the password was changed.
payment_commission_rate	No	float	No	The commition applied when payment is entered (only applicable to distributor).
payment_method_info	No	PaymentMethodInfo structure	No	Payment method info to be assigned to the customer being created/updated. Used in add_customer/update_customer.
pdf_generation_mode	No	string	No	Generate Invoice PDF: C - At the end of the billing period; R - Postponed, based on resource availability; D - On demand.
perm_credit_limit	No	float	Yes	Customer's original credit limit.
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
purge_after_months	No	int	Yes	Shows when customer personal data will be deleted. -1 - functionality is disabled, 0 - immediately, N - delete in N months, NULL - inherited from the customer class.
refnum	No	string	No	Reference number (custom field).
restore_on	No	dateTime	Yes	The date when the customer status will be returned to Open.
rt_auth_info	No	RTAuthInfo structure	No	Customer's RT information.
sale_commission_rate	No	float	No	The commission that is applied when an account is created or a distributor is assigned (only applicable to distributor).
salutation	No	string	No	Customer's salutation.
scheduled_billing_change	No	date	No	A date when the billing period will close and a new billing period and a new time zone will be applied.
scheduled_status_change_list	No	Array of ScheduledCustomerStatusChangeInfo structure	No	The list of scheduled customer status changes.
send_invoices	No	string	No	Defines whether a regular invoice should be automatically sent to the customer as soon as it is created. Possible values: Y - Send invoice; N - Do not send invoice. If undefined, the settings defined in the customer class are applied.
send_statistics	No	string	No	Defines what kind of xDR statistics should be delivered to the customer by email: F - send full statistics to customer; S - send short statistics; N - do not send statistics. If undefined, the settings defined in the customer class are applied.
service_features	No	Array of ServiceFeatureInfo structure	Yes	Contains service feature values for the given customer.
service_flags	No	string	No	Customer's service features settings. Note that this property is read-only (the add_customer and update_customer methods ignore it) and it is used in the get_customer_info and get_customer_list responses as informative. To change customer's service features use the service_features property.
shifted_billing_date	No	date	No	This is applicable only for "monthly anniversary" and 30-day billing periods; allows you to set the billing date to a different day of the month in the future (used only in requests).
state	No	string	No	Province or state.
status	No	string	No	The status of the customer.
subreseller_status	No	int	No	Current Subreseller status.
suspend_on_insuff_funds	No	string	Yes	Specifies whether to suspend the customer on insufficient funds for charging subscriptions: Y - automatically suspend prepaid customers whose funds are not sufficient to cover pending subscription charges; N - do not suspend customers; Empty - the settings defined in the customer class are applied.
suspension_delay_date	No	dateTime	Yes	The date when the customer will be suspended.
tax_id	No	string	No	Tax ID.
tax_info	No	string	No	The configured taxation method options. For example: vat_exempt=no;vat_percen t=20;vat_cdr_per_service= 0.
temp_credit_limit	No	int	No	Value by which the customer's credit limit will be temporarily increased. Allows to extend the customer’s credit limit until a certain date.
terminate_on	No	dateTime	Yes	The date when the customer will be terminated.
time_zone_name	No	string	No	The name of the customer's time zone.
ui_time_zone_name	No	string	No	The unique ID of the customer's user interface time zone; refers to the Time_Zones table.
unallocated_payments	No	float	No	The customer's unallocated payments.
zip	No	string	No	Postal (zip) code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).

AccountRoleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_role	No	unsignedLong	No	The unique ID of the account role type.
inventory_usage	No	string	No	Specifies whether to retrieve the inventory for the account role type.
name	No	string	No	The name of the account role type.
realm	No	string	Yes	The top realm of the account role type.
validation_format	No	string	Yes	The validation for the ID of the account role type.

AccountControlNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
control_number	Yes	unsignedLong	No	The sequential number of the account in the batch.

CustomFieldsValuesInfo
Property	Mandatory	Type	Nillable	Description	Possible values
db_value	Yes	string	Yes	Database value of the custom field.
i_custom_field	No	unsignedLong	No	The unique ID of the custom field. Either the 'i_custom_field' or the 'name' is required for the 'update_custom_fields_values' method.
i_custom_field_value	No	unsignedLong	No	The unique ID of the custom field value. The field is ignored in the 'update_custom_fields_values' method request.
name	Yes	string	No	Custom field name.
text_value	No	string	Yes	Deprecated: the option is deprecated in MR82-0 and will be removed in MR86-0. Custom field value.

AccountProvisioningStatusInfo
Property	Mandatory	Type	Nillable	Description	Possible values
error_list	No	string	Yes	The stringed list of errors for the unsuccessful provisioning.
event_variables	No	string	Yes	The object with event variables in JSON format used for unsuccessful provisioning.
i_account	No	unsignedLong	No	The unique ID of the account.
i_group	No	unsignedLong	No	The unique ID of the account provisioning group.
last_updated	No	dateTime	No	The date and time when the field was last updated.
status	No	int	No	The status of the provisioning. Possible values: 0 - success, 1 - failed and retrying, 2 - failed completely.

AliasInfo
Property	Mandatory	Type	Nillable	Description	Possible values
blocked	No	string	No	Block the account's calls. The default value is: N.
i_account	No	unsignedLong	No	The unique ID of an account (alias).
i_account_role	No	unsignedLong	No	The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID.
i_did_number	No	unsignedLong	No	The unique identifier of the assigned DID number.
i_master_account	No	unsignedLong	No	ID of parent account record.
id	No	string	No	Alias ID.
realm	No	string	No	A custom string. An account realm allows administrators to impose a scope of uniqueness for an account ID.

AutoPaymentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
balance_threshold	No	float	No	When the customer's balance crosses this threshold their credit card will be charged for the amount specified in the pay_amount field.
frozen	No	string	No	Flag which indicates whether the auto payment was frozen.
i_object	No	unsignedLong	No	The unique ID of an account or a customer.
object	No	string	No	A type of entity (account/customer) for which the auto-payment is applied.
pay_amount	No	float	No	When the customer's balance crosses the threshold their credit card will be charged for the amount specified in this field.

ServiceFeatureInfo
Property	Mandatory	Type	Nillable	Description	Possible values
attributes	No	Array of ServiceAttributeInfo structure	Yes	The list of service feature attributes. Note that both attributes of the cli_trust service feature (the accept_caller and supply_caller attributes) are mandatory.
defined	No	int	No	Shows whether the service feature is defined on the object's service features level or not. If absent in the response, it means that the feature is always defined on the object's service features level.
effective_flag_value	No	string	Yes	A value of the service feature. It can be received in one of the two ways: inherited by the account from the customer, customer site or the product; inherited by the customer site from the customer.
flag_value	Yes	string	No	Value of the corresponding service_flag item. Note that for the cli_trust and permitted_sip_proxies service features the flag_value property is not mandatory.
locked	No	int	No	Specifies whether the feature is locked for editing for current user or not. If absent in response, then the feature can’t be locked.
locks	No	ArrayOfString	No	A list of types of users who cannot change service features. If absent in the response, it means that locks are not supported on the object's service features level .
name	Yes	string	No	Service feature name.

AccountsAdvancedSearchInfo
Property	Mandatory	Type	Nillable	Description	Possible values
bill_status	No	string	No	The billing status of the account. Possible values: O – open; I – inactive; C – terminated.
city	No	string	No	City of account owner's address.
companyname	No	string	No	Account owner's company name.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
country	No	string	No	Country code.
faxnum	No	string	No	Fax number.
firstname	No	string	No	Account owner's first name.
id	No	string	No	Search pattern for account IDs.
lastname	No	string	No	Account owner's last name.
login	No	string	No	User login for self-care web interface.
midinit	No	string	No	Account owner's middle initial(s).
note	No	string	No	Short note (description).
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
salutation	No	string	No	Account owner's salutation.
state	No	string	No	Province or state.
zip	No	string	No	Postal (zip) code.

CallBarringRuleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	Yes	unsignedLong	No	The unique ID of call barring rule.
name	No	string	Yes	Call barring rule name.
rule_description	No	string	Yes	User-friendly description of this rule.
state	Yes	string	No	'Y' if enabled, 'N' if disabled.

CPConditionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account.
i_cp_condition	No	unsignedLong	No	The unique ID of the call screening condition record.
is_used	No	string	No	Read-only – whether the condition is used in a rule (Y / N).
name	No	string	No	Name of condition.
numbers	No	Array of CPConditionNumberInfo structure	No	Used by ToNumber and FromNumber condition types.
time_window	No	CPConditionTimeWindowInfo structure	No	Used by TimeWindow condition type.
type	No	string	No	One of the following: ToNumber, FromNumber, TimeWindow.

CPRuleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	No	int	No	Specifies which action should be taken if a particular phone call satisfies conditions for a rule. Possible values: 0 - Reject, 1 - Ring Only, 2 - Forward Only, 3 - Ring Then Forward, 4 - Voicemail Only, 5 - Ring Then Voicemail, 6 - Forward Then Voicemail, 7 - Ring, Forward, Voicemail.
from_number_i_cp_condition	No	unsignedLong	Yes	The unique ID of the FromNumber condition.
i_account	No	unsignedLong	No	The unique ID of the account.
i_cp_rule	No	unsignedLong	No	The unique ID of the call screening condition record.
is_active	No	string	No	Whether rule is enabled (Y / N).
order_number	No	int	No	Read-only – ordinal number for this rule in the rule set.
time_window_i_cp_condition	No	unsignedLong	Yes	The unique ID of the TimeWindow condition.
to_number_i_cp_condition	No	unsignedLong	Yes	The unique ID of the ToNumber condition.

SaleDiscountConfigurationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_recurring_term	No	unsignedLong	No	The identifier of the commitment recurring term to which the sale discount is being configured. Can be obtained from the Commitment.get_recurring_term_list method response.
sale_discount_list	No	Array of CommitmentSaleDiscountInfo structure	No	The list of the sale discounts. The sale discounts can be applied along with the regular discount configured on the commitment level. The number of sale discounts applied to the single term is unlimited but only one sale discount can be active at the moment of time.

AccountCommitmentOneTimeTermInfo
Property	Mandatory	Type	Nillable	Description	Possible values
apply_penalty	No	string	No	Specifies whether the penalties are applied for this term if it's terminated before the end of the minimum period.
description	No	string	No	The description of the term that will be used as the description of the created charge xdr.
discount_amount	No	float	No	The discount amount applied to the charge.
fee	No	float	No	The full fee for the term.
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.
i_one_time_term	No	unsignedLong	No	The unique identifier of the one-time term.
i_service	No	unsignedLong	No	The identifier of the service that will be used for the charge xdr.

AccountCommitmentRecurringTermInfo
Property	Mandatory	Type	Nillable	Description	Possible values
addon_product_name	No	string	No	The name of the addon product.
apply_penalty	No	string	No	The flag that specifies whether the penalties should be applied for this term if the commitment is terminated before the minimum period end. Can be specified only in the commitment record termination configuration in the Account.terminate_assigned_commitment_record method. The penalties won't be applied if the commitment discount period is over (min_terminate_date is passed). Possible values: Y (default), N.
apply_sale_discount_penalty	No	string	No	The flag shows whether the penalty for the applied sale discounts should be applied. If set to 'Y', the sum of all sale discounts applied to this recurring term will be added to the total penalty. Requires the general recurring term penalty to be enabled (the 'apply_penalty' flag ). Can be specified only in the commitment record termination configuration in the Account.terminate_assigned_commitment_record method. The penalties won't be applied if the commitment discount period is over (min_terminate_date is passed). Possible values: Y (default), N.
discount_amount	No	float	No	The discount amount to apply to the recurring charge.
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.
i_addon_product	No	unsignedLong	No	The identifier of the addon product.
i_recurring_term	No	unsignedLong	No	The unique identifier of the recurring term.
i_subscription	No	unsignedLong	No	The identifier of the subscription.
sale_discount_list	No	Array of CommitmentSaleDiscountInfo structure	No	The list of the sale discounts that are associated with the recurring term. The sale discounts are applied to the recurring charge together with the commitment discount defined in the 'discount_amount' field. The period of the commitment sale discounts should not overlap. The discount period is limited by the commitment discount period.
subscription_name	No	string	No	The name of the subscription.

AccountCommitmentOneTimeEstimateTermInfo
Property	Mandatory	Type	Nillable	Description	Possible values
fee	No	float	No	The estimated fee including discounts.
i_one_time_term	No	unsignedLong	No	The unique identifier of the one-time term.

AccountCommitmentRecurringEstimateTermInfo
Property	Mandatory	Type	Nillable	Description	Possible values
fee	No	float	No	The estimated fee including discounts.
i_recurring_term	No	unsignedLong	No	The unique identifier of the recurring term.

AccountCommitmentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	date	No	The date when the charges for a commitment are activated. Activation date is shifted from the start date for the period specified by 'Commitments.ActivationDelay' in config.
apply_penalties	No	string	No	The flag that specifies whether the penalties for early termination should be applied. The flag can be overwritten on the level of a specific account commitment term during commitment termination.
apply_prev_penalty	No	string	No	The flag specifies whether the penalties should be applied from previous commitments (default: they should).
auto_prolong	No	string	No	The flag specifies whether the commitment is auto-prolonged after its initial period finished.
commitment_name	No	string	No	The name of the commitment.
finish_date	No	date	No	The date when the commitment finishes.
i_account	No	unsignedLong	No	The unique identifier of the account record.
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record.
i_commitment	No	unsignedLong	No	The unique identifier of the commitment record.
is_finished	No	string	No	The flag shows if service is no longer provided per this commitment.
is_paused	No	string	No	The flag specifies whether the commitment is paused.
min_terminate_date	No	date	No	The date specifies the end of the minimum period, after which the commitment may be terminated without penalties.
pause_from_date	No	date	No	The start of the pause.
pause_to_date	No	date	No	The end of the pause.
penalties_from_date	No	date	No	The date staring from which the penalties are calculated on the commitment termination. May be set in the request to 'terminate_assigned_commitment_record' method.
penalties_to_date	No	date	No	The date until which the penalties are calculated on the commitment termination. May be set in the request to 'terminate_assigned_commitment_record' method.
prev_penalty_amount	No	float	No	The penalties from previous commitments.
start_date	No	date	No	The date when the commitment services are enabled. The charges may be postponed by the config option 'Commitments.ActivationDelay'.

ScheduledCommitmentReplacementInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_commitment	No	unsignedLong	No	The unique identifier of the account commitment record that should be replaced. On the 'upgrade_on' date this commitment will be terminated (without penalties) and replaced with the new one.
i_addon_product	No	unsignedLong	No	The identifier of the addon product that will be assigned to the account until the upgrade is done.
i_new_commitment	No	unsignedLong	No	The unique identifier of the commitment that will be assigned to the account after the upgrade.
upgrade_on	No	date	No	The date on which the new commitment should be applied permanently. Until this date the customer may use the services provided by the new i_addon_product according to the old commitment price.

AccountCustomFieldsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_value	No	string	No	Default value for the Custom Field.
i_custom_field	No	unsignedLong	No	Unique ID of the Custom Field record.
managed_by	No	unsignedLong	No	The unique ID of the reseller who manages the Custom Field record.
mandatory	No	string	No	Shows that the Custom Field is mandatory. Possible values: 'Y', 'N'.
name	No	string	No	Name of the Custom Field.
personal_data	No	string	No	Shows that the custom field contains private data and should not be shown to unauthorized users.
properties	No	string	No	JSON-encoded Validation Schema for the Custom Field.
type	No	string	No	Canonical name of the Custom Field's type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'.
value	No	string	No	Value of the Custom Field.
visible_to_end_user	No	string	No	Shows that the Custom Field is visible to the End User. Possible values: 'Y', 'N'.

PreferableAccountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
firstname	No	string	No	Account owner's first name.
group_name	No	string	No	The name used to group frequently used accounts.
i_account	No	unsignedLong	No	The unique ID of the account.
i_owner_account	No	unsignedLong	No	The unique ID of the owner account for a frequently used account.
i_preferable_account	No	unsignedLong	No	The unique ID of the frequently used account.
id	No	string	No	ID (PIN) of the account on the PortaBilling interface, unique in the environment.
lastname	No	string	No	Account owner's last name.

FollowMeNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
active	No	string	No	Defines use of follow-me number.
domain	No	string	No	IP Address of the network device the call will be routed to. Applies to the Advanced Forwarding and Forward to SIP URI forward mode settings.
i_account	No	unsignedLong	No	The follow-me record's unique ID.
i_follow_me	No	unsignedLong	No	ID of the follow-me database record.
i_follow_me_number	No	unsignedLong	No	The unique ID for the followme number in the table.
i_follow_order	No	unsignedLong	No	Serial number or follow-me entry, sequentially incremented within array of numbers.
keep_original_cld	No	string	No	If set to Y, the call will appear as originated by the account forwarding the call; applies to the Advanced Forwarding, Forward to SIP URI and Forward CLD forward mode settings.
keep_original_cli	No	string	No	Y – a call is forwarded with the phone number and the name of the original caller; N – a call is forwarded with the phone number and the name of the forwarder; I – the phone number of the caller and the forwarder name are put in the CLI of the forwarded call.
max_sim_calls	No	int	Yes	Limits simultaneous calls. When the specified number of concurrent calls has already been established (calls are in a "connected" state) and the account tries to place another call, that call will be rejected.
name	No	string	No	The entry's symbolic name .
period	No	string	Yes	Period during which number can be used. Possible values: Always; Null; Time: hours, minute; The list of months: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'; The list of month day numbers: values from 1 to 31; The list of week days: 'su', 'mo', 'tu', 'we', 'th', 'fr', 'sa'. For instance: wd{fr},hr{5},min{35},md{5},m{jan}.
period_definition	No	Array of SubPeriodInfo structure	No	Structured definition of the period.
period_description	No	string	Yes	Verbal description of the period seen by a user on the web interface.
redirect_number	No	string	No	The number's destination.
timeout	No	int	No	Number timeout, in seconds.
use_tcp	No	string	No	Enables you to choose the TCP transport protocol. You can use the TCP protocol instead of UDP for SIP communications for PBXs that do not support UDP.
weight	No	float	No	Record weight (probability).

FollowMeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_account	No	unsignedLong	No	The unique ID of the account database record.
i_follow_me	No	unsignedLong	No	The unique ID of the follow-me database record.
max_forwards	No	int	No	For follow-me or advanced call forwarding, you must also provide a value for the Maximum Forwards parameter, so as to limit the number of concurrently active forwarding destinations allowed. Please note that you do not have to limit the total number of phone numbers entered, but rather the number of phone numbers active at any given moment of time. For instance, a user may have a list of 20 numbers, each active in its own time period, some temporarily turned off, and so on. When call forwarding is done, PortaBillingwill compute a list of numbers which may be used at that moment, and choose only the first N in the list, where N is the number specified here. The maximum value is 99.
mode	No	string	No	Deprecated: See Using Service Feature Methods to Change FollowMe Settings in the Appendix.
sequence	No	string	No	Order of use of numbers: Order - as listed, Random - random order, Simultaneous - all at once.
timeout	No	int	No	Timeout, in seconds.

AssignMultiserviceUAPortInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_type	Yes	unsignedLong	No	Specifies the type of service this port is used for. Only for multiservice devices.
port	Yes	int	No	The port number.

ProductInfo
Property	Mandatory	Type	Nillable	Description	Possible values
addon_effective_from	No	dateTime	No	Account product addon effective from date.
addon_effective_to	No	dateTime	No	Account product addon effective to date.
addon_priority	No	int	No	In order to differentiate the add-on products there is also a "precedence level" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Allowed values: 0 – Main Product, 10 – Low, 15 – Medium Low, 20 – Medium, 25 – Medium High, 30 – High.
allowed_products	No	Array of unsignedLong structure	No	The list of main products that can be used in combination with the add-on product (corresponds to the "Allowed With" tab on the web interface).
breakage	No	float	No	Used in Account Management to obtain a summary of depleted (practically unusable) accounts.
default_i_acl	No	unsignedLong	No	Which ACL should be assigned to new accounts created with this product.
description	No	string	Yes	Product description.
end_user_description	No	string	Yes	Description visible to End User.
end_user_name	No	string	Yes	Product Name visible to End User.
fraud_protection	No	string	No	Overdraft Protection mode for the Product. Possible values: 'None', 'All', 'Debit'.
hidden	No	string	No	Indicates whether the product is hidden.
i_account_role	No	unsignedLong	No	The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a topup voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID.
i_customer	No	unsignedLong	No	Managed by.
i_product	No	unsignedLong	No	The unique ID of the product record.
i_product_group	No	unsignedLong	Yes	Product Group ID.
i_subscription	No	unsignedLong	Yes	The unique ID of the Subscription Plan.
i_vd_plan	No	unsignedLong	Yes	ID of an assigned volume discount plan.
included_services	No	Array of int structure	No	The list of services provided to an end user with the product (corresponds to the "Included Services" tab on the web interface).
info_url	No	string	Yes	URL to an external website describing product features.
is_used	No	int	No	Shows if product is used or not.
is_used_by_resellers	No	int	No	Shows whether the shared product is used by resellers.
iso_4217	No	string	No	ISO4217 code for product currency.
managed_by_user	No	string	No	Can be managed by end user.
name	No	string	No	Product name.
notepad	No	string	No	Product notepad.
product_group_name	No	string	No	Product Group name.
product_subscription	No	ProductSubscriptionInfo structure	No	Product Subscription info.
realm	No	string	No	A custom string. An account realm enables administrators to impose a scope of uniqueness for an account ID.
service_features	No	Array of ServiceFeatureInfo structure	No	Contains values for service features available within the product.
service_flag_locks	No	string	No	Specifies whether values for each service feature are allowed to be changed by administrator and end user.
shared	No	string	No	Shows whether the product managed by the administrator is available to resellers.
subscription_discount_list	No	Array of SubscriptionDiscountInfo structure	No	Product Subscription discount list.
subscription_host	No	string	Yes	Deprecated: the option is deprecated in MR67-0 and will be removed in MR71-0. Left for backward compatibility.
topup_addon	No	string	No	Specifies whether this is an add-on product or the main one. Possible values: Y – an add-on product, N – the main product.
volume_discount_plan_name	No	string	Yes	The name of the associated volume discount plan.

HGInfo
Property	Mandatory	Type	Nillable	Description	Possible values
assigned_callqueue	No	CQInfo structure	No	Information about the call queue.
assigned_extensions	No	Array of AssignedExtensionsInfo structure	No	The list of assigned extension records.
hunt_keep_original_cli	No	string	No	Specifies whether to keep the original CLI; one of the following: 'Y' - The call is redirected with the phone number and name of the original caller. 'N' - The call is redirected with the phone number and name of the huntgroup. 'I' - Id Only, The call is redirected with the phone number of the original caller and name of the huntgroup. .
hunt_sequence	No	string	No	The ringing strategy; one of the following: Order, Random, Simultaneous, LeastUsed.
i_c_ext	No	unsignedLong	No	Extension ID; Refers to the Centrex_Group_Extensions table.
i_c_group	No	unsignedLong	No	The unique ID of the group record (for type = Group).
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_prompt	No	unsignedLong	Yes	The unique ID of the assigned prompt file.
i_ringback_tone	No	unsignedLong	No	The unique ID of the assigned ringback tone file.
id	No	string	No	Identifier.
name	No	string	No	The name of the owner.
pickup_allowed	No	string	No	Specifies whether to allow extensions to pick up calls made to the members of this huntgroup. Possible values: Y – Allow; N – Disallow.
prompt_error	No	string	No	A description of the last processing error.
prompt_status	No	string	No	The prompt file processing status. Possible values: IN_PROGRESS, ERROR, FINISHED.
published	No	string	No	When creating an extension you can mark it as "published" so that it is included in the dial-by-name directory. One of the following: Y – Makes an extensions accessible via dial-by-name; N – Excludes a certain extension from being accessible via dial-by-name (e.g. you do not want telemarketers to directly reach your CEO or CFO because their names are publicly accessible).

AccountMOHListInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_defined_moh_list	No	Array of MOHInfo structure	No	MOH list defined by the account.
aggregated_moh_list	No	Array of MOHInfo structure	No	Default MOH list joined with Account's defined MOH list.
default_moh_list	No	Array of MOHInfo structure	No	Default MOH list.
is_moh_update_disabled	No	int	No	Indicates whether the MOH update is allowed.
system_default_i_moh	No	unsignedLong	No	Default system MOH object.

PermittedSipProxiesInfo
Property	Mandatory	Type	Nillable	Description	Possible values
proxy_name	No	string	No	Name of the proxy.

ServiceWalletXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	Additional info.
CLI	No	string	No	Additional information about the XDR.
account_discount	No	float	No	An amount of discount used by an account.
aux_xdrs	No	Array of AuxXDRInfo structure	No	The array of auxiliary xDRs.
beneficiary_account_id	No	string	No	The unique ID of the beneficiary account if the service was consumed by a beneficiary. Otherwise, this value is the same as the 'account_id'.
bill_time	No	dateTime	No	Date and time when operation was done.
charged_amount	No	float	No	An amount of money in currency units.
charged_quantity	No	float	No	A number of charged service units.
customer_discount	No	float	No	An amount of discount used by a customer.
h323_incoming_conf_id	No	string	No	The group ID for records withing a single operation, UUID, e.g. for e-commerce topup few records: payment topup + tax records.
history	No	string	No	Additional information about XDR.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
i_dest_group	No	unsignedLong	No	ID of a destination group.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_xdr	No	unsignedLong	No	The ID of XDR record.
peak_level	No	int	No	The ID of a peak level.
used_quantity	No	float	No	A number of used service units.

ConsumedServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charged_amount	No	string	No	Amount charged.
charged_quantity	No	int	No	The number of charged units in which service is measured.
i_service	No	unsignedLong	No	The unique ID of the service record.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges.
rating_base	No	string	No	Specifies which particular parameter is used to calculate charges, e.g. "session time", "amount of data transferred" and the like.
roaming	No	int	No	Specifies the xDR's roaming status.
service_name	No	string	No	The name of the service.
total	No	int	No	The Total number of records.
total_sessions	No	int	No	The total number of the sessions.
unit	No	string	No	A customer-visible name for the units in which service use is measured.

SipStatusInfo
Property	Mandatory	Type	Nillable	Description	Possible values
callid	No	string	No	Call-id of the register request.
contact	No	string	No	URI of the user agent which the SIP Proxy uses to contact the IP phone.
domain	No	string	No	Domain of the registrar: IP address and, if port is non-standard, port number (after the colon).
expires	No	dateTime	No	Date and time this registration will expire.
flags	No	int	No	1 - UA is behind NAT.
last_modified	No	dateTime	No	Date and time the register request was received.
user_agent	No	string	No	User agent identification info.
username	No	string	No	Username of registered account; same as account's id attribute from AccountInfo.

StatusHistoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_acc_stat	No	unsignedLong	No	The unique ID of the account status change record.
i_cust_stat	No	unsignedLong	No	The unique ID of the customer status change record.
i_status	No	unsignedLong	No	The unique ID of the status record.
status_name	No	string	No	Status name.
time_stamp	No	dateTime	No	Date and time when this change was made.

AccountVdCounterHistoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
counter	No	float	No	The money amount of the counter after the delta was applied.
counter_delta	Yes	float	No	The amount of money that was applied to the counter.
discount	No	float	No	The calculated discount applied to XDR.
i_avd_counter	Yes	unsignedLong	No	The ID of the counter record from the Account_VD_Counters table.
i_history	No	unsignedLong	No	The unique ID of the record.
i_xdr	No	unsignedLong	No	The ID of the XDR record from the CDR_Accounts table.
modification_date	Yes	dateTime	No	The timestamp when the counter was updated.
unit_counter	No	int	No	The unit number of the counter after the delta was applied.
unit_counter_delta	Yes	int	No	The number of units that was applied to the counter.

AccountVdNotificationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
addon_priority	No	int	No	The add-on level for discount counter.
counter	Yes	float	No	Accumulated money amount.
counter_id	Yes	unsignedLong	No	The identifier of the account-level counter.
i_account	Yes	unsignedLong	No	The identifier of the account, unique in the environment.
i_dest_group	Yes	unsignedLong	No	The ID of the destination group to which the counter is applicable.
i_notification	No	unsignedLong	No	The unique ID of the record.
i_service	Yes	unsignedLong	No	Unique identifier of a service.
last_updated	Yes	dateTime	No	Timestamp when the notification record was last updated.
peak_level	Yes	int	No	Allow to limit the counter to specified peak level only (the unique ID ot the Time_Periods table).
unit_counter	Yes	int	No	Accumulated units amount (in service rating units).

AccountXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	Called Line Identification.
CLI	No	string	No	Calling Line Identification.
account_id	No	string	No	The identifier of the account related to the xDR, unique in the environment.
aux_xdrs	No	Array of AuxXDRInfo structure	Yes	The array of auxiliary xDRs.
beneficiary_account_id	No	string	No	The unique ID of the beneficiary account if the service was consumed by a beneficiary. Otherwise, this value is the same as 'account_id'.
bill_status	No	string	No	Call bill status.
bill_time	No	dateTime	No	Call bill time.
bit_flags	No	int	No	Extended information how the service was used; the integer field that should be treated as a bit-map. Each currently used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position).
bytes_downloaded	No	unsignedLong	No	The quantity of downloaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request.
bytes_uploaded	No	unsignedLong	No	The quantity of uploaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request.
call_id	No	string	No	The unique identifier of the call.
charged_amount	No	float	No	Amount charged.
charged_quantity	No	int	No	Units charged.
connect_time	No	dateTime	No	Call connect time.
country	No	string	No	Country.
cr_download_ids	No	ArrayOfString	No	A list of download ids for the recorded files.
description	No	string	No	Destination description.
disconnect_cause	No	string	No	The code of disconnect cause.
disconnect_reason	No	string	No	Call disconnect reason.
disconnect_time	No	dateTime	No	Call disconnect time.
failed	No	int	No	xDR call failed status.
h323_conf_id	No	string	No	The unique identifier of the session.
h323_incoming_conf_id	No	string	No	The unique ID of the incoming session (if exists) used for interrelating xDRs, when the charged session is established as a result of a previous session (possibly having its own xDR).
history	No	string	No	Additional information about XDR.
i_account	No	unsignedLong	No	The unique identifier of the account in the system.
i_customer	No	unsignedLong	No	The unique identifier of the customer in the system.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
i_rate	No	unsignedLong	Yes	The unique ID of the rate record.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_xdr	No	unsignedLong	No	ID of XDR record.
is_split	No	string	No	Shows whether the xDR is splitted.
setup_time	No	int	No	The time (in ms) between first provisional response and connect_time.
split_order	No	int	No	The sequential number in case the XDR is part of a group of XDRs resulting from the same session.
subdivision	No	string	No	Country Subdivision.
unix_connect_time	No	int	No	Call connect time (expressed in: Unix time format – seconds since epoch).
unix_disconnect_time	No	int	No	Call disconnect time (expressed in: Unix time format – seconds since epoch).

XDRQualityMetricInfo
Property	Mandatory	Type	Nillable	Description	Possible values
metric_data_list	No	Array of VoiceQualityMetricDataInfo structure	No	A set of metric data.
profile_info	No	VoiceQualityProfileInfo structure	No	The voice quality profile information.

AllowedLocationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_a_verified_locations	No	unsignedLong	No	The ID of the account's allowed location record.
i_account	No	unsignedLong	No	The unique ID of the account record.
iso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
period_from	No	dateTime	No	The start date and time of the allowed location.
period_to	No	dateTime	No	The end date and time of the allowed location.
subscriber_ip	No	string	No	Subscriber IP address.
verified_by	No	string	No	Mark shows whether the record was set by screening or by admin from web. Possible values: A, S.

UsedLocationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
country_name	No	string	No	Country name.
last_used	No	dateTime	No	The timestamp of the last usage event.
restriction_level	No	string	No	The restriction level which belongs to the location (0-no restriction, 5 - cautious, 10 - high risk).
subscriber_ip	No	string	No	Subscriber IP address.
usage_counter	No	int	No	Accumulated event counter.
verified_until	No	string	No	The timestamp for the validity of the location after it was verified by screening or administrator.

EstimateTaxesXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	Called Line Identification.
CLI	No	string	No	Calling Line Identification.
account_id	No	string	No	The unique ID of the account record. Applicable only to accounts.
bill_time	No	dateTime	No	The call bill time.
charged_amount	Yes	float	No	The amount charged.
charged_quantity	No	int	No	The units charged.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_subscription	No	unsignedLong	No	The unique ID of the subscription plan record.
i_xdr	No	unsignedLong	No	The unique ID of the xDR record.
iso_3166_1_a3	No	string	No	A three-letter country code defined in ISO 3166-1 alpha-3.
taxation_code	No	string	No	The tax transaction code.

EstimatedTax
Property	Mandatory	Type	Nillable	Description	Possible values
amount	Yes	float	No	Estimated or calculated tax for provided xDRs.
level_name	Yes	string	No	Tax name. Possible values for the EZtax (formerly known as BillSoft EZtax) plug-in: Federal; State; County; City; Un-incorporated. Possible values for Suretax: Federal; State; County; City; Local; Reporting Agency. Possible values for VAT: VAT. Possible values for GST: GST. Or specify a custom name of tax if you use a different one.
name	Yes	string	No	N% for VAT or the name of tax for custom tax.
type	Yes	string	No	The name of the plugin that was used for tax estimation.

AccountPaymentMethodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_number	No	string	No	Bank account number. Applicable to the Check and DirectDebitNL methods.
address	No	string	No	Address of the cardholder.
available_for_refund	No	float	No	The amount available for refund.
bank_number	No	string	No	Bank routing number. Applicable to the Check method.
city	No	string	Yes	Name of the city of the cardholder.
csc_required	No	int	No	Shows whether card security code is required or not.
cvv	No	string	No	Card security code (CVV, CVS, etc.). Applicable to all credit card methods.
exp_date	No	date	No	Card expiration date. Applicable to all credit card methods.
i_country_subdivision	No	unsignedLong	Yes	ID for cardholder's state; refers to Country_Subdivision table.
i_payment_method	No	unsignedLong	No	Unique ID of the payment method.
iso_3166_1_a2	No	string	Yes	ISO 3166 two-letter country code.
issue_no	No	string	No	Card issue number. Applicable to the Switch method.
name	No	string	No	Name of the cardholder (owner of a bank account, etc.).
number	No	string	No	Credit card number without spaces, e.g. 4444333322221111.
number_hash	No	string	No	A crypted hexadecimal code of the credit card number.
payment_method	No	string	No	Name of the payment method, one of the following: Cash, Cheque, American Express, Discover, MasterCard, VISA, Maestro, Check, DirectDebitNL. Pass undefined value in order to dismiss payment method.
phone_number	No	string	No	Phone number in E.164 format for validating the Credit Card.
processing_type	No	string	No	Processing type of the payment method.
refnum	No	string	No	Reference number (custom field).
start_date	No	date	No	Card activation date. Applicable to the Switch method.
token	No	string	No	A reference to the payment information (which is stored by the Payment Processor only).
zip	No	string	No	Postal code of the cardholder. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).

AccountTransactionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The identifier of the account (unique in the environment).
amount	No	float	No	Money amount for the transaction.
cc_number_hash	No	string	No	A crypted hexadecimal code of the credit card number that was used to perform the transaction.
cdrid	No	string	No	XDR ID created for the transaction.
customer_name	No	string	No	The name of the customer.
details	No	string	No	Description of the transaction.
i_account	No	unsignedLong	No	The unique ID of the account.
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_merchant_account	No	unsignedLong	No	The unique payment system ID for the transaction.
i_online_payment_processor	No	unsignedLong	No	The unique payment processor ID for the transaction.
i_payment_method	No	unsignedLong	No	Unique payment method ID for the transaction.
i_payment_transaction	No	unsignedLong	No	The unique ID of a payment transaction.
i_payment_transaction_type	No	unsignedLong	No	The unique ID of the Transaction Type.
iso_4217	No	string	No	Currency for the transaction.
payment_method_info	No	string	No	Comment on the transaction's payment method.
purpose	No	string	No	The purpose of the transaction.
purpose_details	No	string	No	The details of the purpose.
result_code	No	string	No	Transaction's result code.
result_message	No	string	No	Transaction's result message.
secret	No	string	No	A secret code for the transaction.
status	No	string	No	Status of the transaction.
test_mode	No	string	No	Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N.
timestamp	No	dateTime	No	Timestamp of the transaction.
unique_transaction_id	No	string	No	UUID based unique transaction ID. Should be used as i_payment_transaction for transactions via PayNearMe processor.
x_transaction_id	No	string	No	The external transaction unique ID.

VoucherInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	string	No	The unique ID of the voucher.

PhoneBookRecInfo
Property	Mandatory	Type	Nillable	Description	Possible values
dial_id	No	string	No	Abbreviated dial assigned.
favorite_rating	No	string	No	Flag which indicates is phone record is privillidged record or not (Y, N); default is N.
i_account	No	unsignedLong	No	The unique ID of an account record (used only for adding a new record).
i_account_phonebook	No	unsignedLong	No	The unique ID of a Phonebook record (used only for updating an existing record).
lock_type	No	string	No	Lock type of phonebook record (None, Number, Full); default is None.
name	No	string	No	Contact name.
phone_number	No	string	No	Contact phone number.
phone_type	No	string	No	Type of phone record (work, home, mobile, other).
unlock_time	No	string	No	Time when Phonebook record will be unlocked.

EstimatedCallPriceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
currency	No	string	No	ISO 4217 code of the tariff currency.
discount_price	No	float	No	A rate (currency/unit, e.g. USD/minute) with volume discount applied.
discount_time	No	int	Yes	The call length covered by the volume discount (in untis, e.g. 'minute'). null stands for 'unlimited'.
general_price	No	float	No	A general rate (currency/unit, e.g. USD/minute) without volume discounts applied.
unit	No	string	No	Units (e.g. USD, messages, minutes).

AccountSubscriptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	date	No	The date when the subscription was activated.
billed_to	No	date	No	The date to which subscription charges have already been applied.
commitment_name	No	string	No	The name of the commitment.
discount_amount	No	float	No	The fixed discount amount for the subscription periodic fee. This is a read-only field which is used by commitments only.
discount_list	No	Array of SubscriptionDiscountInfo structure	No	Only available for subscription plans charged in advance; specifies list of multi-month discounts for the subscription.
discount_rate	No	float	No	Discount rate for the subsciption in percents; if missed or provided undefined, it means that the discount rate defined in the customer information should be applied.
effective_fee	No	float	No	Amount of the actual periodic fee for the current billing period according to its order number.
finish_date	No	date	Yes	The date when the subscription should be automatically canceled; if provided must be greater or equal to the start_date.
generate_daily_charge	No	string	No	Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y - Generate daily charges; N - Keep the total charge only.
has_discount	No	int	No	The flag shows whether the subscription has a discount assigned.
i_account	No	unsignedLong	No	The unique ID of the account.
i_account_subscription	No	unsignedLong	No	The unique ID of the account subscription record.
i_commitment	No	unsignedLong	No	The reference to the commitment if the subscription was assigned as a part of the commitment.
i_discount_current	No	unsignedLong	No	The unique ID of the current period multimonths discount.
i_discount_next	No	unsignedLong	Yes	The unique ID of the next period multimonths discount.
i_product	No	unsignedLong	No	The unique ID of the product from which the subscription is inherited.
i_subscription	No	unsignedLong	No	The unique ID of the subscription plan; refers to Subscriptions table.
int_status	No	int	No	A status of the subscription: 0 - pending, 1 - active, 2 - closed.
invoice_description	No	string	No	The subscription plan name that is visible to the end user. Can be specified directly on the account level. Otherwice the value from the subscription level is used.
is_finished	No	string	No	Indicates whether the subscription has been already closed.
monthly_fee	No	float	No	Standard subscription's monthly fee value .
multiple	No	int	No	Can this Subscription be applied more than once.
name	No	string	No	Name of the subscription plan, referenced by the i_subscription attribute.
next_effective_fee	No	float	No	The amount of the periodic fee for the next billing period.
obligatory	No	string	No	Indicates that the subscription comes from the account's product, and so cannot be closed until the account has this product assigned to it.
rounding	No	int	No	A pattern that defines the rounding of the amount charged for a billing period.
start_date	No	date	No	The desired subscription activation date (defined in the customer's time zone); if missing or undefined, the subscription will start immediately after it is created; otherwise, the value should be greater than or equal to today's date (in the customer's time zone); can be updated for pending subscriptions only.
subscription_level_invoice_description	No	string	No	The subscription plan name visible to the end user inherited from the subscription (default configuration) or from the product settings.

AccountPerServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charged_amount	No	float	No	The sum of the amounts in the 'credits' and 'charges' fields.
charged_quantity	No	int	No	Units charged.
charges	No	float	No	The sum of charge transaction amounts related to the service.
credits	No	float	No	The sum of credit transaction amounts related to the service.
i_service	No	unsignedLong	No	The unique ID of the service; refers to Services table.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
name	No	string	No	The service name.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges (e.g. message, minute).
rating_base	No	string	No	Specifies which particular parameter is used to calculate charges, e.g. "session time", "amount of data transferred" and the like.
rating_base_unit	No	string	No	A customer-visible name for the units in which service use is measured; this also is the smallest possible unit you use in the rating configuration (e.g. second).
ratio	No	int	No	Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration.
total	No	int	No	Subtotal for this type of transactions/service.
total_sessions	No	int	No	The total number of sessions of this transactions/service type.
unit	No	string	No	The unit in which the charged quantity is shown (e.g. second).

TotalTransInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	Transaction type.
value	No	float	No	The total amount for transactions of this type.

TransactionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The identifier of the account (unique in environment).
amount	No	float	No	Money ammount for the Transaction.
cc_number_hash	No	string	No	A crypted hexadecimal code of the credit card number that was used to perform the transaction.
cdrid	No	string	No	XDR ID created for the Transaction.
customer_name	No	string	No	The name of the customer.
details	No	string	No	Description of the Transaction.
i_account	No	unsignedLong	No	The unique Account ID for the Transaction.
i_customer	No	unsignedLong	No	The unique Customer ID for the Transaction.
i_merchant_account	No	unsignedLong	No	The unique Payment System ID for the Transaction.
i_online_payment_processor	No	unsignedLong	No	The unique Payment Processor ID for the Transaction.
i_payment_method	No	unsignedLong	No	Unique Payment Method ID for the Transaction.
i_payment_transaction	No	unsignedLong	No	The unique ID of the Transaction.
i_payment_transaction_type	No	unsignedLong	No	The unique ID of the Transaction Type.
iso_4217	No	string	No	Currency for the Transaction.
payment_method_info	No	string	No	Comment on Transaction's Payment Method.
purpose	No	string	No	The Purpose transaction is made for.
purpose_details	No	string	No	The details of the purpose.
result_code	No	string	No	Result code of the Transaction.
result_message	No	string	No	Result message of the Transaction.
secret	No	string	No	A secret code for the Transaction.
status	No	string	No	Status of the Transaction.
test_mode	No	string	No	Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N.
timestamp	No	dateTime	No	Timestamp of the Transaction.
unique_transaction_id	No	string	No	UUID based universally unique transaction ID. Should be used as i_payment_transaction for transactions via PayNearMe processor.
x_transaction_id	No	string	No	The external transaction unique ID.

FullCounterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
addon_priority	No	int	No	In order to differentiate the add-on products there is also a "precedence level" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Allowed values: 0 - Main Product; 10 - Low; 15 - Medium Low; 20 - Medium; 25 - Medium High; 30 - High.
allocated_amount	No	float	No	The total amount of traffic (units) allocated to the customer in the current volume discount plan.
combined_discount	No	float	No	Total discount to be applied. The discount_flag property must have the "A" value. When the discount is configured in such a way, that the discount can't be calculated in advance (only for a specific call), then this will show the maximum combined discount.
combining_mode	No	string	No	Defines the possibility of combining various discount plans when more then one discount plan is applicable for the same session (call): I - Never - the full override, when the higher priority discount prevents the use of lower priority ones; N - Always - the discount rate is summed up to 100% (we never give money back for the call). For example, two 30% discounts will result in 60% resulting discount, 70% + 40% discount rates will only result in 100% discount; Y - When discount lower than 100 is active – as long as a higher priority discount defines 100% rate, all the lower priority discounts are not applied. Only after the volume exceeds the 100% discount rate threshold of the discount, the rest of the discounts can be applied. For example, Germany 100% discounted calls for 50 minutes exclusively, followed by 1000 minutes of 50% discount rate, while another discount for EU has 30% discount rate. The EU discount will only become applicable if the 50 minutes are used up, then the total discount rate will be 30+50=80% for a call to Germany; F – After reaching the last threshold limit – the higher priority discount prevents the use of lower priority ones until the last limited threshold is reached (regardless of discount rate). For example, Germany 100% discounted calls for 50 minutes exclusively, followed by 1000 minutes of 50% discount rate, while another discount for EU has 30% discount rate. The EU discount will only become applicable if the 1050 minutes are used up.
continued_unit_amount	No	float	No	Shows the amount of traffic used in the current usage period before the volume discount plan change.
dg_name	No	string	No	A destination group name.
discount_flag	No	string	No	Discount applicability: A - discount is available; U - not applicable (exceeded); N - excluded, e.g. when a higher priority discount prevents the use of a lower priority one.
discount_info	No	string	No	Information about discount.
discount_level	No	string	No	Current discount value.
discount_value	No	float	No	A value of the discount.
discounts	No	Array of Discounts structure	No	The list of discount thresholds per destination group.
full_discount_info	No	DiscountInfo structure	No	Full information about applicable discount thresholds.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_service	No	unsignedLong	No	The unique ID of the service.
i_vd_dg	No	unsignedLong	No	The unique ID of the discount for a specific destination group.
i_vd_plan	No	unsignedLong	No	The unique ID of the volume discount plan.
i_vd_type	No	unsignedLong	No	The unique ID of the discount type. Possible values: 1 - Discount; 2 - Quota.
next_discount_level	No	string	No	Next discount value.
peak_level	No	string	No	An ID of the peak level: 0 - Peak period; 1 - Off-peak period; 2 - Second off-peak period.
period_from	No	date	No	Discount start date.
period_to	No	date	No	Discount reset date.
prev_threshold	No	float	No	Previous threshold value.
remaining	No	string	No	Remaining discount amount.
rollover_info	No	Array of Rollovers structure	No	The list of the customer's carriedover discounts.
rollover_periods	No	int	No	The maximum number of usage periods that unused traffic can be rolled over (Allow no more than on the web interface). For example, if the usage period is monthly and you select 2, the unused traffic left from the first month will be rolled over to the second month and if not used completely, to the third month (2 rollovers). If unused traffic is not completely used by the end of the third month, it will expire. Note that if unused traffic from two or more usage periods is rolled over to the next one, the quota with the earliest expiration time is used first.
service_name	No	string	No	The name of the service.
service_pool_info	No	ServiceInfo structure	No	The service pool information. It is used only for pool services.
service_ratio	No	int	No	The service ratio.
tax_transaction_code	No	string	No	A tax code related to the taxation processor. Used for the service wallet top-up.
threshold	No	string	No	Threshold value.
threshold_shift	No	float	No	Shows how the discount threshold has shifted after rollovers. I.e., this reflects the sum of unused traffic rolled over from previous periods to the current one. Note that if a customer downgraded the volume discount plan after he had used more than the new plan offers, the sum will be negative.
threshold_type	No	string	No	Specifies the threshold type: will you use thresholds based on the charged amount, or on the total call time? Amount means the threshold is measured in currency units (e.g. USD), and the counters will go up by the amount which the customer should have been charged for the call before the volume discount was applied. Volume means the unit is minutes, and the counters will go up by the same value as the charged call duration. Note the difference between call duration and charged call duration. For instance, if a rate specifies 5 minutes rounding and a customer has spoken for 3 minutes 42 seconds, he will be charged for 5 minutes and the counter will go up by 5 minutes as well.
unit	No	string	No	Units (e.g. USD, minutes).
usage_period	No	int	No	This specifies how often the volume discount is reset. Possible values: Empty - One time - A volume discount is applied one time only; 1 - Daily - A volume discount is applied every day; 2 - Weekly - A volume discount is applied every week; 3 - Semimonthly - A volume discount is applied semimonthly; 4 - Monthly - A volume discount is applied every month.
used	No	string	No	Used discount amount.
vdp_combination_list	No	ArrayOfString	No	The list of all discounts combined together.
vdp_name	No	string	No	The name of the volume discount plan.

VdDestGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
destination_group_name	No	string	No	Destination group name.
discount_plan_name	No	string	No	Discount plan name.
discount_type	No	string	No	Volume discount type.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_service	No	unsignedLong	No	The unique ID of the service.
i_vd_dg	No	unsignedLong	No	The unique ID of the volume discount record.
i_vd_plan	No	unsignedLong	No	The unique ID of the volume discount plan record.
i_vd_type	No	unsignedLong	No	The unique ID of the discount type. Possible values: 1 - Discount; 2 - Quota.
peak_level	No	string	No	An ID of the peak level: 0 - Peak period; 1 - Off-peak period; 2 - Second off-peak period.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges (e.g. message, minute).
ratio	No	int	No	Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration.
service_name	No	string	No	The name of the service.
threshold_type	No	string	No	The type of the volume discount plan coounter threshold.
unit	No	string	No	A customer-visible name for the units in which volume discount use is measured.
usage_period	No	int	No	This defines how often the volume discount is reset.

CounterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
addon_priority	No	int	No	The "precedence level" parameter of the add-on product.
allocated	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The amount is allocated during this period and is used as a base for prorating rollovers.
amounts	No	CounterAmountsInfo structure	No	The information about the counter amount.
continued	No	int	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The amount of the used units is carried over on to the next period when counter is reset within a regular period.
counter	No	float	No	The raw counter value.
counter_value	No	float	No	Value of the counter.
dg_name	No	string	No	Destination group name.
i_account	No	unsignedLong	No	The unique ID of the account record.
i_avd_counter	No	unsignedLong	No	The unique ID of the account volume discount counter.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_cvd_counter	No	unsignedLong	No	The unique ID of the customer volume discount counter.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_vd_dg	No	unsignedLong	No	The unique ID of the volume discount record (volume discount destination group record).
last_modified	No	dateTime	No	The date and time when the counter was last updated.
money_continued	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The amount of the used monetary is carried over on to the next period when counter is reset within a regular period.
peak_level	No	int	No	ID of the Peak Level: 0 (Peak Period), 1 (Off-Peak Period), 2 (2nd Off-Peak Period).
period_from	No	dateTime	No	The start date of the counter.
period_to	No	dateTime	No	The end date of the counter.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges.
rollover0	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The rolled over quota amount will be expired in the current counter usage period.
rollover1	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The rolled over quota amount will be expired in the next counter usage period.
rollover2	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The rolled over quota amount will be expired in the +2 counter usage period.
rollover3	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The rolled over quota amount will be expired in the +3 counter usage period.
rollovers	No	CounterRolloversInfo structure	No	The information about the counter rollovers.
service_name	No	string	No	The name of the service.
threshold_modifiers	No	CounterThresholdModifiersInfo structure	No	The information about the counter threshold modifiers.
threshold_multiplier	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The multiplication modifier for thresholds on prorated counter.
threshold_shift	No	float	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. The additive modifier for thresholds on the shifted base (rolled over) counter.
threshold_type	No	string	No	The type of the volume discount plan coounter threshold.
unit_counter	No	int	No	The number of units.

AccountPaymentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment.
amount	Yes	float	No	The payment amount.
card_info	No	AccountPaymentMethodInfo structure	No	The information about the payment method.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly.
save_card	No	string	No	Specifies whether the supplied payment method must be saved as the preferred payment method. Possible values: Y – Save the payment method as the preferred payment method; N – Do not save the payment method as the prefereed payment method.
visible_comment	No	string	No	A comment on this transaction visible to the end user in the xDR browser.

AclInfo
Property	Mandatory	Type	Nillable	Description	Possible values
group	No	string	No	Name of ACL group.
i_acl	No	unsignedLong	No	Unique ID of the ACL.
name	No	string	No	ACL by name.
subsystem	No	string	No	Name of subsystem ACL belongs to.
type	No	string	No	Type of ACL.

AccessLevelInfo
Property	Mandatory	Type	Nillable	Description	Possible values
objects	No	Array of ObjectPermissions structure	No	The Web interface objects for which ACL permissions have been retrieved.
parents	No	Array of AccessLevelInfo structure	No	A list of ACLs that are parents to the current ACL.
subsystem	No	string	No	The name of the subsystem the current web interface objects belong to.

AsyncRequestInfo
Property	Mandatory	Type	Nillable	Description	Possible values
arguments	No	string	No	The input arguments used to start the request.
i_async_request	No	unsignedLong	No	The unique ID of the request.
method	No	string	No	The name of the request method.
progress	No	float	No	The progress of the request.
start_time	No	dateTime	No	The date and time when the request started.
status	No	string	No	The status of the request.
stop_time	No	dateTime	No	The date and time when the request was completed.
update_time	No	dateTime	No	The date and time when the request was last updated.

AuthzRuleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID of the account for which the rule is auto-generated. Filled in case if the 'auto_link_type' is 'Accounts' and when 'with_extended_info' in the method info is equal to 1.
auto_link_id	No	int	No	The unique ID of the entity for which the rule has been auto-generated.
auto_link_type	No	string	No	Entity for which the rule has been auto-generated.
cld_pattern	No	string	Yes	CLD (DNIS) pattern to check during authorization. Expected input pattern: "ANONYMOUS" or a number in the E.164 format. Supported characters: 'a-D','0-9','%','#','_','*','x'.
cli_pattern	No	string	Yes	CLI (ANI) pattern to check during authorization. Expected input pattern: "ANONYMOUS" or number in the E.164 format. Supported characters: 'a-D','0-9','%','#','_','*','x'.
connection_description	No	string	No	The description of the connection for which the rule is auto-generated. Filled in case if the 'auto_link_type' is 'Connections' and when 'with_extended_info' in the method info is equal to 1.
i_authz_rule	No	unsignedLong	No	The unique ID of the authentication rule record.
i_authz_type	No	unsignedLong	No	The unique ID of the authentication method type record.
i_service_policy	No	unsignedLong	Yes	The unique ID of the Service Policies record.
ip_pattern	No	string	No	The IP or Network/Mask of the trusted source. Expected input pattern: "X.X.X.X/N".
node_name	No	string	No	The name of the node for which the rule is auto-generated. Filled in case if the 'auto_link_type' is 'Nodes' and when 'with_extended_info' in the method info is equal to 1.
order_number	No	int	No	Authorization rule sequence number.
translation_rule	No	string	Yes	Translation rule for the chosen user-name.

AuthzMethodTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_authz_type	Yes	unsignedLong	No	The unique ID of the authentication method type.
name	Yes	string	No	The name of the authentication method type.

RearrangeAuthzRuleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_authz_rule	Yes	unsignedLong	No	The unique ID of the authentication rule.
order_number	Yes	int	No	The sequential number of the authentication rule.

ActiveCallInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	Calling line destination.
CLI	No	string	No	Calling line identification.
call_id	Yes	string	No	The unique ID of the call.
connect_time	No	dateTime	No	Time when connection was initiated.
i_node	No	unsignedLong	No	The unique ID of the node.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
id	Yes	string	No	Call owner's account ID.
leg_origin	No	string	No	Together with leg_type determines leg for accounting record.
leg_type	No	string	No	Together with leg_origin determines leg for accounting record.
session_id	No	string	No	ID of the session to work with.
subscriber_ip	No	string	No	Subscriber IP address.

ActiveSessionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID (PIN) of the account on the PortaBilling interface, unique in the environment.
call_id	No	string	No	The call-id of the session.
cld	No	string	No	The called line phone number.
cli	No	string	No	The calling line phone number.
connect_time	No	dateTime	No	The time when the connection was initiated.
connection_name	No	string	No	The name of the connection used.
connection_type_name	No	string	No	The name of the connection type.
country	No	string	No	The called destination country name.
customer_name	No	string	No	The name of the customer.
duration	No	int	No	The session length (number of seconds) from the moment when the session was started.
h323_conf_id	No	string	No	The h323-conf-id of the session.
hotlined	No	int	No	The flag that shows whether hotlining is configured (Internet sessions only).
i_account	No	unsignedLong	No	The unique ID of the account.
i_connection	No	unsignedLong	No	The unique ID of the connection.
i_connection_type	No	unsignedLong	No	The unique ID of the connection type.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
i_vendor	No	unsignedLong	No	The unique ID of the vendor.
is_disconnectable	No	int	No	The flag that shows whether the session can be disconnected.
nodes_passed	No	Array of SessionNodeInfo structure	No	The ordered list of nodes used in the session.
on_net	No	int	No	The flag that shows whether the session is on-net.
original_cld	No	string	No	The original called line phone number.
original_cli	No	string	No	The original calling line phone number.
resale_hierarchy	No	Array of CustomerInfo structure	No	The resellers hierarchy.
service_type_name	No	string	No	The logical name of the Service Type.
setup_time	No	dateTime	No	The setup time of the session.
source_ip	No	string	No	The IP address of the entity.
subdivision	No	string	No	The called destination country subdivision name.
vendor_name	No	string	No	The name of the vendor on the PortaBilling interface.

BundlePromotionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the bundle promotion plan.
i_bd_plan	No	unsignedLong	No	The unique ID of the bundle promotion plan.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set associated with this bundle promotion plan. This property is mandatory when the structure is used as a parameter of the AddBundlePromotionRequest.
is_used	No	int	No	Indicates whether the bundle promotion plan is used or not. Possible values: 1 – The bundle promotion plan is used. 0 – The bundle promotion plan is not used.
iso_4217	No	string	No	The bundle promotion plan currency in the three-letter format (ISO 4217). This property is mandatory when the structure is used as a parameter of the AddBundlePromotionRequest.
managed_by	No	unsignedLong	No	The unique ID of the reseller that manages this bundle promotion plan.
name	No	string	No	The name of the bundle promotion plan. This property is mandatory when the structure is used as a parameter of the AddBundlePromotionRequest.

CriterionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
amount_type	No	string	No	Valid values are: 'fixed', 'percentage'; the default value is 'fixed'.
analyzed_parameter	No	string	No	The parameter to check for the analyzed service. Valid values are: 'charged_sum', 'used_volume' ('charged_sum' is used by default).
bundle_discount_threshold_list	No	Array of BundleDiscountThresholdInfo structure	No	The list of bundle promotion thresholds.
charge_type	No	string	No	Valid values are: 'credit', 'charge'; the default value is 'credit'.
i_bd_criteria	No	unsignedLong	No	The unique ID of the bundle promotion criterion. This parameter is mandatory for the update_criterion method.
i_bd_plan	No	unsignedLong	No	The unique ID of the Bundle Promotion Plan.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group associated with this criteria.
i_service_apply	No	unsignedLong	No	The unique ID of the entity to apply the promotion to - a service, the whole bill, taxes, credits / adjustments or subscriptions (all or one in particular).
i_service_used	No	unsignedLong	No	The unique ID of the service which will be used to analyze how much money the customer has spent on services during the billing period to credit or charge the customer accordingly.
i_subscription	No	unsignedLong	No	The unique ID of the subscription associated with this bundle promotion criterion. If blank, the promotion is apllied to the customer’s own subscriptions and all of their credit accounts’ subscriptions.
i_tax_transaction_code	No	unsignedLong	No	The tax transaction code ID.
inv_comment	No	string	No	The invoice comment.

CalendarDateInfo
Property	Mandatory	Type	Nillable	Description	Possible values
day	No	date	No	The date value of the calendar date record (e.g. "2020-01-25").
description	No	string	No	The description of the calendar date record, to store any additional information about this date.
i_calendar_day	No	unsignedLong	No	The unique ID of the calendar date record.
type	No	string	No	The date type of the calendar date record. Possible values: working, non-working.

CallBarringClassInfo
Property	Mandatory	Type	Nillable	Description	Possible values
barred_by_default	No	string	No	'Y' - to activate this call barring class in an account’s Call barring settings by default.
i_cp_condition	No	unsignedLong	No	The unique ID of call barring class.
is_used	No	int	No	Shows whether the call barring class is in use.
matching_type	No	string	No	The mode of number selection for the call barring class. Possible values: 'excluding' - bar numbers that do not fit the patterns defined in the number_pattern_list, 'including' - bar numbers that fit the patterns defined in the number_pattern_list.
name	No	string	No	The call barring class name.
number_pattern_list	No	Array of CBCNumberPatternInfo structure	No	A list of patterns that defines phone numbers that are included to the call barring class.

DefaultCallBarringOptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_condition	No	unsignedLong	No	The unique ID of the call barring rule record.
i_default_cb_option	No	unsignedLong	No	The unique ID of the default call barring option record.

SIPPrivacyHeaderInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the header that will be added to the INVITE request.
value	Yes	string	No	The value of the header that will be added to the INVITE request.

SIPMessageInfo
Property	Mandatory	Type	Nillable	Description	Possible values
message	No	string	No	The text of the message.
type	No	string	No	Shows whether the message was sent or received by the UA. Possible values: 'sent', 'received'.

CCStaffInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	dateTime	No	The date when the user's account is activated.
address_line_2	No	string	No	2nd line of the user's address.
baddr1	No	string	No	1st line of the user's address.
city	No	string	No	The name of the city.
companyname	No	string	No	The conventional form of the user company's name.
cont1	No	string	No	The main contact person.
cont2	No	string	No	The alternative contact person.
country	No	string	No	The code of the country in the ISO 3166-1 alpha-2 format.
daily_allowance	No	float	No	The maximum amount of credit/refund per day for the user.
description	No	string	No	A short description associated with the user.
email	No	string	No	An email contact for the user.
expiration_date	No	dateTime	No	The date when the user's account expires.
faxnum	No	string	No	A fax number.
firstname	No	string	No	The user's first name.
hide_personal_info	No	int	No	Shows whether personal information is hidden from the user. Can be 0 - is visible or 1 - is hidden.
i_acl	No	unsignedLong	No	The privilege level or role assigned to the user.
i_callshop	No	unsignedLong	No	The unique ID of the callshop in which this user is operating.
i_cc_staff	No	unsignedLong	No	The unique ID of the CC staff record.
i_customer	No	unsignedLong	No	The unique ID of the reseller.
i_lang	No	string	No	The language used on the web interface for this user.
i_time_zone	No	unsignedLong	No	The time zone in which this user is operating.
in_date_format	No	string	No	Input date format.
in_time_format	No	string	No	Input time format.
last_login	No	dateTime	No	The date when the user last logged in into web interface.
lastname	No	string	No	The user's last name.
login	No	string	No	The username for login and user identification.
max_credit_limit_days	No	int	No	The maximum period of validity of the temporary credit limit.
max_credit_limit_increase	No	string	No	The maximum possible increase of the permanent credit limit.
midinit	No	string	No	The user's middle name.
out_date_format	No	string	No	Output date format.
out_date_time_format	No	string	No	Output date and time format.
out_time_format	No	string	No	Output time format.
password	No	string	No	The password for this user.
password_timestamp	No	dateTime	No	The date when the password was changed.
phone1	No	string	No	The main phone number.
phone2	No	string	No	An alternative phone number.
refunded_today	No	float	No	The amount of refunds made during this day.
refunds_counter	No	int	No	The number of refunds made by this user today.
rst	No	dateTime	No	The date when the statistic was reset for the last time.
salutation	No	string	No	The user's salutation.
search_counter	No	int	No	The number of traced sessions.
senior	No	string	No	Specifies whether this user is a senior user.
state	No	string	No	The name of the state.
transaction_allowance	No	float	No	The maximum amount of credit/refund per one transaction for the user.
zip	No	string	No	The user's ZIP code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).

CRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	unsignedLong	No	The ID of XDR record.

BatchDeleteCRStatusInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	unsignedLong	No	The ID of XDR of deleted call record file.

DisconnectReasonInfo
Property	Mandatory	Type	Nillable	Description	Possible values
disconnect_cause	Yes	unsignedLong	No	The unique ID of the disconnect reason.
disconnect_class	Yes	string	No	The human-readable description of the disconnect reason class for the disconnect reason.
disconnect_text	Yes	string	No	The human-readable description of the disconnect reason.

AuxXDRTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_aux_type	No	int	No	The unique ID of the XDR column.
name	No	string	No	The name of the XDR column.
xdr_column_id	No	string	No	The XDR column identifier.

NetaccessUsageRecordInfo
Property	Mandatory	Type	Nillable	Description	Possible values
bytes_downloaded	No	unsignedLong	No	The number of bytes that were downloaded from 'period_from' to 'period_to'.
bytes_uploaded	No	unsignedLong	No	The number of bytes that were uploaded from 'period_from' to 'period_to'.
peak_level	No	int	No	The ID of the peak level (0 - Peak period, 1 - Off-peak period, 2 - 2nd Off-peak period).
period_from	No	dateTime	No	The date and the time when net access usage started according to the record.
period_to	No	dateTime	No	The date and the time when net access usage stopped according to the record.
xdr_id	No	unsignedLong	No	The unique ID of the xDR related to the net access usage record.

XDRRevertInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charged_amount	No	float	No	The charged amount that will be saved in the correction xDR.
comment	No	string	No	The comment related to the revert procedure.
hide	No	string	No	If equal to 'Y', the original and correction xDRs will be marked hidden. Possible values: 'Y' - hide the original and correction xDRs during the refund procedure, 'N' - do not hide the xDRs. The field is ignored if the 'charged_amount' field in the structure is not equal to the original xDR amount.
id	Yes	unsignedLong	No	The unique ID of the xDR.
owner	Yes	string	No	The name of the xDR list owner. Possible values: 'customer', 'account' or 'vendor'.

CodecConverterStorageInfo
Property	Mandatory	Type	Nillable	Description	Possible values
column_family	No	string	No	Storage column family. E.g. MusicOnHold, VoicePrompts or AudioFiles.
key	No	CodecStorageKeysInfo structure	No	Storage key for each codec generated for the uploaded file.
working_dir	No	string	No	Directory with audio files.

CodecConverterFileInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	No	unsignedLong	No	The unique identifier of the file.
name	No	string	No	The file name.
own	No	int	No	The flag that shows whether the file is owned by the current user.
status	No	string	No	The file status.

CommissionPlanInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_commission	No	float	No	The commission which will be used if there are no other commissions.
global_commissions	No	Array of CPPeriodInfo structure	No	The list of the commissions used on the commission plan.
i_commission_plan	No	unsignedLong	No	The unique ID of the commission plan.
i_cp_base	No	int	No	The unique ID of the commission plan base.
is_used	No	int	No	Shows whether the commission plan is used or not.
iso_4217	No	string	No	The currency of the commission plan .
managed_by	No	unsignedLong	No	The unique ID of the entity managing the commission plan.
name	No	string	No	The name of the commission plan .
service_commissions	No	Array of CPServiceInfo structure	No	The list of the commissions for services used on the commission plan.
subscription_commissions	No	Array of CPSubscriptionInfo structure	No	The list of the commissions for subscriptions used on the commission plan.

CommissionPlanBaseInfo
Property	Mandatory	Type	Nillable	Description	Possible values
base	No	string	No	The commission plan base name.
i_cp_base	No	int	No	The unique ID of the commission plan base.

CommitmentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
allowed_pause_times_per_year	No	int	No	The maximum number of times the commitment can be paused per year.
description	No	string	No	The commitment description.
i_commitment	No	unsignedLong	No	The unique identifier of the commitment record.
iso_4217	No	string	No	The commitment currency.
managed_by	No	unsignedLong	No	The identifier of the reseller who manages the commitment.
min_period	No	int	No	The minimum number of billing periods the commitment shall be active before it can be terminated without penalties.
name	No	string	No	The name of the commitment.
pausing_fee	No	float	No	The fee for commitment pausing.
pausing_max_days	No	int	No	The maximum number of days for a single commitment pause.
pausing_min_days	No	int	No	The minimum number of days for a single commitment pause.
transfer_fee	No	float	No	The fee for commitment transferring.
upgrade_fee	No	float	No	The fee the customer has to pay for upgrading to this commitment from another one. The minimum value is zero. If set to zero, no xDR will be created. The UI equivalent of this field is the "Upgrade fee" input on the Edit commitment main panel.
used	No	int	No	The flag that specifies whether the commitment is assigned to at least one account.

CommitmentOneTimeTermInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the term that will be used as the description of the created charge xdr.
discount_amount	No	float	No	The discount amount to apply to the full fee.
fee	No	float	No	The full one-time fee to charge.
i_commitment	No	unsignedLong	No	The identifier of the commitment record.
i_one_time_term	No	unsignedLong	No	The unique identifier of the commitment one-time term.
i_service	No	unsignedLong	No	The identifier of the service that will be used for the charge xdr.

CommitmentRecurringTermInfo
Property	Mandatory	Type	Nillable	Description	Possible values
discount_amount	No	float	No	The discount amount to apply to the recurring charge.
i_addon_product	No	unsignedLong	No	The identifier of the addon product.
i_commitment	No	unsignedLong	No	The identifier of the commitment record.
i_recurring_term	No	unsignedLong	No	The unique identifier of the commitment recurring term.
i_subscription	No	unsignedLong	No	The identifier of the subscription.

MarketingGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	Marketing group description.
i_marketing_group	No	unsignedLong	No	The ID of the marketing group.
id	No	string	No	Marketing group code on the CoSS server.
name	No	string	No	Marketing group name.

RatingGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
assigned_marketing_groups	No	Array of MarketingGroupInfo structure	No	The list of the assigned marketing groups.
description	No	string	No	A short description of the specified destination.
destination	No	string	No	Destination prefix.
i_dest	No	unsignedLong	No	The ID of the destination assigned to the rating group.
i_rating_group	No	unsignedLong	No	The ID of the rating group.
id	No	int	No	The rating group code used for communication with the CoSS server.
name	No	string	No	The name of the rating group.

XrateInfo
Property	Mandatory	Type	Nillable	Description	Possible values
base_units	No	float	No	Currency exchange rate. Defines the number of units of the base currency equal to one unit of the foreign currency. (For example, with British Pounds as the foreign currency and U.S. Dollars as the base currency , the base currency units would be "1.5326" and the value of this column would be "1 GBP = 1.5326").
is_active	No	int	No	Specifies whether the exchange rate is usable now: 1 - the exchange rate is now usable, 0 - the exchange rate is not usable, e.g. outdated.
iso_4217	No	string	No	Specifies a currency in ISO4217 code (the currency to convert to).
name	No	string	No	A currency name.
source	No	string	No	Shows the exchange rate source for the given currency as defined on the Currency page.
timestamp	No	dateTime	No	The effective date for the given exchange rate.

CurrencyInfo
Property	Mandatory	Type	Nillable	Description	Possible values
base_units	No	float	No	An exchange rate between the currency and base unit. This property is used for manual exchange only (i_x_rate_source=1 ).
decimal_digits	No	int	No	Maximum number of decimal places for a currency, e.g. for US dollars or euros it will be 2, since the smallest unit is one cent (0.01), while for yens it will be 0.
i_ma_currency	No	unsignedLong	No	The unique merchant account currency identifier. This property is mandatory if min_payment or i_merchant_account is supplied.
i_merchant_account	No	unsignedLong	No	The unique payment system ID for the transaction.
i_x_rate_source	No	unsignedLong	No	Defines the method of entering the exchange rate for the currency. Refers to X_Rate_Source table.
is_used	No	int	No	Shows whether the currency is in use.
iso_4217	Yes	string	No	Currency ISO4217 code.
min_allowed_payment	No	float	No	The smallest allowed amount for an online payment (in the corresponding currency), in order to prevent service abuse.
name	No	string	No	Currency name.
name_major	No	string	No	The main currency unit, e.g. dollar.
name_minor	No	string	No	The lesser currency unit (if applicable), e.g. cent.

CustomFieldsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_value	No	string	No	Default value for the Custom Field.
i_custom_field	No	unsignedLong	No	Unique ID of the Custom Field record.
is_used	No	int	No	Shows whether the custom field was used.
managed_by	No	unsignedLong	No	The unique ID of the reseller who manages the Custom Field record.
mandatory	No	string	No	Marks that the Custom Field is mandatory. Possible values: 'Y', 'N'.
name	No	string	No	Name of the Custom Field.
object	No	string	No	The type of entity (account/customer) to which the сustom field is applied.
personal_data	No	string	No	Shows that the custom field contains private data and should not be shown to unauthorized users.
properties	No	string	No	JSON-encoded Validation Schema for the Custom Field.
type	No	string	No	Canonical name of the Custom Field's type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'.
value	No	string	No	Deprecated: the option is deprecated in MR79-0 and will be removed in MR81-0. Value of the Custom Field.
visible_to_end_user	No	string	No	Marks that the Custom Field is visible to the End User. Possible values: 'Y', 'N'.

BusinessModelInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_business_model	No	unsignedLong	No	The unique ID of a business model.
name	No	string	No	The name of a business model.

CustomerClassInfo
Property	Mandatory	Type	Nillable	Description	Possible values
active_custom_fields	No	ArrayOfInt	No	The list of active custom fields in the customer class.
balance_transfer_allowed	No	string	No	Defines if balance transfer is enabled for a Customer Class (Y, N).
block_debit_on_insuff_funds	No	string	No	Defines if a debit account should be blocked when its funds are not enough for subscription charges.
bp_charge_cc	No	string	No	Automatically charge customer's credit card when a billing period is closed.
bp_closure_delay_days	No	int	No	Max days to delay billing period closure.
charge_cc_on_generation	No	string	No	The flag shows whether to start charging the customer's credit card starting from the regular invoice due date.
closing_days	No	int	Yes	In how many days after the due date the customer's account will be closed if the regular invoice is still unpaid.
closing_days_after_terminated	No	int	No	In how many days after provisional termination the customer’s account will be permanently closed (if the administrator does not manually restore this customer within this period).
closing_warning_days	No	int	Yes	How many days before the closing date a notification of possible closing should be sent to the customer if the regular invoice is still unpaid.
collection_threshold	No	float	No	If no payment is made, the balance is applied to the next invoice(s) until the amount due on a new invoice crosses this threshold.
comm_term_periods	No	int	Yes	How many periods (days or billing periods, depending on "period_terms_in" value) after the due date the customer's account commitments will be terminated if the regular invoice is still unpaid.
comm_term_warning_days	No	int	Yes	How many days before the commitment terminate date a notification of possible closing should be sent to the customer if the regular invoice is still unpaid.
default_class	No	string	No	Flag that designates default customer class.
description	No	string	No	The customer class description.
estimate_taxes	No	string	No	Estimate taxes on receiving payments for the prepaid customers is enabled or disabled.
extra_invoice	No	string	No	Separate Invoice for Recurring Fees.
grace_period	No	int	Yes	Regular invoice grace period, i.e. for how many days after invoice generation the payment is expected.
hide_reset_balance_xdr	No	int	No	Shows whether the reset balance XDR is hidden from end-user. This option is related to the 'reset_customer_balance' option and can be enabled only together with it.
i_billing_processor	No	unsignedLong	No	Refers to Billing Processor record.
i_business_model	No	unsignedLong	No	The unique identifier for a business model; refers to the Business_Models table.
i_customer	No	unsignedLong	No	The unique ID of the reseller who manages the customer class.
i_customer_class	No	unsignedLong	No	The unique ID of the customer class record.
i_notification_preset	No	unsignedLong	No	The notification preset assigned to the customer class.
i_tax_transaction_code	No	unsignedLong	No	The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table.
i_template	No	unsignedLong	Yes	The unique ID for customer's regular invoice template; refers to the Templates table.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
inclusive_taxation	No	string	No	Identifies that taxes are included in rates for a Customer Class (Y, N).
invoice_rounding_precision	No	int	No	The number of digits after decimal point for rounding.
is_used	No	int	No	Shows whether the customer class is in use.
is_used_by_resellers	No	int	No	Shows whether the shared customer class is used by resellers.
iso_4217	No	string	No	Currency.
late_payment_fee	No	float	Yes	The service late payment fee.
limit_after_periods	No	int	Yes	How many periods (days or billing periods, depending on the "period_terms_in" value) after the due date the customer's services will be limited if regular invoice is still unpaid.
limit_warning_days	No	int	Yes	How many days before the customer's services are limited a notification of the possible limitation of services should be sent to the customer if the regular invoice is still unpaid.
managed_by	No	string	No	The name of the reseller who manages the customer class.
name	No	string	No	The name of the customer class on the PortaBilling interface, unique in the environment.
notific_days	No	string	Yes	Regular invoice notification intervals. Used to remind the customer about the invoice. The customer will get notifications of his regular invoice the stated number of days before you expect the payment. Expected format: a string of comma-separated digits. Note that the specified days cannot be greater than the grace_period. The UI equivalent of this field is the "Notify of the due date in advance, days" field on the "Edit Customer class" regular invoices panel.
ot_bp_charge_cc	No	string	Yes	Enables customer's credit card auto-charge for Out-of-Turn invoices.
ot_charge_cc_on_generation	No	string	No	The flag shows whether to start charging the customer's credit card starting from the Out-of-Turn invoice due date.
ot_closing_days	No	int	Yes	In how many days after the due date the customer's account will be closed if the out-of-turn invoice is still unpaid.
ot_closing_warning_days	No	int	Yes	How many days before the closing date a notification of possible closing should be sent to the customer if the out-of-turn invoice is still unpaid.
ot_grace_period	No	int	Yes	Out-of-turn invoice grace period, i.e. for how many days after invoice generation the payment is expected.
ot_i_template	No	unsignedLong	Yes	ID for customer's out-of-turn invoice template; refers to the Templates table.
ot_notific_days	No	string	Yes	Out-of-turn invoice notification intervals. Used to remind the customer about the invoice. The customer will get notifications of his out-of-turn invoice on days before you expect payment. Expected format: a string of comma-separated digits. Note that the specified days cannot be greater than the grace_period. The UI equivalent of this field is the "Notify of the due date in advance, days" field on the "Edit Customer class" out-of-turn invoices panel.
ot_recollect_days	No	string	Yes	Out-of-turn invoice re-collection intervals Used to try charging the needed amount from the customer credit card with the specified intervals in days, before or after the invoice due date. Expected format: a string of comma-separated digits. A negative value corresponds to days before the due date. Note that "ot_charge_cc_on_generation" should be enabled. The UI equivalent of this field is the "Additional attempts" field on the "Edit Customer class" out-of-turn invoices panel.
ot_resend_days	No	string	Yes	Out-of-turn invoice re-sending intervals Used to re-send the invoice to the customer after the invoice due date with the specified intervals in days. Expected format: a string of comma separated digits. The UI equivalent of this field is the "Re-send the invoice after the due date" field on the "Edit Customer class" out-of-turn invoices panel.
ot_send_invoices	No	string	No	Defines whether an out-of-turn invoice should be automatically sent to the customer as soon as it is created.
ot_suspension_days	No	int	Yes	In how many days after the due date the customer's services will be suspended if the out-of-turn invoice is still unpaid.
ot_warning_days	No	int	Yes	How many days before the suspension date a notification of possible suspension of services should be sent to the customer if the out-of-turn invoice is still unpaid.
pdf_generation_mode	No	string	No	Generate Invoice PDF: C - At the end of the billing period; R - Postponed, based on resource availability; D - On demand.
period_terms_in	No	string	No	Defines the units in which the options grace_period, suspension_days, closing_days are specified.
purge_after_months	No	int	Yes	Shows when customer personal data will be deleted. NULL - functionality is disabled, 0 - immediately, N - delete in N months.
reactivation_fee	No	float	Yes	The service reactivation fee.
recollect_days	No	string	Yes	Regular invoice re-collect intervals. Used to try charging the needed amount from the customer credit card with the specified intervals in days, before or after the invoice due date. Expected format: a string of comma-separated digits. A negative value corresponds to days before the due date. Note that "charge_cc_on_generation" should be enabled. The UI equivalent of this field is the "Additional attempts" field on the "Edit Customer class" regular invoices panel.
resend_days	No	string	Yes	Regular invoice re-sending intervals. Used to re-send the invoice to the customer after the invoice due date with the specified intervals in days. Expected format: a string of comma-separated digits. The UI equivalent of this field is the "Re-send the invoice after the due date" field on the "Edit Customer class" regular invoices panel.
reset_customer_balance	No	int	No	Shows whether related customers' balances are reset to 0 at the end of the billing period. This option is related to the 'use_external_billing' option and can be enabled only together with it.
review_invoices	No	string	No	Send invoices via email after review and approval by admin.
review_term_days	No	int	No	Days to hold invoice for review.
rounding_step	No	float	No	The amount to be used to round the expected payment.
send_invoices	No	string	No	Defines whether a regular invoice should be automatically sent to the customer as soon as it is created.
send_statistics	No	string	No	Defines what kind of xDR statistics should be delivered to the customer by email.
shared	No	string	No	Shows whether the customer class managed by the administrator is available to resellers.
special_rounding	No	string	No	With this option you can use a special rounding up behaviour.
statistics_disabled	No	string	No	Defines if the customers of this class will be processed by the statistics task. Be careful while disabling statistics: the system keeps xDRs only for a limited time, and you'll need statistics reports to access the records for earlier dates.
suspend_on_insuff_funds	No	string	Yes	Suspend customer on insufficient funds for subscriptions.
suspension_days	No	int	Yes	In how many days after the due date the customer's services will be suspended if the regular invoice is still unpaid.
tax_info	No	string	No	Taxation info.
use_external_billing	No	int	No	Shows whether an external billing is used by the customer class's postpaid customers.
warning_days	No	int	Yes	How many days before the suspension date a notification of possible suspension of services should be sent to the customer if the regular invoice is still unpaid.

CustomerClassNotificationCategoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_category	No	unsignedLong	No	The unique ID of the notification category.
name	No	string	No	The name of the notification category.
send_mail	No	int	No	Deprecated: the option is deprecated in MR84-0 and will be removed in MR86-0. Specifies whether this notifications will be sent by email. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email.
send_sms	No	int	No	Deprecated: the option is deprecated in MR84-0 and will be removed in MR86-0. Specifies whether this notifications will be sent by sms. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email.

NotificationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
can_mail	No	int	No	Specifies whether this template can be sent by email.
can_sms	No	int	No	Specifies whether this template can be sent by SMS.
category	No	string	No	The category of the notication.
description	No	string	No	The description of the notidication.
i_notification	Yes	unsignedLong	No	The unique ID of the notification.
i_notification_category	No	unsignedLong	No	The category ID.
mail_template_name	No	string	No	The name of the email template.
mail_tpl_authorship	No	string	No	Specifies whether the email template used is default or has been modified. Possible values: System - default template, Custom - modified template.
name	Yes	string	No	The name of the notification.
send_mail	No	int	No	Specifies whether this notification will be sent by email. Possible values: 1 - The nofication will be sent by email, 0 - The notification will not be sent by email.
send_sms	No	int	No	Specifies whether this notification will be sent by SMS. Possible values: 1 - The nofication will be sent by SMS, 0 - The notification will not be sent by SMS.
sms_template_name	No	string	No	The name of the SMS template.
sms_tpl_authorship	No	string	No	Specifies whether the SMS template used is default or has been modified. Possible values: System - default template, Custom - modified template.

NotificationTemplateVariable
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the variable.
editor_name	No	string	No	The name of the variable.
i_format	No	unsignedLong	No	The unique ID of the format of the variable.
i_format_type	No	string	No	The unique ID of the format type of the variable.
i_td_field	Yes	string	No	The unique ID of the variable as it appears in the Template_Data_Fields_Base (for system templates) and Template_Data_Fields (for custom templates) tables in the database.
pp_rule	No	string	No	Post-processing rule for variables that can be specified using regular expressions in Perl.
rule	No	string	No	The custom name of the rule used for post-processing.
var_group	No	string	No	The name of the group the variable belongs to.

CustomerClassNotificationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification	No	unsignedLong	No	The unique ID of the notification.
send_mail	No	int	No	Specifies whether this notification will be sent by email. Possible values: 1 – The notification will be sent by email, 0 – The notification will not be sent by email.
send_sms	No	int	No	Specifies whether this notification will be sent by sms. Possible values: 1 – The notification will be sent by sms, 0 – The notification will not be sent by sms.

TaxationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
options_avalara	No	TaxationOptionsAvalara structure	No	The set of parameters of the Avalara plug-in.
options_billsoft	No	TaxationOptionsBillsoft structure	No	Parameters of the EZtax (formerly known as BillSoft) plug-in.
options_custom	No	Array of TaxationOptionsCustom structure	No	The set of custom taxation options.
options_gst	No	TaxationOptionsGST structure	No	Parameters of the GST plug-in.
options_suretax	No	TaxationOptionsSureTax structure	No	Parameters of the SureTax plug-in.
options_vat	No	TaxationOptionsVat structure	No	Parameters of the VAT plug-in.
processor	Yes	string	No	Taxation plug-in name.

AbbreviatedDialingNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
abbreviated_number	No	string	No	Abbreviated number.
description	No	string	Yes	Text description for this entry.
i_ab_dialing	No	unsignedLong	Yes	ID of abbreviated dialing number record.
number_to_dial	No	string	No	Number to dial.

CustomerBatchInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_batch	No	unsignedLong	No	The unique ID of the batch.
i_customer	No	unsignedLong	No	The unique ID of the batches owner.
is_used	No	int	No	Possibe values: 1 – If the batch is used; 0 – If the batch is not used.
iso_4217	No	string	No	The ISO4217 code for the customer currency.
name	No	string	No	The name of the batch.
payment_commission_rate	No	float	Yes	The commission (in %) paid to a distributor for topping up the balance of this batch's existing account.
sale_commission_rate	No	float	Yes	A commission (in %) paid to a distributor when a new account is created.

CQInfo
Property	Mandatory	Type	Nillable	Description	Possible values
announce_estimated_wait_time	No	string	No	Specifies whether the announcement of the current estimated waiting time in the call queue is enabled.
announce_number_of_callers	No	string	No	Specifies whether the announcement of the current number of callers in the call queue is enabled.
announcement_interval	No	int	No	Announcement replay interval (in minutes).
average_duration	No	int	No	The average expected processing time in minutes for each call (used to calculate the estimated waiting time).
capacity	No	int	No	Deprecated: the option is deprecated in MR69-0 and will be removed in MR71-0. The maximum number of calls in the call queue.
group_id	No	string	No	The number (destination) of the huntgroup the call queue is configured for.
group_name	No	string	No	The name of the huntgroup the call queue is configured for.
i_c_group	No	unsignedLong	No	The unique ID of the huntgroup record the call queue is configured for.
i_c_queue	No	unsignedLong	No	The unique ID of the call queue record.
i_intro_prompt	No	unsignedLong	Yes	The unique ID of the audio file to be used as intro announcement for the call queue. Refers to the Audio_Files table. Corresponding binary files can be downloaded using the Customer.get_prompt_file method.
i_moh	No	unsignedLong	Yes	The unique ID for the "music on hold" record used for this call queue. Refers to the Audio_Files table. Corresponding binary files can be downloaded using the Customer.get_prompt_file method.
incoming_capacity	No	int	No	The maximum number of calls that can be placed on hold within this queue.
intro_prompt	No	string	No	SOAP attachment name to be used as intro announcement for the call queue. The first attachment is used if this property is not defined.
intro_prompt_action	No	string	No	One of the following: set - Sets MoH for the queue; unset - Removes MoH if it is already set.
moh	No	string	No	SOAP attachment name to be used as MoH for the queue. The first attachment is used if this property is not defined.
moh_action	No	string	No	One of the following: set - Sets MoH for the queue; unset - Removes MoH if it is already set.
moh_file_name	No	string	No	Saved MoH file name.

CustomerCustomFieldsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_value	No	string	No	Default value for the Custom Field.
i_custom_field	No	unsignedLong	No	Unique ID of the Custom Field record.
managed_by	No	unsignedLong	No	The unique ID of the reseller who manages the Custom Field record.
mandatory	No	string	No	Shows that the Custom Field is mandatory. Possible values: 'Y', 'N'.
name	No	string	No	Name of the Custom Field.
personal_data	No	string	No	Shows that the custom field contains private data and should not be shown to unauthorized users.
properties	No	string	No	JSON-encoded Validation Schema for the Custom Field.
type	No	string	No	Canonical name of the Custom Field's type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'.
value	No	string	No	Value of the Custom Field.
visible_to_end_user	No	string	No	Shows that the Custom Field is visible to the End User. Possible values: 'Y', 'N'.

CloneProductInfo
Property	Mandatory	Type	Nillable	Description	Possible values
clone_discount_plan	No	string	No	Specifies whether discount plan should be cloned while cloning the product: Y - enabled, N - disabled.
clone_rates	No	string	No	Specifies whether rates should be cloned while cloning the product: Y - enabled, N - disabled.
clone_subscription	No	string	No	Specifies whether subscriptions should be cloned while cloning the product: Y - enabled, N - disabled.
exchange_rate	No	string	No	A custom exchange rate.
i_parent	No	unsignedLong	No	The unique ID of the parent Product Record.
name	No	string	No	The name of the new cloned product.

CloneTariffInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_tariff_buy	No	unsignedLong	No	The unique ID of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider).
i_tariff_sell	No	unsignedLong	No	The unique ID of the resale tariff record (the one that the reseller charges their subresellers). If this property is not defined, a new resale tariff will be created as a copy of the reseller's wholesale tariff with the markup.
tariff_sell	No	TariffSellInfo structure	No	The information about the resale tariff record (the one the reseller charges their subresellers).

UpdateCustomerParams
Property	Mandatory	Type	Nillable	Description	Possible values
apply_spending_counter_charge_now	No	int	No	Indicates when charge for the traffic profile spending counter should be applied. Possible values: '1' - immediately, '0' - at the beginning of the next day.

ExtensionsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	Account name.
bill_status	No	string	No	Possible values: O – The account is open, I – The account is inactive, C – The account is terminated.
cont1	No	string	No	Main contact person.
firstname	No	string	No	Account's first name.
group_name	No	string	No	Group name.
hunt_keep_original_cli	No	string	No	Specifies whether to keep the original CLI; one of the following: 'Y' – The call is redirected with the phone number and name of the original caller; 'N' – The call is redirected with the phone number and name of the huntgroup; 'I' – ID only, the call is redirected with the phone number of the original caller and name of the huntgroup.
hunt_sequence	No	string	No	The ringing strategy; One of the following: Order, Random, Simultaneous, LeastUsed.
i_account	No	unsignedLong	No	The unique ID of the account record (for type = Account). Can only be a regular account, not an alias. For linked customers the account can belong to both current Branch Office (site) customer or the Main Office (HQ) customer which is linked with it.
i_c_ext	No	unsignedLong	No	Extension ID; Refers to the Centrex_Group_Extensions table.
i_c_group	No	unsignedLong	No	The unique ID of the group record (for type = Group).
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_customer_of_account	No	unsignedLong	No	The unique ID of the customer – owner of these accounts.
i_prompt	No	unsignedLong	Yes	The unique ID of the assigned prompt file.
id	No	string	No	The extension identifier used in dialing.
ip_phone_name	No	string	No	IP phone model.
lastname	No	string	No	Account's last name.
midinit	No	string	No	Account's middle initial(s).
name	No	string	No	The name of the extension / owner.
primary_group_id	No	int	No	The number of the huntgroup that is set for this extension as primary. Returns an empty string if this extension doesn't have a primary extension assigned.
primary_group_name	No	string	No	The name of the huntgroup that is set for this extension as primary. Returns an empty string if this extension doesn't have a primary extension assigned.
primary_i_c_group	No	unsignedLong	No	The unique ID of the huntgroup that is set for this extension as primary. Returns an empty string if this extension doesn't have a primary extension assigned.
prompt_error	No	string	No	A description of the last processing error.
prompt_name	No	string	No	The name of the prompt file.
prompt_status	No	string	No	The prompt file processing status. Possible values: IN_PROGRESS, ERROR, FINISHED).
published	No	string	No	When creating an extension you can mark it as "published" so that it is included in the dial-by-name directory. One of the following: Y – Makes an extensions accessible via dial-by-name; N – Excludes a certain extension from being accessible via dial-by-name (e.g. you do not want telemarketers to directly reach your CEO or CFO because their names are publicly accessible).
type	No	string	No	One of the following: Account, Group, Unassigned.

AssignedExtensionsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID of the account this extension is assigned to.
hunt_active	No	string	No	Specifies whether ringing is enabled or not. Possible values: Y – Ringing is enabled; N – Ringing is disabled.
hunt_delay	No	int	No	Indicates the delay (in seconds) before the extension starts ringing.
hunt_expire	No	int	No	Indicates the duration of ringing (in seconds).
hunt_order	No	int	No	Indicates the position of this extension in the huntgroup ringing order. For the add_customer_huntgroup and update_customer_huntgroup methods, if hunt_order of the extension is not specified, then the extension will be automatically assigned the next highest hunt order number. That is, if you already have extensions with hunt order numbers 0, 1, 2, the new extension will be assigned hunt order number 3.
huntstop	No	string	No	Indicates whether to disable any forwarding for calls made to this huntgroup.
i_c_ext	No	unsignedLong	No	Extension ID; Refers to the Centrex_Group_Extensions table. Used in the 'add_extensions' structure.
i_c_group	No	unsignedLong	No	The unique ID of the huntgroup record. Used in the 'add_extensions' structure.
i_cg_ext	No	unsignedLong	No	Primary key in the Centrex_Group_Extensions table – the list of numbers to forward the call to. Used in the 'chg_extensions' and 'del_extensions' structures.
i_customer_of_account	No	unsignedLong	No	The unique ID of the customer who owns the account.
id	No	string	No	The extension identifier used in dialing.
name	No	string	No	The name of the owner.
primary_group	No	string	No	Indicates whether this huntgroup is assigned as the primary group for the extension.
type	No	string	No	One of the following: Account, Group, Unassigned.

AccAliasesListInfo
Property	Mandatory	Type	Nillable	Description	Possible values
blocked	No	string	No	Block account's calls.
i_account	No	unsignedLong	No	The unique ID of the alias record.
i_master_account	No	unsignedLong	No	The unique ID of the main account this alias account is associated with.
id	No	string	No	ID (PIN) of the account on the PortaBilling interface, unique in the environment.
master_account_id	No	string	No	The main account name that this alias account is associated with.

CreditLimitChangeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
comment	No	string	No	Deprecated: the option is deprecated in MR68-0 and will be removed in MR71-0. A comment on the credit limit change.
comment_list	No	Array of CreditLimitChangeCommentInfo structure	No	A list of credit limit change comments.
curr_cl	No	float	No	The current credit limit.
prev_cl	No	float	No	The previous credit limit.
timestamp	No	dateTime	No	The timestamp of the credit limit change.
user	No	string	No	The name of the user who made the change.
valid_until	No	string	No	The date and time when the temporary credit limit will become invalid.

CustomXdrReportInfo
Property	Mandatory	Type	Nillable	Description	Possible values
custom_file_name	No	string	No	The name of the report file (in a format defined in the configuration).
file_name	No	string	No	The name of the report file (the unique report ID).
period_from	No	date	No	Get custom xDR reports dated starting from this date.
period_to	No	date	No	Get custom xDR reports dated before this date.
type	No	string	No	The name of a custom xDR report type.

CustomXdrReportType
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	The name of a custom xDR report type.

CustomerXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	Called Line Identification.
CLI	No	string	No	Calling Line Identification.
account_id	No	string	No	The unique ID of the account database record (used only for accounts).
aux_xdrs	No	Array of AuxXDRInfo structure	Yes	The array of auxiliary xDRs.
beneficiary_account_id	No	string	No	The unique ID of the beneficiary account if the service was consumed by a beneficiary. Otherwise, this value is the same as 'account_id' (used only for accounts).
bill_status	No	string	No	Call bill status.
bill_time	No	dateTime	No	Call bill time.
bit_flags	No	int	No	Extended information how the service was used; the integer field that should be treated as a bit-map. Each currently used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position). To learn more about bit flags values, please see the How to Use Bit Flags chapter in this guide.
bytes_downloaded	No	unsignedLong	No	The quantity of downloaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request.
bytes_uploaded	No	unsignedLong	No	The quantity of uploaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request.
call_id	No	string	No	The identifier of the call.
charged_amount	No	float	No	Amount charged.
charged_quantity	No	int	No	Units charged.
connect_time	No	dateTime	No	Call connect time.
country	No	string	No	Country.
cr_download_ids	No	ArrayOfString	No	A list of download ids for the recorded files.
description	No	string	No	Destination description.
destination	No	string	No	The destination name.
disconnect_cause	No	string	No	The code of disconnect cause.
disconnect_reason	No	string	No	Call disconnect reason.
disconnect_time	No	dateTime	No	Call disconnect time.
h323_conf_id	No	string	No	The unique session ID.
h323_incoming_conf_id	No	string	No	The unique ID of the incoming session (if exists) used for interrelating xDRs, when the charged session is established as a result of a previous session (possibly having its own xDR).
history	No	string	No	Additional information about XDR.
i_account	No	unsignedLong	No	The unique ID of the account the XDR belongs to.
i_customer	No	unsignedLong	No	The unique ID of the customer/reseller the XDR belongs to.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
i_rate	No	unsignedLong	No	The unique ID of the rate record.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_xdr	No	unsignedLong	No	The unique ID of the xdr record.
is_split	No	string	No	Shows whether the xDR is split.
iso_3166_1_a3	No	string	No	ISO 3166-1 alpha-3 - three-letter country code.
service	No	string	No	The service name.
setup_time	No	int	No	The time (in ms) between first provisional response and connect_time.
split_order	No	int	No	The sequential number in case the XDR is part of a group of XDRs resulting from the same session.
subdivision	No	string	No	Country subdivision.
unix_connect_time	No	int	No	Call connect time (expressed in Unix time format - seconds since epoch).
unix_disconnect_time	No	int	No	Call disconnect time (expressed in Unix time format - seconds since epoch).
xdr_type	No	string	No	The type of xDR. Possible values: 'customer' or 'account'.

SampleDialingRulesInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	Text description for the dialing rule.
i_dialing_rule	No	unsignedLong	No	The unique ID of the dialing rule record.
name	No	string	No	Sample dialing rule name.
options	No	DialingRuleOptionsInfo structure	No	Sample dialing rule object.
rule	No	string	No	Dialing rule in a string format.

CustomerLastBillingDateConstraintInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_billing_period	Yes	unsignedLong	No	The unique ID of the billing period.
max_shift	Yes	dateTime	No	The maximum allowed value for the last billing date of the billing period.
min_shift	Yes	dateTime	No	The minimum allowed value for the last billing date of the billing period.

MOHListInfo
Property	Mandatory	Type	Nillable	Description	Possible values
aggregated_moh_list	No	Array of MOHInfo structure	No	Aggregated MOH list.
customer_defined_moh_list	No	Array of MOHInfo structure	No	Customer defined MOH list.
default_moh_list	No	Array of MOHInfo structure	No	Default MOH list.
is_moh_update_disabled	No	int	No	Indicates whether the MOH update is allowed.
system_default_i_moh	No	unsignedLong	No	Default system MOH object.

RTRequestorInfo
Property	Mandatory	Type	Nillable	Description	Possible values
entity_type	No	string	No	The type of the requestor. Possible values: 'customer', 'reseller', 'env'.
i_entity	No	unsignedLong	No	The unique identifier of the requestor.
name	No	string	No	The name of the requestor.

TicketInfo
Property	Mandatory	Type	Nillable	Description	Possible values
created	No	dateTime	No	Ticket creation time.
id	No	int	No	Ticket number.
last_updated	No	dateTime	No	Last date when ticket has been updated.
priority	No	int	No	Ticket priority.
requestors	No	ArrayOfString	No	Ticket requestors.
status	No	string	No	Ticket status.
subject	No	string	No	Ticket subject.

CustomerVdCounterHistoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
counter	No	float	No	The money amount of the counter after the delta was applied.
counter_delta	Yes	float	No	The amount of money that was applied to the counter.
discount	No	float	No	The calculated discount applied to XDR.
i_cvd_counter	Yes	unsignedLong	No	The ID of the counter record from the Customer_VD_Counters table.
i_history	No	unsignedLong	No	The unique ID of the record.
i_xdr	No	unsignedLong	No	The ID of the XDR record from the CDR_Accounts table (in the case of a reseller, it refers to the CDR_Customer table).
modification_date	Yes	dateTime	No	The timestamp when the counter was updated.
unit_counter	No	int	No	The unit number of the counter after the delta was applied.
unit_counter_delta	Yes	int	No	The number of units that was applied to the counter.

CustomerVdNotificationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
counter	Yes	float	No	Accumulated money amount.
counter_id	Yes	unsignedLong	No	The identifier of the counter.
i_customer	Yes	unsignedLong	No	The identifier of the customer, unique in the environment.
i_dest_group	Yes	unsignedLong	No	The ID of the destination group to which the counter is applicable.
i_notification	No	unsignedLong	No	The unique ID of the record.
i_service	Yes	unsignedLong	No	Unique identifier of a service.
last_updated	Yes	dateTime	No	Timestamp when the notification record was last updated.
peak_level	Yes	int	No	Allow to limit the counter to specified peak level only (the unique ID ot the Time_Periods table).
unit_counter	Yes	int	No	Accumulated units amount (in service rating units).

BillingPeriodHistoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
billing_period_closed	No	dateTime	No	The date and time when billing period becomes closed.
i_history	No	unsignedLong	No	The unique ID of the history record.
period_from	No	dateTime	No	The start date and time of the billing period.
period_to	No	dateTime	No	The end date and time of the billing period.
stat_calculated	No	dateTime	No	The date and time when statistics is calculated.

MetricDataInfo
Property	Mandatory	Type	Nillable	Description	Possible values
date	Yes	dateTime	No	The timestamp of the measurement. For example, if the data is measured 12 times an hour, it makes 12 * 24 = 288 measurements per day, which may be not easy for a browser to show on the chart. Thus, scale-function is applied, and only 24 values per day will be returned. For each of these 24 values the date property shows the when the first measurement of 12 made during corresponding hour period has begun.
value	Yes	float	No	The number that characterizes the measurement result, can be changed by adding measured data with the same date.

CustomerInvoicesListInfo
Property	Mandatory	Type	Nillable	Description	Possible values
amount_due	No	string	No	Amount the customer is supposed to pay for this period.
amount_net	No	string	No	Sum of all charges in this period minus credits / refunds.
amount_paid	No	string	No	Amount paid by the customer already.
due_date	No	date	No	Date by which payment must be received.
i_customer	No	unsignedLong	No	Refers to customer record which the invoice belongs to.
i_invoice	No	unsignedLong	No	The unique ID of the invoice record.
i_invoice_status	No	unsignedLong	No	Refers to the invoice status record.
invoice_number	No	int	No	Invoice Number – unique identifier of the invoice.
invoice_status_desc	No	string	No	Invoice status.
is_pdf_exists	No	int	No	Indicates whether the PDF file exists.
is_void	No	string	No	This flag is set to 'Y' if the invoice is void (i.e. there is a new invoice with new data).
issue_date	No	date	No	Date when the invoice was generated.
period_from	No	date	No	Start date of the billing period.
period_to	No	date	No	End date of the billing period.

CustomerInvoicesSummary
Property	Mandatory	Type	Nillable	Description	Possible values
iso_4217	No	string	Yes	ISO4217 code for customer’s currency.
last_amount_due	No	float	Yes	The amount due of the last invoice issued.
last_due_date	No	date	Yes	The due date of the last invoice issued.
last_payment_amount	No	float	Yes	The amount of the last payment applied to an invoice.
last_payment_date	No	date	Yes	The date of the last payment applied to an invoice.
outstanding_balance	No	float	Yes	The outstanding balance.
overdue_balance	No	float	Yes	The amount which is overdue.

PaymentMethodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_number	No	string	No	Bank account number. Applicable to the Check and DirectDebitNL methods.
address	No	string	No	Address of the cardholder.
available_for_refund	No	float	No	The amount available for refund.
bank_number	No	string	No	Bank routing number. Applicable to the Check method.
city	No	string	Yes	Name of the city of the cardholder.
csc_required	No	int	No	Shows whether card security code is required or not.
cvv	No	string	No	Card security code (CVV, CVS, etc.). Applicable to all credit card methods.
exp_date	No	date	No	Card expiration date. Applicable to all credit card methods.
i_country_subdivision	No	unsignedLong	Yes	ID for cardholder's state; refers to Country_Subdivision table.
i_payment_method	No	unsignedLong	No	Unique ID of the payment method.
iso_3166_1_a2	No	string	Yes	ISO 3166 two-letter country code.
issue_no	No	string	No	Card issue number. Applicable to the Switch method.
name	No	string	No	Name of the cardholder (owner of a bank account, etc.).
number	No	string	No	Credit card number without spaces, e.g. 4444333322221111.
number_hash	No	string	No	A crypted hexadecimal code of the credit card number.
payment_method	No	string	No	Name of the payment method, one of the following: Cash, Cheque, American Express, Discover, MasterCard, VISA, Maestro, Check, DirectDebitNL. Pass undefined value in order to dismiss payment method.
phone_number	No	string	No	Phone number in E.164 format for validating the Credit Card.
processing_type	No	string	No	Processing type of the payment method.
refnum	No	string	No	Reference number (custom field).
start_date	No	date	No	Card activation date. Applicable to the Switch method.
token	No	string	No	A reference to the payment information (which is stored by the Payment Processor only).
zip	No	string	No	Postal code of the cardholder. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).

CustomerTransactionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The identifier of the account (unique in the environment).
amount	No	float	No	Money amount for the transaction.
cc_number_hash	No	string	No	A crypted hexadecimal code of the credit card number that was used to perform the transaction.
cdrid	No	string	No	XDR ID created for the transaction.
customer_name	No	string	No	The name of the customer.
details	No	string	No	Description of the transaction.
i_account	No	unsignedLong	No	The unique ID of the account.
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_merchant_account	No	unsignedLong	No	The unique payment system ID for the transaction.
i_online_payment_processor	No	unsignedLong	No	The unique payment processor ID for the transaction.
i_payment_method	No	unsignedLong	No	Unique payment method ID for the transaction.
i_payment_transaction	No	unsignedLong	No	The unique ID of a payment transaction.
i_payment_transaction_type	No	unsignedLong	No	The unique ID of the Transaction Type.
iso_4217	No	string	No	Currency for the transaction.
payment_method_info	No	string	No	Comment on the transaction's payment method.
purpose	No	string	No	The purpose of the transaction.
purpose_details	No	string	No	The details of the purpose.
result_code	No	string	No	Transaction's result code.
result_message	No	string	No	Transaction's result message.
secret	No	string	No	A secret code for the transaction.
status	No	string	No	Status of the transaction.
test_mode	No	string	No	Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N.
timestamp	No	dateTime	No	Timestamp of the transaction.
unique_transaction_id	No	string	No	UUID based unique transaction ID. Should be used as i_payment_transaction for transactions via PayNearMe processor.
x_transaction_id	No	string	No	The external transaction unique ID.

CustomerSiteInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm.
i_customer_site	Yes	unsignedLong	No	The unique ID of the customer site.
name	No	string	No	The name of the customer site.
service_features	No	Array of ServiceFeatureInfo structure	Yes	The list of the customer site's service features.
used	No	int	No	Shows whether site is used by account or not.

NetworkConnectivityInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_env	No	unsignedLong	No	The unique ID of the environment for the network connectivity profile.
i_network_connectivity	Yes	unsignedLong	No	The unique ID of the network connectivity profile.
mtu	No	int	No	Maximum transmission unit for the network connectivity profile.
name	Yes	string	No	The name of the network connectivity profile.
overhead_bits	No	int	No	Overhead bits for the network connectivity profile.

SpendingCounterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
constraint_amount	No	float	No	The initial amount of money that the customer can spend on services in the period.
extra_amount	No	float	No	The additional credit for the period – temporarily amount that increases the customer's spending limit.
i_c_spend_counter	No	unsignedLong	No	The unique ID of the customer's spending counter.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_spend_constraint_limit	No	unsignedLong	No	The unique ID of the spend constraint limit record.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
last_modified	No	dateTime	No	The date and time when the counter was last updated.
notified_depletion	No	dateTime	No	The date and time when the notification about the funds depletion was sent.
notified_estimation_ratio	No	dateTime	No	The date and time when the notification about the reaching of the warning thresholds was sent.
notified_ratio	No	dateTime	No	The date and time when the notification about the reaching of the spending limit was sent.
period_from	No	dateTime	No	The date and time when the spending counter is activated.
period_to	No	dateTime	No	The date and time when the spending counter expires.
spent_amount	No	float	No	The amount actually spent.
spent_amount_limit	No	float	No	The total amount of money per period that a customer can spend on services. It is calculated as sum of the constraint_amount and the extra_amount.

CustomerSubscriptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	date	No	Date when the subscription was activated.
billed_to	No	date	No	Date to which subscription charges have already been applied.
discount_list	No	Array of SubscriptionDiscountInfo structure	No	Only available for subscription plans charged in advance; specifies list of multi-month discounts for the subscription.
discount_rate	No	float	No	Discount rate for the subsciption in percents; if missed or provided undefined, it means that the discount rate defined in the customer information should be applied.
effective_fee	No	float	No	The amount of the periodic fee for the current billing period.
finish_date	No	date	Yes	Date when the subscription should be automatically canceled; if defined must be greater or equal to the start_date.
generate_daily_charge	No	string	No	Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y – Generate daily charges; N – Keep the total charge only.
has_discount	No	int	No	The flag shows whether the subscription has a discount assigned.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_customer_subscription	No	unsignedLong	No	The unique ID of the customer subscription record.
i_discount_current	No	unsignedLong	No	The unique ID of the current period multi-months discount.
i_discount_next	No	unsignedLong	No	The unique ID of the next period multi-months discount.
i_subscription	No	unsignedLong	No	ID for subscription plan; refers to Subscriptions table.
int_status	No	int	No	Status of the subscription: 0 - pending, 1 - active, 2 - closed.
invoice_description	No	string	No	The subscription plan name that is visible to the end user.
is_finished	No	string	No	Indicates whether the subscription has been already closed.
name	No	string	No	Name of the subscription plan, referenced by the i_subscription attribute.
next_effective_fee	No	float	No	The amount of the periodic fee for the next billing period.
rounding	No	int	No	A pattern that defines the rounding of the amount charged for a billing period.
start_date	No	date	No	The desired subscription activation date (defined in the customer's timezone), if missed or provided undefined when a subscription record is created, subscription will start immediately otherwise should be greater or equal to the customer's today date; can be updated for pending subscriptions only.

ZendeskOrganizationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	string	No	The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side.
name	No	string	No	The name of the Zendesk organization.
zendesk_organization_id	Yes	unsignedLong	No	The Zendesk organization ID number.

ZendeskTicketInfo
Property	Mandatory	Type	Nillable	Description	Possible values
created_at	No	dateTime	No	The date and time when the Zendesk ticket was created.
i_customer	No	unsignedLong	No	An existing Zendesk organization for the Customer with this ID. Note: this parameter will be used as an external_id for organization on the Zendesk side.
priority	No	string	No	The Zendesk ticket priority. Possible values: 'urgent', 'high', 'normal', 'low'.
recipient	No	string	No	The original recipient e-mail address of the Zendesk ticket.
status	No	string	No	The Zendesk ticket status. Possible values: 'new', 'open', 'pending', 'hold', 'solved', 'closed'.
subject	No	string	No	The Zendesk ticket subject.
type	No	string	No	The Zendesk ticket type. Possible values: 'problem', 'incident', 'question' or 'task'.
updated_at	No	dateTime	No	The date and time when the Zendesk ticket last got updated.
zendesk_ticket_id	No	unsignedLong	No	The Zendesk ticket unique ID number.

CustomerPerServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charged_amount	No	float	No	The sum of the amounts in the 'credits' and 'charges' fields.
charged_quantity	No	int	No	Units charged.
charges	No	float	No	The sum of charge transaction amounts related to the service.
credits	No	float	No	The sum of credit transaction amounts related to the service.
i_service	No	unsignedLong	No	The unique ID of the service; refers to Services table.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
name	No	string	No	The service name.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges (e.g. message, minute).
rating_base	No	string	No	Specifies which particular parameter is used to calculate charges, e.g. "session time", "amount of data transferred" and the like.
rating_base_unit	No	string	No	A customer-visible name for the units in which service use is measured; this also is the smallest possible unit you use in the rating configuration (e.g. second).
ratio	No	int	No	Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration.
total	No	int	No	Subtotal for this type of transactions/service.
total_sessions	No	int	No	The total number of sessions of this transactions/service type.
unit	No	string	No	The unit in which the charged quantity is shown (e.g. second).

PaymentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment.
amount	Yes	float	No	The payment amount.
card_info	No	PaymentMethodInfo structure	No	The information about the payment method.
internal_comment	No	string	No	An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly.
save_card	No	string	No	Specifies whether the supplied payment method must be saved as the preferred payment method. Possible values: Y – Save the payment method as the preferred payment method; N – Do not save the payment method as the prefereed payment method.
visible_comment	No	string	No	A comment on this transaction visible to the end user in the xDR browser.

DestinationPrefixInfo
Property	Mandatory	Type	Nillable	Description	Possible values
country	No	string	No	Country name.
description	No	string	No	Text description for this entry.
dest_type	No	string	No	Destination Type.
destination	No	string	No	Destination number.
group_name	No	string	No	The name of the related destination group. The field is present only if the i_dest_group of a group that belongs to a complete DG set is present in the request.
i_country_subdivision	No	unsignedLong	No	The unique ID of the state or province related to the destination.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
iso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
iso_3166_1_a3	No	string	No	A three-letter country code defined in ISO 3166-1 alpha-3.
network	No	string	No	Mobile network name.
subdivision	No	string	No	Country subdivision.
used	No	int	No	Is destination prefix used.

DestinationGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	Yes	The destination group description.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set to which the current destination group belongs.
name	No	string	No	The destination group name.
prefixes	No	string	No	Comma separated list of destinations included in the current destination group.
used	No	int	No	Shows whether the destination group set is used.

DestGroupSetInfo
Property	Mandatory	Type	Nillable	Description	Possible values
complete_match	No	string	No	Y/N marks the destination group set with ability to match all existent destinations.
default_i_dest_group	No	unsignedLong	No	The id of the group within the set (with complete_match "Y" only) which acts as a failover when no match is found.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set record.
is_set_empty	No	int	No	Shows whether the destination group set has at least one destination group assigned.
name	No	string	No	The destination group set name.
used	No	int	No	Shows whether the destination group set is used.

RequestDestinationPrefixInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_dest	No	unsignedLong	No	The unique ID of the destination prefix record.

DialingRuleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The dialing rule description.
dial_codes	No	DialingCodes structure	No	Structure of the Dialing Codes.
i_dialing_rule	No	unsignedLong	No	The unique ID of the dialing rule record.
i_owner	No	unsignedLong	No	The unique ID of the dialing rule owner record.
is_default	No	int	No	Shows whether the dialing rule is default in the system.
is_used	No	int	No	Shows whether the dialing rule is in use. Possible values: 1 - in use, 0 - not in use.
name	No	string	No	The dialing rule name.
owner_type	No	string	No	The type of dialing rule owner. One of the following: Customer, CustomerSite, Account.
restricted	No	string	No	Only administrator is allowed to assign restricted rules.
rule	No	DialingRuleOptionsInfo structure	No	The structure of dialing rule options.
rule_type	No	string	No	Type of the dialing rule wizard. Possible values: 'pbx – The wizard for creating pbx dialing rules. Both translation parameters and service codes are available.', 'planOnly - translation parameters will be available in the wizard.', 'advanced - The wizard for creating custom dialing rules. Dialing rules can be created by using Perl regular expressions.'.
tr_rule_from_local	No	string	No	Translation rule "from local format".
tr_rule_to_local	No	string	No	Translation rule 'to local format'.
usage_type	No	string	No	Where this rule can be applied/assigned.

DIDNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_cost	No	float	No	A one-time amount paid by the API method caller for the activation of the DID number.
activation_fee	No	float	No	A one-time amount paid to the vendor for the DID number activation.
activation_revenue	No	float	No	A one-time amount paid to the API method caller for the activation of the DID number.
assigned	No	dateTime	No	Date and time when the number was assigned to an account.
city_name	No	string	No	The area that this number belongs to.
country_iso	No	string	No	The country that this number belongs to; two-letter country code (ISO 3166-1 alpha-2).
country_name	No	string	No	Name of the country that this number belongs to.
customer_name	No	string	No	The name of the customer who owns the DID Number.
description	No	string	No	DID number description.
estimated_cost_list	No	Array of EstimatedDIDNumberPricingParameterInfo structure	No	The list of estimated costs for the i_customer provided in the request.
external	No	int	No	Shows whether the DID number is received from an external DID provider (like DIDx/DIDww).
free_of_charge	No	string	No	Indicates whether this number is completely free of charge or not.
frozen	No	string	No	Indicates whether this number is frozen or not.
group_name	No	string	No	The name of the DID group to which this number belongs.
i_account	No	unsignedLong	No	The unique ID of the account this number was assigned to.
i_customer	No	unsignedLong	No	The unique ID of the customer who owns the DID number.
i_did_number	No	unsignedLong	No	The unique ID of the DID number record.
i_do_batch	No	unsignedLong	No	The unique ID of the DID pricing batch.
i_dv_batch	No	unsignedLong	No	ID of the vendor batch this DID belongs to.
i_group	No	unsignedLong	No	The unique ID of the DID group.
i_ivr_an	No	unsignedLong	No	The ID of the IVR access number this DID is assigned to.
i_reseller_group	No	unsignedLong	No	The unique ID of the reseller DID group.
i_vendor	No	unsignedLong	No	The unique ID of the vendor who owns the DID Number.
is_used	No	int	No	Shows whether the DID number is in use.
iso_4217	No	string	No	ISO 4217 code of the currency.
managed_by	No	int	No	The unique ID of the reseller who owns the DID Number.
moved	No	string	No	Indicates whether the number was moved to a different env/system.
number	No	string	No	DID number.
owner_batch_individual	No	string	No	Shows whether the related DID pricing batch is individual.
owner_batch_name	No	string	No	Name of the owner batch this number belongs to.
periodic_fee	No	float	No	A monthly amount charged by the vendor for the provisioned DID number.
recurring_cost	No	float	No	A monthly amount paid by the API method caller for using this DID number.
recurring_revenue	No	float	No	A monthly amount paid to the API method caller for using this DID number.
released	No	dateTime	No	Date and time when the number was de-assigned from an account (account was terminated or its id changed).
reseller_group_name	No	string	No	The name of the reseller DID group to which this number belongs.
reseller_name	No	string	No	The name of the reseller that can manage this DID number.
reserved	No	dateTime	No	Date and time when this number was reserved.
reserved_stamp	No	string	No	Date and time when this number was reserved.
vendor_batch_name	No	string	No	Name of the vendor batch this number belongs to.
vendor_name	No	string	No	The name of the vendor who owns the DID Number.

WarningInfo
Property	Mandatory	Type	Nillable	Description	Possible values
message	Yes	string	No	The warning message.

DeleteDIDNumberInfoStatus
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	int	No	The unique ID of the DID number record.
status	Yes	string	No	The status that shows whether the operation was successful. Possible values: 'failure', 'success'.

CustomerDIDNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
area_name	No	string	Yes	Area name.
country_name	No	string	Yes	Country name.
description	No	string	No	DID number description.
did_number	No	string	Yes	DID number.
extension_id	No	string	No	ID of the extension.
extension_name	No	string	No	Name of the extension.
group_name	No	string	No	Name of the DID group the number belongs to.
i_account	No	unsignedLong	No	The unique ID of the account created for this DID number.
i_customer	No	unsignedLong	No	The unique ID of the customer record to which the DID number belongs.
i_did_number	No	unsignedLong	No	The unique ID of the DID number record.
i_master_account	No	unsignedLong	No	The unique ID of the account this DID number is assigned to.
is_provisioned	No	int	No	Indicates whether this number is provisioned from an online DID provider.
master_account_id	No	string	No	ID (PIN) of the account this DID number is assigned to.
pricing	No	DIDPricing structure	Yes	DID number costs info.

EstimateDIDNumberCostInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer/reseller for whom the prices will be estimated.
iso_4217	No	string	No	The iso currency code in which the resulting prices will be presented.

RequestDIDNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	No	unsignedLong	No	The unique ID of the DID number record.

UpdateDIDNumberInfoStatus
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_number	Yes	unsignedLong	No	The unique ID of the DID number record.
status	Yes	string	No	The status that shows whether the operation was successful. Possible values: 'failure', 'success'.

DIDGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The DID group description.
i_group	No	unsignedLong	No	The unique ID of the DID group.
name	No	string	No	The name of the DID group.
total_dids	No	int	No	The total number of DID numbers in the group.
total_dids_free	No	int	No	The total number of DID numbers in the group that are not in use.
total_dids_used	No	int	No	The total number of DID numbers in the group that are in use.

DIDInventoryOptionsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_activation_ttc	No	unsignedLong	Yes	The ID of the activation tax transaction code.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller who manages the inventory options.
i_did_inventory_option	No	unsignedLong	No	The unique ID of the inventory option record.
i_usage_ttc	No	unsignedLong	Yes	The ID of the usage tax transaction code.
number_type	No	string	No	The number type; possible values: standard, toll_free.

DIDOwnerBatchInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	DID Pricing Batch Description.
free_of_charge	No	string	No	Indicates whether this owner batch is completely free of charge or not.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller who owns the DID pricing batch.
i_do_batch	No	unsignedLong	No	The unique ID of the DID pricing batch.
is_used	No	string	No	Indicates whether this owner batch is in use.
iso_4217	No	string	No	The currency for the DID pricing batch.
markup_options	No	DIDMarkupOptionsInfo structure	No	The information about the DID pricing batch markup.
name	No	string	No	The name of the DID pricing batch.
retention_time	No	int	No	The DID owner batch retention time.
total_dids	No	int	No	The total number of DID numbers in the owner batch.
total_dids_free	No	int	No	The total number of DID numbers in the owner batch that are not in use.
total_dids_used	No	int	No	The total number of DID numbers in the owner batch that are in use.
type	No	string	No	The type of the DID pricing batch.

VendorBatchInfo
Property	Mandatory	Type	Nillable	Description	Possible values
area_code	No	string	No	Area Code.
area_code_description	No	string	No	Area Code Description.
country	No	string	No	ISO 3166 two-letter country code.
description	No	string	No	The description of the vendor batch.
i_dv_batch	No	unsignedLong	No	The unique ID of the vendor batch record.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
is_used	No	int	No	Shows whether the DID vendor batch is in use.
name	No	string	No	The name of the vendor batch.
total_dids	No	int	No	The total number of DID numbers in the vendor batch.
total_dids_free	No	int	No	The total number of DID numbers in the vendor batch that are not in use.
total_dids_used	No	int	No	The total number of DID numbers in the vendor batch that are in use.
vendor_name	No	string	No	The name of the vendor related to this vendor batch.

CustomerDIDProviderIdent
Property	Mandatory	Type	Nillable	Description	Possible values
customer_batch	No	int	No	The unique ID of the DID Owner Batch assigned to customer.
i_customer	No	unsignedLong	No	The unique ID of the customer.
reseller_batch	No	int	No	The unique ID of the DID Owner Batch assigned to reseller.

DIDRequestParameters
Property	Mandatory	Type	Nillable	Description	Possible values
area_name	No	string	Yes	Area name.
area_prefix	No	string	No	Area prefix.
city_id	No	int	No	Unique city ID number.
city_prefix	No	string	No	City prefix.
country_id	No	int	No	The unique ID of the country record.
country_iso	No	string	Yes	Country ISO code.
country_name	No	string	No	Country name.
country_prefix	No	string	No	Country prefix.
i_did_provider	No	unsignedLong	No	The unique ID of the DID provider record.
number	No	string	No	DID number.

DIDAreaInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	int	No	The consecutive area number in the list.
name	Yes	string	No	Area name.
prefix	Yes	string	No	Area prefix.
pricing	No	DIDPricing structure	No	DID number costs info.
req_params	No	DIDRequestParameters structure	Yes	Parameters which should be passed back while checking available numbers list.

DIDCountryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	int	No	The consecutive country number in the list.
name	Yes	string	No	Country name.
prefix	No	string	No	Country prefix.
req_params	No	DIDRequestParameters structure	Yes	The list of the parameters that should be passed back while checking available areas list.

DIDProviderInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_did_provider	No	unsignedLong	No	The unique ID of the DID provider.
is_numbers_list_available	No	int	No	The flag which indicates whether the DID provider allows to choose a particular number from the provided list.
name	No	string	No	The DID provider name.
provider_currency	No	string	No	The DID provider currency. For the customer it means their actual currency used when buying the DID from the provider.

DIDNumberListInfo
Property	Mandatory	Type	Nillable	Description	Possible values
id	Yes	int	No	The consecutive number in the list.
number	Yes	string	No	DID number.
pricing	No	DIDPricing structure	Yes	DID number costs info.
req_params	No	DIDRequestParameters structure	Yes	Parameters which will be obtained while allocating a DID number.

DIDNumberOrderInfo
Property	Mandatory	Type	Nillable	Description	Possible values
area_name	No	string	Yes	Area name.
country_name	No	string	Yes	Country name.
did_number	No	string	Yes	Provisioned DID number.
did_status	No	string	Yes	DID number status.
fault_code	No	string	Yes	Error code.
fault_string	No	string	Yes	Error description.
i_did_number	No	unsignedLong	Yes	Provisioned number ID in the DID inventory.
is_success	Yes	int	No	A flag that informs if the order request has been successfully processed.
order_id	No	string	Yes	Order ID on DID provider side.
pricing	No	DIDPricing structure	Yes	DID number costs info.

DiscountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
align_billing	No	string	No	Defines how/if the usage period should be aligned to the customer's billing period (Supported values: 'Y', 'R', 'N', where 'R' and 'Y' are identical and 'R' is kept only to preserve compatibility).
dg_name	No	string	No	Destination Group name.
exclusive	No	string	No	Specifies whether an account should be granted exclusive free calls. Possible values: I – Never – for all discount types; N – Always – for discounts; Y – When lower than full – for discounts; F – After the last threshold – for all discount types; The default value depends on the discount type: F – default for quotas and service wallets; N – default for discounts. .
i_dest_group	No	unsignedLong	No	Unique Destination Group ID.
i_service	No	unsignedLong	No	Unique Service id.
i_tax_transaction_code	No	unsignedLong	No	The ID of Tax Transaction Code for Service Wallet Top-Up.
i_vd_dg	No	unsignedLong	No	The unique ID of the volume discount record (volume discount destination group record).
i_vd_plan	No	unsignedLong	No	The unique ID of the discount plan.
i_vd_type	No	unsignedLong	No	The ID of the discount type. This option works in conjunction with usage_period. Possible values: 1 - discount; 2 - quota or service wallet (distinguished by the usage_period value).
max_peak_level	No	int	No	In pair with peak_level defines period when this Discount Thresholds should be used. This field defines maximal level (from Peak, Off-Peak, 2nd Off-Peak) for this Discount Thresholds .
peak_level	No	int	No	Indicates whether this Discount Thresholds should be applied during the peak or off-peak period. If off-peak Discount Group doesn't exist peak will be used. 0 - Peak, 1 - Off-Peak, 2 - 2nd Off-Peak .
prorate	No	string	No	Prorate the thresholds when period can't be used from its regular beginning (Supported values: 'Y', 'N').
rate_unit	No	string	No	Units.
restart	No	string	No	Should the new Discount be applied after the previous one finished (Supported values: 'Y', 'N').
rollover_periods	No	int	No	Number of periods to expire the rolled over quota amount.
service_name	No	string	No	Service name.
tax_transaction_code	No	string	No	The Tax Transaction Code for Service Wallet Top-Up.
threshold_list	No	Array of VDThresholdInfo structure	No	Discount thresholds list.
threshold_type	No	string	No	Discount type value ( enum 'Charged Amount', 'Charged Time').
topup_option_list	No	Array of VDTopupOptionInfo structure	No	Quota Topup Options list.
transfer_allowed	No	string	No	Determines whether to allow transfer of unused units between entities. (Y = Yes / N = No).
usage_period	No	int	No	This defines how often the volume discount is reset and what type of discount to create. Possible values for vd_type = 1: Empty value - create a one-time discount; 1 - create a daily reset discount; 2 - create a weekly reset discount; 3 - create a semimonthly reset discount; 4 - create a monthly reset discount. Possible values for vd_type = 2: Empty value - create a service wallet; 1 - create a daily reset quota; 2 - create a weekly reset quota; 3 - create a semimonthly reset quota; 4 - create a monthly reset quota .
wallet_expiration_warning	No	int	No	The number of days in advance for the notification that the service wallet expires.
wallet_expired_notify	No	string	No	Determines whether to send the notification when the service wallet expires. (Y = Yes / N = No).
wallet_transfer_allowed	No	string	No	Deprecated: the option is deprecated in MR80-0 and will be removed in MR86-0. Determines whether to allow transfer of the service wallet contents between entities. (Y = Yes / N = No).

DiscountPlanInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	A description of this volume discount plan.
dest_group_set_name	No	string	Yes	The destination group set name.
destination_lookup	No	string	No	Destination lookup strategy.
i_customer	No	unsignedLong	Yes	The unique ID of the customer to whom the volume discount plan record is assigned.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set associated with this discount plan.
i_vd_plan	No	unsignedLong	No	The unique ID of the volume discount plan.
is_complete	No	int	No	Shows whether the discount plan is complete and ready for assigning to other entities.
is_used	No	int	No	Shows whether the discount plan is used or not.
is_used_by_resellers	No	int	No	Shows whether the shared discount plan is used by resellers.
iso_4217	No	string	No	The volume discount plan currency.
managed_by	No	string	Yes	The name of the customer who manages the volume discount plan.
name	No	string	No	The volume discount plan name.
reset_period	No	string	No	The discount plan lifetime period.
shared	No	string	No	Shows whether the discount plan managed by the administrator is available to resellers.

VDThresholdInfo
Property	Mandatory	Type	Nillable	Description	Possible values
alter_service	No	string	No	Alter service value.
discount	No	float	No	Discount value in percent (%).
i_vd_dg	No	unsignedLong	No	ID of the volume discount record (volume discount destination group record).
i_vd_threshold	No	unsignedLong	No	The unique ID of the volume discount threshold record.
notify_if_exceeded	No	string	No	The flag indicates if a notification is sent when the threshold is exceeded. Possible values: 'Y', 'N'. The default value is 'N'.
threshold_value	No	float	Yes	Threshold value.
warning_threshold	No	float	Yes	Warning notification threshold value.
xdr_split	No	string	No	The flag shows if the threshold record is marked as splitting (Splitting XDRs). Possible values: 'Y', 'N'. The default value is 'N'.

VDTopupOptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_vd_dg	No	unsignedLong	No	The unique ID of the discount for a specific destination group.
i_vd_topup	No	unsignedLong	No	The unique ID of the volume discount topup record.
topup_amount	No	float	No	The amount of service units to topup.
topup_expiry_time	No	int	No	The lifetime of the top-up option, the number of days.
topup_fee	No	float	No	The amount of money an end user is charged for topup.

EmergencyUnitInfo
Property	Mandatory	Type	Nillable	Description	Possible values
emergency_unit_id	No	string	No	The canonical path of the administrative unit. Delimiter "." (dot).
i_emergency_unit	No	unsignedLong	No	The identifier of the administrative unit.
iso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
name	No	string	No	The name of the emergency administrative unit. The field is unique for "i_env" and "country".
routing_number	No	string	No	The (default) routing number, when the cld rule is not specified.
routing_number_rule	No	Array of EmergencyUnitRoutingNumberRuleInfo structure	No	The list of routing number rules.

EmergencyUnitRoutingNumberRuleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
cld_number	No	string	No	Emergency number dialed.
routing_number	No	string	No	Routing number.

CustomTaxOptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
alias	No	string	No	The alias of the custom tax. By default is construsted as a combination of the prefix ct_ and the value of the i_option property. For example: "ct_81".
applied_to	No	string	No	Shows which services this tax is applied to. Possible values: only_usage_charges – All charges except for subscriptions and credits / adjustments; all_charges – Applied to all charges including subscriptions and credits / adjustments; all_recurring_charges – Applied only to subscriptions.
i_option	No	unsignedLong	No	The unique ID of the custom tax.
name	No	string	No	The name of the custom tax option.
tax_percent	No	float	No	A percentage rate value for this tax.
used	No	int	No	Shows whether this tax is used. Possible values: 1 - The tax is used, 0 - The tax is not used.

EnvInfo
Property	Mandatory	Type	Nillable	Description	Possible values
addr1	No	string	No	The 1st line of company's address.
address_line_2	No	string	No	The 2nd line of the company's address.
billed_to	No	dateTime	No	Billed to date.
calls_counted_time	No	dateTime	No	Calls counted time.
companyname	No	string	No	The name of the company.
contact_city	No	string	No	The city that is printed in the invoice.
contact_email	No	string	No	The contact email that is printed in the invoice.
contact_i_country_subdivision	No	unsignedLong	No	Refers to the ID of the province or state that is printed in the invoice.
contact_zip	No	string	No	The postal code for the company's registered location that is printed in the invoice.
cost_revenue_daily	No	dateTime	No	Cost revenue daily date.
cost_revenue_monthly	No	dateTime	No	Cost revenue monthly date.
cost_revenue_weekly	No	dateTime	No	Cost revenue weekly date.
description	No	string	No	A short description of the env.
email	No	string	No	Primary email contact for the company.
faxnum	No	string	No	Company's fax number.
i_billing_period	No	unsignedLong	No	ID for billing period; refers to Billing_Period table.
i_country_subdivision	No	unsignedLong	No	Refers to the ID of province or state where the company is registered.
i_env	No	unsignedLong	No	The unique ID of the environment.
i_number_scope	No	unsignedLong	No	PortaBilling can generate invoices for all customers with sequential invoice numbering distributed throughout the environment. In some cases, you may want to have more than one sequence of numbers. One of the following: 1 – Individual for Environment, 2 – Individual for Reseller, 3 – Individual for Customer.
i_time_zone	No	unsignedLong	No	ID for the environment's time zone which global reports for the environment will be generated in; refers to Time_Zones table.
iso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
iso_4217	No	string	No	ISO4217 code for company's internal currency.
laddr1	No	string	No	The 1st line of company's address where this company name is legally registered.
laddr2	No	string	No	The 2nd line of company's address where this company name is legally registered.
lcity	No	string	No	City in which the company is legally registered.
liso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2 where the company is legally registered.
lname	No	string	No	Proper, legally-recognized form of the company's name.
lzip	No	string	No	Postal code for the company's registered location. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).
name	No	string	No	The name of the environment.
phone	No	string	No	Company's phone number.
tax_id	No	string	No	Tax ID.
tax_info	No	string	No	The configured taxation method options. For example: business=0;incorporated=0; federal_exempt=1;state_exempt=1; county_exempt=1; May contain all taxation method options or only those that need to be passed.
web	No	string	No	Company's web address.

BillingPeriodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	Yes	string	No	The Billing Period description.
i_billing_period	Yes	unsignedLong	No	The unique ID of the Billing Period.

GlobalCurrencyInfo
Property	Mandatory	Type	Nillable	Description	Possible values
decimal_digits	No	int	No	Maximum number of decimal places allowed for a currency, e.g. for US dollars or euros it will be 2, since the smallest unit is one cent (0.01), while for yens it will be 0.
iso_4217	No	string	No	ISO4217 alphabetic code, the unqiue currency identifier.
iso_4217_num	No	string	No	ISO4217 numeric code, the unqiue currency identifier.
name	No	string	No	The currency name.
name_major	No	string	No	Major name of the currency, e.g. dollar (returned only in the response to the "get" method).
name_minor	No	string	No	Minor name of the currency, e.g. cent, (returned only in the response to the "get" method) .
obsolete	No	string	No	Specifies whether this currency is obsolete.

ExtendedDataObjectInfo
Property	Mandatory	Type	Nillable	Description	Possible values
fields	Yes	ArrayOfString	No	The list of fields to select.
object	No	string	No	The name of the object.

ExtendedDataFilterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
condition	No	string	No	The condition used to group the entries.
entries	No	Array of ExtendedDataEntryInfo structure	No	The set of filter entries.

ExtendedDataRecordInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	date	No	The date from which the account is usable.
additional_invoices	No	float	No	The balance of all previous invoices.
addon_priority	No	int	No	In order to differentiate between add-on products, there is also a "precedence level" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level.
adjustments	No	float	No	The adjusted amount the customer is supposed to pay you for this period.
amount_due	No	float	No	The amount the customer is supposed to pay for this period.
amount_net	No	float	No	The sum of all charges for this period minus credits/refunds.
amount_paid	No	float	No	The amount already paid by the customer .
baddr1	No	string	No	1st line of the customer's address.
baddr2	No	string	No	Deprecated: the option is deprecated in MR86-0 and will be removed in MR91-0. 2nd line of the customer's address.
baddr3	No	string	No	Deprecated: the option is deprecated in MR86-0 and will be removed in MR91-0. 3rd line of the customer's address.
baddr4	No	string	No	Deprecated: the option is deprecated in MR86-0 and will be removed in MR91-0. 4th line of the customer's address.
baddr5	No	string	No	Deprecated: the option is deprecated in MR86-0 and will be removed in MR91-0. 5th line of the customer's address.
balance	No	float	No	The balance.
balance_transfer_allowed	No	string	No	Defines if balance transfer is enabled for a customer class.
bcc	No	string	No	BCC email address.
bill_status	No	string	No	The bill status.
billed_to	No	dateTime	No	The customer's "billed to" date.
billing_lock	No	string	No	The advisory billing period closure lock. Possible values: N - vacant; C - engaged, billing period closure is restricted; F - engaged, both billing period closure and any fixups are restricted.
billing_model	No	int	No	The account type.
blocked	No	string	No	Block customer's calls.
bp_charge_cc	No	string	No	Automatically charge customer's credit card when a billing period is closed.
bp_closure_delay_days	No	int	No	Max days to delay billing period closure.
breakage	No	float	No	Used in account management to obtain a summary of depleted (practically unusable) accounts.
bundle_billed_to	No	dateTime	No	Any bundles earlier than this date and time are already calculated.
calls	No	float	No	Service charges (e.g. call charges).
callshop_enabled	No	string	No	Enable callshop features on customer's self-care interface.
city	No	string	No	City of the customer's address.
closed	No	string	No	Indicates whether the invoice is closed (sent to the customer).
closing_days	No	int	No	In how many days after the due date the customer's account will be closed if the regular invoice is still unpaid.
closing_days_after_terminated	No	int	No	In how many days after provisional termination the customer’s account will be permanently closed (if the administrator does not manually restore this customer within this period).
closing_warning_days	No	int	No	How many days before the closing date a notification of possible closing should be sent to the customer if the regular invoice is still unpaid.
collection_threshold	No	float	No	If no payment is made, the balance is applied to the next invoice(s) until the amount due on a new invoice crosses this threshold.
companyname	No	string	No	Customer's company name.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
control_number	No	int	No	The sequential number of the account in the batch.
country	No	string	No	The code of the country in the ISO 3166-1 alpha-2 format.
creation_date	No	dateTime	No	The date and time when the customer was created.
credit_limit	No	float	No	Customer's credit limit value. Please note that this property may be used with the nil attribute set to true, in which case the credit limit will not be enforced.
credit_limit_until	No	dateTime	No	The date and time when the temporarily extended credit limit will be automatically reverted to the original value.
deactivate_on	No	dateTime	No	The date when the customer will be deactivated.
default_class	No	string	No	The flag that designates the default customer class.
default_i_acl	No	unsignedLong	No	Which ACL should be assigned to new accounts created with this product.
description	No	string	No	The description.
disable_statistics	No	int	No	Defines if the customers of this class will be processed by the statistics task.
discount_rate	No	float	No	The value of customer's subscription discount; a percentage.
due_date	No	date	No	The date by which payment must be received.
ecommerce_enabled	No	string	No	Allow the account's owner to make online payments or set up periodical payments on the account's self-care page.
effective_from	No	dateTime	No	Account product add-on effective from date.
effective_to	No	dateTime	No	Account product add-on effective to date.
email	No	string	No	Email address.
email_from	No	string	No	Email address for reseller to use as sender email for customer notifications.
end_user_description	No	string	No	Description visible to the end user.
end_user_name	No	string	No	Product name visible to the end user.
estimate_taxes	No	string	No	If set, enables taxes estimation on receiving payments for prepaid customers.
expiration_date	No	date	No	The date from which the account will become unusable.
extra_invoice	No	string	No	Separate Invoice for Recurring Fees.
faxnum	No	string	No	Fax number.
first_usage_time	No	dateTime	No	The date and time when the account was first used.
firstname	No	string	No	Customer's first name.
fraud_protection	No	string	No	Overdraft Protection mode for the product. Possible values: 'None', 'All', 'Debit'.
generate_invoice_earlier	No	string	No	Defines whether an invoice will be generated before the end of the billing period (Y, N).
grace_period	No	int	No	Regular invoice grace period, i.e. for how many days after invoice generation the payment is expected.
h323_password	No	string	No	The VoIP password used to authenticate calls made using the account.
hidden	No	string	No	Indicates whether the product is hidden.
hide_reset_balance_xdr	No	int	No	Shows whether the reset balance XDR is hidden from the end user. This option is related to the 'reset_customer_balance' option and can be enabled only together with it.
i_account	No	unsignedLong	No	Account balance control type.
i_account_balance_control_type	No	unsignedLong	No	Account balance control type.
i_account_role	No	unsignedLong	No	The unique ID of the account role.
i_acl	No	unsignedLong	No	The unique ID of the access level.
i_addon_product	No	unsignedLong	No	The unique ID of the assigned product add-on record.
i_balance_control_type	No	unsignedLong	No	Customer balance control type.
i_batch	No	unsignedLong	No	The unique ID of the batch to which the account belongs.
i_billing_period	No	unsignedLong	No	The unique ID of the customer's billing period; refers to the Billing_Period table.
i_billing_processor	No	unsignedLong	No	The unique ID of the taxation plugin.
i_business_model	No	unsignedLong	No	The unique identifier for a business model; refers to the Business_Models table.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_customer_class	No	unsignedLong	No	The unique ID of the customer class.
i_customer_site	No	unsignedLong	No	The unique ID of the customer site.
i_customer_type	No	unsignedLong	No	The customer type.
i_distributor	No	unsignedLong	No	The unique ID of the distributor record associated with the customer.
i_do_batch	No	unsignedLong	No	The unique ID of the owner DID Batch used for DID numbers auto-provisioning.
i_invoice	No	unsignedLong	No	The unique ID of the invoice record.
i_invoice_status	No	unsignedLong	No	The unique ID of the invoice status.
i_invoice_type	No	unsignedLong	No	The unique ID of the invoice type.
i_lang	No	string	No	The code for the web interface language.
i_main_office	No	unsignedLong	No	The unique ID of the main office.
i_master_account	No	unsignedLong	No	Applicable only to the alias account type; the main account this alias is associated with.
i_number_scope	No	unsignedLong	No	PortaBilling can generate invoices for all customers with sequential invoice numbering distributed throughout the environment. In some cases, you may want to have more than one sequence of numbers. One of the following: 1 – Individual for Environment, 2 – Individual for Reseller, 3 – Individual for Customer.
i_number_scope_reseller	No	unsignedLong	No	The identifier of the invoice sequence numbers scope for the reseller.
i_office_type	No	unsignedLong	No	The unique ID of the Office_Types record.
i_parent	No	unsignedLong	No	Omit for a direct customer; i_customer of the reseller for a subcustomer.
i_product	No	unsignedLong	No	The unique ID of the product record.
i_product_group	No	unsignedLong	No	The unique ID of the product group record.
i_rep	No	unsignedLong	No	The unique ID of the customer's representative.
i_subscriber	No	unsignedLong	No	The unique ID of the account's subscriber record.
i_tariff	No	unsignedLong	No	The unique ID of the customer's tariff; applies to resellers only.
i_tariff_incoming	No	unsignedLong	No	The unique ID of the customer's incoming tariff; applies to resellers only.
i_tax_transaction_code	No	unsignedLong	No	The unique identifier for a tax transaction code.
i_template	No	unsignedLong	No	The unique ID of the invoice template.
i_time_zone	No	unsignedLong	No	The unique ID of the customer's time zone.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
i_ui_time_zone	No	unsignedLong	No	The unique ID of the user interface time zone.
i_vd_plan	No	unsignedLong	No	The unique ID of the discount plan.
id	No	string	No	The ID (PIN) of the account on the PortaBilling interface, unique in the environment.
in_date_format	No	string	No	Input format for date indication.
in_time_format	No	string	No	Input format for time indication.
inactivity_expire_time	No	int	No	Specifies the number of days the account remains active after its last use or recharge.
inclusive_taxation	No	string	No	Identifies that taxes are included in the rates for a customer class.
info_url	No	string	No	The URL to an external website describing product features.
invoice_number	No	int	No	Invoice Number - the unique identifier of the invoice.
invoice_rounding_precision	No	int	No	The number of digits after decimal point for rounding.
is_void	No	string	No	Specifies whether the invoice is void (i.e. there is a new invoice with actual data).
iso_4217	No	string	No	The ISO4217 code for the currency.
iso_639_1	No	string	No	The language the user prefers when interacting with an IVR application.
issue_date	No	date	No	The date when the record was created.
last_closing_date	No	date	No	Last closing date. The date the customer's account was closed after an invoice became overdue.
last_notific_date	No	date	No	The date the invoice was first sent to the customer.
last_recharge	No	dateTime	No	The date on which the account was last recharged using IVR, web self-care, SMS, etc.
last_recollect_date	No	date	No	Last recollect date. The date the collection attempt was made (attempt to charge the customer's credit card on file for the amount due).
last_resend_date	No	date	No	Last resend date. The date the invoice was resent to the customer.
last_suspension_date	No	date	No	Last suspension date. The date the customer was suspended after an invoice became overdue.
last_usage	No	dateTime	No	The date on which the account was last used.
last_warning_date	No	date	No	Last warning date. The date the notification email was sent to the customer informing about service suspension.
lastname	No	string	No	Customer's last name.
life_time	No	int	No	Defines the number of days the account remains active after the date of its first use. The account will expire on the first usage date + life time days.
login	No	string	No	Customer's login for self-care web interface.
mac	No	string	No	The MAC address of the CPE associated with this account.
managed_by_user	No	string	No	Flag shows whether product can be managed by end user.
management_number	No	string	No	A custom identifier of the account (optional).
manual_charges	No	float	No	Manual charges. Non-service related charges.
max_abbreviated_length	No	int	No	Maximum allowed length of customer's abbreviated numbers; applies to retail customers only.
measured_services	No	float	No	Measured service charges.
midinit	No	string	No	Customer's middle initial(s).
name	No	string	No	The name.
new_i_billing_period	No	unsignedLong	No	The unique ID of the customer's future billing period.
new_i_time_zone	No	unsignedLong	No	The unique ID of the customer's future time zone.
new_style	No	int	No	Defines whether the invoice includes the previous balance.
note	No	string	No	Short note (description).
notific_days	No	string	No	Regular invoice notification intervals. Used to remind the customer about the invoice. The customer will get notifications of his regular invoice the stated number of days before you expect the payment. Expected format: a string of comma-separated digits. Note that the specified days cannot be greater than the grace_period. The UI equivalent of this field is the "Notify of the due date in advance, days" field on the "Edit Customer class" regular invoices panel.
opening_balance	No	float	No	The initial balance.
out_date_format	No	string	No	Output format for date indication on the self-care interface.
out_date_time_format	No	string	No	Output format for full date/time indication.
out_time_format	No	string	No	Output format for time indication.
override_tariffs_enabled	No	string	No	Specifies whether the Override Tariffs feature is enabled.
password	No	string	No	The password for the self-care web interface.
password_timestamp	No	dateTime	No	The date when the password was changed.
payment_commission_rate	No	float	No	The commission applied when a payment is entered (only applicable to distributors).
payments	No	float	No	Payments. Sum of all charges.
pdf_created	No	dateTime	No	The date when the PDF file was created for this invoice.
pdf_generation_mode	No	string	No	Generate invoice PDF.
period_from	No	dateTime	No	The start date of the billing period.
period_to	No	dateTime	No	The end date of the billing period.
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
previous_balance	No	float	No	Previous balance. Balance reported in the last invoice.
previous_credit_limit	No	float	No	Customer's original credit limit value.
prior_balance	No	float	No	Prior balance.
prior_balance_paid	No	float	No	Prior balance paid.
realm	No	string	No	A custom string. A realm enables administrators to impose a scope of uniqueness for an account ID.
recollect_days	No	string	No	Regular invoice re-collect intervals. Used to try charging the needed amount from the customer credit card with the specified intervals in days, before or after the invoice due date. Expected format: a string of comma-separated digits. A negative value corresponds to days before the due date. Note that "charge_cc_on_generation" should be enabled. The UI equivalent of this field is the "Additional attempts" field on the "Edit Customer class" regular invoices panel.
redirect_number	No	string	No	Associated number specifies the number to be sent back to the IVR in an authorization confirmation. For example, this might be a redirect to a technical support number in an IVR application.
refnum	No	string	No	Reference number (custom field).
resend_days	No	string	No	Regular invoice re-sending intervals. Used to re-send the invoice to the customer after the invoice due date with the specified intervals in days. Expected format: a string of comma-separated digits. The UI equivalent of this field is the "Re-send the invoice after the due date" field on the "Edit Customer class" regular invoices panel.
reset_customer_balance	No	int	No	Shows whether related customers' balances are reset to 0 at the end of the billing period. This option is related to the 'use_external_billing' option and can be enabled only together with it.
restore_on	No	dateTime	No	The date when the customer status will be returned to open.
review_invoices	No	string	No	Send invoices "via" email after review and approval by admin. Days to hold the invoice for: "review".
review_term_days	No	int	No	Days to hold invoice for review.
rounding_step	No	float	No	The rounding step for callshops.
sale_commission_rate	No	float	No	The commission that is applied when an account is created or a distributor is assigned (only applicable to distributors.
salutation	No	string	No	Customer's salutation.
scheduled_billing_change	No	date	No	The date when the billing period will close and a new billing period and a new time zone will be applied.
send_invoices	No	string	No	Defines whether a regular invoice should be automatically sent to the customer as soon as it is created.
send_statistics	No	string	No	Defines what kind of xDR statistics should be delivered to the customer by email.
service_flag_locks	No	string	No	Specifies whether values for each service feature are allowed to be changed by administrator and end user.
service_flags	No	string	No	The service features settings.
shared	No	string	No	Shows whether the product managed by the administrator is available to resellers.
shifted_billing_date	No	date	No	This is applicable only for "monthly anniversary" and 30-day billing periods; allows you to set the billing date to a different day of the month in the future (used only in requests).
special_rounding	No	string	No	With this option you can use a special rounding up behaviour.
state	No	string	No	Province or state.
subscriptions	No	float	No	Subscription fee.
suspend_on_insuff_funds	No	string	No	Specifies whether to suspend the customer on insufficient funds for charging subscriptions.
suspension_days	No	int	No	In how many days after the due date the customer's services will be suspended if the regular invoice is still unpaid.
suspension_delay_date	No	dateTime	No	The date when the customer will be suspended.
tax_id	No	string	No	Tax ID.
tax_info	No	string	No	The configured taxation method options.
tax_method	No	int	No	Taxation method.
taxes	No	float	No	Calculated taxes. The amount of taxes for this period.
terminate_on	No	dateTime	No	The date when the customer will be terminated.
timer	No	dateTime	No	Booth timer (for accounts of a callshop reseller).
ua_profile_id	No	unsignedLong	No	The unique ID for the UA profile; indicates the IP phone assigned to the account.
unallocated_payments	No	float	No	The customer's unallocated payments.
use_external_billing	No	int	No	Shows whether an external billing is used by the customer class's postpaid customers.
warning_days	No	int	No	How many days before the suspension date a notification of possible suspension of services should be sent to the customer if the regular invoice is still unpaid.
zero_balance_date	No	date	No	Applicable only to debit accounts; specifies when the account has used up all of its available funds.
zip	No	string	No	Postal (zip) code.

APIServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
method_list	No	Array of APIMethodInfo structure	No	The list of API methods that are implemented in the API service.
name	Yes	string	No	The name of the API service.

CodecInfo
Property	Mandatory	Type	Nillable	Description	Possible values
mime_subtype	Yes	string	No	The subtype of the codec.
mime_type	Yes	string	No	The type of the codec.

CountryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
iso_3166_1_a2	Yes	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
name	Yes	string	No	Country name.

LocaleLanguageInfo
Property	Mandatory	Type	Nillable	Description	Possible values
direction	No	string	No	Text direction.
iso_639_1	No	string	No	The ISO 639-1 code of the language.
name	No	string	No	The name of the language.

SubdivisionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_country_subdivision	Yes	unsignedLong	No	A unique ID of country subdivision.
iso_3166_1_a2	Yes	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
iso_3166_2	Yes	string	No	A code of a principal subdivision (e.g. province or state).
name	Yes	string	No	Subdivision name.

UIConfigInfo
Property	Mandatory	Type	Nillable	Description	Possible values
section_name	No	string	No	The name of the UI config section.
value	No	string	Yes	The value for the UI config section.

TimeZoneInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_time_zone	No	unsignedLong	No	The unique ID of the time zone.
time_zone_name	No	string	No	A commonly used name of the time zone.

OutOfTurnXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_xdr	Yes	unsignedLong	No	The unique ID of the xDR record.
owner_type	Yes	string	No	An xDR owner entity. One of the following: Customer; Account.

InvoiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
additional_invoices	No	float	No	The balance of all previous invoices.
adjustments	No	float	No	Adjusted amount the customer is supposed to pay you for this period.
amount_due	No	float	No	Amount the customer is supposed to pay for this period.
amount_net	No	float	No	Sum of all charges in this period minus credits/refunds.
amount_paid	No	float	No	Amount paid by the customer already.
calls	No	float	No	Service charges (e.g. call charges).
closed	No	string	No	Indicates whether the invoice is closed (sent to the customer) or not.
customer_name	No	string	No	Customer name to which the invoice belongs.
due_date	No	date	No	Date by which payment must be received.
i_billing_processor	No	unsignedLong	No	Refers to Billing Processor record.
i_customer	No	unsignedLong	No	Refers to customer record to which the invoice belongs.
i_invoice	No	unsignedLong	No	The unique ID of the invoice record.
i_invoice_status	No	unsignedLong	No	Refers to the invoice status record.
i_invoice_type	No	unsignedLong	No	The unique ID of the invoice type.
i_parent	No	unsignedLong	No	The unique ID of the reseller (for subcustomer).
invoice_number	No	int	No	Invoice Number - unique identifier of the invoice.
invoice_status	No	string	No	Invoice status.
is_pdf_exists	No	int	No	Indicates whether the PDF file exists for this invoice.
is_void	No	string	No	Specifies whether the invoice is void (i.e. there is a new invoice with actual data) .
iso_4217	No	string	No	ISO4217 code for the invoice currency.
issue_date	No	date	No	Date when the invoice was generated.
last_closing_date	No	date	No	Last closing date. Date the customer's account was closed after an invoice became overdue.
last_notific_date	No	date	No	Date the invoice was first sent to the customer.
last_recollect_date	No	date	No	Last recollect date. Date the collection attempt was made (attempt to charge the customer's credit card on file for the amount due).
last_resend_date	No	date	No	Last resend date. Date the invoice was resent to the customer.
last_suspension_date	No	date	No	Last suspension date. Date the customer was suspended after an invoice became overdue.
last_warning_date	No	date	No	Last warning date. Date the notification email was sent to the customer informing about service suspension.
manual_charges	No	float	No	Manual charges. Non-service related charges.
measured_services	No	float	No	Measured service charges.
new_style	No	int	No	Defines whether the invoice includes the previous balance or not.
payments	No	float	No	Payments. Sum of all charges.
pdf_created	No	dateTime	No	The date when the PDF file was created for this invoice.
period_from	No	dateTime	No	Start date of the billing period.
period_to	No	dateTime	No	End date of the billing period.
previous_balance	No	float	No	Previous balance. Balance reported in the last invoice.
prior_balance	No	float	No	Prior Balance.
prior_balance_paid	No	float	No	Prior Balance Paid.
subscriptions	No	float	No	Subscription fee.
tax_method	No	int	No	Taxation method.
taxes	No	float	No	Calculated taxes. Amount of taxes for this period.

InvoiceNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
invoice_number	Yes	int	No	Refers to Invoice Number – unique identifier of the invoice.

InvoiceStatusInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The status description.
i_invoice_status	No	unsignedLong	No	The unique ID of the invoice status record.

InvoiceTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice_type	No	unsignedLong	No	The unique ID of the invoice status record.
name	No	string	No	The invoice type name.

RegenerateInvoicePDFInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_invoice	Yes	unsignedLong	No	The unique identifier of the invoice.

ReviewInvoiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	The action to be applied to this invoice. Possible values: approve, regenerate.
i_invoice	Yes	unsignedLong	No	The unique identifier of the invoice.
postponed	No	int	No	Specifies whether to schedule delivery of approved invoices to customers / regeneration of selected invoices for off-peak.

TemplateInfo
Property	Mandatory	Type	Nillable	Description	Possible values
body_list	No	Array of TemplateBodyInfo structure	No	The list of the template bodies (a template file and images that it uses).
custom_description	No	string	No	User-defined template description.
description	No	string	No	Template description.
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_media_type	No	unsignedLong	No	The unique ID of media type record.
i_template	No	unsignedLong	No	The unique ID of the invoice template.
i_template_type	No	unsignedLong	No	The unique ID of the template type.
i_time_zone	No	unsignedLong	No	Defines a time zone in which the datetime will be set in tariff download/upload templates.
is_default	No	string	No	Shows whether the invoice template is default or not.
is_system	No	int	No	Shows whether the invoice template is system or not.
managed_by	No	string	No	Name of the owner entity name.
media_name	No	string	No	Name of the template media type.
name	No	string	No	Template name.
raw_flags	No	string	No	Template flags.
type_name	No	string	No	The name of the template type.
tz	No	string	No	The name of the time zone.
used	No	int	No	Shows whether invoice template is used or not.

IptvChannelPackageFilter
Property	Mandatory	Type	Nillable	Description	Possible values
i_channel_package	Yes	unsignedLong	No	Get the IPTV channel package with the specified i_channel_package.

IPTVChannelPackage
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the IPTV channel package.
external_id	No	unsignedLong	No	The unique ID of the IPTV channel package in the external system.
i_channel_package	Yes	unsignedLong	No	The unique ID of the IPTV channel package in PortaBilling.
name	No	string	No	The name of the IPTV channel package.
provider	No	string	No	The name of the provider of the channel.
type	No	string	No	The type of the IPTV channel package ( enum 'iptv', 'vod' ).

IPTVServicePackage
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the IPTV service package.
external_id	No	unsignedLong	No	The unique ID of the IPTV service package in the external system.
i_service_package	Yes	unsignedLong	No	The unique ID of the IPTV service package in PortaBilling.
name	No	string	No	The name of the IPTV service package.
provider	No	string	No	The name of the provider of the channel.

AccessNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
cld_match	No	string	No	The CLD match pattern. Can contain only the following symbols: a-d, A-D, 0-9; also, '*', '#'; '%', '_' or 'x' can be used as the final symbol only (no other symbols can be used after it).
description	No	string	No	The description of an IVR access number.
i_account	No	unsignedLong	Yes	The unique ID of the account record.
i_ivr_an	No	unsignedLong	No	The unique ID of the IVR access number.
i_voice_app_access_number	No	unsignedLong	No	The ID of the corressponding IVR application.
is_used	No	int	No	Check usage of the IVR access number.

IvrApplicationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
code	No	string	No	The code of the Voice application.
description	No	string	No	The description of the IVR application.
i_voice_app_access_number	No	unsignedLong	No	The unique ID of the IVR application.
i_voice_application	No	unsignedLong	No	The ID of the corressponding Voice application.
name	No	string	No	The name of the IVR application.
options	No	Array of VoiceApplicationOptionInfo structure	No	Voice application options.

VoiceApplicationOptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
block_name	No	string	No	The name of the option container block.
default_value	No	string	No	The default value of the option.
i_an_parameter	No	unsignedLong	No	The unique identifier of the option.
i_block	No	unsignedLong	No	The unique identifier of the option container block.
i_block_attr	No	unsignedLong	No	The unique ID of the dependent IVR option.
i_parent	No	unsignedLong	No	The ID of IVR option that is depended on.
name	No	string	No	The name of the option.
required_value	No	string	No	The required value of the option.
type	No	string	No	The type of the option value.
validation	No	string	No	Validation settings for the option value.
value	No	string	No	The value of the option.

SupportedLanguageInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_voice_application	No	unsignedLong	No	The ID of the corresponding voice application.
iso_639_1	No	string	No	The ISO 639-1 code of the language.
name	No	string	No	The name of the language.

VoiceApplicationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
app_name	No	string	No	The name of the IVR application.
code	No	string	No	The code of the voice application.
description	No	string	No	The description of the voice application.
i_voice_application	No	unsignedLong	No	The unique ID of the voice application.

CustomerClassMetricInfo
Property	Mandatory	Type	Nillable	Description	Possible values
apply_charge	No	string	No	Defines whether this service is free of charge or not. Possible values: 'Y', 'N'.
destination	No	string	No	The destination name. Only certain special destinations are applicable. In-built special destinations (rate codes) that are applicable for available measured services: ACTIVECALLS – Covers charges for the actual number of concurrent calls made by a particular customer's accounts; ALLOWEDCALLS – Covers charges for the number of concurrent calls allowed for a particular customer. Other special destinations can be created and used as well, but they must not associate with any country. Note that specified destination doesn't impact measurement base. The destination is used only for information purpose in xDRs and statistics.
free_items	No	int	No	The amount of free items.
i_customer_class	Yes	unsignedLong	No	The unique ID of the customer class.
i_dest	No	unsignedLong	No	The unique ID of the destination. Only certain special destinations are applicable.
i_measured_metric	No	unsignedLong	No	The ID of the measured metric.
i_metric_charge_method	No	unsignedLong	No	The ID of the charge method.
i_service	No	unsignedLong	No	The unique ID of the service type. Note that specified service type does not impact measurement base. The service type value is used only for information purpose in xDRs and statistics. E.g. if API user specifies ID of the Voice Calls service here, an xDR with charges for active calls will have the Voice Calls service type.
price	No	float	No	The price for each consumed service item.

CustomerMetricInfo
Property	Mandatory	Type	Nillable	Description	Possible values
apply_charge	No	string	No	Defines whether this service is free of charge or not. Possible values: 'Y', 'N'.
definition_level	No	string	No	Level of the metric definition (enum 'customer_class', 'customer').
destination	No	string	No	The destination name. Only certain special destinations are applicable. In-built special destinations (rate codes) that are applicable for available measured services: ACTIVECALLS – Covers charges for the actual number of concurrent calls made by a particular customer's accounts; ALLOWEDCALLS – Covers charges for the number of concurrent calls allowed for a particular customer. Other special destinations can be created and used as well, but they must not associate with any country. Note that specified destination doesn't impact measurement base. The destination is used only for information purpose in xDRs and statistics.
free_items	No	int	No	The amount of free items.
i_customer	Yes	unsignedLong	No	The unique ID of the customer.
i_dest	No	unsignedLong	No	The unique ID of the destination. Only certain special destinations are applicable.
i_measured_metric	No	unsignedLong	No	The ID of the measured metric.
i_metric_charge_method	No	unsignedLong	No	The ID of the charge method.
i_service	No	unsignedLong	No	The unique ID of the service type. Note that specified service type doesn’t impact measurement base. The service type value is used only for information purpose in xDRs and statistics. E.g. if API user specifies ID of the Voice Calls service here, an xDR with charges for active calls will have the Voice Calls service type.
price	No	float	No	The price for each consumed service item.

MeasuredMetricInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	A description of the added or updated measured metric. The description can be undefined or it can be specified using the add or update API methods.
i_measured_metric	No	unsignedLong	No	The unique ID of the measured metric.
name	No	string	No	The field that contains the unique name of the measured metric and can be used to retrieve and save the metric data to the system. When the name of a metric is changed, it may become impossible to retrieve the stored data associated with this metric.

MeasuredMetricsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	A description of the added or updated measured metric. The description can be undefined or it can be specified using the add or update API methods.
i_measured_metric	Yes	unsignedLong	No	The unique ID of the measured metric. Possible values: 1 – Active calls. Measure number of active call. This is the actual number of connected calls at a specific moment in time; 2 – Call recording storage. Measure used call recording storage; 3 – IP Centrex phone lines. Measure number of used phone lines; 4 – Allowed concurrent calls. Measure the number of concurrent calls allowed (SIP trunks).
name	Yes	string	No	Measured metric name. Possible values: Active calls – Measure number of active call. This is the actual number of connected calls at a specific moment in time; Call recording storage – Measure used call recording storage; IP Centrex phone lines – Measure number of used phone lines; Allowed concurrent calls – Measure number of allowed calls. The number of concurrent calls allowed (SIP trunks).

ChargeMethodsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the charge method.
i_metric_charge_method	Yes	unsignedLong	No	The ID of the charge method.
name	Yes	string	No	The name of the charge method.

MeasuredMetricDataInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_measured_metric	Yes	unsignedLong	No	The unique identifier of the measured metric.
i_object	Yes	unsignedLong	No	The unique identifier of the object.
object	Yes	string	No	The type of object to which the addition of measurement data is applied. Possible values: 'account', 'customer'.
value_list	Yes	Array of MetricDataInfo structure	No	The field consisting of a set of measured meta information that contains the date and number characterizing the measurement result.

MetricInputInfo
Property	Mandatory	Type	Nillable	Description	Possible values
aggregator_list	Yes	Array of MetricAggregatorInfo structure	No	Allows to aggregate data on the given time intervals using aggregation functions (e.g. max, min, avg, etc.).
filter_list	No	Array of MetricFilterInfo structure	No	Specifies a list of tag names and their values for filtering statistic of specific entities (e.g. the 'ip' tag allows you to get metrics of specific cluster node).
grouping_list	No	Array of MetricGroupingInfo structure	No	Specifies in which way the fetched data will be grouped in the fetching procedure. For example, the time grouping creates the given number of groups of the specified time interval.The beginning of the first group is set to the value of 'date_from'. To group data by the day of the week, specify:'date_from' as the midnight of the first day of the week, and the following parameters for time grouping: 'unit':'day', 'value':'1', 'group_count':7.
name	Yes	string	No	The name of the metric. Possible values: system_load.psmsc_load.active_registrations - the number of registered accounts (available tags: ip). system_load.psmsc_load.calls_counter - the number of processed call attempts (available tags: ip). system_load.psmsc_load.active_calls - the number of calls in progress (available tags: ip). system_load.psmsc_load.registrations_counter - the number of processed registration attempts (available tags: ip). system_load.connection_load - the number of calls via the connection (available tags: connection). system_load.connection_load.setup_time - the average setup time in milliseconds (available tags: connection). system_load.connection_load.asr - the average success rate (percent) (available tags: connection). system_load.total_calls.calls - the number of calls per minute. system_load.total_calls.zero_calls - the number of zero-duration calls per minute. system_load.daily_calls - the total calls duration (minutes) at a given day. system_load.cc_staff.search_counter - the number of traced sessions (available tags: cc_staff). system_load.cc_staff.refunds_counter - the number of balance adjustments made by the staff (available tags: cc_staff). system_load.cc_staff.refunded_today - the total amount of money refunded by the staff (available tags: cc_staff).

SystemMetricDataInfo
Property	Mandatory	Type	Nillable	Description	Possible values
metric_data	Yes	Array of MetricDataInfo structure	No	A set of metric data.
name	Yes	string	No	The coded name of the metric.

NegotiatedFeatureInfo
Property	Mandatory	Type	Nillable	Description	Possible values
capability	No	int	No	This parameter enables you to specify an end user device’s capabilities or prohibit the use of call media features for incoming calls.
group_name	No	string	No	The name of the call media feature group.
i_voice_negotiate_feature	No	unsignedLong	No	The unique ID of the call media feature.
name	No	string	No	The name of the call media feature (such as a specific codec or T.38 fax capability).
requirement	No	int	No	This parameter describes the filters applied to call media features requested by the calling party.

NodeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
aaa_protocol	No	string	No	Describes the AAA protocol used to communicate with the node. Possible values: 'disabled', 'RADIUS', 'DIAMETER'.
cld_translation_rule	No	string	No	Deprecated: the option is deprecated in MR73-0 and will be removed in MR76-0. The authentication translation rule used to transform a dialed phone number into the E.164 format used in PortaBilling.
diameter_realm	No	string	No	This is the realm for all Diameter interactions.
h323_id	No	string	No	For a VoIP node, this is equivalent to a hostname for an internet server (e.g. mail1.cyberdyne.com), i.e. a descriptive, human-readable name used for identification purposes. Expected input: a string that can contain a-z, A-Z, 0-9 and '.', '_', '-' symbols. It cannot be larger than 253 symbols. The UI equivalent of this field is the "Node ID" field on the "Create Node" panel.
i_node	No	unsignedLong	No	The unique ID of the node.
i_node_type	No	unsignedLong	No	The unique ID of the node type.
i_time_zone	No	unsignedLong	No	The unique ID for the node's time zone.
ip	No	string	No	The IP address of the node.
is_used	No	int	No	Shows whether the node is in use.
name	No	string	No	The logical name of the node.
notepad	No	string	No	Node notepad.
pod_port	No	int	No	The internet UDP port to which requests are sent.
pod_radius_ip	No	string	No	The IP address for the RADIUS RFC 3576 server to which requests are sent.
pod_server	No	string	No	This enables the event-triggered interaction with the RFC 3576-based service controlling the network sessions on the NAS. Possible values: 'Y', 'N'.
pod_shared_key	No	string	No	A shared secret used for requests authentication.
radius_key	No	string	No	This is the authentication key for all Radius interactions.
radius_source_ip	No	string	No	If more than one interface can be present on the node, specifies the IP address of the one that communicates with the Radius server.
rtpp_level	No	int	No	Describes the NAT traversal capabilities of this node.
telephony_user_name	No	string	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. Defines which parameters should be used to identify the account the call should be billed to (applies to calls that arrived from PSTN network).
voip_user_name	No	string	No	Deprecated: the option is deprecated in MR75-0 and will be removed in MR81-0. Defines which parameters should be used to identify the account the call should be billed to (applies to calls that arrived from the IP network).

NodeTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
diameter_support	No	string	No	Specifies whether the node type supports DIAMETER protocol. Possible values: Y, N.
h323_support	No	string	No	Specifies whether the node type supports H323. Possible values: Y, N.
i_node_type	No	unsignedLong	No	The unique ID of the node type.
manufacturer	No	string	No	The manufacturer of the node.
pod_support	No	string	No	Specifies whether the node type supports Packet of Disconnect. Possible values: Y, N.
radius_dictionary	No	string	No	The dictionary used in RADIUS packets.
radius_support	No	string	No	Specifies whether the node type supports RADIUS protocol. Possible values: Y, N.
sip_support	No	string	No	Specifies whether the node type supports SIP protocol. Possible values: Y, N.
type	No	string	No	The node type.
type_code	No	string	No	The code of the node type.
voip_dynamic_routing	No	string	No	Specifies whether the node type supports VoIP dynamic routing. Possible values: Y, N.

NotificationPresetInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The identifier of the reseller who manages the preset.
i_notification_preset	No	unsignedLong	No	The unique identifier of the notification preset.
is_used	No	int	No	The flag shows whether the notification preset was used.
managed_by	No	string	No	The name of the reseller who manages the notification preset.
name	No	string	No	The notification preset name.
type	No	string	No	The type of the preset. Possible values are: user, customer_class.

NotificationTemplateInfo
Property	Mandatory	Type	Nillable	Description	Possible values
bcc	No	string	No	An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address, make sure they are separated with commas.
body	No	string	No	The content of the message.
default	No	string	No	The flag shows whether the notification is default. Possible values are: Y, N.
i_notification_preset	No	unsignedLong	No	The identifier of the notification preset.
name	No	string	No	The notification name.
subject	No	string	No	The subject as it appears in an email to a recepient.
variables	No	Array of NotificationTemplateVariable structure	No	The set of available variables with information about them.

NotificationPresetCategoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_category	No	unsignedLong	No	The unique ID of the notification category.
name	No	string	No	The name of the notification category.
send_mail	No	int	No	Specifies whether this notifications will be sent by email. Possible values: 1 - The notifications will be sent by email, 0 - The notifications will not be sent by email.
send_sms	No	int	No	Specifies whether this notifications will be sent by sms. Possible values: 1 - The notifications will be sent by SMS, 0 - The notifications will not be sent by SMS.

NetnumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	Yes	string	No	The action performed with this number. Possible values: A (added), D (deleted).
p_number	Yes	string	No	The number to update the information for in the NetNumber database.

PortingRequestInfo
Property	Mandatory	Type	Nillable	Description	Possible values
due_date	No	dateTime	No	The date and the time by which the customer's request must be completed.
i_account	No	unsignedLong	No	The unique ID of the account which the request relates to.
i_request	No	unsignedLong	No	The unique ID of the number porting request.
id	No	int	No	The account the request relates to.
porting_number	No	string	No	The number being ported.
provider	No	string	No	The provider to which the number belongs or will belong depending on the request type.
request_id	No	string	No	The number porting request.
request_parameters	No	Array of PortingRequestParameterInfo structure	No	The list of objects for the current request.
status	No	string	No	The current processing status of the porting request.
type	No	string	No	The porting request type. Possible values: PORTIN (default); PORTOUT.

PortingRequestParameterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
is_advanced	No	int	No	Porting request parameter for advanced users.
is_editable	No	int	No	Value of porting request parameter that can be modified.
name	Yes	string	No	Name of the porting request parameter.
value	No	string	Yes	Value, porting request parameter specific.

OffPeakInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	Yes	The unique ID of the reseller record (managed by).
i_offpeak	No	unsignedLong	No	The unique ID of the off-peak period.
name	No	string	No	The name of the off-peak period.

OliInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The OLI description.
i_oli	No	unsignedLong	No	The unique ID of the OLI record.
oli	No	int	No	The OLI value.

MerchantAccount
Property	Mandatory	Type	Nillable	Description	Possible values
assigned_payment_methods	No	Array of PaymentMethod structure	No	The list of assigned payment methods.
available_payment_methods	No	Array of PaymentMethod structure	No	The list of currently available payment methods which can be assigned.
csc_policy	No	string	No	Shows whether transactions via merchant require credit card security code or not.
i_customer	No	unsignedLong	No	The unique ID of the Customer record (reseller).
i_merchant_account	No	unsignedLong	No	The unique ID of the Merchant_Account record.
i_online_payment_processor	No	unsignedLong	No	The unique ID of the Online_Payment_Processor record.
login	No	string	No	Merchant account login.
name	No	string	No	Merchant account name. Expected input: a string that cannot contain most of the special symbols, except of '.','_','-' and whitespaces. The UI equivalent of this field is the "Name" field on the "Create payment system" panel.
password	No	string	No	Merchant account password.
remote_cc_storage	No	string	No	Shows whether the payment information is stored in PortaBilling or not.
test_mode	No	string	No	Shows whether merchant works in test mode or not.
url_suffix	No	string	No	An URL suffix required to determine transaction for a processor with post-processing. Expected input: a string that can contain characters 'a-Z','0-9','_'. The UI equivalent of this field is the "URL suffix" field on "Create payment system" panel.
used	No	int	No	Shows whether merchant account is used for some currency or not.

PaymentSystemInfo
Property	Mandatory	Type	Nillable	Description	Possible values
callback	No	string	No	Name of the callback page for Payment Processor with external authentication.
csc_policy	No	string	No	Shows whether transactions via merchant require credit card security code or not.
ext_auth	No	string	No	Does method need External authentication.
handler	No	string	No	Name of Mason component for creating a specific request template for particular Payment Processor with external authentication.
i_online_payment_processor	No	unsignedLong	No	The unique ID of the Payment Processor.
i_payment_method	Yes	unsignedLong	No	The unique ID of Payment Method.
icon_url	No	string	No	URL for the payment method icon.
login	No	string	No	Login for the Payment Processor.
merchant_account_name	No	string	No	The Name of the Merchant Account for the Payment Processor.
min_allowed_payment	No	float	No	The minimal allowed payment amount.
payment_method	Yes	string	No	Name of the payment method, one of the following: Cash, Cheque, American Express, Discover, MasterCard, VISA, Switch, Check, DirectDebitNL. Pass undefined value in order to dismiss payment method.
processor	No	string	No	The name of the Payment Processor.
recurring	No	string	No	Indicates whether Recurring Payments are enabled. Possible values: Y, N.
refnum	No	string	No	Reference number (custom field).
remote_cc_storage	No	string	No	Indicates whether Payment Processor supports remote storing card info and can use a token for payments. Possible values: Y, N.
sca_support	No	string	No	Shows whether SCA support is implemented for the payment processor.
test_mode	No	string	No	Indicates that Payment Processor is in test mode.
url_suffix	No	string	No	Suffix URL for Merchant Account.
web_link	No	string	No	An URL for Payment Processor API and documentation.

PaymentProcessor
Property	Mandatory	Type	Nillable	Description	Possible values
callback	No	string	No	Callback page for processors with external authorization.
email_auth	No	string	No	Shows whether processor requires email authorization or not.
ext_auth	No	string	No	Shows whether processor requires external authorization or not.
handler	No	string	No	Handler page for processors with external authorization.
i_online_payment_processor	No	unsignedLong	No	Unique ID of Online_Payment_Processors record.
name	No	string	No	The payment processor name visible to the end-user.
obsolete	No	string	No	Shows whether processor is obsolete or not.
post_processing	No	string	No	Shows whether processor post-processing actions or not.
processor	No	string	No	Processor name.
remittance	No	string	No	Shows whether processor is remittance or payment.
remote_cc_storage	No	string	No	Shows whether processor supports storing of payment data on its side or not.
sca_support	No	string	No	Shows whether SCA support is implemented for the payment processor.
supported_payment_methods	No	Array of PaymentMethod structure	No	List of payment methods supported by payment processor.
web_link	No	string	No	Link to the official site.

TransactionActionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_amount	No	int	No	The default amount for the transaction.
default_comment	Yes	string	No	A comment on this transaction visible to the customer in the xDR browser.
description	Yes	string	No	Transaction description.
i_manual_transaction	Yes	unsignedLong	No	The unique ID of the manual transaction record.
i_service	No	unsignedLong	No	The unique ID of the service record.
name	Yes	string	No	One of the following: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment.

ProductGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The ID of the Customer to which the group belongs.
i_product_group	No	unsignedLong	No	The ID of the group record.
included_products	No	Array of GroupIncludedProductInfo structure	No	The list of included products in the group.
is_used	No	int	No	Shows whether the product group is used by some product.
name	No	string	No	The name of the product group.
products_total	No	int	No	The total number of products that are in the group.

ProductPriorityInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	Product priority level name.
value	Yes	int	No	Product priority value.

ProductRolesInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_account_role	Yes	unsignedLong	No	The role id.
name	Yes	string	No	Role name.
realm	No	string	No	The name of the realm.

SubrealmsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	Subrealm name.

AddonLifeCycleInfo
Property	Mandatory	Type	Nillable	Description	Possible values
effective_from	Yes	dateTime	No	The date and time when the add-on product will be activated.
effective_to	No	dateTime	No	Date and time when add-on product will be expired.
i_product	Yes	unsignedLong	No	The unique ID of the add-on product.

AddonsValidationResults
Property	Mandatory	Type	Nillable	Description	Possible values
disallowed_products	No	Array of DisallowedProducts structure	Yes	Validation information.
service_features_conflicts	No	Array of ServiceFeaturesConflicts structure	Yes	Detected conflicts in Service Features between the main and add-on products.
subscription_conflicts	No	Array of SubscriptionConflicts structure	Yes	Array of Subscription Plan conflicts of current Add-Ons configuration.
vdp_conflicts	No	Array of VDPConflicts structure	Yes	Array of Volume Discount Plan conflicts of current Add-Ons configuration.

ServiceAndRatingInfo
Property	Mandatory	Type	Nillable	Description	Possible values
alert_overuse_reject	No	string	No	Flag which indicates whether the system should notify in case of a fraud suspicion.
allow_suspended_consumption	No	string	No	This parameter allows/disallows end users to use certain services when their accounts are suspended. Possible values: 'None','FreeOnly'.
check_funds	No	string	No	Type of the policy for checking funds in the call beginning(enum: Y, N, B,D).
cld	No	string	No	CLD tech prefix helps to identify connection from several with same IP address.
i_accessibility	No	unsignedLong	No	Service&Rating identifier.
i_node	No	unsignedLong	No	Node identifier.
i_oli	No	unsignedLong	No	OLI identifier.
i_product	No	unsignedLong	No	Product identifier to which Service&Rating entity belongs.
i_rate_match_mode	No	unsignedLong	No	Rate Mode identifier.
i_service	No	unsignedLong	No	Unique service ID.
i_service_type	No	unsignedLong	No	Unique service type ID.
i_tariff	No	unsignedLong	No	Tariff identifier.
i_tariff_reseller	No	unsignedLong	No	Tariff identifier (used for a reseller's product or a shared product managed by the admin).
max_auth_funds	No	float	No	This determines the maximum amount of account funds to be used for the session.
max_session_funds	No	float	No	Reduces deposit amount to be locked for each individual session but does not restrict the session.
min_session_funds	No	float	No	The deposit amount for each individual session to be locked to a specified value.
reseller_tariff_name	No	string	No	Tariff name(used for resellers product).
routing_list	No	Array of ServiceAndRatingRoutingInfo structure	No	Configure the product to use "tariff per routing plan". Allows to apply a different tariff based on which routing plan (i.e. which set of vendors – cheaper or more expensive ones) was used to terminate the call to your partners. Thus if a customer chooses to use premium routes, he will be charged more, while if he uses a routing plan that includes low-cost carriers, he will be charged less.
tariff_name	No	string	No	Tariff name.

ProductSubscriptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_fee	No	float	No	A one-time fee applied when the subscription is activated.
activation_mode	No	int	No	If the subscription is assigned to an account, this parameter specifies the date upon which the subscription charges will apply. Possible values: 1 - at the given start date, 2 - upon the account's first usage.
advance_periods	No	int	No	Only available for subscription plans charged in advance; specifies for how many periods advance charges should be made.
cancel_penalty	No	float	No	A one-time fee applied when the subscription is cancelled earlier than the minimum subscription period.
charge_model	No	int	No	Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance.
description	No	string	No	The Subscription Plan description.
effective_fee	No	float	No	Effective subscription fee value for current billing period.
generate_daily_charge	No	string	No	Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y – Generate daily charges; N – Keep the total charge only.
i_product	No	unsignedLong	No	The unique ID of the product record.
i_product_subscription	No	unsignedLong	No	The unique ID of the product subscription record.
i_subscription	No	unsignedLong	No	The ID for subscription plan, refers to Subscriptions table.
invoice_description	No	string	No	The subscription plan name that is visible to the end user.
iso_4217	No	string	No	The currency for the Subscription Plan.
minimum_period	No	int	No	Time interval (in months) during which the subscription must remain uninterrupted so as to avoid penalties.
multiple	No	int	No	Can this Subscription be applied more than once.
name	No	string	No	The name of the subscription plan.
periodic_fees	No	A 2-dimensional array of the OnePeriodSubscriptionPeriodicFeeInfo structure	No	The list of Periodic Fees for the Subscription Plan.
rounding	No	int	No	A pattern that defines the rounding of the amount charged for a billing period.

QFFieldInfo
Property	Mandatory	Type	Nillable	Description	Possible values
caption	No	string	No	The name for the field to be shown on the form.
description	No	string	No	Description of the field.
enabled	No	string	No	Defines whether the field will be shown on the quick form.
entity_number	Yes	int	No	The number of the entity the fields belong to.
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.
i_quick_form_field	No	unsignedLong	No	The unique ID of the quick form field.
mandatory	No	string	No	Defines whether the value for the field is mandatory.
name	No	string	No	The name of the field.
order_number	No	int	No	Defines the position of the component in the form.
type	No	string	No	Defines the control that will be used for the field on the quick form. If type = 'Hidden' is set then the value for the 'enabled' field will be set = 'N' automatically and the control will not be visible on the form.
value	No	string	No	The value of the field.

QFAddInfo
Property	Mandatory	Type	Nillable	Description	Possible values
display_summary	No	string	No	Specifies whether the summary table is shown after saving the entities.
granted_acls	No	Array of int structure	No	Quick form Visible To options.
i_customer_class	Yes	unsignedLong	No	The ID of the customer class.
iso_4217	Yes	string	No	Currency code for the quick form.
managed_by	No	int	No	The ID of the customer.
name	Yes	string	No	Name of the quick form.

QFInfo
Property	Mandatory	Type	Nillable	Description	Possible values
display_summary	No	string	No	Specifies whether the summary table is shown after saving the entities.
granted_acls	No	Array of int structure	No	Quick form Visible To options.
i_customer_class	No	unsignedLong	No	The unique ID of the customer class.
i_env	Yes	unsignedLong	No	The unique environment ID.
i_quick_form	Yes	unsignedLong	No	The unique ID of the quick form.
iso_4217	No	string	No	A currency code for the quick form.
managed_by	No	int	No	The unique ID of the reseller who uses the quick form.
name	No	string	No	The name of the quick form.
state	Yes	string	No	The current state of the quick form.

RateInfo
Property	Mandatory	Type	Nillable	Description	Possible values
country	No	string	No	Country name.
description	No	string	No	Text description for this entry.
destination	No	string	No	Destination number.
destination_group	No	string	No	Destination group name.
discontinued	No	string	No	Indicates that rate is discontinued.
editable	No	int	No	Shows whether the rate is editable. Possible values: 1 - editable; 0 - not editable.
effective_from	No	dateTime	No	Defines when the rate starts to be applied.
effective_immediately	No	string	No	Specifies whether the rate must be applied immediately. Possible values: Y – The effective_from date is ignored. The rate becomes effective immediately upon its adding / updating; N – The effective_from date is applied; P – Only the rate with the effective_from date in the past becomes effective immediately upon its adding / updating. The default value is N.
effective_now	No	int	No	Shows whether the rate is currently effective. Possible values: 1 - the rate is effective now; 0 - the rate is not effective now.
forbidden	No	string	No	Indicates that no calls are authorized for the particular destination.
formula	No	string	No	Indicates if this rate uses a call rating formula.
hidden	No	string	No	Indicates that the rate is excessive and may be omitted when making the list of rates.
huntstop	No	string	No	Indicates whether huntstop is set or not.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
i_dest_group	No	unsignedLong	Yes	ID of the destination group.
i_offpeak	No	unsignedLong	Yes	The unique ID of the off-peak record.
i_rate	No	unsignedLong	No	The unique ID of the rate record (mandatory for update operations).
i_rate_formula	No	unsignedLong	Yes	The unique ID of the rating formula record.
i_tariff	No	unsignedLong	No	The unique ID of the tariff record.
inactive_from	No	dateTime	No	Defines when the rate stops to be applied.
inter_intra_state_enabled	No	int	No	Specifies whether the price per minute depends not only on the destination, but also on the caller and the called party residing in the same state.
interval_1	No	int	No	First billing interval.
interval_n	No	int	No	Next billing interval.
iso_3166_1_a2	No	string	No	The ISO 3166 two-letter country code.
network	No	string	No	The name of the mobile network.
op_huntstop	No	string	No	Indicates whether huntstop for off-peak period is set or not.
op_interval_1	No	int	No	First billing interval for off-peak time.
op_interval_n	No	int	No	Next billing interval for off-peak time.
op_preference	No	int	No	Routing priority for off-peak period.
op_price_1	No	float	No	Price for first interval for off- peak time.
op_price_n	No	float	No	Price for next interval for off- peak time.
op_route_category	No	int	No	ID of route category for off-peak period.
preference	No	int	No	Routing priority.
price_1	No	float	No	Price for first interval.
price_n	No	float	No	Price for next interval.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges. Related to ServiceInfo type.
reverse_rating	No	string	No	Indicates whether rate is marked reverse or not.
route_category	No	int	No	ID of route category.
special_price_1	No	float	No	Special price for first interval.
special_price_n	No	float	No	Special price for next interval.
unit	No	string	No	A customer-visible name for the units in which service use is measured. Related to ServiceInfo type.

ResultBatchAddRateInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_rate	No	unsignedLong	No	The unique ID of the rate record.

ReportFileInfo
Property	Mandatory	Type	Nillable	Description	Possible values
file_name	Yes	string	No	The file name.

RepresentativeXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	Additional info.
account_id	No	string	No	The ID (PIN) of the account.
bill_time	No	dateTime	No	Date and time when operation was done.
charged_amount	No	float	No	An amount of money in currency units.
charged_quantity	No	float	No	A number of charged service units.
customer_name	No	string	No	The name of the customer.
i_account	No	unsignedLong	No	The unique identifier of the account.
i_customer	No	unsignedLong	No	The unique identifier of the customer.
i_dest	No	unsignedLong	No	The unique ID of the destination record.
i_rate	No	unsignedLong	No	The unique ID of the rate record.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_xdr	No	unsignedLong	No	The ID of XDR record.
used_quantity	No	float	No	A number of used service units.

RepresentativeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
address_line_2	No	string	No	The 2nd line of the representative's address.
baddr1	No	string	No	1st line of the representative's address.
balance	No	float	No	The balance of the representative's outstanding payout.
city	No	string	No	City of the representative's address.
commission_plan_effective_from	No	dateTime	No	The date and time when the commission plan was assigned.
companyname	No	string	No	The representative's company name.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
country	No	string	No	Country of the representative's address.
customers_total	No	int	No	The total number of customers related to the representative.
distributors_total	No	int	No	The total number of distributors related to the representative.
email	No	string	Yes	Email address.
faxnum	No	string	No	Fax number.
firstname	No	string	No	The representative's first name.
hidden	No	string	No	Hidden.
i_acl	No	unsignedLong	No	ID for the representative's access level; refers to Access_Levels table.
i_commission_plan	No	unsignedLong	Yes	The ID of the commission plan for this representative.
i_customer	No	unsignedLong	Yes	ID of the reseller who manage this representative.
i_lang	No	string	Yes	Code for the representative's web language; refers to Languages table.
i_rep	No	unsignedLong	No	The unique ID of the representative record.
i_time_zone	No	unsignedLong	No	ID for the representative's time zone; refers to Time_Zones table.
in_date_format	No	string	No	Input format for date indication.
in_time_format	No	string	No	Input format for time indication.
initials	No	string	No	Initials of the representative.
is_used	No	int	No	Shows whether the representative is in use.
iso_4217	No	string	No	ISO4217 code of the currency.
lastname	No	string	No	The representative's last name.
login	No	string	Yes	The representative's login for self-care web interface.
midinit	No	string	No	The representative's middle initial(s).
name	No	string	No	Name of the representative on the PortaBilling interface, unique in the environment.
notepad	No	string	No	Comments regarding this representative.
out_date_format	No	string	No	Output format for date indication on customer's self-care interface.
out_date_time_format	No	string	No	Output format for full date/time indication.
out_time_format	No	string	No	Output format for time indication.
password	No	string	Yes	The representative's password for self-care web interface.
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
refnum	No	string	Yes	Reference number (custom field).
resellers_total	No	int	No	The total number of resellers related to the representative.
salutation	No	string	No	The representative's salutation.
state	No	string	No	Province or state of the representative's address.
tax_id	No	string	Yes	Tax ID.
zip	No	string	No	Postal (zip) code of the representative's address.

RouteCategoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default	No	string	No	Shows whether the route category is default. Possible values: 'Y', 'N'.
description	No	string	No	The route category record description.
i_route_category	No	unsignedLong	No	The unique ID of the route category DB record.
is_used	No	int	No	Shows whether the route category is in use.
name	No	string	No	The name of the route category.

RoutingCriteriaDestGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
aloc_penalty_threshold	No	int	No	The penalty threshold of the average length of call. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in seconds.
aloc_warning_threshold	No	int	No	The warning threshold of the average length of call. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in seconds.
asr_penalty_threshold	No	int	No	The penalty threshold of the average success rate (the number of successfully connected calls divided by the total number of call attempts). The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in percents.
asr_warning_threshold	No	int	No	The warning threshold of the average success rate. The value of the field defines when an alert will be sent to the administrator if the quality statistics are under the threshold. Measured in percents.
calls_threshold	No	int	No	The minimum required amount of calls to enable routing adjustments.
disabled_flags	No	RoutingCriteriaDestGroupMetricFlags structure	No	The list of quality metric thresholds excluded from routing criteria for a destination group.
high_pdd_penalty_threshold	No	int	No	The penalty threshold for the maximum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are above the threshold value. Measured in percents.
high_pdd_value	No	int	No	Defines the maximum acceptable PDD (Post-Dial Delay). Measured in milliseconds.
high_pdd_warning_threshold	No	int	No	The warning threshold of the maximum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are above the threshold value. Measured in percents.
i_criteria	No	unsignedLong	No	The unique ID of the routing criteria DB record.
i_criteria_dest_group	No	unsignedLong	No	The unique ID of the routing criteria destination group DB record.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group DB record.
low_pdd_penalty_threshold	No	int	No	The penalty threshold of the minimum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in percents.
low_pdd_value	No	int	No	Defines the minimum acceptable PDD (Post-Dial Delay). Measured in milliseconds.
low_pdd_warning_threshold	No	int	No	The warning threshold of the minimum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in percents.
penalty_time	No	int	No	The time interval for which the connection will be “penalized” (put at the very bottom of the routing list) if a given vendor does not meet the quality criteria. Measured in minutes.
ppm_penalty_threshold	No	float	No	The penalty threshold of the profit per minute. The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency.
ppm_warning_threshold	No	float	No	The warning threshold of the profit per minute. The value of the field defines when an alert will be sent to the administrator if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency.

RoutingCriteriaInfo
Property	Mandatory	Type	Nillable	Description	Possible values
aloc_penalty_threshold	No	int	No	The penalty threshold of the average length of call. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in seconds.
aloc_warning_threshold	No	int	No	The warning threshold of the average length of call. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in seconds.
asr_penalty_threshold	No	int	No	The penalty threshold of the average success rate (the number of successfully connected calls divided by the total number of call attempts). The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in percents.
asr_warning_threshold	No	int	No	The warning threshold of the average success rate. The value of the field defines when an alert will be sent to the administrator if the quality statistics are under the threshold. Measured in percents.
calls_threshold	No	int	No	The minimum required amount of calls to enable routing adjustments.
description	No	string	No	The routing criteria record description.
high_pdd_penalty_threshold	No	int	No	The penalty threshold for the maximum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are above the threshold value. Measured in percents.
high_pdd_value	No	int	No	Defines the maximum acceptable PDD (Post-Dial Delay). Measured in miliseconds.
high_pdd_warning_threshold	No	int	No	The warning threshold of the maximum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are above the threshold value. Measured in percents.
i_criteria	No	unsignedLong	No	The unique ID of the routing criteria DB record.
i_dest_group_set	No	unsignedLong	No	The unique ID of the destination group set DB record.
is_used	No	int	No	Shows whether the routing criteria is used.
low_pdd_penalty_threshold	No	int	No	The penalty threshold of the minimum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in percents.
low_pdd_value	No	int	No	Defines the minimum acceptable PDD (Post-Dial Delay). Measured in miliseconds.
low_pdd_warning_threshold	No	int	No	The warning threshold of the minimum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in percents.
name	No	string	No	The name of the routing criteria.
penalty_time	No	int	No	The time interval for which the connection will be “penalized” (put at the very bottom of the routing list) if a given vendor does not meet the quality criteria. Measured in minutes.
ppm_penalty_threshold	No	float	No	The penalty threshold of the profit per minute. The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency.
ppm_warning_threshold	No	float	No	The warning threshold of the profit per minute. The value of the field defines when an alert will be sent to the administrator if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency.
sampling_interval	No	int	No	Quality measurements will be calculated for all calls in this interval. Measured in minutes.

RPConnectionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
hunt_order	No	int	No	Specifies the place of this connection in the list of connections created to route the call according to this sequence before (or instead of) applying "normal" LCR routing.
hunt_order_exclusive	No	string	No	Specifies whether this entry in the override list is a percentage-share connection pool, where each connection has a chance to be the first route proportionate to the assigned percentage value.
i_connection	No	unsignedLong	Yes	The unique ID of the connection record. The nill flag sets LCR.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group record.
i_routing_plan	No	unsignedLong	No	The unique ID of the Routing Plan record.
i_rp_connection	No	unsignedLong	No	The unique ID of the custom routing configured for a particular destination group.
weight	No	int	No	A percentage value assigned to this connection pool in the override list.

RoutingPlanCategoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The route category record description.
i_route_category	No	unsignedLong	No	The unique ID of the route category record.
i_routing_plan	No	unsignedLong	No	The unique ID of the routing plan record.
i_routing_plan_cat	No	unsignedLong	No	The unique ID of the routing plan route category record.
name	No	string	No	The name of the route category.
order_number	No	int	No	The route category order number.

RoutingPlanInfo
Property	Mandatory	Type	Nillable	Description	Possible values
categories_enabled	No	string	No	Enable routing categories.
codecs_presentation_mode	No	int	No	The user-selected general policy for supporting incoming call codecs received from the vendor: 0 - forbidden, 1 - supported.
description	No	string	No	Routing Plan's description.
i_dest_group_set	No	unsignedLong	No	Unique ID of Destination_Group_Sets record.
i_routing_plan	No	unsignedLong	No	The unique ID of the Routing Plan record.
i_tariff_profit	No	unsignedLong	Yes	The unique ID of the routing margin tariff to compare the vendor tariff with.
name	No	string	No	Routing Plan's name.
no_delete	No	int	No	Shows that Routing Plan is used and can't be deleted (used in the RoutingPlanList method only).
override_routes_enabled	No	string	No	Enable routing override.
profit_combination	No	string	No	Function for profit operations applying.
profit_dispersion	No	float	No	Round-robin between routes with this cost difference (currency/min).
profit_guarantee	No	string	No	Enable/Disable of choosing only routes which guarantee profit.
profit_min_abs	No	float	No	Min/Max allowed per-minute loss.
profit_min_rel	No	float	No	Min required relative profit/Max allowed relative loss.
profit_monitor	No	string	No	Enable/Disable sending of real-time alerts about calls with losses.
route_category_list	No	Array of RoutingPlanCategoryInfo structure	No	The list of the route categories assigned to the routing plan.
rp_connection_list	No	Array of RPConnectionInfo structure	No	A list of custom routing records.
selection_code	No	string	No	Routing Plan's selection code.
utilization_cost_diff_limit	No	float	No	Overload handicap (currency/min).

RouteInfo
Property	Mandatory	Type	Nillable	Description	Possible values
appcode	No	string	No	IVR Application number.
cld	No	string	No	Called number.
connection_name	No	string	No	Name of used connection.
cost	No	float	No	Call cost.
currency	No	string	No	The currency used to provide call cost value.
destination	No	string	No	Called destination.
destination_country	No	string	No	Called destination country.
destination_description	No	string	No	Called destination description.
h323	No	string	No	Is route supports H323 protocol.
huntstop	No	string	No	Is huntstop route.
i_connection	No	unsignedLong	No	The unique ID of the Connection record.
i_rate	No	unsignedLong	No	The unique ID of the Rate record.
i_route_category	No	unsignedLong	No	The unique ID of the Route Category record.
i_tariff	No	unsignedLong	No	The unique ID of the Tariff record.
i_vendor	No	unsignedLong	No	The unique ID of the Vendor record.
node_name	No	string	No	Name of used node.
penalty	No	string	No	Reduce priority.
preference	No	int	No	Route preference.
remote_ip	No	string	No	Remote IP to call.
route_category_name	No	string	No	Routing category name.
sip	No	string	No	Is route supports SIP protocol.
skip_reason	No	string	No	The reason for skipping the route.
t_cld	No	string	No	Called number with applied translation rule.
tariff_name	No	string	No	Name of used tariff.
tech_prefix	No	string	No	Connection's tech prefix.
translation_rule	No	string	No	Connection's translation rule.
vendor_name	No	string	No	Name of used vendor.

ServiceFeaturesList
Property	Mandatory	Type	Nillable	Description	Possible values
Accounts	No	Array of ServiceFeatureDetails structure	No	The list of account's service features.
CustomerSites	No	Array of ServiceFeatureDetails structure	No	The list of service features defined in customer sites.
Customers	No	Array of ServiceFeatureDetails structure	No	The list of customers' service features.
Products	No	Array of ServiceFeatureDetails structure	No	The list of service features defined in products.

ServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default	No	string	No	Shows whether the service belongs to the system's default set.
dest_group_set_name	No	string	No	The destination group set name.
i_dest_group_set	No	unsignedLong	No	Unique ID of Destination_Group_Sets record.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_service_type	No	unsignedLong	No	The unique ID of the related service type.
i_st_charge_unit	No	unsignedLong	No	The unique ID of the related service type charge unit.
i_tax_transaction_code	No	unsignedLong	No	The identifier of the tax transaction code.
internal	No	string	No	Indicates whether the service is considered for internal usage.
invoice_group	No	string	No	Deprecated: the option is deprecated in MR87-0 and will be removed in MR91-0. Shows the group in the invoice to which the usage records must be placed.
is_used	No	int	No	Shows whether the service has been used.
name	No	string	No	Service name.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges. You will use these units to specify your rating prices, and the usage details in xDRs will be shown in these units.
rating_base	No	string	No	Specification of which particular parameter is used to calculate charges, e.g. "session time", "amount of data transferred" and the like. Where applicable, the rating base selection also defines what is to be used as the base unit; e.g. for the Internet Access service you could use bytes, kilobytes or megabytes as the base unit.
ratio	No	int	No	If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration.
service_pool_combination_list	No	Array of ServicePoolCombinationInfo structure	No	The list of the combinations of the service pool. It is used only for pool services.
unit	No	string	No	A customer-visible name for the units in which service use is measured; this also would be the smallest possible unit you can use in the rating configuration.
usage_rating	No	string	No	Shows whether usage charging is mandatory or not for the Service. Possible values: 'Y', 'N'.

ServiceTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charge_unit_list	No	Array of ChargeUnitInfo structure	No	The list of the service type charge units.
i_service_type	No	unsignedLong	No	The unique ID of the Service Type.
name	No	string	No	The logical name of the Service Type.
usage_rating	No	string	No	Shows whether usage charging is mandatory or not for the Service Type. Possible values: 'Y', 'N'.

ServicePolicyInfo
Property	Mandatory	Type	Nillable	Description	Possible values
attributes	No	Array of ServicePolicyAttributeValues structure	No	Contains service policy attribute values.
description	No	string	No	The description of the service policy.
generated_by	No	string	No	Shows by which entity this service policy was generated by.
i_service_policy	No	unsignedLong	No	The unique ID of the service policy.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
id	No	string	No	Deprecated: the option is deprecated in MR70-0 and will be removed in MR76-0. The internal ID of the service policy.
is_used	No	int	No	Shows if the service policy is used or not.
match_pattern	No	string	No	If this field is not empty the service policy is considered dynamically matched and will be attempted for every new call initiated by internal accounts.
match_priority	No	int	No	This is only used for policies that match dynamically. If more than one service policy corresponds to the caller’s user agent name, the one with the highest priority will be used.
name	No	string	No	The name of the service policy.

ServicePolicyAttributeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_values	No	ArrayOfString	No	The default values of service policy attribute.
group_name	No	string	No	The name used to group service policy attributes.
i_service_type	No	int	No	The unique ID of the service type.
i_sp_attribute	No	int	No	The unique ID of the service policy attribute.
multiple	No	string	No	Indicates whether multiple value entries are allowed.
name	No	string	No	The name of the service policy attribute.
possible_values	No	Array of ServicePolicyAttributePossibleValue structure	No	The only possible values of service policy attribute.
value_type	No	string	No	The type of attribute value.

SIMCardInfo
Property	Mandatory	Type	Nillable	Description	Possible values
amf	No	string	No	The authentication management field. It is a hexadecimal string of 4 symbols.
auth_key	No	string	No	Authentication key. It is a hexadecimal string of exactly 32 symbols.
description	No	string	No	SIM card description.
hlr	No	string	No	The name of Home Location Register database.
i_account	No	unsignedLong	No	The ID of the account record.
i_sim_card	No	unsignedLong	No	The ID of the SIM card record.
iccid	No	string	No	The Integrated Circuit Card ID. Should be a string of 19 to 20 digits.
imsi	No	string	No	The International Mobile Subscriber Identity of the SIM card. Should be a string of 6 to 15 digits.
managed_by	No	int	No	The unique ID of the reseller who owns the SIM card.
msisdn	No	string	No	The Mobile Subscriber Integrated Services Digital Number. This is the account ID (PIN) on the PortaBilling interface.
notepad	No	string	No	Comments regarding this SIM card.
opc_key	No	string	No	The operator key associated with and stored on the SIM card. It is a hexadecimal string of exactly 32 symbols.

SubscriptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_fee	No	float	No	A one-time fee applied when the subscription is activated.
activation_mode	No	int	No	If the subscription is assigned to an account, this parameter specifies the date upon which the subscription charges will apply. Possible values: 1 - at the given start date, 2 - upon the account's first usage.
advance_periods	No	int	No	Only available for subscription plans charged in advance; specifies for how many periods advance charges should be made.
cancel_penalty	No	float	No	A one-time fee applied when the subscription is cancelled earlier than the minimum subscription period.
cancel_penalty_prorated	No	int	No	Deprecated: the option is deprecated in MR86-0 and will be removed in MR91-0. Specifies whether the remaining subscription charges should be applied when the subscription is cancelled earlier than the minimum subscription period.
charge_model	No	int	No	Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance.
charge_suspended_customers	No	string	No	Deprecated: the option is deprecated in MR89-0 and will be removed in MR91-0. Specifies whether subscription charges are applied to suspended customers. Possible values: N - not applied, Y - applied in full.
description	No	string	No	The Subscription Plan description.
discount_list	No	Array of SubscriptionDiscountInfo structure	No	Only available for subscription plans charged in advance; specifies list of multi-month discounts for the subscription.
discount_type	No	string	No	Only available for subscription plans charged in advance; specifies type of multi-month discounts for the subscription. Possible values: fixed - discounts are represented as fixed amounts, percentage - discounts are represented as percentage of the standard fee.
generate_daily_charge	No	string	No	Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y – Generate daily charges; N – Keep the total charge only.
i_activation_ttc	No	unsignedLong	No	The activation tax transaction code ID.
i_cancellation_ttc	No	unsignedLong	No	The cancellation tax transaction code ID.
i_customer	No	unsignedLong	No	The ID of the reseller who manages the Subscription.
i_subscription	No	unsignedLong	No	The unique ID of the Subscription Plan.
i_usage_ttc	No	unsignedLong	No	The usual tax transaction code ID.
invoice_description	No	string	No	The subscription plan name that is visible to the end user.
is_used	No	int	No	Shows whether the subscription plan is in use.
is_used_by_resellers	No	int	No	Shows whether the shared subscription is used by resellers.
iso_4217	No	string	No	The currency for the Subscription Plan.
minimum_period	No	int	No	Time interval (in months) during which the subscription must remain uninterrupted so as to avoid penalties.
multiple	No	string	No	Specifies whether the same subscription can be applied multiple times to one account. Possible values: N - subscription can be applied only once, Y - subscription can be applied multiple times.
name	No	string	No	The name of the Subscription Plan.
penalty_mode	No	string	No	Specifies the type of penalty for a subscription cancelled earlier than the minimum subscription period. Possible values: none - no fee is applied, fixed - apply a fixed one-time fee, remaining - apply the remaining subscription charges, discount - the fee is equal to the applied amount of the discount provided by the subscription.
periodic_fees	No	A 2-dimensional array of the OnePeriodSubscriptionPeriodicFeeInfo structure	No	The list of Periodic Fees for the Subscription Plan.
prorate_first_period	No	string	No	Specifies whether subscription charges for the first billing period are prorated. Possible values: Y – prorated; N – in full, no prorating (available for postpaid and in advance charge models).
prorate_last_period	No	string	No	Specifies whether subscription charges for the last billing period are prorated. Possible values: Y – prorated; N – in full, no prorating (available for postpaid and in advance charge models).
rounding	No	int	No	A pattern that defines the rounding of the amount charged for a billing period.
shared	No	string	No	Shows whether the subscription managed by the administrator is available to resellers.
tax_info	No	string	No	Deprecated: the option is deprecated in MR61-0 and will be removed in MR66-0. The configured taxation menthod options.
waive_charges_for_first_bp	No	string	No	Specifies whether subscription charges are waived for the days when no service was provided in the first billing period. Please note that for progressive subscriptions this property is read-only and inherited from the waive_charges_for_regular_bp property. Possible values: N - do not waive charges, Y - waive charges.
waive_charges_for_last_bp	No	string	No	Specifies whether subscription charges are waived for the days when no service was provided in the last billing period. Please note that for progressive subscriptions this property is read-only and inherited from the waive_charges_for_regular_bp property. Possible values: N - do not waive charges, Y - waive charges.
waive_charges_for_regular_bp	No	string	No	Specifies whether subscription charges are waived for the days when no service was provided for regular billing periods. Possible values: N - do not waive charges, Y - waive charges.
waive_credit_exceeded_charges	No	string	No	Specifies whether subscription charges are waived for the days when credit limit was exceeded for an account or customer. Please note that this property depends on the waive_charges_for_first_bp / waive_charges_for_regular_bp / waive_charges_for_regular_bp properties. Possible values: N - do not waive charges, Y - waive charges.

OverrideTariffInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_customer_override_tariff	No	unsignedLong	No	The unique override tariff rule ID. This field is only used for update request.
i_tariff_original	No	unsignedLong	No	The unique ID of the original tariff.
i_tariff_override	No	unsignedLong	No	The unique ID of the override tariff.
original_tariff_name	No	string	No	The original tariff name.
override_tariff_name	No	string	No	The override tariff name.

ResaleMapRecordInfo
Property	Mandatory	Type	Nillable	Description	Possible values
buying_tariff_name	No	string	No	The name of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider).
currency	No	string	No	Shows the resale tariff currency.
description	No	string	No	The resale tariff description. Only used if the i_tariff_sell property is not defined.
ex_rate	No	float	No	A custom exchange rate. If empty or not defined, the current exchange rate will be used. Only used if the i_tariff_sell property is not defined.
i_customer	No	unsignedLong	No	The unique ID of the reseller record.
i_resale_tariff_mapping	No	unsignedLong	No	The unique ID of the tariff mapping record.
i_service_type	No	unsignedLong	No	The unique ID of the related service type.
i_tariff_buy	No	unsignedLong	No	The unique ID of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider).
i_tariff_sell	No	unsignedLong	No	The unique ID of the resale tariff record (the one that the reseller charges their subresellers). If this property is not defined, a new resale tariff will be created as a copy of the reseller's wholesale tariff with the markup.
markup_fixed_amount	No	float	No	Specifies the fixed amount to be added to the resale tariff if (only if) the calculated percentage markup is lower than this one. Only used if the i_tariff_sell property is not provided.
markup_percent	No	float	No	Specifies a percentage markup for the resale tariff as compared with the wholesale tariff rates. Only used if the i_tariff_sell property is not provided.
selling_tariff_name	No	string	No	The name of the resale tariff record (the one that the reseller charges their subresellers). Only used if the i_tariff_sell property is not defined.
service_name	No	string	No	The name of the service.

TariffInfo
Property	Mandatory	Type	Nillable	Description	Possible values
authorized_email_list	No	Array of AuthorizedEmailInfo structure	No	The list of email addresses with access to upload data to the tariff.
connect_fee	No	float	No	Amount to be charged for each successful call.
currency	No	string	No	Tariff currency.
description	No	string	No	Tariff description.
formula	No	string	No	Call rating formula that applies to new rates.
free_sec	No	int	No	Number of free seconds granted for each call.
i_customer	No	unsignedLong	No	The unique ID of the customer.
i_dest_group_set	No	unsignedLong	No	Refers to ID of destination groups.
i_offpeak	No	unsignedLong	No	Refers to ID of the off_peak period record.
i_service	No	unsignedLong	No	Refers to ID of the service type for which this tariff will be used.
i_service_type	No	unsignedLong	No	The unique ID of the related service type.
i_tariff	No	unsignedLong	No	ID of the tariff record.
i_tariff_template_download	No	unsignedLong	No	Refers to ID of download template.
i_tariff_template_upload	No	unsignedLong	No	Refers to ID of upload template.
is_used	No	string	No	Shows whether the tariff is in use.
is_used_by_resellers	No	int	No	Shows whether the shared tariff is used by resellers.
login_fee	No	float	No	Amount to be charged immediately after the first user authentication.
name	No	string	No	The tariff name.
notepad	No	string	No	Comments regarding this tariff.
obsolete_from	No	dateTime	No	The date a tariff is obsolete from.
period	No	string	No	Discontinued.
post_call_surcharge	No	float	No	Increases the total call cost by the given value.
rate_format	No	string	No	Determines which numbering format rates could be added to the tariff.
rating_mode	No	string	No	Deprecated: the option is deprecated in MR67-0 and will be removed in MR71-0. Left for backward compatibility.
rounding	No	int	No	Quantity of digits after point for rounding.
routing_ext	No	string	No	Flag that inform if the tariff contains information about the carrier's routing preferences.
shared	No	string	No	Shows whether the tariff managed by the administrator is available to resellers.
short_description	No	string	No	Short tariff description.
type	No	string	No	Designates whom this tariff is applied to. One of the following: Customer, Vendor, Reseller.
usage_update	No	string	No	Usage update. One of the following: Always, Billable.

TaxTransactionCode
Property	Mandatory	Type	Nillable	Description	Possible values
code	No	string	No	The value of the transaction code. Expected input: a string of up to 32 digits. The UI equivalent of this field is the "Tax transaction code" field on the "Create tax transaction code" panel.
description	No	string	No	The description of the transaction code.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller who manages this tax transaction code.
i_tax_transaction_code	No	unsignedLong	No	The unique ID of the taxation code database record.
is_used	No	int	No	Shows whether the tax transaction code is in use.
plugin_code_list	No	Array of TaxPluginTransactionCodeInfo structure	No	The list of tax plugin specific codes.

TaxationCode
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the taxation code.
value	Yes	string	No	The value of the taxation code.

ExemptionCodeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
code	Yes	string	No	The exemption code.
name	Yes	string	No	The name of the exemption code.

TaxPluginParameterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	The name of the taxation plugin parameter.
value	No	string	No	The value of the taxation plugin parameter.

TaxPluginInfo
Property	Mandatory	Type	Nillable	Description	Possible values
can_process_prepaid_taxes	No	int	No	Defines if the taxation plugin can make estimates and handle taxes for prepaid customers and debit accounts.
catalog_based	No	int	No	Defines if the taxation plugin requires special codes for any transaction (0 - no, 1 - yes).
i_billing_processor	Yes	unsignedLong	No	The unique ID of the taxation plugin database record.
is_configured	No	int	No	Shows whether the taxation plugin is configured. This field is only applicable if the "catalog_based" option is set to 1.
is_used	No	int	No	Shows whether the taxation plugin has been assigned.
name	No	string	No	The name of the taxation plugin that is displayed on the WI.
requires_configuration	No	int	No	Shows whether the taxation plugin requires configuration. This field is only applicable if the "catalog_based" option is set to 1.
tax_plugin_parameters	No	Array of TaxPluginParameterInfo structure	No	The list of taxation plugin parameters.

TemplateComponentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
comp_name	No	string	No	The name of the component's type.
editor_order	No	int	No	Defines the position of the component in the editor.
handler	No	string	No	The handler for the component.
i_component_type	No	unsignedLong	No	The unique ID of the component's type.
i_template	No	unsignedLong	No	The unique ID of the template.
i_template_component	No	unsignedLong	No	The unique ID of the component.

TemplateDataFieldInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The description of the field.
document_order	No	int	No	Defines the position of the data field in the document.
editor_name	No	string	No	The name of the data field.
editor_order	No	int	No	Defines the position of the data field in the editor.
format	No	string	No	The format of the field.
format_type_name	No	string	No	The name of the format type.
i_component_type	No	unsignedLong	No	The unique ID of the component's type.
i_format	No	unsignedLong	No	The unique ID of the format of the field.
i_format_type	No	unsignedLong	No	The unique ID of the format type of the field.
i_td_field	No	unsignedLong	No	The unique ID of the data field.
i_template	No	unsignedLong	No	The unique ID of the template.
pp_rule	No	string	No	The post-processing rule for the field.
rule	No	string	No	The format rule used if the format is set to 'Other'.
sample_data	No	string	No	The value of the field shown in 'Preview' mode.
symbolic_id	No	string	No	The name of the variable used for the field in the template.

TemplateMediaAttributeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
attribute_name	No	string	No	The name of the attribute.
attribute_type	No	string	No	The type of the attribute.
editable	No	string	No	Defines whether the value of the attribute can be changed for the template.
editor_order	No	int	No	Defines the position of the attribute in the editor.
hidden	No	string	No	Defines whether the value of the attribute is hidden on the Web Interface.
i_ma_definition	No	unsignedLong	No	The unique ID of the media attribute.
i_template	No	unsignedLong	No	The unique ID of the template.
i_tma	No	unsignedLong	No	The unique ID of the template media attribute.
list_values	No	Array of MediaAttributeValueInfo structure	No	The list of the possible values of the attribute and their representation on the Web Interface.
mandatory	No	string	No	Defines whether the value of the attribute is mandatory.
value	No	string	No	The value of the attribute of the template.

TimePeriodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
definition_list	No	A 2-dimensional array of the SubPeriodInfo structure	No	The list of definitions for every part (sub-period) of the period.
i_customer	No	unsignedLong	Yes	The unique ID of the reseller record (managed by).
i_offpeak	No	unsignedLong	No	The unique ID of the time period.
is_used	No	int	No	Shows whether the time period is in use.
name	No	string	No	The name of the time period.
period_type	No	string	No	The type of the time period. Possible values: 'offpeak', 'access_policy', 'intrazone'.
usage	No	string	No	The field describes how PortaBilling uses the time period. The field applies only for the 'offpeak' type. Possible values: 'start' - session starts during the period; 'stop' - session finishes during the period; 'startstop' - session starts and stops during the period.

SubPeriodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
end_time	No	time	No	The time when the sub-period ends.
month_list	No	ArrayOfString	No	The list of months included into the sub-period. The following values are possible for each element of the list: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'. The field doesn't apply to access policies.
monthday_list	No	ArrayOfInt	No	The list of month day numbers included into the sub-period. Integer values from 1 to 31 are possible as elements of the list. The field doesn't apply to access policies.
start_time	No	time	No	The time when the sub-period starts.
weekday_list	No	ArrayOfString	No	The list of week days included into the sub-period. The following values are possible for each element of the list: 'su', 'mo', 'tu', 'we', 'th', 'fr', 'sa'.

SessionLogIdInfo
Property	Mandatory	Type	Nillable	Description	Possible values
session_id	Yes	string	No	The h323-conf-id or call-id of the session.

SessionLogInfo
Property	Mandatory	Type	Nillable	Description	Possible values
log_message_list	No	Array of SessionLogMessage structure	No	The list of messages of the session log.
meta_info	No	SessionLogMetaInfo structure	No	Meta information of the session log.

TraceSessionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID of the account the extension is assigned to.
call_id	No	string	No	The call-id of the session.
cld	No	string	No	The called line phone number.
cli	No	string	No	The calling line phone number.
connection_name	No	string	No	Name of used connection.
customer_name	No	string	No	The name of the customer.
disconnect_cause	No	int	No	The code of disconnect cause.
duration	No	int	No	The session length (number of seconds) from the moment when the session was started.
from_date	No	dateTime	No	The beginning of the search interval.
h323_conf_id	No	string	No	h323-conf-id of the session.
i_account	No	unsignedLong	No	The unique ID of the account.
i_connection	No	unsignedLong	No	The unique ID of the connection.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_disconnect_cause_class	No	int	No	The unique ID of the disconnect cause class.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
i_vendor	No	unsignedLong	No	The unique ID of the vendor.
parent_h323_conf_id	No	string	No	The h323-conf-id of the parent session.
quantity	No	int	No	The number of service units used.
service_type_name	No	string	No	The logical name of the Service Type.
source_ip	No	string	No	The IP address of the entity.
status	No	string	No	The status of the session.
to_date	No	dateTime	No	The end of the search interval.
vendor_name	No	string	No	Name of the vendor on the PortaBilling interface.

SessionLogInfoForRT
Property	Mandatory	Type	Nillable	Description	Possible values
call_id	No	string	No	The ID of the service session.
h323_conf_id	No	string	No	The ID of the billing session.
node_list	No	Array of SessionLogNodeInfo structure	No	The list of the SIP log nodes related to the session.

FraudTrafficAlertInfo
Property	Mandatory	Type	Nillable	Description	Possible values
accumulation_period	No	string	No	The name of the accumulation period. Possible periods: [hour, day].
attempts	No	unsignedLong	No	The number of call attempts.
calls	No	unsignedLong	No	The number of calls.
constraint_duration	No	unsignedLong	No	The initial duration of calls that the customer can accumulate in the period before notification.
cost	No	float	No	The total cost of all calls.
customer	No	string	No	The name of the customer.
destination_group	No	string	No	The name of the destination group.
destination_group_set	No	string	No	The name of the destination group set.
duration	No	unsignedLong	No	The total duration of all calls.
i_customer	No	unsignedLong	No	The identifier of the customer.
i_dest_group	No	unsignedLong	No	The unique identifier of the destination group record.
i_dest_group_set	No	unsignedLong	No	The unique identifier of the destination group set record.
i_ft_constraint	No	unsignedLong	No	The identifier of the fraud traffic constraint.
i_traffic_profile	No	unsignedLong	No	The unique identifier of the traffic profile record.
last_modified	No	dateTime	No	The date and time when the counter was last updated.
notified	No	dateTime	No	The date and time when the alert was triggered.
period_from	No	dateTime	No	The date and time when the traffic counter is created.
period_to	No	dateTime	No	The date and time when the traffic counter expires.
revenue	No	float	No	The total revenue for all calls.
traffic_profile_name	No	string	No	The name of the traffic profile.

FraudConstraintInfo
Property	Mandatory	Type	Nillable	Description	Possible values
accumulation_period	No	string	No	The name of the accumulation period. Possible periods: [hour, day].
destination_group	No	string	No	The name of the destination group.
duration	No	int	No	The duration of the fraud constraint.
fraud_traffic_info	No	FraudTrafficInfo structure	No	Information about the fraud traffic.
i_customer	No	unsignedLong	No	The identifier of the customer.
i_dest_group	No	unsignedLong	No	The identifier of the destination group.
i_ft_constraint	No	unsignedLong	No	The identifier of the fraud constraint.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
is_used	No	int	No	Determines whether the fraud constraint is used by the customer.

SpendingConstraintInfo
Property	Mandatory	Type	Nillable	Description	Possible values
amount	No	string	No	The spending limit of the spending constraint.
i_sp_constraint	No	unsignedLong	No	The identifier of the spending constraint.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
limit_funds_allocation	No	string	No	Shows if the spending constraint limits funds for new calls. Possible values: 'Y', 'N'.
notify_ratio	No	int	No	The warning threshold of the spending constraint, %.
send_notification	No	string	No	Specifies whether to notify the user when the spending limit is reached. Possible values: N - do not notify, Y - notify.

FraudTrafficInfo
Property	Mandatory	Type	Nillable	Description	Possible values
duration_avg	No	int	No	The average traffic duration.
duration_max	No	int	No	The maximum traffic duration.
duration_min	No	int	No	The minimum traffic duration.

TrafficProfileInfo
Property	Mandatory	Type	Nillable	Description	Possible values
customer_name	No	string	No	The name of the customer who owns the traffic profile. Filled when the 'with_extended_info' field in the method info is equal to 1.
description	No	string	Yes	The description of the traffic profile.
dest_group_set_name	No	string	No	The destination group set name assigned to the traffic profile. Filled when the 'with_extended_info' field in the method info is equal to 1.
i_customer	No	unsignedLong	Yes	The identifier of the traffic profile owner.
i_dest_group_set	No	unsignedLong	No	The identifier of the traffic profile destination group set.
i_traffic_profile	No	unsignedLong	No	The identifier of the traffic profile.
is_draft	No	int	No	Shows whether the traffic profile is configured or is a draft profile.
is_used	No	unsignedLong	No	Shows whether the traffic profile is in use.
iso_4217	No	string	No	The currency of the traffic profile.
name	No	string	No	The name of the traffic profile.
spending_constraint_info	No	SpendingConstraintInfo structure	No	Information about the traffic profile spending constraint. Filled when the 'with_spending_constraint' field in the method info is equal to 1.

PriceListInfo
Property	Mandatory	Type	Nillable	Description	Possible values
price	Yes	string	No	The total charge applied to the account for this remittance transaction.
product	Yes	string	No	The amount to be added to the balance of the mobile recipient for this remittance transaction.

UATypeUsageInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_ua_type	Yes	unsignedLong	No	The unique ID of the UA type.
manufacturer	No	string	No	The UA type device manufacturer's company name.
product	No	string	No	The model of the UA device of this type.
total_free	Yes	int	No	The total number of the UA devices of this type that are available.
total_used	Yes	int	No	The total number of the UA devices of this type that are in use.
version	No	string	No	The version of the UA device of this type.

UAProfileInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	UA Profile description.
discontinued	No	string	No	The flag shows whether the UA profile is discontinued. Possible values: 'Y', 'N'.
effective_from	No	dateTime	No	UA Profile effective from date.
i_customer	No	unsignedLong	Yes	Managed by.
i_ua_profile	No	unsignedLong	No	The unique ID of the UA Profile record.
i_ua_type	No	unsignedLong	No	UA Type ID.
is_active	No	int	No	Shows whether the current version of the profile is active.
is_used_by_resellers	No	int	No	Shows whether the shared CPE profile is used by resellers.
manufacturer	No	string	No	The UA manufacturer name.
mode	No	int	No	Shows whether the Cisco ATA profile is configured in H323 or SIP mode. Possible values: 0 - H323, 1 - SIP. This field is present in the response of the 'get_ua_profile_info' method if the 'get_parameters' flag is true.
name	No	string	No	Name of the UA Profile.
notepad	No	string	No	UA Profile notepad.
product	No	string	No	The UA product name.
shared	No	string	No	Shows whether the CPE profile managed by the administrator is available to resellers.
ua_profile_id	No	unsignedLong	No	ID of UA Profile.
ua_profile_parameters	No	Array of UAProfileParameterInfo structure	No	The UA profile parameters.
used	No	string	No	Indicates whether UA Profile is used or not. Possible values - 'Y', 'N'.
version	No	string	No	The UA version.

UAInfo
Property	Mandatory	Type	Nillable	Description	Possible values
ascii_key	No	string	No	ASCII Key. For Yealink devices, the expected value is a string of 16 Latin1 symbols without whitespaces. For other devices, the expected value is a string of 16, 32 or 64 characters. Supported characters are 'a-Z','0-9'. Note that an empty string is accepted as well. The UI equivalent of this field is the "ASCII/AES key" field on the "Create CPE" panel.
available_ports	No	ArrayOfInt	No	The list of the available ports of the UA.
busy_ports	No	ArrayOfInt	No	The list of the busy ports of the UA.
description	No	string	No	UA description.
i_customer	No	unsignedLong	Yes	Managed by.
i_ua	No	unsignedLong	No	ID of UA record.
i_ua_profile	No	unsignedLong	No	The ID of the UA profile record.
i_ua_type	No	unsignedLong	No	UA Type Id (used to add new UA).
inventory_id	No	string	No	UA Inventory ID.
is_multiservice	No	int	No	Indicates whether this UA supports provisioning of multiple services.
is_used_by_resellers	No	int	No	Shows whether the shared CPE is used by resellers.
mac	No	string	Yes	UA MAC address.
name	No	string	No	UA name.
notepad	No	string	No	UA notepad.
opc_key	No	string	No	The Opc key.
port	No	string	No	UA port that is used by this account (makes sense for get_ua_info requests).
ports_config	No	Array of UAPortConfiguration structure	No	The list of UA port configurations.
profile	No	string	No	UA Provisioning Profile.
shared	No	string	No	Shows whether the CPE managed by the administrator is available to resellers.
type	No	string	No	UA type.
ua_profile_id	No	unsignedLong	No	ID of UA profile.
used	No	string	No	Flag that indicates UA usage.

UATypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
hidden	No	int	No	Shows whether the UA type is hidden or not: 1 – the UA type is hidden; nil or 0 – the UA type is not hidden.
i_ua_type	No	unsignedLong	No	The unique ID of the UA type.
manufacturer	No	string	No	The UA type device manufacturer's company name.
name	No	string	No	The name of the UA device of this type (Combination of the manufacturer and product fields).
ports	No	int	No	The total number of available ports for the UA device of this type.
product	No	string	No	The model of the UA device of this type.
version	No	string	No	The version of the UA device of this type.

UserNotificationCategoryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification_category	No	unsignedLong	No	The unique ID of the notification category.
name	No	string	No	The name of the notification category.
send_mail	No	int	No	Deprecated: the option is deprecated in MR84-0 and will be removed in MR86-0. Specifies whether this notifications will be sent by email. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email.
send_sms	No	int	No	Deprecated: the option is deprecated in MR84-0 and will be removed in MR86-0. Specifies whether this notifications will be sent by sms. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email.

UserNotificationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_notification	No	unsignedLong	No	The unique ID of the notification.
send_mail	No	int	No	Specifies whether this notification will be sent by email. Possible values: 1 – The notification will be sent by email, 0 – The notification will not be sent by email.
send_sms	No	int	No	Specifies whether this notification will be sent by sms. Possible values: 1 – The notification will be sent by sms, 0 – The notification will not be sent by sms.

UserInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_date	No	string	No	The date when the user's account is activated (UTC).
address_line_2	No	string	No	The 2nd line of the user's address.
api_token	No	string	No	The API token of the user. You could use tokens instead of the standard login-password pairs for authenticating your applications integrated with PortaBilling via API. It is a string of 36 symbols containing the '0-9','a-f','-' characters.
auto_redirect_to_foreign	No	int	No	The flag shows whether to redirect the user to your other system in case the data is located there.
baddr1	No	string	No	1st line of user's address.
city	No	string	No	The name of the city.
class	No	string	No	The class of the user.
companyname	No	string	No	The conventional form of user company's name.
cont1	No	string	No	The main contact person.
cont2	No	string	No	The alternative contact person.
country	No	string	No	The code of the country in the ISO 3166-1 alpha-2 format.
daily_allowance	No	float	No	The maximum amount of credit/refund per day for the user.
description	No	string	No	A short description associated with the user.
email	No	string	No	An email contact for the user.
expiration_date	No	string	No	The date when the user's account expires.
faxnum	No	string	No	A fax number.
firstname	No	string	No	The user's first name.
hide_personal_info	No	int	No	Shows whether personal information is hidden from the user. Can be 0 - is visible or 1 - is hidden.
i_acl	No	unsignedLong	No	The privilege level or role assigned to the user.
i_lang	No	string	No	The language used on the admin web interface for this user.
i_notification_preset	No	unsignedLong	No	The notification preset assigned to the user.
i_role	No	unsignedLong	No	The identifier of the access role.
i_time_zone	No	unsignedLong	No	The time zone in which this user is operating.
i_user	No	unsignedLong	No	The unique ID of the user record.
in_date_format	No	string	No	Input date format.
in_time_format	No	string	No	Input time format.
ip_filter	No	string	No	The list of IP addresses that are enabled for the user to login into PortaBilling.
is_super_user	No	string	No	Shows whether the user is super user.
iso_4217	No	string	No	The ISO4217 currency code.
lastname	No	string	No	The user's last name.
login	No	string	No	The username for login and user identification.
login_allowed_ip_list	No	ArrayOfString	No	The list of IP addresses that are enabled for the user to login into PortaBilling.
max_credit_limit_days	No	int	No	The maximum period of validity of the temporary credit limit.
max_credit_limit_increase	No	string	No	The maximum possible increase of the permanent credit limit.
midinit	No	string	No	The user's middle name.
out_date_format	No	string	No	Output date format.
out_date_time_format	No	string	No	Output date and time format.
out_time_format	No	string	No	Output time format.
password	No	string	No	The password for this user.
phone1	No	string	No	The main phone number.
phone2	No	string	No	An alternative phone number.
role_name	No	string	No	The name of the access role.
rt_auth_info	No	RTAuthInfo structure	No	User's RT information.
salutation	No	string	No	The user's salutation.
state	No	string	No	The name of the state.
status	No	string	No	Indicates user's status. Can be the following: empty (if the user is active), inactive, expired or exceeded.
transaction_allowance	No	float	No	The maximum amount of credit/refund per one transaction for the user.
zip	No	string	No	The user's ZIP code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash).

ConnectionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	The access number the customer dialed to reach your network.
active	No	string	No	The flag shows whether the connection is active. Possible values: 'Y' - active, 'N' - not active, 'I' - internal.
capacity	No	int	No	Specifies the maximum number of simultaneous calls the connection can support.
cld_prefix	No	string	No	CLD tech prefix helps to identify connection from several user agents with the same IP address. Expected value: a string of 'a-D','0-9','*','#',',' characters with the maximum length of 32 characters.
cli_trust	No	string	No	Describes how outgoing calls for which the caller has requested privacy are to be displayed to the vendor.
conn_type_leg_origin	No	int	No	The numeric identification of the connection type origin (the meaning depends on the service type: for VOICE CALLS, 0 - originate, 1 - answer; for messaging, 0 - outgoing message, 1 - incoming message).
conn_type_technology	No	string	No	The technology used by the connection type to perform the transport.
description	No	string	No	Description of the connection.
gateway_id	No	string	No	A distinctive name for the remote gateway.
i_connection	No	unsignedLong	No	Unique connection identifier.
i_connection_type	No	unsignedLong	No	The unique ID of the connection type record.
i_criteria	No	unsignedLong	No	Defines what routing criteria will be applied to this connection.
i_dial_rule_cld	No	unsignedLong	No	Reference to dialing rule, which is applied for CLD.
i_dial_rule_cli	No	unsignedLong	No	Reference to dialing rule, which is applied for CLI.
i_node	No	unsignedLong	No	The ID of the node used for this connection.
i_oli	No	unsignedLong	No	Unique oli identifier.
i_rate_match_mode	No	unsignedLong	No	This parameter allows you to rate calls either based on their destination or the caller's number.
i_service_policy	No	unsignedLong	No	Specifies a predefined set of options which are applied to calls going through this connection.
i_service_type	No	unsignedLong	No	The type of service transported via this connection (voice calls, Internet connectivity, etc.).
i_tariff	No	unsignedLong	No	The ID of the tariff used to calculate the cost of terminating calls via this connection.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
i_vendor_acc	No	unsignedLong	No	Defines the username/password used for authorization of calls via this connection.
ip_transport_protocol	No	string	No	Transport protocol for outgoing connections to Vendor.
port	No	string	No	Only on PSTN-related connections. The specified port for PSTN origination or termination. Expected value: a string containing the '0-9',',','_','%' characters.
remote_ip	No	string	No	The IP of the remote gateway, e.g. 23.45.67.89.
rtpp_level	No	int	No	Describes the NAT traversal capabilities of the remote gateway (the default value is set to Optimal).
sip_specific_settings	No	string	No	Additional settings for some call scenarios, for example routing based on Point of Presence.
utilization_balthreshold	No	int	No	The threshold after which load-balancing is started.
utilization_routing	No	string	No	Flag which indicates whether load-balancing is enabled for this connection.
vendor_name	No	string	No	The name of the vendor.

ConnectionDestinationGroupInfo
Property	Mandatory	Type	Nillable	Description	Possible values
aloc	No	int	No	The average duration of call for a certain period of time.
asr	No	int	No	The average success rate (the number of successfully connected calls divided by the total number of call attempts) for a certain period of time.
block_from	No	dateTime	No	The datetime timestamp when the connection destination group was blocked.
block_until	No	dateTime	No	The datetime timestamp when the connection destination group will be unblocked.
calls	No	int	No	The total number of calls for a certain period of time.
dest_group_name	No	string	No	The name of the destination group.
destination_group_thresholds	No	RoutingCriteriaDestGroupInfo structure	No	The information about the destination group of the routing criteria.
high_pdd	No	int	No	The value of the maximum acceptable PDD (Post-Dial Delay) for a certain period of time.
i_dest_group	No	unsignedLong	No	The unique identifier of the destination group.
is_blocked	No	int	No	Shows whether the destination group in the connection is blocked.
last_updated	No	dateTime	No	The datetime timestamp when the values in the structure were updated.
low_pdd	No	int	No	The minimum acceptable PDD (Post-Dial Delay) for a certain period of time.
ppm	No	float	No	The profit per minute for a certain period of time.
reduce_priority	No	string	No	Shows whether the destination group in the connection is penalized.

ConnectionTypeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_connection_type	No	unsignedLong	No	The unique ID of the connection type.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
leg_origin	No	int	No	The numeric identification of the origin (the meaning depends on the service type: for VOICE CALLS, 0 - originate, 1 - answer; for messaging, 0 - outgoing message, 1 - incoming message).
leg_type	No	int	No	The numeric identification of the leg type (the meaning depends on the service type: for VOICE CALLS, 0 - Telephony, 1 - VoIP; for messaging it's always 0).
name	No	string	No	The name of the connection type.
technology	No	string	No	The technology used to perform the transport.
transport_code	No	string	No	The internal unique identifier used for connection matching.
transport_protocol	No	string	No	The protocol used to perform the transport.

DIDProviderAccountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
api_key	No	string	No	This key will be used for the authentication of API sessions.
i_did_provider	No	unsignedLong	No	The unique ID of the DID provider.
i_did_provider_acc	No	unsignedLong	No	The unique ID of the DID provider account.
i_dv_batch	No	unsignedLong	No	The unique ID of the vendor batch.
i_node	No	unsignedLong	No	The unique ID of the node on which calls from this vendor will be accepted.
i_tariff	No	unsignedLong	No	The unique ID of the tariff.
i_vendor	No	unsignedLong	No	The unique ID of the vendor.
server_address	No	string	No	The DID provider server address, is used only for PortaSwitch providers.
username	No	string	No	This user name will be used for the authentication of API sessions.
vendor_name	No	string	No	The name of the vendor related to the DID provider account.

VendorXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
CLD	No	string	No	The called line identification.
CLI	No	string	No	The calling line identification.
account_id	No	string	No	The identifier of the account (unique in environment).
aux_xdrs	No	Array of AuxXDRInfo structure	Yes	The array of auxiliary xDRs.
bill_time	No	dateTime	No	The time when the session was billed.
bit_flags	No	int	No	Extended information on how the service was used; the integer field that should be treated as a bit-map. Each currently used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position).
call_id	No	string	No	The unique identifier of the call.
charged_amount	No	float	No	The amount charged.
charged_quantity	No	int	No	The number of service units charged for.
charged_time	No	int	No	The amount of time that was charged.
connect_time	No	dateTime	No	The session connect time.
country	No	string	No	The country name of the destination related to the XDR.
description	No	string	No	The description of the destination related to the XDR.
disconnect_cause	No	int	No	The code of the session disconnect cause.
disconnect_time	No	dateTime	No	The session disconnect time.
failed	No	string	No	The failed status of the XDR.
h323_conf_id	No	string	No	The unique identifier of the session.
h323_incoming_conf_id	No	string	No	The unique ID of the incoming session (if exists) used for interrelating xDRs, when the charged session is established as a result of a previous session (possibly having its own xDR).
history	No	string	No	The additional information about the XDR.
i_account	No	unsignedLong	No	The unique identifier of the account related to the XDR.
i_connection	No	unsignedLong	No	The unique identifier of the connection.
i_customer	No	unsignedLong	No	The unique identifier of the customer.
i_dest	No	unsignedLong	No	The unique identifier of the destination.
i_dest_group	No	unsignedLong	No	The unique identifier of the destination group.
i_service	No	unsignedLong	No	The unique identifier of the service related to the XDR.
i_vendor	No	unsignedLong	No	The unique identifier of the vendor.
i_xdr	No	int	No	The unique ID of the XDR record.
setup_time	No	int	No	The time (in ms) between first provisional response and connect_time.
used_quantity	No	int	No	The number of service units used.

VendorPerServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charged_amount	No	float	No	The sum of the amounts in the 'credits' and 'charges' fields.
charged_quantity	No	int	No	Units charged.
charges	No	float	No	The sum of charge transaction amounts related to the service.
credits	No	float	No	The sum of credit transaction amounts related to the service.
i_service	No	unsignedLong	No	The unique ID of the service; refers to Services table.
i_service_type	No	unsignedLong	No	The unique ID of the service type.
name	No	string	No	The service name.
rate_unit	No	string	No	A customer-visible name for the units used to calculate service charges (e.g. message, minute).
rating_base	No	string	No	Specifies which particular parameter is used to calculate charges, e.g. "session time", "amount of data transferred" and the like.
rating_base_unit	No	string	No	A customer-visible name for the units in which service use is measured; this also is the smallest possible unit you use in the rating configuration (e.g. second).
ratio	No	int	No	Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration.
total	No	int	No	Subtotal for this type of transactions/service.
total_sessions	No	int	No	The total number of sessions of this transactions/service type.
unit	No	string	No	The unit in which the charged quantity is shown (e.g. second).

VendorAccountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
del	No	int	No	Indicates whether this vendor account can be deleted or not.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record which this account belongs to.
i_vendor_acc	No	unsignedLong	No	The unique ID of the vendor account record.
login	No	string	No	A username/login provided to you by your termination partner, which will be used to authorize every outgoing call from your network to this vendor.
name	No	string	No	A vendor account name.
password	No	string	No	A password provided to you by your termination partner, which will be used to authorize every outgoing call from your network to this vendor.

VendorInfo
Property	Mandatory	Type	Nillable	Description	Possible values
address_line_2	No	string	No	The 2nd line of the vendor's address.
baddr1	No	string	No	The 1st line of vendor's address.
balance	No	float	No	Vendor's balance.
bcc	No	string	No	BCC email address.
billed_to	No	date	No	The date to which subscription charges have already been applied.
city	No	string	No	City of vendor's address.
companyname	No	string	No	Vendor's company name.
connections_total	No	int	No	The total number of configured connections for the vendor.
cont1	No	string	No	Main contact person.
cont2	No	string	No	Alternative contact person.
country	No	string	No	Country.
email	No	string	No	Email address.
faxnum	No	string	No	Fax number.
firstname	No	string	No	Vendor's first name.
i_acl	No	unsignedLong	No	The unique ID of the vendor's access level; refers to Access_Levels table.
i_billing_period	No	unsignedLong	No	The unique ID of the vendor's billing period; refers to Billing_Period table.
i_customer	No	unsignedLong	No	The unique ID of the customer record.
i_lang	No	string	No	Code of the vendor's web interface language; refers to Languages table.
i_time_zone	No	unsignedLong	No	the unique ID of the vendor's time zone; refers to Time_Zones table.
i_vendor	No	unsignedLong	No	The unique ID of the vendor record.
in_date_format	No	string	No	Input format for date indication.
in_time_format	No	string	No	Input format for time indication.
is_used	No	int	No	Shows whether the vendor has entities assigned.
iso_4217	No	string	No	ISO4217 code for currency in which the vendor is billed.
lastname	No	string	No	Vendor's last name.
login	No	string	No	Vendor's login for self-care web interface.
midinit	No	string	No	Vendor's middle initial(s).
name	No	string	No	Name of the vendor on the PortaBilling interface, unique in the environment.
note	No	string	No	Short note (description).
notepad	No	string	No	Comments regarding this vendor.
offset_threshold	No	int	No	Defines the vendor for automatically offsetting the vendor's balance (if this vendor also sends you traffic, i.e. he is also your vendor). You may only choose a reseller or retail vendor defined with the same currency.
opening_balance	No	float	No	Vendor's opening balance.
out_date_format	No	string	No	Output format for date indication on the vendor's self-care interface.
out_date_time_format	No	string	No	Output format for full date/time indication.
out_time_format	No	string	No	Output format for time indication.
password	No	string	No	Vendor's password for self-care web interface.
phone1	No	string	No	Main phone number.
phone2	No	string	No	Alternative phone number.
refnum	No	string	No	Reference number (custom field).
salutation	No	string	No	Vendor's salutation.
send_statistics	No	string	No	F - send full statistics to vendor, S - send short statistics, N - do not send statistics.
state	No	string	No	Province or state.
tz	No	string	No	Name of vendor's time zone; refers to Time_Zones table.
zip	No	string	No	Postal (zip) code.

VoiceQualityProfileInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The voice quality profile description.
i_vq_profile	No	unsignedLong	No	The unique ID of the voice quality profile.
inter_arrival_jitter_l1	No	int	No	The inter arrival jitter metric level1 value, ms.
inter_arrival_jitter_l2	No	int	No	The inter arrival jitter metric level2 value, ms.
is_used	No	int	No	Shows whether the voice quality profile is in use.
managed_by	No	unsignedLong	No	The ID of the voice quality profile owner record.
mos_cq_l1	No	float	No	The MOS-CQ metric level1 value.
mos_cq_l2	No	float	No	The MOS-CQ metric level2 value.
name	No	string	No	The voice quality profile name.
packet_loss_l1	No	int	No	The packet loss metric level1 value, percents.
packet_loss_l2	No	int	No	The packet loss metric level2 value, percents.
round_trip_delay_l1	No	int	No	The round trip delay metric level1 value, ms.
round_trip_delay_l2	No	int	No	The round trip delay metric level2 value, ms.

RoamingProfileInfo
Property	Mandatory	Type	Nillable	Description	Possible values
countries	No	RoamingCountries structure	No	The lists of roaming countries for each restriction level.
default_restriction_level	No	string	No	Specifies default restriction level of the roaming profile.
description	No	string	No	The roaming profile description.
i_roaming_profile	No	unsignedLong	No	The ID of the roaming profile record.
managed_by	No	int	No	The ID of the roaming profile owner record.
name	No	string	No	The roaming profile name.
policy	No	RoamingPolicyInfo structure	No	The fraud policy used for each restriction level.
used	No	int	No	Shows whether the roaming profile is in use.

RoamingCountryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
continent_code	No	string	Yes	The code of the continent where the country is located.
iso_3166_1_a2	No	string	No	A two-letter country code defined in ISO 3166-1 alpha-2.
name	No	string	No	The roaming country name.

WebLogInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action_type	No	string	No	The type of the action (e.g. insert, update, delete) that was applied to the entity.
data_access_mode	No	string	No	The type of data access applied to the user when the action was requested. Possible values: open, protected.
description	No	string	No	The description of the web log record.
entity_name	No	string	Yes	The name of the entity to which the changes were applied.
entity_type	Yes	string	No	The type of the entity (e.g. Accounts, Customers, etc.).
fields	No	Array of WebLogFieldInfo structure	Yes	The list of fields affected by the change.
i_entity	No	string	Yes	The unique ID of the entity to which the changes were applied.
i_log	No	unsignedLong	No	The unique ID of the web log record.
i_parent	No	string	No	The unique ID of the parent entity.
i_user	No	unsignedLong	No	The unique ID of the user.
ip	No	string	No	The IP address of the user.
parent_name	No	string	No	The name of the parent entity.
parent_type	No	string	No	The type of the parent entity (e.g. Products, Tariffs, etc.).
realm	No	string	No	The unique name of the realm (e.g. admin, accounts, customer, etc.).
timestamp	No	dateTime	No	The timestamp of the action.
username	No	string	No	The unique name of the user who applied the changes.

WebLogFieldInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	No	string	No	The name of the field.
new_value	No	string	Yes	The current value of the field.
old_value	No	string	Yes	The previous value of the field.

XDRCollectionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
add_date	No	dateTime	No	The datetime when the collection was added to the processing queue.
collection_name	No	string	No	The name of the xDR collection.
finish_date	No	dateTime	No	The datetime when processing of the xDR collection was finished.
i_collection	No	unsignedLong	No	The ID of the xDR collection.
status	No	string	No	The status of the xDR collection (enum: any, new, processing, finished).
xdr_stats_info	No	XDRStatsInfo structure	No	The information about xDR records in the collection.

MediatorXDRInfoDetailed
Property	Mandatory	Type	Nillable	Description	Possible values
attribute_data	No	Array of RadiusAttributeData structure	No	A parsed Radius attribute data from the raw xDR.
origin_data	No	string	No	A raw xDR data from the source file.
record_id	No	int	No	A line number of original xDR record in the source file.
source_file	No	string	No	The filename of the source file.
status	No	string	No	The status of the xDR record.
xdr_id	No	string	No	The ID of the xDR record.

XDRCollectionDetailedInfo
Property	Mandatory	Type	Nillable	Description	Possible values
xdr_error_stats	No	XDRErrorStatsInfo structure	No	The stats of the xDR records grouped by error type.
xdr_status_stats	No	XDRStatsInfo structure	No	The stats of the xDR records grouped by status.

MediatorXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
charged_quantity	No	int	No	A number of used service units.
cld	No	string	No	Calling line destination.
cli	No	string	No	Calling line identification.
connect_time	No	dateTime	No	Time when connection was initiated.
customer_charge	No	float	No	An amount of money of the customer charge in currency units.
customer_currency	No	string	No	ISO 4217 code for currency of the customer.
customer_name	No	string	No	The name of the customer.
error_explanation	No	string	No	The error explanation message.
h323_conf_id	No	string	No	The ID of the billing session.
i_account	No	unsignedLong	No	The ID of the account.
i_customer	No	unsignedLong	No	The ID of the customer.
i_service	No	unsignedLong	No	The unique ID of the service record.
i_service_type	No	unsignedLong	No	The ID of the service type.
i_vendor	No	unsignedLong	No	The ID of the vendor.
service_name	No	string	No	The name of the service.
service_type_name	No	string	No	The name of the service type.
service_units	No	string	No	The service type charge units.
status	No	string	No	The status of the xDR record.
user_name	No	string	No	The name of the user.
vendor_charge	No	float	No	An amount of money of the vendor charge in currency units.
vendor_currency	No	string	No	ISO 4217 code for currency of the vendor.
vendor_name	No	string	No	The name of the vendor.
xdr_id	No	string	No	The ID of the xDR record.

MediatorXDRId
Property	Mandatory	Type	Nillable	Description	Possible values
xdr_id	Yes	string	No	The ID of the xDR record.

AccessPolicyPhaseInfo
Property	Mandatory	Type	Nillable	Description	Possible values
definition_list	No	A 2-dimensional array of the SubPeriodInfo structure	No	The definition list for the related time period.
i_access_policy_phase	No	unsignedLong	No	The unique ID of the access policy phase DB record.
i_offpeak	No	unsignedLong	No	The unique ID of the time period DB record related to the access policy phase.
rx_rate	No	int	No	The download speed rate of the access policy phase.
rx_rate_unit	No	string	No	The download measure unit of the access policy phase.
tx_rate	No	int	No	The upload speed rate of the access policy phase.
tx_rate_unit	No	string	No	The upload measure unit of the access policy phase.
type	No	string	No	The type of the access policy phase. Possible values: offpeak, regular and limited.

ServicePolicyAttributeValues
Property	Mandatory	Type	Nillable	Description	Possible values
group_name	No	string	No	The name used to group service policy attributes. The field is applicable only to getters.
i_sp_attribute	Yes	unsignedLong	No	The unique id of service policy attribute.
name	No	string	No	The name of the service policy attribute. The field is applicable only to getters.
values	No	ArrayOfString	No	The array of attribute values.

AccessComponentPermission
Property	Mandatory	Type	Nillable	Description	Possible values
components	No	Array of AccessComponentPermission structure	No	The permissions for subcomponents of the access component.
name	Yes	string	No	The name of the access component.
objects	No	Array of AccessObjectPermission structure	No	The permissions for objects of the access component.
permission	No	int	No	The permission for the access component.

AccountAuxFieldInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The field name.
value	No	string	Yes	The field value.

CustomerAuxFieldInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The field name.
value	No	string	Yes	The field value.

BillingPeriodClosureDelayedInfo
Property	Mandatory	Type	Nillable	Description	Possible values
auto_close_on	Yes	dateTime	No	The timestamp when the customer's billing period will be automatically closed.
is_closing_scheduled	Yes	string	No	Shows whether the customer's billing period is scheduled to be closed.

BalanceWarningThreshold
Property	Mandatory	Type	Nillable	Description	Possible values
type	Yes	string	No	Type of the warning threshold. Possible values: A - absolute amount, P - percent.
warning_threshold	Yes	float	No	Warning threshold value. NOTE: For postpaid customers, balance warning thresholds can be defined either as amounts or as percentages of a positive Permanent Credit Limit value. For prepaid customers, balance warning thresholds can be defined only as an amount of an Available Funds value.

RTAuthInfo
Property	Mandatory	Type	Nillable	Description	Possible values
queue	No	string	No	RT queue name.
requestor	No	string	No	RT requestor name.
rt_login	No	string	No	Customer RT login.
rt_pass	No	string	No	Customer RT password.
rt_server_url	No	string	No	RT Server URL.

ScheduledCustomerStatusChangeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
generate_invoice_earlier	Yes	string	No	Defines whether an invoice will be generated before the end of the billing period.
i_status	Yes	unsignedLong	No	The unique ID of the scheduled customer status change.
status_name	Yes	string	No	The human-readable name of the status.
time_stamp	Yes	dateTime	No	The timestamp when the status will be applied to the customer.

ServiceAttributeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
effective_values	No	ArrayOfString	Yes	A list of the service feature attribute values. They can be received in one of two ways: inherited by the account from the customer, customer site or the product; inherited by the customer site from the customer.
name	Yes	string	No	Name of the service feature.
values	No	ArrayOfString	Yes	Values of the service attribute. If the attribute accepts single value, only first item will be checked/populated.

CPConditionNumberInfo
Property	Mandatory	Type	Nillable	Description	Possible values
negated	No	string	No	Indicates that the condition is met when the number is not matched. (Y / N).
number	Yes	string	No	Phone number.
onnet	No	string	No	Whether the number is onnet (Y / N).

CPConditionTimeWindowInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	Description of period.
period	Yes	string	No	Time::Period string.

CommitmentSaleDiscountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
absolute_discount	No	float	No	The amount of the discount provided during this discount period.
end_date	No	date	No	The end of the discount period. Should be earlier or the same as the commitment's 'min_terminate_date' (discount period) and should not overlap with other sale discounts associated with the recurring term. The discount is not applied for the 'end_day'. If the commitment was paused, the discount dates that go after the pause interval are shifted for the number of days the commitment was in the paused state. If not specified, the discount is applied till the end of commitment lifetime.
start_date	No	date	No	The date when the sale discount is activated. Should be later or the same as the commitment start date and should not overlap with other sale discounts associated with the recurring term. If the commitment was paused, the discount dates that go after the pause interval are shifted for the number of days the commitment was in the paused state. If not specified, the discount is applied starting from the first commitment period.

SubscriptionDiscountInfo
Property	Mandatory	Type	Nillable	Description	Possible values
discount_fee	No	float	No	A fee with applied discount for the number of months.
i_subscription	No	unsignedLong	No	The unique ID of the Subscription Plan record.
i_subscription_discount	No	unsignedLong	No	The unique ID of the Subscription Discount record.
number_of_months	No	int	No	The number of months covered by this discount.
percent	No	float	No	Only for the percentage discount type; the amount of discount.
rate	No	float	No	Only for the fixed amount discount type; the amount of discount.
standard_fee	No	float	No	The standard fee for the number of months.

MOHInfo
Property	Mandatory	Type	Nillable	Description	Possible values
converted	No	string	No	Indicates whether the MOH was converted.
i_moh	No	unsignedLong	No	The unique ID of the MOH record.
name	No	string	No	MOH record name.
tries	No	int	No	Deprecated: the option is deprecated in MR67-0 and will be removed in MR71-0. Left for backward compatibility.

AuxXDRInfo
Property	Mandatory	Type	Nillable	Description	Possible values
value	No	string	No	The value of the XDR.
xdr_column_id	No	string	No	The name of the XDR column.
xdr_time	No	dateTime	No	The date and time that shows when the XDR was processed.

VoiceQualityMetricDataInfo
Property	Mandatory	Type	Nillable	Description	Possible values
direction	No	string	Yes	The direction of the call (incoming, outgoing).
inter_arrival_jitter	No	int	Yes	The parameter is expressed in milliseconds; related to quality.
local_address	No	string	Yes	The field provides the IP address, port, and synchronization source (SSRC) for the session from the perspective of the endpoint that is measuring performance. The IPAddress MAY be in IPv4 or IPv6 format.
mos_cq	No	float	Yes	The parameter is the estimated mean opinion score for conversation voice quality on a scale from 1 to 5, in which 5 represents excellent and 1 represents unacceptable; related to quality.
packet_loss	No	int	Yes	The value corresponds to "loss rate" in RFC, related to quality.
party_id	No	string	Yes	The party number (ANI or DNIS).
payload_desc	No	string	Yes	A text description of the codec.
payload_type	No	int	Yes	The payload type, codec. IANA-registered type.
ptime	No	int	No	The field reflects the amount of voice content in each frame within the RTP payload, measured in milliseconds.
quality	No	string	No	The call quality. Possible values: good, fair, poor, unknown.
remote_address	No	string	Yes	The field provides the IP address, port, and SSRC of the session peer from the perspective of the remote endpoint measuring performance.
round_trip_delay	No	int	Yes	The parameter is expressed in milliseconds; related to quality.
sample_rate	No	float	Yes	The field provides the rate at which the voice was sampled, measured in Hertz (Hz).
silence_suppression_state	No	int	Yes	The field indicates whether silence suppression, also known as Voice Activity Detection (VAD), is enabled for the identified session.

Discounts
Property	Mandatory	Type	Nillable	Description	Possible values
alter_service	No	string	No	This property is only available for services based on the Internet Access service type. In this case, when the discount period is active and the threshold has been crossed, the level of service provided can also be adjusted.The possible values are: l – limited, b – blocked, The nill flag sets to norestriction.
discount	No	float	No	The percentage discount value must be numeric (with a period allowed) in the 0 – 100 range. A 0% discount means "standard rate applied," while a 100% discount means "free call".
notify_if_exceeded	No	string	No	Specifies whether to send an email notification to the customer when the threshold is crossed and the discount no longer applies.
threshold	No	float	Yes	The threshold value is measured either in currency units or time units (minutes), according to the type of discount. Will show "0" for unlimited.
xdr_split	No	string	No	When a session spans several rating periods (e.g. covers both peak and off-peak periods) it is divided into portions. This property specifies whether multiple xDR records will be produced for sessions like this one. Each xDR record will be linked to the applicable discount level / rate.

Rollovers
Property	Mandatory	Type	Nillable	Description	Possible values
amount	No	float	No	The amount of the service volume that has rolled over.
expiration_date	No	date	No	The reset date of the rolled-over discount.

CounterAmountsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
allocated	No	float	No	The amount is allocated during this period and is used as a base for prorating rollovers.
continued	No	int	No	The amount of the used units is carried over on to the next period when counter is reset within a regular period.
money_continued	No	float	No	The amount of the used monetary is carried over on to the next period when counter is reset within a regular period.

CounterRolloversInfo
Property	Mandatory	Type	Nillable	Description	Possible values
rollover0	No	float	No	The rolled over quota amount will be expired in the current counter usage period.
rollover1	No	float	No	The rolled over quota amount will be expired in the next counter usage period.
rollover2	No	float	No	The rolled over quota amount will be expired in the +2 counter usage period.
rollover3	No	float	No	The rolled over quota amount will be expired in the +3 counter usage period.

CounterThresholdModifiersInfo
Property	Mandatory	Type	Nillable	Description	Possible values
threshold_multiplier	No	float	No	The multiplication modifier for thresholds on prorated counter.
threshold_shift	No	float	No	The additive modifier for thresholds on the shifted base (rolled over) counter.

ObjectPermissions
Property	Mandatory	Type	Nillable	Description	Possible values
attributes	Yes	Array of AttributePermission structure	No	A list of ACL permissions for this web interface object.
object	Yes	string	No	The web interface object for which the ACL permissions were collected.

SessionNodeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_node	No	unsignedLong	No	The unique ID of the node.
i_node_type	No	unsignedLong	No	The unique ID of the node type.
ip	No	string	No	The IP address of the node.
manufacturer	No	string	No	The manufacturer of the node.
node_name	No	string	No	The logical name of the node.
node_type	No	string	No	The node type.
order	No	int	No	The order number of the node in the session nodes chain.

BundleDiscountThresholdInfo
Property	Mandatory	Type	Nillable	Description	Possible values
discount	Yes	float	No	The amount of the discount that applies to the threshold set.
threshold	Yes	float	No	The threshold of the bundle promotion criterion. 0 means that te threshold is unlimited.

CBCNumberPatternInfo
Property	Mandatory	Type	Nillable	Description	Possible values
number	No	string	No	The call barring class number pattern. Expected input pattern: "ANONYMOUS" or a number in the E.164 format. Supported characters: 'a-D','0-9','%','#','_','*','x'.

CodecStorageKeysInfo
Property	Mandatory	Type	Nillable	Description	Possible values
a_law	No	string	No	Storage key for the codec a_law.
g723	No	string	No	Storage key for the codec g723.
g729	No	string	No	Storage key for the codec g729.
mp3	No	string	No	Storage key for the codec mp3.
u_law	No	string	No	Storage key for the codec u_law.
wav	No	string	No	Storage key for the codec wav.

CPPeriodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
commission	Yes	float	No	The commission used for period of the commission plan.
i_cp_period	No	unsignedLong	No	The unique ID of the commission plan period.
periods	Yes	int	No	The boundary number of the period for which the commission is effective.

CPServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_service	No	unsignedLong	No	The unique ID of the commission plan service.
i_service	No	unsignedLong	Yes	The unique ID of the service.
periods	Yes	Array of CPPeriodInfo structure	No	The list of periods used on service of commission plan.

CPSubscriptionInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_cp_subscription	No	unsignedLong	No	The unique ID of the commission plan subscription.
i_subscription	No	unsignedLong	Yes	The unique ID of the subscription.
one_time_commission	No	float	No	The amount of the one-time commission.
periods	Yes	Array of CPPeriodInfo structure	No	The boundary number of the period for which the commission is effective.

TaxationOptionsAvalara
Property	Mandatory	Type	Nillable	Description	Possible values
business_class	No	string	No	Describes a company as a service provider. Possible values: ILEC - This is a telephone company that owns most of the local loops and facilities in a serving area; CLEC - This is a company that builds and operates communication networks within areas, providing its customers with an alternative to the local telephone company within the existing ILEC's territory.
county_exempt	No	string	No	Exempt from county taxes.
customer_type	No	string	No	The type of customers who use the service. Possible values: industrial - These are manufacturing companies; business - These are business entities that use the services for business purposes; residential - These are customers that use the services for personal purposes.
facilities_based	No	string	No	This defines if a company owns or controls facilities for providing telecommunication services.
federal_exempt	No	string	No	Exempt from federal taxes.
franchise	No	string	No	This defines if a company provides services under a franchise agreement. Possible values: Y, N.
incorporated_area	No	string	No	The location of the customer. Possible values: inside - Located inside an incorporated city area; outside - Located outside an incorporated city area.
lifeline_program	No	string	No	Defines a company as entitled to a Lifeline assistance program. Possible values: Y, N.
local_exempt	No	string	No	Exempt from local taxes.
regulated	No	string	No	Defines whether a company is regulated by the regulatory commission in the state where the services are provided. Possible values: Y, N.
service_class	No	string	No	Defines the primary activity. Possible values: local - If more than 50% revenue is received from local calls; long_distance - If more than 50% revenue is received from long distance calls.
state_exempt	No	string	No	Exempt from state taxes.
taxation_mode	No	string	No	Defines which taxes will be calculated for a customer. Possible values: not_switched - Tax is calculated based on the number of DID numbers a customer uses; switched - Taxes are calculated for the number of customer sites and extensions and the number of an IP Centrex customer's simultaneous outgoing calls.
transaction_codes	No	Array of TransactionCodes structure	No	The set of transaction codes available for this taxation plugin.
voipa	No	string	No	VoIP Taxation; Available options: normal, aggressive.

TaxationOptionsBillsoft
Property	Mandatory	Type	Nillable	Description	Possible values
county_exempt	No	string	No	Exempt from county taxes.
customer_type	No	string	No	Type of the customer; one of the following: Default, Business, Residential.
federal_exempt	No	string	No	Exempt from federal taxes.
incorporated_area	No	string	No	Incorporated City Area; one of the following: Default, Inside, Outside.
local_exempt	No	string	No	Exempt from local taxes.
reseller_regulated	No	string	No	Reseller’s status in the sale; one of the following: Default, Regulated, Unregulated.
reseller_voipa	No	string	No	VoIP Taxation; one of the following: Default, Normal, Aggressive.
state_exempt	No	string	No	Exempt from state taxes.
taxation_mode	No	string	No	Specifies which additional taxes will be calculated for a customer. The objects that are taxed depend both on the Taxation Mode and on the VoIP Taxation configuration. Possible values: not_switched - Taxation is applied based on the number of lines the customer uses; switched - Taxation is applied based on the number of trunks, extensions and outbound channels that the customer uses.
transaction_codes	No	Array of TransactionCodes structure	No	The set of transaction codes available for this taxation plug-in.

TaxationOptionsCustom
Property	Mandatory	Type	Nillable	Description	Possible values
applied_to	No	string	No	This field shows which services this tax is applied to.
i_option	Yes	unsignedLong	No	The unique ID of the custom tax option.
is_apply	Yes	string	No	Indicates whether the custom tax option has been applied(flag - Y/N).
name	Yes	string	No	The name of the custom tax option.
tax_percent	Yes	string	No	A percentage value for the custom tax option.

TaxationOptionsGST
Property	Mandatory	Type	Nillable	Description	Possible values
certificate	No	string	No	The relief certificate code that applies a 0% tax to goods.
expiration_date	No	date	No	Indicates when the relief certificate expires.
goods	No	string	No	The goods that fall under the relief certificate with the 0% tax.
transaction_codes	No	Array of TransactionCodes structure	No	The set of transaction codes available for this taxation plug-in.

TaxationOptionsSureTax
Property	Mandatory	Type	Nillable	Description	Possible values
decimal_digits	No	int	No	The number of decimal digits for rounding the taxes. Possible values: 2; 3; 4; 5; no value – The customer class settings apply.
exemption_codes	No	Array of ExemptionCodeInfo structure	No	The set of exemption codes available for this taxation plug-in.
regulatory_code	No	string	No	Regulatory code. Possible values: 00 – ILEC; 01 – IXC; 02 – CLEC; 03 – VOIP (used when 'default' is specified); 04 – ISP; 05 – Wireless; 99 – Non-Telecom; default – The customer class settings apply.
sales_type	No	string	No	The type of a customer involved in the transaction. Possible values: B – The customer pays taxes as a legal entity; I – Transactions are made at an industrial business; L – Transactions are made by the customer granted a subsidy; R – The customer pays taxes as a private individua; default – The customer class settings apply.
summary_type	No	string	No	Specifies whether federal, state and local taxes are displayed summarized. Possible values: 0 – federal, state and local taxes are displayed separately; 1 – federal, state and local taxes are displayed summarized; default – The customer class settings apply.
tax_exemption	No	string	No	The name of the tax exemption as specified in the SureTax_Exemption_C odes table in the database. Default – The customer class settings apply.
transaction_codes	No	Array of TransactionCodes structure	No	The set of transaction codes available for this taxation plug-in.

TaxationOptionsVat
Property	Mandatory	Type	Nillable	Description	Possible values
exempt	Yes	string	Yes	Exempt From Tax - Y/N.
percent	No	float	Yes	VAT percentage.
transaction_codes	No	Array of TransactionCodes structure	No	The set of transaction codes available for this taxation plug-in.
xdr_per_service	No	int	No	This allows you to calculate taxes per service (and respectively show them in the invoices).

TariffSellInfo
Property	Mandatory	Type	Nillable	Description	Possible values
description	No	string	No	The resale tariff description. Only used if the i_tariff_sell property is not defined.
exchange_rate	No	float	No	A custom exchange rate. If empty or not defined, the current exchange rate will be used. Only used if the i_tariff_sell property is not defined.
markup_fixed_amount	No	float	No	Specifies the fixed amount to be added to the resale tariff if (only if) the calculated percentage markup is lower than this one. Only used if the i_tariff_sell property is not provided.
markup_percent	No	float	No	Specifies a percentage markup for the resale tariff as compared with the wholesale tariff rates. Only used if the i_tariff_sell property is not provided.
name	No	string	No	The name of the resale tariff record (the one that the reseller charges their subresellers). Only used if the i_tariff_sell property is not defined.

CreditLimitChangeCommentInfo
Property	Mandatory	Type	Nillable	Description	Possible values
comment	No	string	No	A comment on the credit limit change.

DialingRuleOptionsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
ac	No	string	No	Area code(s).
cc	No	string	No	Country code.
cs	No	int	No	0 - Routing plan selection disabled, 1 - Routing plan selection enabled.
csdr	No	int	No	1 - Apply the customer dialling rules to a number follows after the selection code.
css	No	int	No	1 - Strip selection code after selection Routing Plan.
dp	No	string	No	Prefix for domestic calls outside area code.
em	No	string	No	Emergency Numbers; comma-separated list .
ex	No	string	No	Exceptions; comma-separated list .
ia	No	int	No	1 - Always Dial the Area Code as a part of the number.
ip	No	string	No	International dialing prefix.
location	No	string	No	Indicates where the relevant dialing rule belongs: 'I' for an international dialing rule, or 'A' for North America.
nex	No	string	No	National Exceptions; comma-separated list .
nl	No	int	No	Local dialing number length.
op	No	string	No	Prefix for accessing the outside phone network.

DialingCodes
Property	Mandatory	Type	Nillable	Description	Possible values
bypass_dial_plan	No	string	Yes	A feature access code (e.g. 3164).
call_park	No	string	Yes	An end user can dial this code to park a call. The default value is *70.
call_release	No	string	Yes	An end user can dial this code to retrieve a call from the parked status. The default value is *71.
clir_hide	No	string	Yes	An end user can dial this code before dialing the phone number to hide the calling number from the called party. The default value is *67.
clir_show	No	string	Yes	An end user can dial this code before dialing the phone number to allow displaying the calling number to the called party. The default value is *68.
dial_out	No	string	Yes	An end user can dial this code while on a call to transfer the call to another end user. This feature is available only for forwarded calls. The default value is *66.
group_pickup	No	string	Yes	An end user can dial this code to answer a call arriving to the other accounts of this customer. The default value is *40.
paging_prefix	No	string	Yes	A dial code that allows establishing intercom calls between two extensions. The default value is *33.
voicemail	No	string	Yes	A dial code that allows an end user to access a voicemail. The default value is *98.

EstimatedDIDNumberPricingParameterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
cost	No	EstimatedDIDNumberPriceInfo structure	No	The information about the amounts the reseller/customer pays for using the DID number.
i_customer	No	unsignedLong	Yes	The unique ID of the customer/reseller the estimated prices are related to.
i_do_batch	No	unsignedLong	No	The unique ID of the DID pricing batch that is used to calculate the revenue.
name	No	string	No	The name of the customer/reseller the estimated prices are related to.
revenue	No	EstimatedDIDNumberPriceInfo structure	No	The information about the profit that the reseller earns for selling the DID number.

DIDPricing
Property	Mandatory	Type	Nillable	Description	Possible values
admin_costs	No	DIDCostsInfo structure	No	Shows the costs associated with the DID number and applied to PortaBilling owner (available for administrator users only).
customer_costs	No	DIDCostsInfo structure	No	Shows the DID number price for a customer.
reseller_costs	No	DIDCostsInfo structure	No	Shows the DID number price for a reseller (available for administrator and reseller users only).

DIDMarkupOptionsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_fee	No	float	No	A one-time cost paid by Customer or Reseller for the DID number activation.
base_periodic_fee	No	float	No	A monthly amount charged from Customer or Reseller for the DID number.
external_provisioning	No	string	No	On-Demand provisioning from External Vendor active (Y/N), default - N.
i_vendor	No	unsignedLong	No	The unique ID of the Vendor record.
periodic_fee_markup	No	unsignedLong	No	A monthly fee markup charged from Customer or Reseller for the DID number.
rounding	No	int	No	Quantity of digits after point for rounding.

ExtendedDataEntryInfo
Property	Mandatory	Type	Nillable	Description	Possible values
field	Yes	string	No	The field of the object.
match	No	string	No	The field describes how to match the values with object field.
object	Yes	string	No	The name of the object.
values	Yes	ArrayOfString	No	The filter values.

APIMethodInfo
Property	Mandatory	Type	Nillable	Description	Possible values
access_list	Yes	Array of APIMethodACLInfo structure	No	The list of permissions required to access the method.
input	No	Array of APIMethodFieldInfo structure	No	The structure of fields the API method can take in a request.
name	Yes	string	No	The name of the API method.
output	No	APIMethodFieldInfo structure	No	The structure of fields the API method can return in a response.
realm_list	No	Array of APIMethodRealmInfo structure	No	The list of realms the method is available for.

TemplateBodyInfo
Property	Mandatory	Type	Nillable	Description	Possible values
body_name	No	string	No	The name of the file.
content	No	string	No	The content of the file. For binary data (such as images) it returns a base64 encoded string.
language	No	string	No	The language of the body.
mime_type_id	No	string	No	The MIME type of the file.
rel_file_path	No	string	No	The relative path to the directory where the file is located.
version	No	int	No	The version of the template.

MetricAggregatorInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of an aggregation function to be applied to data points that fit in the same time intervals. Possible values: max - returns the largest value in the interval min - returns the smallest value in the interval sum - sums all values first - returns the first data point for the interval least_squares - returns two points for the range which represent the best fit line through the set of points avg - computes average value last - returns the last data point for the interval gaps - marks gaps in data according to sampling rate with a null data point rate - returns the rate of change between a pair of data points.
unit	Yes	string	No	The name of the sampling time unit for the aggregation function. Possible values: year, month, week, day, hour, min, sec, msec.
value	Yes	int	No	The value of the sampling time unit for the aggregation function. Min value: 1.

MetricFilterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	A tag name. Data points that have the same tag value will be grouped together. Possible values: connection - for connection metrics; cc_staff - for CC staff metrics; ip - for PSMSC metrics.
value	Yes	string	No	The value of the filter field.

MetricGroupingInfo
Property	Mandatory	Type	Nillable	Description	Possible values
filter_list	No	Array of MetricGroupingFilterInfo structure	No	Shows which filter fields will be used to execute data grouping (executes the kairosdb grouping by tags). The field is mandatory if the 'filter' grouping_type is used.
grouping_type	Yes	string	No	Grouping type. Possible values: 'filter', 'time', 'value'.
time_info	No	MetricGroupingTimeInfo structure	No	Shows which time ranges will be used to execute data grouping (executes the kairosdb grouping by time). The field is mandatory if the 'time' grouping_type is used.
value_info	No	MetricGroupingValueInfo structure	No	Shows which values will be used to execute data grouping (executes the kairosdb grouping by value). The field is mandatory if the 'value' grouping_type is used.

PaymentMethod
Property	Mandatory	Type	Nillable	Description	Possible values
ecommerce	No	string	No	Specifies whether the payment method can be used for ecommerce transactions.
i_payment_method	No	unsignedLong	No	The unique ID of the chosen payment method.
icon_url	No	string	No	URL for payment method icon.
name	No	string	No	The public name of a payment method.
online	No	string	No	Specifies whether the payment method can be used online.
payment_method	No	string	No	The internal name of a payment method.
simple_usage	No	string	No	Specifies whether the payment method can be used without any redirections.

GroupIncludedProductInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	Yes	unsignedLong	No	The unique ID of the product record.

DisallowedProducts
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	No	unsignedLong	No	The unique ID of a product record which can't be assigned to an account together with the main product.

ServiceFeaturesConflicts
Property	Mandatory	Type	Nillable	Description	Possible values
addon_precedence	No	string	No	In order to differentiate the add-on products there is also a "precedence level" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level.
conflicting_addons	No	Array of ConflictingAddOns structure	Yes	The list of add-on products with conflicts.
sf_name	No	string	No	Service feature name.

SubscriptionConflicts
Property	Mandatory	Type	Nillable	Description	Possible values
addons	No	Array of ConflictingAddOns structure	Yes	The list of add-on products with conflicts.
i_subscription	No	unsignedLong	No	The unique ID of the subscription plan record.
name	No	string	No	The subscription plan name.

VDPConflicts
Property	Mandatory	Type	Nillable	Description	Possible values
addon_precedence	No	string	No	In order to differentiate the add-on products there is also a 'precedence level' parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level.
conflicting_vdps	No	Array of ConflictingVDPs structure	Yes	The information about conflicting volume discount plans.
service_name	No	string	No	The name of the service.

ServiceAndRatingRoutingInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_acc_routing_tariff	No	unsignedLong	No	Routing plan and tariff pair identifier.
i_accessibility	No	unsignedLong	No	Service&Rating identifier.
i_routing_plan	No	unsignedLong	No	Routing identifier.
i_tariff	No	unsignedLong	No	Tariff identifier.
i_tariff_reseller	No	unsignedLong	No	Tariff identifier(used for resellers product).
reseller_tariff_name	No	string	No	Tariff name(used for resellers product).
routing_plan_name	No	string	No	Routing Plan name.
tariff_name	No	string	No	Tariff name.

OnePeriodSubscriptionPeriodicFeeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
fee	Yes	float	No	The amount of the fee.
i_billing_period	Yes	unsignedLong	No	The unique ID of the Billing Period; refers to the Billing_Period table.
i_subscription	Yes	unsignedLong	No	The unique ID of the Subscription Plan record; refers to Subscriptions table.
i_subscription_fee	No	unsignedLong	No	The unique ID of the Subscription Fee record.
periods	Yes	int	No	The number of billing periods covered by this fee.

RoutingCriteriaDestGroupMetricFlags
Property	Mandatory	Type	Nillable	Description	Possible values
aloc_penalty	No	int	No	Exclude the penalty threshold of the average length of call from the routing criteria.
aloc_warning	No	int	No	Exclude the warning threshold of the average length of call from the routing criteria.
asr_penalty	No	int	No	Exclude the penalty threshold of the average success rate from the routing criteria.
asr_warning	No	int	No	Exclude the warning threshold of the average success rate from the routing criteria.
high_pdd_penalty	No	int	No	Exclude the penalty threshold for the maximum acceptable PDD from the routing criteria.
high_pdd_warning	No	int	No	Exclude the warning threshold of the maximum acceptable PDD from the routing criteria.
low_pdd_penalty	No	int	No	Exclude the penalty threshold of the minimum acceptable PDD from the routing criteria.
low_pdd_warning	No	int	No	Exclude the warning threshold of the minimum acceptable PDD from the routing criteria.
ppm_penalty	No	int	No	Exclude the penalty threshold of the profit per minute from the routing criteria.
ppm_warning	No	int	No	Exclude the warning threshold of the profit per minute from the routing criteria.

ServiceFeatureDetails
Property	Mandatory	Type	Nillable	Description	Possible values
attributes_list	No	Array of ServiceFeatureAttributeDetails structure	No	The list of service feature attributes.
default_flag	No	string	No	Default value of the corresponding service feature item. One of the following: Y – enabled, N – disabled, ^ – customer's default, ~ – product default.
feature_name	No	string	No	Service feature name.
flag_pos	No	int	Yes	Service_flag item position in the service features array.
i_service_feature	No	unsignedLong	No	The unique ID of the service feature.

ServicePoolCombinationInfo
Property	Mandatory	Type	Nillable	Description	Possible values
dg_name	No	string	No	The destination group name.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group.
i_service	No	unsignedLong	No	The ID of the service.
pooled_ratio	No	int	No	The ratio for pooled units.
pooled_unit	No	string	No	The pooled unit.
pooled_unit_ratio	No	string	No	The ratio for pooled units.
service_name	No	string	No	The name of the service.
unit_ratio	No	int	No	The ratio for service pool units.

ChargeUnitInfo
Property	Mandatory	Type	Nillable	Description	Possible values
default_rate_ratio	No	int	No	If billing units are different from base units, this parameter defines how many base units make up one billing unit.
default_rate_unit	No	string	No	The default customer-visible name for the units used to calculate service charges.
i_st_charge_unit	No	unsignedLong	No	The unique ID of the service type charge unit.
name	No	string	No	The name of the service type charge unit.
rating_base	No	string	No	Specification of the particular parameter that is used to calculate charges, e.g. “session time”, “amount of data transferred” and the like.

ServicePolicyAttributePossibleValue
Property	Mandatory	Type	Nillable	Description	Possible values
text	No	string	No	The way the value should be displayed.
value	No	string	No	The possible value of service policy attribute.

AuthorizedEmailInfo
Property	Mandatory	Type	Nillable	Description	Possible values
disabled	No	string	No	Disable tariff upload from this source.
email_from	No	string	No	Sender’s email; to prevent unauthorized access, only a trusted email will be allowed.
email_key	No	string	No	Security key; the tariff will be accepted only if the correct key is specified in the message’s subject line or body.
i_tariff_template	No	unsignedLong	No	The unique ID of the tariff template DB record.

TaxPluginTransactionCodeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
code	No	string	No	The value of the taxation code.
i_plugin	Yes	unsignedLong	No	The unique identifier of the taxation plugin.

MediaAttributeValueInfo
Property	Mandatory	Type	Nillable	Description	Possible values
editor_value	No	string	No	The value of the attribute shown on the Web Interface.
value	No	string	No	The value of the attribute.

SessionLogMessage
Property	Mandatory	Type	Nillable	Description	Possible values
meta_info	No	SessionLogMessageMetaInfo structure	No	Meta information of the session log message.
text	No	string	No	The text of the session log message.
type	No	string	No	The type of the session log message.

SessionLogMetaInfo
Property	Mandatory	Type	Nillable	Description	Possible values
call_id	No	string	No	The ID of the service session.
cld_list	No	ArrayOfString	Yes	The list of the called line phone numbers.
cli_list	No	ArrayOfString	Yes	The list of the calling line phone numbers.
end_time	No	string	No	The end time of the session.
h323_conf_id	No	string	No	The ID of the billing session.
merged_call_id_list	No	Array of SessionLogIdInfo structure	No	The list of the merged service sessions' IDs.
node_list	No	ArrayOfString	No	The list of the SIP log nodes related to the session.
participant_list	No	Array of SessionParticipantInfo structure	No	The list of the participants of the session.
response_code	No	int	No	The code of the response. 0 - all log messages are fetched, 1 - log messages limit is reached, 2 - timeout is reached.
session_list	No	ArrayOfString	No	The list of the related billing session IDs.
start_time	No	string	No	The start time of the session.

SessionLogNodeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
node	No	string	No	The IP address of SIP node.

UAProfileParameterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The UA profile parameter name.
skip	No	string	No	The flag shows whether to skip the parameter if partial profile configuration is enabled. Possible values: Y, N.
value	No	string	No	The UA profile parameter value.

UAPortConfiguration
Property	Mandatory	Type	Nillable	Description	Possible values
account_id	No	string	No	The ID of the account.
allowed_services	No	Array of UAPortApplicableServiceInfo structure	No	The list that contains info about services available for this port. Only for multiservice devices.
i_account	No	unsignedLong	No	The unique integer identifier of account record in the PortaBilling(TM) database.
i_service_type	No	unsignedLong	No	Shows the type of the service this port is currently used for. Only for multiservice devices.
physical_interface_number	No	int	No	For devices that have different types of physical interfaces this field contains the physical interface number.
port	Yes	int	No	The port number.
release_allowed	No	string	No	The flag shows if the port can be released. Possible values: Y, N.

RoamingCountries
Property	Mandatory	Type	Nillable	Description	Possible values
high_risk	No	ArrayOfString	No	A country (or countries) from where any usage is considered a security breach and triggers immediate action.
no_restriction	No	ArrayOfString	No	A country (or countries) where users are expected to use the service.
suspicious	No	ArrayOfString	No	A country (or countries) from where it would be unusual for a user to use the service.

RoamingPolicyInfo
Property	Mandatory	Type	Nillable	Description	Possible values
high_risk	No	RoamingPolicyHighRiskInfo structure	No	The policy for countries from where any usage is considered a security breach and triggers immediate action.
suspicious	No	RoamingPolicySuspiciousInfo structure	No	The policy for countries from where it would be unusual for a user to use the service.

XDRStatsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
imported	No	int	No	The number of succesful imported of xDR records.
rejected	No	int	No	The number of rejected xDR records.
skipped	No	int	No	The number of skipped xDR records.
todo	No	int	No	The number of xDR records to be processed.
total	No	int	No	The total number of the xDR records in the collection.

RadiusAttributeData
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the Radius attribute.
value	Yes	string	No	The value of the Radius attribute.

XDRErrorStatsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
account_charge_error	No	int	No	The number of the xDR records rejected due to account charge error.
other_error	No	int	No	The number of the xDR rejected records with not classified error.
radius_error	No	int	No	The number of the xDR records rejected due to Radius error.
vendor_charge_error	No	int	No	The number of the xDR records rejected due to vendor charge error.

AccessObjectPermission
Property	Mandatory	Type	Nillable	Description	Possible values
attributes	No	Array of AccessAttributePermission structure	No	The permissions for attributes of the access object.
name	Yes	string	No	The name of the access object.
permission	No	int	No	The permission for the access object.

AttributePermission
Property	Mandatory	Type	Nillable	Description	Possible values
attribute	Yes	string	No	An attribute name.
permissions	Yes	string	No	String representation of attribute permissions in the "CRUD" format (1-granted, 0- revoked): create, read, update, delete. For example, 1100 means that only the create and read permissions are granted to a specific user.

TransactionCodes
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the transaction code.
value	Yes	string	No	The value of the transaction code.

EstimatedDIDNumberPriceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation_fee	Yes	float	No	A one-time amount paid for the DID number activation.
periodic_fee	Yes	float	No	A monthly amount paid for using this DID number.

DIDCostsInfo
Property	Mandatory	Type	Nillable	Description	Possible values
activation	No	float	No	A fee applied for a DID number allocation.
free_of_charge	No	string	No	Indicates whether this number is completely free of charge or not.
iso_4217	No	string	No	ISO 4217 code of the currency in which the fee is applied.
periodic	No	float	No	A periodic fee applied for the DID number usage.

APIMethodACLInfo
Property	Mandatory	Type	Nillable	Description	Possible values
attribute	No	string	Yes	The name of the ACL attribute.
object	No	string	Yes	The name of the ACL object.
permission	No	int	Yes	The permission level that is needed. Possible values: 1 - read permission is required, 2 - modify permission is required.

APIMethodFieldInfo
Property	Mandatory	Type	Nillable	Description	Possible values
access_list	Yes	Array of APIMethodACLInfo structure	No	The permissions needed to access the field.
array_item	No	APIMethodFieldInfo structure	No	The information about an item in the array. Present only if the field type is 'array'.
mandatory	Yes	int	No	Shows whether the field in the structure is mandatory.
name	No	string	No	The name of the API method field.
object_field_list	No	Array of APIMethodFieldInfo structure	No	The list of fields in the object. Present only if the field type is 'object'.
type	Yes	string	No	The data type of the API method field.

APIMethodRealmInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the realm.

MetricGroupingFilterInfo
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	A filter field name. Data points that have the same tag value will be grouped together. Possible values: connection - for connection metrics; cc_staff - for CC staff metrics; ip - for PSMSC metrics.

MetricGroupingTimeInfo
Property	Mandatory	Type	Nillable	Description	Possible values
group_count	Yes	int	No	Shows how many data groups should be created. Min value: 1.
unit	No	string	No	A sampling time unit. Possible values: year, month, week, day, hour, min, sec, msec.
value	Yes	int	No	The value of the sampling time unit. Min value: 1.

MetricGroupingValueInfo
Property	Mandatory	Type	Nillable	Description	Possible values
range_size	Yes	string	No	The size of each group in the response. The data will be grouped into ranges of the specified size. Min value: 1.

ConflictingAddOns
Property	Mandatory	Type	Nillable	Description	Possible values
i_product	No	unsignedLong	No	The unique ID of a product record.
is_sf_enabled	No	int	No	Specifies whether service features have been enabled.
product_name	No	string	No	Product name.

ConflictingVDPs
Property	Mandatory	Type	Nillable	Description	Possible values
dg_name	No	string	No	The name of the destination group.
effective_from	No	dateTime	No	The date and time when the add-on product will be activated.
effective_to	No	dateTime	No	The date and time when the add-on product will expire.
i_dest_group	No	unsignedLong	No	The unique ID of the destination group record.
i_product	No	unsignedLong	No	The unique ID of the product record.
i_vd_plan	No	unsignedLong	No	The unique ID of the volume discount plan record.
product_name	No	string	No	The name of the product.
service_name	No	string	No	The name of the service.
vdp_name	No	string	No	The name of the volume discount plan.

ServiceFeatureAttributeDetails
Property	Mandatory	Type	Nillable	Description	Possible values
default_value	No	string	Yes	Service feature attribute default value.
i_sattribute	No	unsignedLong	Yes	The unique ID of the service feature attribute.
multivalue	No	string	No	Indicates whether multiple value entries are allowed.
name	No	string	No	Service feature attribute name.

SessionLogMessageMetaInfo
Property	Mandatory	Type	Nillable	Description	Possible values
cld	No	string	No	The called line identification.
cli	No	string	No	The calling line identification.
datetime	No	string	No	The precise date and time when the message was generated.
diagramtext	No	string	No	The text which is shown on the diagram.
dialog_id	No	string	No	The ID of the dialog the current log message belongs to.
level	No	int	No	The level of the log message.
message_class	No	string	No	The class of the log message.
operation	No	string	No	The type of the operation.
participant_from	No	string	No	The participant that generated the SIP message.
participant_from_id	No	string	No	The unique identifier of the participant that generated the SIP message.
participant_to	No	string	No	The participant that received the SIP message.
participant_to_id	No	string	No	The unique identifier of the participant that received the SIP message.
session_id	No	string	No	The h323-conf-id or call-id of the session.
sip_node	No	string	No	The IP address of the SIP node.
source_ip	No	string	No	The source IP address.
user_name	No	string	No	The user name.

SessionParticipantInfo
Property	Mandatory	Type	Nillable	Description	Possible values
alias	No	string	No	The alias of the participant.
host	No	string	No	The host name of the participant.
name	No	string	No	The name of the participant.
participant_id	No	string	No	The unique identifier of the participant.
product_name	No	string	No	The product name of the participant.
sip_node	No	string	No	The IP address of the SIP node.

UAPortApplicableServiceInfo
Property	Mandatory	Type	Nillable	Description	Possible values
i_service_type	Yes	unsignedLong	No	The service type.

RoamingPolicyHighRiskInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	No	string	No	The action that is taken in case of calls from the countries in the "high_risk" list. Supported actions: screen, quarantine, reject.

RoamingPolicySuspiciousInfo
Property	Mandatory	Type	Nillable	Description	Possible values
action	No	string	No	The action that is taken in case of calls from the countries in the "suspicious" list. Supported actions: screen, reject.
attempts	No	int	No	Defines how many calls a customer can make without screening from the countries in the "suspicious" list when the "action" is set to "screen".

AccessAttributePermission
Property	Mandatory	Type	Nillable	Description	Possible values
name	Yes	string	No	The name of the access attribute.
permission	No	int	No	The permission for the access attribute.

Examples of usage

PortaBilling SOAP communication

Retrieve a customer with accounts

This script retrieves customer data, outputs the desired information about him and shows the list of his accounts.


#!/usr/bin/perl

use SOAP::Lite
#    +trace=>'debug'
    ;
use Encode;
use strict;
use warnings;
use Data::Dumper;

# If the server certificate is not trusted (e.g. it was not issued by a
# trusted certificate authority), then ignore it.
$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME}=0;

binmode(STDOUT, ':utf8');

my $proxy_host = 'https://127.0.0.1'; # Porta-Billing Admin Server
my $proxy_port = '443';

my $login = 'pb-root';
my $password = 'pb-root';

my $uri_base = 'http://portaone.com/Porta/SOAP';
my $proxy = "$proxy_host:$proxy_port/soap/";

my %uris = (
    'Session' => "$uri_base/Session",
    'Account' => "$uri_base/Account",
    'Customer' => "$uri_base/Customer",
);

sub fault_handler {
    my ($soap, $res) = @_;
    die "SOAP Fault: $!, " . (ref $res ? $res->faultstring
                          : $soap->transport->status)
        ;
}

my $session_service = SOAP::Lite
        ->uri($uris{'Session'})
        ->proxy($proxy)
        ->on_fault(\&fault_handler)
        ;

my $customer_service = SOAP::Lite
        ->uri($uris{'Customer'})
        ->proxy($proxy)
        ->on_fault(\&fault_handler)
        ;

my $account_service = SOAP::Lite
        ->uri($uris{'Account'})
        ->proxy($proxy)
        ->on_fault(\&fault_handler)
        ;

# required to support dateTime type
$session_service->serializer()
        ->xmlschema('http://www.w3.org/2001/XMLSchema');
$customer_service->serializer()
        ->xmlschema('http://www.w3.org/2001/XMLSchema');
$account_service->serializer()
        ->xmlschema('http://www.w3.org/2001/XMLSchema');

my $LoginResponse = $session_service->( { login => $login, password => $password } );

my $session_id = $LoginResponse->result->{session_id};

print "Logged in with session $session_id\n";

my $header = SOAP::Header->name('auth_info')
        ->value({ session_id => $session_id })
        ;

eval {
    my $GetCustomerInfoRequest = {
        i_customer => 1
    };
    my $GetCustomerInfoResponse
        = $customer_service->get_customer_info(
            $header, $GetCustomerInfoRequest
        )->result;

    if (! $GetCustomerInfoResponse->{'customer_info'}) {
        die "No customer found\n";
    }
    my $CustomerInfo = $GetCustomerInfoResponse->{'customer_info'};

    print "Customer Name: $CustomerInfo->{'name'}\n"
        . "Email: $CustomerInfo->{'email'}\n"
        . "Balance: $CustomerInfo->{'balance'} "
        . $CustomerInfo->{'iso_4217'} . "\n"
        ;

    # listing accounts under this customer.
    my $has_more_accounts = 1;
    my $limit = 5;
    my $offset = 0;

    ACCOUNT_LIST:
        while ($has_more_accounts) {
            my $GetAccountListRequest = {
                i_customer => 1,
                limit => $limit,
                offset => $offset
            };

        my $GetAccountListResponse
            = $account_service->get_account_list(
                $header, $GetAccountListRequest
            )->result;

        if (! $GetAccountListResponse->{'account_list'}) {
            last ACCOUNT_LIST;
        }

        my $account_list = $GetAccountListResponse->{'account_list'};

        if (@$account_list < $limit) {
            $has_more_accounts = 0;
        }

        for my $AccountInfo (@$account_list) {
            print " Account ID: $AccountInfo->{'id'}\n"
            . " Balance: $AccountInfo->{'balance'}"
            . " $AccountInfo->{'iso_4217'}\n"
            ;
        }

        $offset += $limit;
    }
};

if ($@) {
    print "An error occurred: $@\n";
}

# logging out is required
$session_service->logout( { session_id => $session_id } );

exit 0;

Update customer information

This script retrieves customer data, outputs the desired information about him and modifies customer’s e-mail address.


#!/usr/bin/perl

use strict;
use warnings;

# Include perl module which is
# SOAP-client/SOAP-server implementation
# For more details, please, refer to 'perldoc SOAP::Lite'
# Debug trace is automatically turned on when
# environment variable DEBUG is set.

use SOAP::Lite +trace => $ENV{DEBUG} ? 'debug' : '-all';

# If the server certificate is not trusted (e.g. it was not issued by a
# trusted certificate authority), then ignore it.
$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME}=0;

# Soap server FQDN
# (actually WEB server's address or IP address)
# PUT your WEB server address here!

my $soap_server = 'server_name.com';

# URL of soap service

my $soap_proxy = qq{https://$soap_server/soap/};

# URI string for session SOAP client.
# Basically it looks like
# 'proto://server/Porta/SOAP/SomeModule' where
# 'proto://server/' is just ignored, whereas 'Porta/SOAP/SomeModule' is
# important (behind the scene it is translated into
# Porta::SOAP::SomeModule
# Actually you can take a look into
# /home/porta-admin/site_lib/Porta/SOAP/
# and you will see there main modules for
# Session, Account, Customer clients and others

my $session_client_uri = qq{https://$soap_server/Porta/SOAP/Session};
my $customer_client_uri= qq{https://$soap_server/Porta/SOAP/Customer};

# SOAP user.
# Put your user credentials here!

my $soap_user = 'USER_LOGIN';
my $soap_passwd = 'USER_PASSOWRD';

# this one is supposed to keep session identifier

my $session_id = undef;

# Creating new SOAP client for establishing SOAP session
# and feed it with all required parameters

my $soap_session_client = SOAP::Lite->new();
$soap_session_client->proxy($soap_proxy);
$soap_session_client->uri($session_client_uri);

# This is an error handler adjustment

$soap_session_client->on_fault(sub { return on_fault_handler(@_); } );

# Sending login request to the SOAP server according to
# https:///wsdl/SessionAdminService.wsdl
# login request accepts 2 parameters: login and password

my $login_response = $soap_session_client->login( { login => $soap_user, password => $soap_passwd } );

# Here we obtain session id.
# Again: to discover what is returned we refer to
# WSDL document located at the WEB server
#(https:///wsdl/SessionAdminService.wsdl)
# and see that the data structure is returned with
# a single field: 'session_id'

$session_id = $login_response->result()->{session_id};

# Here we create SOAP header. We need it in order to
# notify SOAP server that we've been already
# authenticated (header contains session identifier
# taken from login response earlier)

my $soap_header = SOAP::Header->new();
$soap_header->name('auth_info')->value({'session_id' => $session_id});
trace("started new session (session id: $session_id)");

# Here we make new soap client which will handle
# customer-related requests/responses

my $soap_customer_client = SOAP::Lite->new();
$soap_customer_client->proxy($soap_proxy);
$soap_customer_client->uri($customer_client_uri);

# Here the support of additional data types is added

$soap_customer_client->serializer()-
>xmlschema('http://www.w3.org/2001/XMLSchema');
$soap_customer_client->on_fault(sub { return on_fault_handler(@_); } );

# now we are about to get information about customer
# (whose name is 'retail-customer').
# At first we will obtain information about customer and display it.
# Then we will change his email address.

# Customer info request is described within Types.xsd
# (https:///wsdl/Types.xsd)

my $customer_info_request = {
    'name' => 'retail-customer'
};

# Here we call ‘get_customer_info’ method.
# How do we know the name of the method?
# We have just to take a look into corresponding
# WSDL document (i.e.
# https:///wsdl/CustomerAdminService.wsdl
# in this case)
#
# Finally, customer info response is described within Types.xsd

my $customer_info_response = $soap_customer_client->get_customer_info(
    $soap_header,
    $customer_info_request
);

my $customer_data = $customer_info_response->result();
my $customer_info = $customer_data->{'customer_info'};

# Here we just output some data about customer

print_customer_info($customer_info);
# Here we about to change email for our test customer.
# if email was not set or doesn't equal to
# 'retail-customer@somewhere.com'
# then we change it to
# 'retail-customer-renamed@somewhere.com'
# otherwise we set it to 'retail-customer@somewhere.com'

if ( ! $customer_info->{'email'} || $customer_info->{'email'} ne
'retail-customer@somewhere.com' ) {
    $customer_info->{'email'} = 'retail-customer@somewhere.com';
}
else {
    $customer_info->{'email'} = 'retail-customer-
renamed@somewhere.com';
}

trace(sprintf("$/Changing customer's email address to '%s'$/",
$customer_info->{'email'}));

# Here we update customer information:
# Again: required parameters for update_customer method
# are described in https:///wsdl/
# CustomerAdminService.wsdl and types of parameters described in
# https:///wsdl/Types.xsd

my $update_customer_response = $soap_customer_client->update_customer(
    $soap_header,
    { 'customer_info' => $customer_info }
);

my $yet_another_customer_info_response = $soap_customer_client-
>get_customer_info(
    $soap_header,
    $customer_info_request
);
my $customer_data_updated = $customer_info_response->result();
my $customer_info_updated = $customer_data_updated->{'customer_info'};
print_customer_info($customer_info_updated);

# Subroutine which is in charge of handling SOAP errors

sub on_fault_handler {
    my($soap, $res) = @_;
    use Data::Dumper;
    printf(STDERR "RES: %s$/", Dumper($res));
    my $err = ref $res ? $res->faultstring() : $soap->transport-
>status();
    die(sprintf("FATAL: %s, %s$/", $! ? $! : 'error', $err ? $err :
'unknown error'));
}

sub trace {
    my($message) = @_;
    if ( defined($message) ) {
        printf(STDERR "%s$/", $message);
    }
}
sub print_customer_info {
    my($customer_info) = @_;

    if ( ref($customer_data) ne 'GetCustomerInfoResponse' ) {
        die("Customer data structure is expected");
    }

    my %map_param_title = (
        'name' => 'Customer',
        'email' => 'E-mail'
    );

    printf(STDERR "Customer info:$/");
    while ( my($param, $title) = each(%map_param_title) ) {
        printf(STDERR "\t%-10s: %s$/",
            defined($title) ? $title : '',
            defined($customer_info->{$param}) ?
    $customer_info->{$param} : '');
    }
}

Create a customer and accounts

This script is an example of how to do a customer/account import from an external system (such as an order entry system).
The general workflow of this script is:

Verify that a customer with such an ID does not already exist (get_customer_info is used for this);
Create a new customer with the given attributes (add_customer is used);
Add several accounts under the newly created customer
- Check that there is no account with such an ID (get_account_info is used);
- Just skip and proceed with the next account if an account with such an ID exists;
- Add a new account (add_customer).


#!/usr/bin/perl

use strict;
use warnings;
use Data::Dumper;
# Include perl module which is a
# SOAP-client/SOAP-server implementation
# For more details, please, refer to the 'perldoc SOAP::Lite'
# Debug trace is automatically turned on when environment
# variable DEBUG is set.

use SOAP::Lite +trace => $ENV{DEBUG} ? 'debug' : '-all';

# If the server certificate is not trusted (e.g. it was not issued by a
# trusted certificate authority), then ignore it.
$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME}=0;

# ==========PARAMETERS SECTION============
#
# ==== YOU SHOULD CONFIGURE PARAMETERS HERE ====
# ===== SET ALL PARAMETERS MARKED BY '!!!' =====

# SOAP server FQDN (actually WEB server's address or IP address)
# PUT your WEB server address here

# !!! SET SERVER NAME OR IP BELOW
my $soap_server = 'server_name.com';

# SOAP user
# PUT your user credentials here

my $soap_user = 'USER_NAME'; # !!! SET USER HERE
my $soap_passwd = 'PASSWORD'; # !!! SET USER’S PASSWORD HERE

# Info about customer which will be added

my $customer_info = {
# !!! SET the name of the customer that will be created
    name => 'NEW_CUSTOMER_NAME',
# !!! SET the currency that will be used for the customer
    iso_4217 => 'USD',

# Actually you can add here other settings for customer
# according to wsdl document
# You can generate them or get by other SOAP requests....
};

# Info about accounts that will be added.
# !!! SET THE LIST OF ACCOUNT IDs
# in ('1','2',...,'x') format
my @ids = ('0009991', '0009992', '0009993');

my $account_info = {
# !!! SET id of the product which will be used during
# accounts creation
    i_product => 1,
# !!! SET account billing model:
# '1' - for credit, '-1' - for debit
    billing_model => 1,
# !!! SET activation date for accounts
    activation_date => '2011-11-01',

# Actually you can add here other settings for accounts
# according to wsdl document
};

# =======================================================
# =======================================================

# URL of soap service

my $soap_proxy = qq{https://$soap_server/soap/};

# URI string for session SOAP client.
# Basically it looks like
# 'proto://server/Porta/SOAP/SomeModule' where
# 'proto://server/' is just ignored, whereas
# 'Porta/SOAP/SomeModule' is
# important (behind the scene it is translated into
# Porta::SOAP::SomeModule
# Actually you can take a look into
# /home/porta-admin/site_lib/Porta/SOAP/ and
# you will see there main modules for
# Session, Account, Customer clients and others

my $session_client_uri = qq{https://$soap_server/Porta/SOAP/Session};
my $customer_client_uri= qq{https://$soap_server/Porta/SOAP/Customer};
my $account_client_uri=qq{https://$soap_server/Porta/SOAP/Account};

# this one is supposed to keep session identifier

my $session_id = undef;

# creating new SOAP client for establishing SOAP session
# and feed it with all required parameters

my $soap_session_client = SOAP::Lite->new();
$soap_session_client->proxy($soap_proxy);
$soap_session_client->uri($session_client_uri);

# this is an error handler adjustment

$soap_session_client->on_fault(sub { return on_fault_handler(@_); } );

# sending login request to the SOAP server according to
# https:///wsdl/SessionAdminService.wsdl
# login request accepts 2 parameters: login and password

my $login_response = $soap_session_client->login( { login => $soap_user, password => $soap_passwd } );

# here we obtain session id.
# Again: to discover what is returned we refer to
# WSDL document located at the portabilling web server
# (https:///wsdl/SessionAdminService.wsdl)
# and see that the data structure is returned with
# single field: 'session_id'

$session_id = $login_response->result()->{session_id};

# here we create SOAP header. We need it in order to notify SOAP server
# that we've been already authenticated (header contains
# session identifier taken from login response earlier)

my $soap_header = SOAP::Header->new();
$soap_header->name('auth_info')->value({'session_id' => $session_id});
trace("started new session (session id: $session_id)");

# here we make a new soap client which will handle
# customer-related requests/responses

my $soap_customer_client = SOAP::Lite->new();
$soap_customer_client->proxy($soap_proxy);
$soap_customer_client->uri($customer_client_uri);

# here the support of additional data types is added
$soap_customer_client->serializer()-
>xmlschema('http://www.w3.org/2001/XMLSchema');
$soap_customer_client->on_fault(sub { return on_fault_handler(@_); } );

# here we make a new soap client which will handle
# account-related requests/responses

my $soap_account_client = SOAP::Lite->new();
$soap_account_client->proxy($soap_proxy);
$soap_account_client->uri($account_client_uri);

# here the support of additional data types is added

$soap_account_client->serializer()-
>xmlschema('http://www.w3.org/2001/XMLSchema');
$soap_account_client->on_fault(sub { return on_fault_handler(@_); } );

# --- Add customer ---

# At first we are about to get customer information
#(whose name we are going to add) to check possibility of adding

my $customer_info_request = {
    'name' => $customer_info->{name},
};

# Here we call ‘get_customer_info’ method.
# How do we know the name of the method?
# We have just to take a look into corresponding WSDL
# document (i.e.
# https:///wsdl/CustomerAdminService.wsdl
# in this case)
# Finally, customer info response is described within Types.xsd

my $customer_info_response = $soap_customer_client->get_customer_info(
    $soap_header,
    $customer_info_request
);

# For example, we should stop script if customer with this name already
# exists

my $customer_data = $customer_info_response->result();
if ( $customer_data && $customer_data->{'customer_info'} ) {
    die("Customer with the name '" . $customer_info->{name} . "'
already exists");
};

# try to add customer

my $add_customer_response = $soap_customer_client->add_customer(
    $soap_header,
    { 'customer_info' => $customer_info }
);

# Check response and print some info

my $add_cust_resp_data = $add_customer_response->result();

# We will save i_customer parameter. We need it for
# accounts adding in future

my $i_customer;
if ( $add_cust_resp_data && $add_cust_resp_data->{i_customer} ) {
    $i_customer = $add_cust_resp_data->{i_customer};
    printf(STDERR "Added customer i_customer=%s$/", $i_customer);
} else {
# Actually it is impossible situation when there is no
# i_customer info in response but still
    printf(STDERR "Wrong answer from server during customer adding$/");
}

# Put i_customer to account info structure.
# It is a mandatory parameter for add_account method

$account_info->{i_customer} = $i_customer;

# --- Add accounts ---

foreach my $account_id ( @ids ) {
    # now we are about to get account information to
    # check possibility of adding
    my $account_info_request = {
        'id' => $account_id,
    };
    my $account_info_response = $soap_account_client->get_account_info(
        $soap_header,
        $account_info_request
    );

# For account let’s just skip this one and try to add
# the next one if account with this id already exists

    my $account_data = $account_info_response->result();
    if ( $account_data && $account_data->{'account_info'} ) {
        printf(STDERR "Account with id=%s already exists$/", $account_id);
        next;
    }

# set id to account info structure which we will use
# for adding a new account

    $account_info->{id} = $account_id;
# try to add an account

    my $add_account_response = $soap_account_client->add_account(
        $soap_header,
        { 'account_info' => $account_info }
    );

# Get the results and print some info

    my $add_acc_resp_data = $add_account_response->result();
    my $i_customer = $add_cust_resp_data->{i_customer};

    if ( $add_acc_resp_data && $add_acc_resp_data->{i_account} ) {
        printf(STDERR "Added account i_account=%s$/", $add_acc_resp_data->{i_account});
    } else {
# Actually there is an impossible situation when
# no i_account info in response, but still the error exists for this
case
        printf(STDERR "Wrong answer from server while during an account
    $/");
    }
};

# subroutine which is in charge of handling SOAP errors

sub on_fault_handler {
    my($soap, $res) = @_;
    printf(STDERR "RES: %s$/", Dumper($res));
    my $err = ref $res ? $res->faultstring() : $soap->transport-
    >status();
        die(sprintf("FATAL: %s, %s$/", $! ? $! : 'error', $err ? $err :
    'unknown error'));
}

sub trace {
    my($message) = @_;
    if ( defined($message) ) {
        printf(STDERR "%s$/", $message);
    }
}

PortaBilling JSON communication

This script retrieves the list of 10 accounts in the user’s environment.


#!/usr/bin/perl

use warnings;
use strict;
use Data::Dumper;

use LWP::UserAgent;
use HTTP::Request::Common qw{ POST };
useJSON;
use HTTP::Request::Common;

use Getopt::Long;

# If the server certificate is not trusted (e.g. it was not issued by a
trusted certificate authority), then ignore it.
$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME}=0;

# Define your User Agent
# This is the object acting as a browser that
# makes requests and receives responses.
my $ua = LWP::UserAgent->new();

#=================================================================
#======================== LOGGING IN =============================
#=================================================================

# Forming the POST request for authentication.
# It must include user’s login and password.
my $request = POST(
    'https://demo.your_domain.com:443/rest/Session/login/', [
        params => '{"login":"demoroot", "password":"u7h79o1$"}',
    ]
);

# Sending the authentication request
my $response = $ua->request($request);

# Getting the authentication information (exiting if unauthorized)
my $auth_info = parse_and_print_response($response);
exit(1) if ( ! $auth_info );

# Receiving session_id
my $session_id = $auth_info->{session_id};

#=================================================================
#================ GETTING THE LIST OF ACCOUNTS ===================
#=================================================================

# To get the list of accounts forming the POST request to be sent
# to the following URL:
# https:///rest///
#
# The request must include:
# auth_info – mandatory authentication information
# (using ‘session_id’ which was received in the previous request);
#
# params – a set of method parameters in JSON format.
$request = POST(
    'https://demo.your_domain.com:443/rest/Account/get_account_list/',
[
        auth_info => sprintf(' { "session_id": "%s" } ', $session_id),
        params => ' { "limit":"10", "offset":"2"} '
    ]
);

# Sending the request
$response = $ua->request($request);

# Receiving the list of accounts
my $account_list = parse_and_print_response($response);
exit(1) if ( ! $account_list );

#=================================================================
#======================== LOGGING OUT ============================
#=================================================================

# Sending the logout request
$request = POST(
    'https://demo.your_domain.com:443/rest/Session/logout/', [
        params => sprintf(' { "session_id": "%s" } ', $session_id),
    ]
);

# sending request
$response = $ua->request($request);

parse_and_print_response($response);

#=================================================================
#======================= HELP SUBROUTING =========================
#=================================================================

sub parse_and_print_response {
    my $response = shift;
# Parse and print data received in the method response:
# in case of success the response will contain data formatted as JSON
# in its body,
# in case of fail the response will contain the '500 Internal Server
# Error' and error information formatted as JSON in its body.

    my $content_data;
    if ( $response->is_success() ) {
        my $content_json = $response->decoded_content();
        print( STDERR ( Dumper($content_json) ) );

        # convert from JSON to Perl data structure
        $content_data = from_json($content_json);
        print( STDERR ( Dumper($content_data) ) );
    }
    else {
        print( STDERR ( Dumper( $response->status_line(), $response->decoded_content() ) ) );
    }
    return $content_data;
}

Scripts in Perl, PHP and Python

Below you will find three examples of scripts in Perl, PHP and Python languages for both SOAP and JSON API communication. All scripts just retrieve a list of currencies defined in a billing environment and show the ISO4217 code, name and base units for each currency.

Perl (SOAP API)


use strict;
use warnings;
use SOAP::Lite; # +trace => 'debug';
use Data::Dumper;

my $api_hostname = 'HOSTNAME';
my $api_login = 'api-user';
my $api_password = 'xxxxxxxxxxx';

# only for self-signed certificates
my $verify_hostname = 0;

my $soap = SOAP::Lite->new;
$soap->serializer()->xmlschema('http://www.w3.org/2001/XMLSchema');
$soap->proxy("https://$api_hostname/soap/");
$soap->transport->ssl_opts(verify_hostname => $verify_hostname);

# login
$soap->uri("http://$api_hostname/Porta/SOAP/Session");
$soap->ns("http://$api_hostname/Porta/SOAP/Session" => 'ns1');
my $login_request = SOAP::Data->name('LoginRequest')->value(
    \SOAP::Data->value(
        SOAP::Data->name('login')->value($api_login),
        SOAP::Data->name('password')->value($api_password),
    )
);
my $som = $soap->call( login => $login_request );
if($som->fault) {
    print Dumper($som);
    exit;
}

my $session_id = $som->result()->{session_id};
printf "Started session %s\n", $session_id;

# get currency list

my $auth_info = SOAP::Data->type('AuthInfoStructure')->value({session_id => $session_id});
my $header = SOAP::Header->name('auth_info')->value($auth_info);

$soap->uri("http://$api_hostname/Porta/SOAP/Currency");
$som = $soap->call('get_currency_list', $header);

my $currency_list = $som->result->{currency_list};
foreach my $currency (@$currency_list) {
    printf "%3s - %s - %.5f\n", $currency->{iso_4217}, $currency->{name}, $currency->{base_units};
}

Perl (JSON API)


use strict;
use warnings;
use Data::Dumper;
use LWP::UserAgent;
use JSON;

my $api_hostname = 'HOSTNAME';
my $api_login = 'api-user';
my $api_password = 'xxxxxxxxxxx';

# only for self-signed certificates
my $verify_hostname = 0;

my $api_base = "https://$api_hostname/rest/";

my $ua = LWP::UserAgent->new(ssl_opts => {verify_hostname =>
$verify_hostname});

my %req = ( params => to_json({login => $api_login, password =>
$api_password}) );
my $reply = $ua->post($api_base . 'Session/login', \%req);
die $reply->as_string if(! $reply->is_success);
my $data = from_json($reply->content);
my $session_id = $data->{session_id};
printf "Started session %s\n", $session_id;

# get currency list
%req = (
    auth_info => to_json({ session_id => $session_id }),
    params => to_json({}),
);

$reply = $ua->post($api_base . 'Currency/get_currency_list', \%req);
    die $reply->as_string if(! $reply->is_success);

$data = from_json($reply->content);

my $currency_list = $data->{currency_list};
foreach my $currency (@$currency_list) {
    printf "%3s - %s - %.5f\n", $currency->{iso_4217}, $currency->{name}, $currency->{base_units};
}

PHP (SOAP API)


<?php
$api_hostname = 'HOSTNAME';
$params = array(
    'login' => 'api-user',
    'password' => 'xxxxxxxxxxx'
);
# for self-signed certificates (allowed by default)
$verify_hostname = false;

$wsdl_base = "https://$api_hostname/wsdl";

try {
    # login
    $soap = new SoapClient($wsdl_base . '/SessionAdminService.wsdl');
    $session_id = $soap->login($params)->session_id;
    echo "Started session $session_id\n";

    # get currency list
    $soap = new SoapClient($wsdl_base . '/CurrencyAdminService.wsdl');
    $auth = new stdClass();
    $auth->session_id = $session_id;
    $auth_header = new SoapHeader('ns1', 'auth_info', $auth);
    $soap->__setSoapHeaders($auth_header);

    $reply = $soap->get_currency_list();

    foreach ($reply->currency_list as &$currency) {
        printf("%3s - %s - %.5f\n", $currency->iso_4217, $currency->name, $currency->base_units);
    }
}
catch (Exception $e) {
    echo "SOAP Request failed: \n\t", $e->faultstring, "\n\t", $e->faultcode, "\n";
}

?>

PHP (JSON API)


<?php
$api_hostname = 'HOSTNAME';
$api_login = 'api-user';
$api_password = 'xxxxxxxxxxx';
# for self-signed certificates
$verify_hostname = false;

$api_url = "https://$api_hostname/rest";

$post_data = array(
    'params' => json_encode(array('login' => $api_login,
    'password' => $api_password)),
);

$curl = curl_init();

curl_setopt_array($curl,
    array(
        //CURLOPT_VERBOSE => true,
        CURLOPT_URL => $api_url . '/Session/login',
        CURLOPT_SSL_VERIFYPEER => $verify_hostname,
        CURLOPT_SSL_VERIFYHOST => $verify_hostname,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST => true,
        CURLOPT_POSTFIELDS => http_build_query($post_data),
    )
);

$reply = curl_exec($curl);
if(! $reply) {
    echo curl_error($curl);
    curl_close($curl);
    exit;
}

$data = json_decode($reply);
$session_id = $data->{'session_id'};
echo "Started session ", $session_id, "\n";

// fetch available currency
$post_data = array(
    'auth_info' => json_encode(array('session_id' => $session_id)),
    'params' => json_encode( new stdClass() ),
);

curl_setopt_array($curl,
    array(
        CURLOPT_URL => $api_url .
        '/Currency/get_currency_list',
        CURLOPT_POST => true,
        CURLOPT_POSTFIELDS => http_build_query($post_data),
    )
);

$reply = curl_exec($curl);

if(! $reply) {
    echo curl_error($curl);
    curl_close($curl);
    exit;
}

$data = json_decode($reply);

foreach ($data->currency_list as $currency) {
    printf("%3s - %s - %.5f\n", $currency->iso_4217, $currency->name,
    $currency->base_units);
}

curl_close($curl);
exit;

?>

Python (SOAP API)


from suds.client import Client

api_hostname = 'HOSTNAME'
api_user = 'api-user'
api_password = 'xxxxxxxxxx'

wsdl_base = 'https://%s/wsdl/' % api_hostname

# login
soap = Client(wsdl_base + '/SessionAdminService.wsdl')
session_id = soap.service.login(LoginRequest={'login': api_user,
'password': api_password})
print "Started session %s" % session_id

# get currency list
soap = Client(wsdl_base + '/CurrencyAdminService.wsdl')

token = soap.factory.create('ns0:AuthInfoStructure')
token.session_id = session_id
soap.set_options(soapheaders=token)

reply = soap.service.get_currency_list()
currency_list = reply.currency_list

for cur in currency_list:
    print "%3s - %s - %.5f" % (cur.iso_4217, cur.name,
float(cur.base_units))

Python (JSON API)


import requests
import json

api_hostname = 'HOSTNAME'
api_user = 'api-user'
api_password = 'xxxxxxxxxx'

# for self-signed certificates
requests.packages.urllib3.disable_warnings()

api_base = 'https://%s/rest/' % api_hostname

# login
req_data = { 'params': json.dumps({'login': api_user, 'password':
api_password}) }
r = requests.post(api_base + 'Session/login', data=req_data,
verify=False)
data = r.json()
session_id = data['session_id']
print "Started session: %s" % session_id

# get currency list
req_data = { 'auth_info': json.dumps({'session_id': session_id}),
    'params:': json.dumps({}) }
r = requests.post(api_base + 'Currency/get_currency_list',
data=req_data, verify=False)
data = r.json()
currency_list = data['currency_list']
for cur in currency_list:
    print "%3s - %s - %.5f" % (cur['iso_4217'], cur['name'],
float(cur['base_units']))

Add_resale_tariff_mappings structure usage

For subresellers to start selling the service, you need to define the usage charges for them. This is the price they pay their resellers for selling their services to customers. Resellers define usage charges in the selling tariffs by mapping them to their buying tariffs - the price at which they buy the service from the administrator.

The add_resale_mappings method performs this mapping. It requires passing all buying tariffs and can either map them to existing selling tariffs or create new ones from buying tariffs. For example you edit the usage charges list for a subreseller Kumar with the i_customer:15. There are two buying tariffs with the IDs 1 and 2 mapped to selling tariffs with the IDs 15 and 16. You need to redefine the selling tariff for the buying tariff 2 with the 20% markup.

The API request will look like this


add_resale_tariff_mappings({
    i_customer: 15,
    resale_map_list: [
        {
            i_tariff_buy: 1,
            i_tariff_sell: 15
        },
        {
            i_tariff_buy: 2,
            i_tariff_sell: 16
        },
        {
            i_tariff_buy: 1,
            selling_tariff_name: 'New Subreseller Tariff',
            description: 'Short Description',
            markup_percent: 20,
            markup_fixed_amount: 0.15
        }
    ]
})

How to ...

Manage service features

Using the service features functionality, you can activate / deactivate various features of the services provided to customers. Note that features are defined per service type (the physical service provided to the use such as Conferencing, Data Service, Voice Calls, Messaging, etc.). Service features' API methods provide you with a convenient tool for managing these parameters at the customer and account levels. Below you will see the service feature object structure illustration, service feature SOAP presentation and an example of how to use service features methods.

The structure of a service feature object

An example of a service feature object

Customer service features SOAP presentation


{
    "service_features": [{
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "cli",
        "attributes": [{
            "effective_values": [null],
            "name": "centrex",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "display_number",
            "values": [null]
        }, {
            "effective_values": ["Y"],
            "name": "display_number_check",
            "values": ["Y"]
        }, {
            "effective_values": [null],
            "name": "account_group",
            "values": [null]
        }, {
            "effective_values": ["N"],
            "name": "display_name_override",
            "values": ["N"]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "paging",
        "attributes": [{
            "effective_values": [null],
            "name": "paging_prefix",
            "values": [null]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "endpoint_redirect"
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "rtpp_level"
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "legal_intercept"
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "call_recording",
        "attributes": [{
        "effective_values": ["0"],
        "name": "auto_record",
        "values": ["0"]
    }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "sip_static_contact",
        "attributes": [{
        "effective_values": ["N"],
        "name": "use_tcp",
        "values": ["N"]
    }, {
        "effective_values": [null],
        "name": "user",
        "values": [null]
    }, {
        "effective_values": [null],
        "name": "port",
        "values": [null]
    }, {
        "effective_values": [null],
        "name": "host",
        "values": [null]
    }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "bundle_discount",
        "attributes": [{
            "effective_values": [null],
            "name": "i_bd_plan",
            "values": [null]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "clir",
        "attributes": [{
            "effective_values": [null],
            "name": "clir_rule",
            "values": [null]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "cli_trust",
        "attributes": [{
            "effective_values": ["N"],
            "name": "accept_caller",
            "values": ["N"]
        }, {
            "effective_values": ["N"],
            "name": "supply_caller",
            "values": ["N"]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "distinctive_ring_vpn"
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "first_login_greeting"
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "sim_calls_limit",
        "attributes": [{
            "effective_values": [null],
            "name": "max_bandwidth",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_calls_in",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_calls_out",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "i_network_connectivity",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_bandwidth_in",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_bandwidth_out",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_calls",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_calls_fwd",
            "values": [null]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "permitted_sip_proxies",
        "attributes": [{
            "effective_values": [],
            "name": "proxies",
            "values": []
        }]
    }, {
        "flag_value": "Y",
        "effective_flag_value": "Y",
        "name": "group_pickup",
        "attributes": [{
            "effective_values": ["*40"],
            "name": "group_pickup_prefix",
            "values": ["*40"]
        }]
    }, {
        "flag_value": "Y",
        "effective_flag_value": "Y",
        "name": "voice_dialing",
        "attributes": [{
            "effective_values": ["Y"],
            "name": "translate_cli_out",
            "values": ["Y"]
        }, {
            "effective_values": ["10110"],
            "name": "i_dial_rule",
            "values": ["10110"]
        }, {
            "effective_values": ["Y"],
            "name": "translate_cli_in",
            "values": ["Y"]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "call_parking",
        "attributes": [{
            "effective_values": ["*70"],
            "name": "park_prefix",
            "values": ["*70"]
        }, {
            "effective_values": ["*71"],
            "name": "release_prefix",
            "values": ["*71"]
        }]
    }, {
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "voice_location",
        "attributes": [{
            "effective_values": [null],
            "name": "primary_location",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "allow_roaming",
            "values": [null]
        }]
    }, {
        "flag_value": "Y",
        "effective_flag_value": "Y",
        "name": "music_on_hold",
        "attributes": [{
            "effective_values": ["1"],
            "name": "i_moh",
            "values": ["1"]
        }]
    }]
}

Account service features SOAP presentation


{
    "service_features": [{
        "locked": "0",
        "flag_value": "Y",
        "effective_flag_value": "Y",
        "name": "unified_messaging",
        "attributes": [{
            "effective_values": ["10"],
            "name": "mailbox_limit",
            "values": ["10"]
        }, {
            "effective_values": ["N"],
            "name": "fax_only_mode",
            "values": ["N"]
        }, {
            "effective_values": ["Voicemail Inbox"],
            "name": "um_link",
            "values": ["Voicemail Inbox"]
        }]
    }, {
        "locked": "0",
        "flag_value": "^",
        "effective_flag_value": "N",
        "name": "endpoint_redirect"
    }, {
        "locked": "0",
        "flag_value": "^",
        "effective_flag_value": "N",
        "name": "rtpp_level"
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "individual_routing_plan",
        "attributes": [{
            "effective_values": [null],
            "name": "i_routing_plan",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "^",
        "effective_flag_value": "N",
        "name": "legal_intercept"
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "cnam_lookup"
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "Y",
        "name": "call_wait_limit"
    }, {
        "locked": "0",
        "flag_value": "2",
        "effective_flag_value": "2",
        "name": "default_action",
        "attributes": [{
            "effective_values": ["30"],
            "name": "timeout",
            "values": ["30"]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "phonebook",
        "attributes": [{
            "effective_values": [null],
            "name": "favorite_allowed_patterns",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "favorite_change_lock_days",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "max_favorites",
            "values": [null]
        }, {
            "effective_values": ["N"],
            "name": "enable_abbrev_dial",
            "values": ["N"]
        }, {
            "effective_values": ["1"],
            "name": "abbrev_dial",
            "values": ["1"]
        }]
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "sip_static_contact",
        "attributes": [{
            "effective_values": [null],
            "name": "user",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "use_tcp",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "port",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "host",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "clir",
        "attributes": [{
            "effective_values": ["N"],
            "name": "blocked",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "clir_rule",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "clir_note",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "auto_attendant"
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "voice_service_policy",
        "attributes": [{
            "effective_values": [null],
            "name": "id",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "^",
        "effective_flag_value": "N",
        "name": "distinctive_ring_vpn"
    }, {
        "locked": "0",
        "flag_value": "~",
        "name": "netaccess_sessions",
        "attributes": [{
            "effective_values": ["1"],
            "name": "max_sessions",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "^",
        "effective_flag_value": "N",
        "name": "cli",
        "attributes": [{
            "effective_values": [null],
            "name": "centrex",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "display_number",
            "values": [null]
        }, {
            "effective_values": ["N"],
            "name": "display_number_allow_external",
            "values": []
        }, {
            "effective_values": ["Y"],
            "name": "display_number_check",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "account_group",
            "values": [null]
        }, {
            "effective_values": ["N"],
            "name": "display_name_override",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "display_name",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "voice_roaming_protection"
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "voice_fup"
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "voice_authentication",
        "attributes": [{
            "effective_values": [null],
            "name": "pin",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "emergency"
        "defined": "1",
        "attributes": [{
            "name": "emergency_administrative_unit",
            "values": [
                ""
            ],
            "effective_values": [
                ""
            ]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "Y",
        "name": "clip"
    }, {
        "locked": "0",
        "flag_value": "~",
        "name": "netaccess_static_ip",
        "attributes": [{
            "effective_values": [],
            "name": "routed_network",
            "values": []
        }, {
            "effective_values": [null],
            "name": "address",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "netmask",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "call_recording",
        "attributes": [{
            "effective_values": ["0"],
            "name": "call_recording_out",
            "values": [null]
        }, {
            "effective_values": ["0"],
            "name": "call_recording_in",
            "values": [null]
        }, {
            "effective_values": ["0"],
            "name": "call_recording_redirect",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "Y",
        "effective_flag_value": "Y",
        "name": "forward_mode",
        "attributes": [{
            "effective_values": [null],
            "name": "max_forwards",
            "values": [null]
        }, {
            "effective_values": ["N"],
            "name": "dtmf_control",
            "values": ["N"]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "voice_pass_through",
        "attributes": [{
            "effective_values": [null],
            "name": "outgoing_access_number",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "call_barring"
    }, {
        "locked": "0",
        "flag_value": "~",
        "name": "wifi_speed_limit",
        "attributes": [{
            "effective_values": [null],
            "name": "tx_rate",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "rx_rate",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "effective_flag_value": "N",
        "name": "call_processing"
    }, {
        "locked": "0",
        "flag_value": "^",
        "effective_flag_value": "N",
        "name": "cli_trust",
        "attributes": [{
            "effective_values": ["N"],
            "name": "accept_caller",
            "values": [null]
        }, {
            "effective_values": ["N"],
            "name": "supply_caller",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "sim_calls_limit"
    }, {
        "locked": "0",
        "flag_value": "~",
        "name": "netaccess_policy",
        "attributes": [{
            "effective_values": [null],
            "name": "access_policy",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "Y",
        "effective_flag_value": "Y",
        "name": "voice_dialing",
        "attributes": [{
            "effective_values": ["Y"],
            "name": "translate_cli_out",
            "values": ["Y"]
        }, {
            "effective_values": ["10111"],
            "name": "i_dial_rule",
            "values": ["10111"]
        }, {
            "effective_values": ["N"],
            "name": "translate_cli_in",
            "values": ["N"]
        }]
    }, {
        "locked": "0",
        "flag_value": "/",
        "effective_flag_value": "N",
        "name": "voice_location",
        "attributes": [{
            "effective_values": [null],
            "name": "primary_location",
            "values": [null]
        }, {
            "effective_values": [null],
            "name": "allow_roaming",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "~",
        "name": "conf_enabled",
        "attributes": [{
            "effective_values": ["5"],
            "name": "max_participants",
            "values": ["5"]
        }]
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "associated_number",
        "attributes": [{
            "effective_values": [null],
            "name": "redirect_number",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "music_on_hold",
        "attributes": [{
            "effective_values": [null],
            "name": "i_moh",
            "values": [null]
        }]
    }, {
        "locked": "0",
        "flag_value": "N",
        "effective_flag_value": "N",
        "name": "lan_name",
        "attributes": [{
            "effective_values": [null],
            "name": "iso_639_1",
            "values": [null]
        }]
    }]
}

Customer site service features SOAP presentation


{
    "site": {
        "i_customer_site": "102",
        "name": "Branch",
        "i_customer": "565",
        "service_features": [{
            "flag_value": "^",
            "effective_flag_value": "N",
            "name": "sim_calls_limit",
            "attributes": [{
                "effective_values": [null],
                "name": "max_bandwidth",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "max_calls_in",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "max_calls_out",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "i_network_connectivity",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "max_bandwidth_in",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "max_bandwidth_out",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "max_calls",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "max_calls_fwd",
                "values": [null]
            }]
        }, {
            "flag_value": "^",
            "effective_flag_value": "N",
            "name": "sip_static_contact",
            "attributes": [{
                "effective_values": ["N"],
                "name": "use_tcp",
                "values": ["N"]
            }, {
                "effective_values": [null],
                "name": "user",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "port",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "host",
                "values": [null]
            }]
        }, {
            "flag_value": "^",
            "effective_flag_value": "Y",
            "name": "voice_dialing",
            "attributes": [{
                "effective_values": ["Y"],
                "name": "translate_cli_out",
                "values": ["N"]
            }, {
                "effective_values": ["10110"],
                "name": "i_dial_rule",
                "values": [null]
            }, {
                "effective_values": ["Y"],
                "name": "translate_cli_in",
                "values": ["N"]
            }]
        }, {
            "flag_value": "^",
            "effective_flag_value": "N",
            "name": "voice_location",
            "attributes": [{
                "effective_values": [null],
                "name": "primary_location",
                "values": [null]
            }, {
                "effective_values": [null],
                "name": "allow_roaming",
                "values": [null]
            }]
        }]
    }
}

Service features flag values

In the list below you can find the Account level service features.

Account level service features
The same of the service feature / The name on web	The default flag value	Possible flag values	Description
auto_attendant / Auto Attendant	~	~	As defined by the Product
		N	No
		Y	Yes
emergency / E911	~	~	As defined by the Product
		N	No
		Y	Yes
cli / Override Identity	^	^	As defined by theCustomer
		N	Never
		L	If Different From Account ID and Aliases
		G	If Different From All Customer Accounts
		B	If Different From All Accounts in Specified Batch
		Y	Always
		S	Always
		H	Always
distinctive_ring_vpn / Ext-to-Ext Call Distinctive Ring	^	^	As defined by the Customer
		N	No
		Y	Yes
legal_intercept / Legal Intercept	^	^	As defined by the Customer
		N	No
		Y	Yes
clir / Hide CLI	~	~	As defined by the Product
		N	Never
		Y	Always
call_processing / Call Screening	~	~	As defined by the Product
		Y	Yes
		Y	Yes
default_action / Default Answering Mode	7	7	Ring, Forward, Voicemail
		3	Ring Then Forward
		5	Ring Then Voicemail
		6	Forward Then Voicemail
		1	Ring Only
		2	Forward Only
		4	Voicemail Only
		0	Reject
conf_enabled / Conferencing	~	~	As defined by the Product
		N	No
		Y	Yes
rtpp_level / RTP Proxy	^	^	As defined by the Customer
		N	Use Default
		0	Direct
		1	Optimal
		2	On NAT
		3	Always
clip / Present Caller Info	~	~	As defined by the Product
		Y	Yes
		N	No
call_wait_limit / Disable Call Waiting	~	~	As defined by the Product
		N	No
		Y	Yes
wifi_speed_limit / Limit Bandwidth	~	~	As defined by the Product
		N	No
		Y	Yes
call_barring / Call Barring	^	^	As defined by the Customer
		~	As defined by the Product
		N	No
		Y	Yes
netaccess_static_ip / Static IP	~	~	As defined by the Product
		N	No
		Y	Yes
netaccess_sessions / Session Limit	~	~	As defined by the Product
		Y	Yes
		N	No
cli_trust / CLI Trust	^	^	As defined by the Customer
		F	Accept caller identity: Favor Forwarder, Supply caller identity: enabled
		Y	Accept caller identity: Caller only, Supply caller identity: enabled
		N	Accept caller identity: None, Supply caller identity: disabled
		y	Accept caller identity: Caller only, Supply caller identity: disabled
		n	Accept caller identity: None, Supply caller identity: enabled
		f	Accept caller identity: Favor Forwarder, Supply caller identity: disabled
call_recording / Call Recording	~	~	As defined by the Product
		^	As defined by the Customer
		N	No
		Y	Yes
netaccess_policy / Internet Access Policy	~	~	As defined by the Product
		N	Enabled
		N	Disabled
voice_service_policy / Service Policy	~	~	As defined by the Product
		N	Disabled
		N	Enabled
sim_calls_limit / Limit Simultaneous Calls	/	/	As defined by the Customer
		Y	Yes
		N	No
Phonebook / Phone Book	~	~	As defined by the Product
		N	Disabled
		Y	Enabled
voice_pass_through / Call via IVR	~	~	As defined by the Product
		Y	Enabled
		N	Disabled
voice_location / Location Information	/	/	As defined by the Customer
	^	^	As defined by the Customer
		N	Disabled
		Y	Enabled
voice_roaming_protection / Geo-IP Fraud Detection	~	~	As defined by the Product
		Y	Enabled
		N	Disabled
endpoint_redirect / Endpoint Redirection	^	^	As defined by the Customer
		N	No
		Y	Yes
cnam_lookup / Caller ID (CNAM) Lookup	~	~	As defined by the Product
		N	No
		Y	Yes
voice_dialing / Dialing Rules	/	/	As defined by the Site
		^	As defined by the Customer
		N	Disabled
		Y	Enabled
iptv / IPTV	~	~	As defined by the Product
voice_fup / Fair Usage Policy	~	~	As defined by the Product
sip_static_contact / Sip Contact	/	/	As defined by the Site
		^	As defined by the Customer
		N	No
		Y	Yes
cps_account_limit / CPS Limitation	~	~	As defined by the Product
		N	Disabled
		Y	Enabled
external_voicemail / External voicemail	~	~	As defined by the Product
		N	Disabled
		Y	Enabled
forward_mode / Call Forwarding	~	~	As defined by the Product
		N	No forwarding
		Y	Follow-Me
		F	Advanced Forwarding
		U	Forward to SIP URI
		C	Simple Forwarding
individual_routing_plan / Individual Routing Plan	~	~	As defined by the Product
		N	Disabled
		Y	Enabled
msg_service_policy / Service Policy	N	N	Disabled
msg_service_policy / Service Policy		Y	Enabled
music_on_hold / Music on Hold	^	^	As defined by the Customer
		N	Disabled
		Y	Enabled
ringback_tone / Ringback Tone	~	~	As defined by the Product
		N	Disabled
		Y	Enabled
sms_routing / SMS/MMS Routing Data	/	/	As defined by the Site
		^	As defined by the Customer
		N	Disabled
		Y	Enabled
unified_messaging / Unified Messaging	~	~	As defined by the Product
		N	Disabled
		Y	Enabled
user_ivr_application / User application	~	~	As defined by the Product
		N	Disabled
		Y	Enabled

Using the service features methods to change the FollowMe settings


#!/usr/bin/perl

use strict;
use warnings;
use SOAP::Lite;
use Carp;

# If the server certificate is not trusted (e.g. it was not issued by a
# trusted certificate authority), then ignore it.
$ENV{PERL_LWP_SSL_VERIFY_HOSTNAME}=0;

# Configuration block

my $uri_base = 'http://portabox.local.com/Porta/SOAP';
my $proxy_host = 'portabox.local.com';
my $proxy_port = '443';

my $login = 'pb-user';
my $password = 'P@$$wd';

my $i_account = 636;

# End of configuration block

my %uris = (
    Session => "$uri_base/Session",
    Account => "$uri_base/Account",
);

my $proxy = "https://$proxy_host:$proxy_port/soap/";

my $FM_REJECT = 0;
my $FM_RING = 0x1;
my $FM_FORWARD = 0x2;
my $FM_VOICEMAIL = 0x4;


my %fm_modes = (
    $FM_REJECT => 'Reject all calls',
    $FM_RING => 'Ring',
    $FM_FORWARD => 'Forward',
    $FM_VOICEMAIL => 'Voicemail',
);

sub fm_decode {
    my ($value) = @_;
    my @response_set;
    for my $fm_mode (sort keys %fm_modes) {
        if ($fm_mode & $value) {
        push(@response_set, $fm_modes{$fm_mode});
        }
    }

    my $result = join(', ', @response_set);
    return $result;
}

sub fm_encode {
    my (@values) = @_;
    my $result = 0;
    for my $value (@values) {
        if (! exists $fm_modes{$value}) {
            croak "Unknown Follow Me Mode: $value";
        }
        $result |= $value;
    }
    return $result;
}

sub fault_handler {
    my ($soap, $res) = @_;
    my $message = 'Unknown Error';
    if (ref ($res)) {
        $message = "Remote SOAP Fault: " . $res->faultstring();
    }
    else {
        $message = "Transport Fault: " . $soap->transport->status();
    }
    croak $message;
}

my $session_srv = SOAP::Lite
    ->uri($uris{Session})
    ->proxy($proxy)
    ->on_fault(\&fault_handler)
    ;

my $account_srv = SOAP::Lite
    ->uri($uris{Account})
    ->proxy($proxy)
    ->on_fault(\&fault_handler)
    ;

my $session_id = $session_srv->login($login, $password)->result();

print "Logged in ($login|$session_id)\n";

my $auth_info = SOAP::Header
    ->name('auth_info')
    ->value({ session_id => $session_id }
    );

my $GetAccountServiceFeaturesRequest = {
    i_account => $i_account,
};

# Current settings
my $GetAccountServiceFeaturesResponse
    = $account_srv->get_service_features(
        $auth_info,
        $GetAccountServiceFeaturesRequest,
    )->result();

my $service_features = $GetAccountServiceFeaturesResponse->{service_features};

my $sf_default_action;

SERVICE_FEATURE_ITEM:
for my $service_feature (@{$service_features}) {
    if ($service_feature->{name} eq 'default_action') {
        $sf_default_action = $service_feature;
        last SERVICE_FEATURE_ITEM;
    }
}

if (! $sf_default_action) {
    print "No Default Action set\n";
}
else {
    print "Default Action setting: ",
    fm_decode($sf_default_action->{flag_value}), "\n";
}

my $UpdateAccountServiceFeaturesRequest = {
    i_account => $i_account,
    service_features => [
        {
            name => 'default_action',
            flag_value => fm_encode($FM_RING, $FM_FORWARD),
        }
    ]
};

my $UpdateAccountServiceFeaturesResponse
    = $account_srv->update_service_features(
        $auth_info,
        $UpdateAccountServiceFeaturesRequest
    )->result();

$GetAccountServiceFeaturesResponse
    = $account_srv->get_service_features(
        $auth_info,
        $GetAccountServiceFeaturesRequest,
    )->result();

$service_features = $GetAccountServiceFeaturesResponse->{service_features};

SERVICE_FEATURE_ITEM_2:
for my $service_feature (@{$service_features}) {
    if ($service_feature->{name} eq 'default_action') {
        print "Default Action settings: ",
            fm_decode($service_feature->{flag_value}),
            "\n"
        ;
        last SERVICE_FEATURE_ITEM_2;
    }
}
exit 0;

Allow ISP customers to purchase extra quota

This feature is mainly intended for ISPs. They may allow their users to purchase extra Internet quota on the company's web site without any actions required from PortaBilling administrators. This feature is based on a PortaSwitch Add-on Products solution. It allows the user to add Internet quotas (provided by one and the same or similar add-on products) to an account more than once and it will aggregate these quotas.

Configuration

The PortaBilling administrator creates a range of options (add-on products), that each provide their own quantity of Internet quota (e.g. 5GB, 10GB, 20GB, 50GB, etc.) and price. All of these add-on products must have the same precedence level and contain volume discount plans having the same destination group set.

API

The interconnection between PortaSwitch and the company's web site, where users may purchase extra quota, can be realized via the PortaSwitch XML/JSON API, as usual. To apply Internet quota to a user, the update_account API method must be used with the appropriate add-on product specified in the assigned_addons property. This add-on product must have the following property specified in its ProductInfo structure: topup_addon - "Y" i_product - the unique ID of a respective add-on product with usage quota configured. This functionality will generate more revenue from existing customers by offering and selling extra Internet quotas.

Use bit flags

Bit flags help to determine the type of an xDR. The common formula for calculation of the type of the call record is:

type = ( bit_flags & bit_mask ) >> bit_offset

where & is a binary ADD and >> is a binary right shift, and the bit_mask and offset values are taken from the Transaction_Flag_Types in the database and correspond to the particular xDR type.

The following table represents the Transaction_Flag_Types table from the database with descriptions added.

Transaction_Flag_Types table
name	bit_mask	bit_offset	Description
acc	1	0	Specifies whether there is a debit overdraft. Possible values: 1 - There is a debit overdraft; 0 - There is no debit overdraft.
time	2	1	Specifies whether the connect or disconnect time is adjusted to the request time, because the original timestamps were unclear or suspiciously old. Possible values: 1 - The connect or disconnect time is adjusted; 0 - The connect or disconnect time is not adjusted.
calltype	12	2	Distinguishes the following call types: 0 - Unknown; 1 - Outbound; 2 - Inbound; 3 - Forwarded.
refeed	16	4	Specifies whether the xDR is created as a result of a refeed process. Possible values: 1 - The xDR is created as a result of the refeed process; 0 - The xDR has not been erased by the refeed process.
privacy	32	5	Specifies whether the call is private. Possible values: 1 - The call is private; 0 - The call is not private.
call_recording	64	6	Specifies whether the call is recorded. Possible values: 1 - The call is recorded; 0 - The call is not recorded.
is_hidden	128	7	Specifies whether the xDR is hidden: 1 - The xDR is hidden; 0 - The xDR is not hidden.
derived	512	9	This flag indicates that the xDR is produced for a subsession of another session and is billed under this parent session (e.g. a single LTE session can include several subsessions per content type consumed, each with its own rating group). Possible values: 0 - the xDR is produced for the parent session, 1 - the xDR is produced for the subsession.
incremental	256	8	This marks an xDR as being billed in an incremental fashion (e.g. for an Internet session). If the xDR is not yet closed (the session is in progress), it can be updated with additional service consumption or charges added until it is closed. Possible values: 1 - the xDR is incremental, 0 - the xDR is not incremental.
direction	12	2	Distinguishes the direction of SMS message handling: 0 - Unknown; 1 - Origination; 2 - Termination.

For example, you have a bit_flag 108 (01101100 in the binary format) and you look for whether the call was recorded.

In the Transaction_Flag_Types table, you can find a bit_mask for call_recording. Its value is 64, which is 01000000 in the binary format. You perform the binary AND operation over the bit_flag and the found bit_mask values:

01101100 & 01000000 = 01000000 (1)

Then you take the offset value from the Transaction_Flag_Types. For call_recording, the offset is 6. So you need to shift the (1) to the right by the number of 6 positions:

01000000 >> 6 = 00000001

That is, as a result of the operations with the bit flag for call recording you receive the value '1' or 'true', which means that the call is really recorded.

In the following tables you can find the list of some bit flags and their transcriptions.

Bit flags and their transcriptions
Bit flag	Bit flag's binary value	Description
0	0000000	Unknown event, i.e. no match is found
1	00000001	Debit overdraft
4	00000100	Outgoing call
5	00000101	Outgoing call with debit overdraft
8	00001000	Incoming call
12	00001100	Forwarded call (outgoing call + incoming call)
36	00100100	Outgoing private call
40	00101000	Incoming private call
44	00101100	Forwarded private call
68	01000100	Outgoing recorded call
72	01001000	Incoming recorded call
76	01001100	Forwarded recorded call
100	01100100	Outgoing private recorded call
104	01101000	Incoming private recorded call
108	01101100	Forwarded private recorded call