API customer EN

en | uk | ru

Section API ERP "UserSide"

Purpose: Actions with customers. Most actions are relevant for manual billing.

Additional parameters:
action - subcategory of the request (possible value: see below)

Subcategories

add

Modified in: 3.13.25 (added is_corporate parameter)

Description: Add a customer
Optional parameters:
 fio - name of the customer
 codeti - customer id in the billing system
 is_potential - flag - potential customer
 is_corporate - flag - legal entity
 billing_id - billing id
 billing_customer_id - customer id in billing (required if this is not a potential customer)

abon_hist

Modified in: 3.17dev1 (excluded usercode parameter, added customer_id parameter)

Description: Display customer transactions (financial and other)
Required parameters:
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID

change_balance

Modified in: 3.16dev2 (removed operator_id parameter, added employee_id parameter)

Modified in: 3.13.22 (added operator_id parameter)

Description: Change balance (income/expense operation)
Required parameters:
 customer_id - customer ID
 amount - Amount
 comment - operation notes
Optional parameters:
 employee_id - employee ID
 operator_id - operator ID (before version 3.16dev2)

change_billing

Modified in: 3.16.23 (added billing_user_id parameter)

Added in: 3.12.48

Description: Change billing
Required parameters:
 customer_id - customer id
 billing_id - billing id
Optional parameters:
 billing_user_id - customer id in billing

change_date_connect

Added in: 3.12.80

Description: Change the connection date
Required parameters:
 customer_id - customer ID
 value - date

delete

Added in: 3.14.21

Description: Delete a customer
Required parameters:
 id - customer ID

edit

Modified in: 3.20.10 (added coordinates parameter)

Modified in: 3.16dev3 (added group_id parameter)

Modified in: 3.13.56 (added manager_id parameter)

Added in: 3.12rc2

Description: Edit a customer
Required parameters:
 id - customer ID
Optional parameters:
 account_number - personal account number
 agreement_date - agreement date
 agreement_number - agreement number
 apartment_number - flat number
 comment - notes
 coordinates - coordinates as text separated by comma (example: 47.839628,35.140553)
 date_activity - date of network activity
 date_activity_inet - date of internet activity
 date_connect - date of connection
 email - email address
 entrance - entrance number
 flag_corporate - flag - legal entity
 floor - floor
 group_id - group id
 house_id - house id
 is_potential - flag - potential customer
 login - login
 manager_id - id of manager employee
 name - name of customer
 parent_id - id of parent customer (for the child customer)
 phone0 - mobile phone number
 phone1 - home phone number
 phone2 - additional phone number 1
 phone3 - additional phone number 2
 phone4 - additional phone number 3

get_activity_counter

Added in: 3.12.81

Description: Retrieve the counter of active customers
Required parameters:
 type - counter type (Possible values: net, internet, personal_area)

get_abon_id

Modified in: 3.14.34 (added possible account value for data_typer parameter)

Description: Retrieve customer ID from input data
Required parameters:
 data_typer - type of data we are checking (possible values: account, billing_uid, codeti, dognumber, ip, login, mac, mail, phone)
 data_value - value
Optional parameters:
 is_skip_old - flag - do not search among former customers

get_customer_group

Added in: 3.19beta1

Description: Get list of customer groups
Required parameters:
 None
Optional parameters:
 None

get_customers_id

Modified in: 3.18.10 (added is_corporate parameter)

Modified in: 3.16dev3 (added parameters name, limit, is_like)

Modified in: 3.15.26 (added is_ex parameter)

Modified in: 3.14.71 (added dependence_device_id parameter)

Modified in: 3.14.58 (added balance_from, balance_to, state_id parameters)

Modified in: 3.14.41 (added date_connect_from and date_connect_to parameters)

Modified in: 3.14.5 (added address_unit_id parameter)

Modified in: 3.13.48 (added tariff_id parameter)

Modified in: 3.13.35 (added mark_id parameter)

Added in: 3.12.8

Description: Retrieve list of customer IDs by incoming conditions
Required parameters:
 None
Optional parameters (but at least one condition must be specified):
 account_number - personal account number
 address_unit_id - address unit id
 appartment - number of the flat
 balance_from - balance (from)
 balance_to - balance (to)
 billing_id - billing number id
 billing_uuid - customer id in billing
 date_connect_from - date of connection (from)
 date_connect_to - date of connection (to)
 dependence_device_id - id of the device the customers depend on
 house_id - house id
 is_corporate - flag - a legal entity
 is_ex - flag - former customers
 manager_id - manager id (0 to search without manager)
 mark_id - mark id
 name - name/title of customer
 state_id - status id
 tariff_id - tariff id
 limit - maximum number of records to return in the response
 is_like - flag - use substring comparison where possible (not a full match)

get_data

Description: Retrieve customer information
Required parameters:
 customer_id - customer ID
 or
 account_number - customer's personal account number
 +
 billing_id - billing ID

get_ip_port_device_commutation

Added in: 3.12beta35

Description: Get customer IP and MAC addresses with switch bindings (including for DHCP use)

get_last_ip

Description: Get the last used IP address for customers

get_mac_history

Added to: 3.16dev8

Description: Get MAC address change history by customer
Required parameters:
 customer_id - customer ID

get_max_agreement_number

Added in: 3.12.3

Description: Get the maximum occupied contract number (numeric)
Optional parameters:
 billing_id - billing id of customers among which to perform the selection

ip_add

Modified in: 3.17.36 (added mac parameter)

Added in: 3.12.83

Description: Add IP address
Required parameters:
 customer_id - customer ID
 value - IP
Optional parameters:
 mac - MAC of the customer

ip_delete

Modified in: 3.19beta1 (added possible value all to the value parameter)

Added in: 3.12.83

Description: Delete IP address
Required parameters:
 customer_id - customer ID
 value - ip or "-1" for entries with no IP address (MAC address only) or "all" for all addresses

ip_subnet_add

Added in: 3.14.71

Description: Add an IP address subnet for a customer
Required parameters:
 customer_id - customer ID
 ip - initial ip address
 subnet - subnet mask/VLSM (for example: 24)

ip_subnet_delete

Added to: 3.14.71

Description: Delete an IP address subnet from a customer
Required parameters:
 customer_id - customer ID
 ip - initial ip address

list_tarif_available

Excluded in: 3.13

Description: List of tariffs available for customer tariff changes
Required parameters:
 usercode - customer ID

mark_add

Added in: 3.12.82

Description: Add a mark to a customer
Required parameters:
 customer_id - customer ID
 mark_id - mark id

mark_delete

Added in: 3.12.82

Description: Delete a mark from a customer
Required parameters:
 customer_id - customer ID
 mark_id - mark id

msg

Modified in: 3.17dev1 (usercode parameter removed, customer_id parameter added)

Modified in: 3.16dev3 (made usercode parameter optional)

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Modified in: 3.14.53 (added date_add_from, date_add_to, operator_id parameters)

Description: Display correspondence with a customer
Optional parameters (at least one is required):
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID
 date_add_from - date of message (from)
 date_add_to - date of message (to)
 is_answer - whether the message has an answer (1 - answered, 0 - not answered)
 is_archive - whether the message is archived
 employee_id - id of the employee who authored the message
 operator_id - id of the operator who authored the message (before version 3.16dev2)

msg_add

Added in: 3.13.25

Description: Add a message from a customer
Required parameters:
 customer_id - customer ID
 text - Message text
Optional parameters:
 is_arc - flag - put the message into the archive

pass_change

Modified in: 3.17dev1 (usercode parameter removed, customer_id parameter added)

Modified in: 3.15.23 (pass_old parameter became optional)

Description: Change password for logging in to the customer portal
Required parameters:
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID
 pass_new - new password
Additional parameters:
 pass_old - current password

service_add

Added in: 3.18beta1

Description: Add additional service
Required parameters:
 customer_id - customer ID
 service_id - id of additional service
Optional parameters:
 price - individual price
 comment - notes

service_remove

Added in: 3.18beta1

Description: Remove additional service
Required parameters:
 customer_id - customer ID
 service_id - id of additional service

set_mac_by_ip

Added in: 3.12beta35

Description: Set the MAC address for a customer's IP address
Required parameters:
 ip - IP address of the customer (for example: 192.168.0.1)
 mac - MAC address of the customer (for example: 00:11:22:33:44:55)

state_change

Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)

Added in: 3.12.8

Description: Change a customer's service status
Required parameters:
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID
 state_id - customer status ID (0 - stop, 1 - paused, 2 - active)

tarif_change

Modified in: 3.17dev1 (excluded usercode parameter, added customer_id parameter)

Description: Change a customer's tariff
Required parameters:
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID
 tarif - new tariff ID

to_ex

Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)

Added in: 3.12.69

Description: Move a customer to the Former customers category
Required parameters:
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID

to_normal

Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)

Added in: 3.12.90

Description: Move a customer back to normal status (from "Former customers")
Required parameters:
 usercode - (for version 3.16 and earlier) customer ID
 customer_id - (for version 3.17 and later) customer ID

merge

Added in: 3.19.33

Description: Merge customers
Required parameters:
 dst_id - main customer id
 src_id - secondary customer id (whose information is moved to the main customer)

msg_add_to_customer

Added in: 3.19.45

Description: Add a message from an employee to a customer
Required parameters:
 employee_id - employee id
 customer_id - customer id
 text - Message text
Optional parameters:
 is_arc - flag - put the message into the archive