Release MR69

Customer

get_customer_info,

get_customer_list

list_processors

get_processor

Added new regenerate_invoice_list() method.

This method enables an API user to regenerate a list of invoice PDF files

get_user_info

get_user_list

add_user

update_user

get_channel_package_list

get_service_package_list

Added new Service IPTV with methods get_channel_package_list() and get_service_package_list()

These methods enables an API user to get the list of IPTV channel and service packages imported into PortaBilling

YT:BA-14042

add_routing_plan,

update_routing_plan,

get_routing_plan_info,

get_routing_plan_list

Account

Customer

Payment

make_transaction

make_tax_transaction

add_group

update_group

enable_api_notifications

disable_api_notifications

originate_call

get_sip_call_list

Make 'object' and 'i_object' input filters of get_payment_transaction_list() are not mandatory for admin realm.

Add 'i_customer_type' input filter to the mentioned method

Customer

Account

Payment

register_transaction

register_transaction

register_transaction, get_payment_transaction_list

Added the following input filters:

'matching_type', 'number'

get_custom_field_info

get_custom_field_list

get_custom_field_list

add_custom_field

update_custom_field

delete_custom_field

get_custom_field_info

Adjust the following filters of the mentioned method:

iso_4217, name, search.

From now '%' and '_' symbols in these filters won't be escaped on the method level.

If you need the previous behaviour - please escape these symbols manually before sending them in a request.

Added one more possible value (IO) for the 'usage_type' input filter.

In case when 'IO' 'usage_type' filter is sent, the method should return entities with both incoming and outgoing usage types in the response.

get_tax_plugins_list,

get_tax_plugin

Added check_usage to get_tax_plugins_list and get_tax_plugin methods

Added is_used to TaxPluginInfo

set_tax_plugin_parameters,

get_tax_plugin_parameters_metainfo

get_tax_transaction_code_list

Extended method get_tax_transaction_code_list input args with:

• plugin_code
• with_plugin_codes
• code
• description
• get_total
• limit
• offset

Added plugin_code_list to TaxTransactionCode

get_tax_transaction_code_info,

add_tax_transaction_code,

update_tax_transaction_code,

delete_tax_transaction_code

Added methods to manage with tax transaction code information

Add new input fields in the GetServicePolicyListRequest:

• check_usage
• i_apply_level

add_service_policy

get_service_policy_info

get_service_policy_list

make_transaction

change_password

make_transaction

make_tax_transaction

Added 'get_total' field to the reqeust of the mentioned method.

From now this method returns 'total' in the response only by 'get_total' in the request.

get_sip_call_list

API notifications

get_connection_list,

get_connection_info

Extended get_connection_list and get_connection_info API methods to return vendor_name in the ConnectionInfo structure.

Extended 'get_number_list' method to take 'number_list' input field in the request.

This field can contain an array of objects with 'i_did_number' field.

Such changes enable an API user to fetch a list of DID numbers by their i_did_number.

Extended 'get_number_list' method to take 'format' input field with possible values: csv, xls and xlsx.

In a case when format is present, the method will return a file with did numbers in the appropriate file format.

add_customer_class,

update_customer_class,

get_customer_class_info,

get_customer_class_list

add_service_policy,

update_service_policy,

get_attribute_list

Adjusted the behaviour of the mentioned methods.
From now 'possible_values' of the boolean attributes are [0,1] instead of ['Yes', 'No'].

If affects the values that are returned by get_attribute_list() for boolean value_type.
Also, a boolean attribute value can be equal to 0 or 1 in the requests of add_service_policy() and update_service_policy() methods.

The validation of the 'ip_filter' field was adjusted.

From now it's possible to specify a netmask in the field.

Both following formats are supported from now:
192.168.192.0/24 or 192.168.192.0/255.255.255.0

Affected methods: add_customer, update_customer, add_user, update_user

Affected API types: CustomerInfo, UserInfo

The following fields are no longer mandatory:

• 'name' in TaxPluginInfo;
• 'description', 'code' in TaxTransactionCode.

The following fields are no longer mandatory:

• 'payment_method' in AccountPaymentMethodInfo;
• 'i_account', 'type' in CPConditionInfo;
• 'destination', 'i_dest' in DestinationPrefixInfo;
• 'i_env' in EnvInfo;
• 'description', 'i_oli', 'oli' in OliInfo;
• 'payment_method' in PaymentMethodInfo;
• 'i_tariff', 'name' in TariffInfo;
• 'xdr_type' in CustomerXDRInfo;
• 'name', 'external_id', 'type' in IPTVChannelPackage;
• 'name', 'external_id' in IPTVServicePackage.

get_dialing_rule_info,

get_dialing_rules_list

Extended 'get_destination_list' method to take 'destination_list' input field in the request.

This field can contain an array of objects with 'i_dest' field.

Such changes enable an API user to fetch a list of destinations by their i_dest.

Account

Customer

Added new types for responses from this methods: AccountCustomFieldsInfo and CustomerCustomFieldsInfo. Responses will use Account_Custom_Fields and Customer_Custom_Fields ACL objects respectively

'is_used' and 'object' fields were removed from responces of this methods

*

• Extended get_destination_list() method to return spreadsheet attachment with destinations by 'file_format' input field (Possible values: 'csv', 'xls', 'xlsx').
  
  
• Implemented get_default_destination_list() method that returns spreadsheet attachment with default destination set.
  
  
• Removed unpublished download_destinations() method. The functionality of this method is covered by get_destination_list() and get_default_destination_list() methods from now.

Added the 'i_block_attr' and 'i_parent' fields  to the response, which establish dependencies between IVR options(unique id of a record - parent record)

Added 'with_usage' field to the method request.

Added 'activation_cost' and 'activation_revenue' fields to the DIDNumberInfo structure in the method response.

The fealds are returned only in case if 'with_extended_info' attribute is true in the method request.

get_discount_plan_info,

get_discount_plan_list

The mentioned methods are extended to return 'is_complete' field in the DiscountPlanInfo structure.

These methods return the field only if the 'check_complete_status' input method attribute is true.

get_countries_list

*

Prefix not more mandatory in DIDCountryInfo

area_name and country_iso can be nil in struct DIDRequestParameters

add_tariff

update_tariff

get_tariff_info

get_tariff_list

Field 'volume_based' was removed from input parameters and TariffInfo output type

Added the following input filters:

'name', 'i_voice_application', 'description', 'number_pattern', 'with_callbacks'

Account

Customer

add_account

update_account

validate_account_info

add_customer

update_customer

validate_customer_info

add_subreseller

Several changes were made to ActiveSessionInfo type:

• field 'on_net' was added;
• types of fields 'hotlined', 'is_disconnectable' were changed to 'int'.

activate_subscriptions
add_account
add_account_advanced (internal)
add_account_with_topup (internal)
add_alias
add_allowed_location
add_auto_payment
add_cp_condition
add_cp_rule
add_followme_number
add_phonebook_record
add_preferable_account
add_subscription
arrange_cp_rules
arrange_followme_numbers
assign_sim_card
assign_ua
assign_ua_advanced (internal)
charge_subscription_fees
delete_account (internal)
delete_alias
delete_auto_payment
delete_cp_condition
delete_payment_method
estimate_call_price
estimate_taxes
generate_accounts
get_account_state
get_alias_list
get_allowed_addons (internal)
get_allowed_location_list
get_auto_payment_info
get_booths (internal)
get_call_barring_options
get_cp_condition_list
get_cp_rule_list
get_custom_fields_schema
get_custom_fields_values
get_full_vd_counter_info
get_member_of_huntgroups_list
get_moh_list_info
get_payment_method_info
get_permitted_sip_proxies_info
get_phonebook_list
get_preferable_account_list
get_service_features
get_service_wallet_xdr_list
get_services_consumption
get_sip_status
get_subscriptions
get_transactions_total_info
get_used_location_list
get_vd_counter_list
make_transaction
move_account
release_sim_card
release_ua
set_account_state
terminate_account
topup_account
update_account
update_account_followme
update_alias
update_auto_payment
update_booth (internal)
update_call_barring_options
update_cp_condition
update_payment_method
update_subscription
vd_topup

activate_subscriptions
add_abbreviated_dialing_number
add_auto_payment
add_batch
add_customer_extension
add_customer_huntgroup
add_customer_site
add_subscription
charge_subscription_fees
close_billing_period
delete_customer
delete_customer_extension
delete_payment_method
estimate_taxes
get_abbreviated_dialing_number_list
get_account_aliases_list
get_accounts_subscriptions (internal)
get_auto_payment_info
get_call_barring_options
get_callqueue_list
get_credit_limit_history
get_custom_fields_schema
get_custom_fields_values
get_custom_xdr_report
get_custom_xdr_report_list
get_customer_billing_periods_history
get_extensions_list
get_full_vd_counter_info
get_huntgroup_list
get_metrics_data
get_moh_list_info
get_number_sequence_info (internal)
get_payment_method_info
get_rt_tickets_list
get_service_features
get_service_wallet_xdr_list
get_services_consumption
get_sites
get_status_history
get_subscriptions
get_taxation_info
get_transactions_total_info
get_vd_counter_list
make_tax_transaction (internal)
make_transaction
modify_spending_limit
suspend_customer
terminate_customer
unsuspend_customer
update_call_barring_options
update_customer
update_customer_advanced (internal)
update_number_sequence (internal)
update_payment_method
update_service_features
update_subscription
update_taxation
vd_topup

get_dest_group_set_list,

get_dest_group_set_info

Adjust the method 'to_date' input filter to search transactions exactly by thedatetimeprovided in the field.

Before these changes, back-end side added 24 hours to the provideddatetimetimestamp and only that performed search.

Add 'get_total' flag to the 'GetUAProfileListRequest' structure.

'total' field will be returned only if 'get_total' flag is passed.

add_service_policy

get_service_policy_info

get_service_policy_list

update_taxation,

get_taxation_info

Extended update_taxation() method to take 'i_tax_transaction_code' and 'estimate_taxes' fields in the method request.

Extended get_taxation_info() method to return 'i_tax_transaction_code' and 'estimate_taxes' fields in the method response.

update_taxation,

get_taxation_info

Extended update_taxation() method to take 'i_tax_transaction_code' and 'estimate_taxes' fields in the method request.

Extended get_taxation_info() method to return 'i_tax_transaction_code' and 'estimate_taxes' fields in the method response.

The 'search' filter of the mentioned method was adjusted.

From now '%' and '_' symbols in this filter won't be escaped on the method level.

If you need the previous behaviour - please escape these symbols manually before sending them in a request.

1. From now the 'i_online_payment_processor' field is always taking into account in the 'merchant_account' input object (before these changes the field was ignored if '"remittance":1' was present in the request)
2. Removed 'remittance' field from the method request,

From now the method automatically determines whether the adding processor is remittance by 'i_online_payment_processor' field in the 'merchant_account' input object.

get_xdr_list
get_transactions_total_info