Получение информации о клиенте
Метод Get account используется для получения информации о клиенте текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
base_url | path | string | Обязательный | URL ActivePlatform |
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
account_id | path | integer | Обязательный | ID клиента |
Модель ответа
Название | Тип данных | Описание | ||||
---|---|---|---|---|---|---|
data | object | Данные ответа | ||||
id | integer | ID клиента | ||||
type | string | Тип данных | ||||
attributes | object | Информация о клиенте | ||||
created_at | date | Дата и время создания клиента | ||||
updated_at | date | Дата и время последнего обновления клиента | ||||
reseller_id | integer | ID реселлера, к которому относится клиент | ||||
name | string | Имя клиента | ||||
account_class_id | integer | ID правила обслуживания клиента | ||||
primary_name | string | Основное имя клиента (например, название компании для юридического лица) | ||||
first_name | string | Имя лица, уполномоченного на заключение договора | ||||
middle_name | string | Отчество лица, уполномоченного на заключение договора | ||||
last_name | string | Фамилия лица, уполномоченного на заключение договора | ||||
country | string | Контакты: Код страны ISO 3166-1 alpha-2 | ||||
region | string | Контакты: Регион | ||||
city | string | Контакты: Город | ||||
street | string | Контакты: Улица | ||||
building | string | Контакты: Дом | ||||
office | string | Контакты: Номер офиса | ||||
zip | string | Контакты: Почтовый индекс | ||||
phone | string | Контакты: Телефон в международном формате:
| ||||
string | Email лица, уполномоченного на заключение договора | |||||
status | string | Статус клиента (см. Просмотр и обновление информации о клиенте) | ||||
balance | string | Полный баланс клиента как сумма свободных средств (см. usable_balance ) и всех заблокированных списаний | ||||
usable_balance | string | Свободные средства на балансе клиента | ||||
current_debt | float | Величина текущей задолженности по всем подпискам клиента с моделью оплаты Постоплата | ||||
subscription_credit_limit | float | Величина кредитного лимита по подписке, заданная на уровне правила обслуживания или переопределенная на уровне клиента | ||||
financial_blocking_threshold | float | Величина порога срабатывания финансовой блокировки, заданная на уровне правила обслуживания или переопределенная на уровне клиента | ||||
account_type_id | integer | ID типа клиента (см. Просмотр списка типов клиентов) | ||||
manager_id | integer | ID Сотрудника, к которому относится клиент | ||||
owner_id | integer | ID пользователя с правами Владелец для клиента | ||||
tech_user_id | integer | ID пользователя, указанного как Технический контакт (см. Просмотр и обновление информации о клиенте) | ||||
bill_user_id | integer | ID пользователя, указанного как Финансовый контакт (см. Просмотр и обновление информации о клиенте) | ||||
custom_attributes | object | Дополнительные параметры клиента (см. Настройка дополнительных параметров) | ||||
attributes.custom-attributes['custom-attribute-key'] | string | Значение дополнительного параметра | ||||
manager | object | Информация о менеджере, к которому относится клиент (см. Просмотр и обновление информации о сотруднике) | ||||
created_at | date | Дата и время создания менеджера | ||||
updated_at | date | Дата и время последнего изменения менеджера | ||||
reseller_id | integer | ID реселлера, к которому относится менеджер | ||||
id | integer | ID менеджера | ||||
name | string | Имя менеджера | ||||
status | string | Статус менеджера:
| ||||
string | Адрес email менеджера, который используется для входа в Панель управления Оператора | |||||
role | string | Уровень доступа менеджера в Панель управления Оператора (список ролей см. в Роли сотрудников) | ||||
custom_attributes | object | Перечень дополнительных параметров менеджера (см. Просмотр списка Дополнительных параметров) | ||||
manager.custom-attributes['custom-attribute-key'] | string | Значение параметра | ||||
owner | object | Информация о связанном пользователе с правами Владелец для клиента | ||||
created_at | string | Дата и время создания пользователя с правами Владелец для клиента | ||||
updated_at | string | Дата и время последнего изменения пользователя с правами Владелец для клиента | ||||
email | string | E-mail пользователя с правами Владелец для клиента | ||||
account_status | string | Текущий статус пользователя для выбранного клиента (подробнее о статусах см. Управление пользователями клиента) | ||||
global_status | string | Глобальный статус пользователя с правами Владелец для клиента | ||||
string | Имя пользователя с правами Владелец для клиента | |||||
middle_name | string | Отчество пользователя с правами Владелец для клиента | ||||
last_name | string | Фамилия пользователя с правами Владелец для клиента | ||||
account_product_managers | array of objects | Ответственные сотрудники для клиента (см. Управление ответственными сотрудниками) | ||||
id | integer | ID записи об ответственном сотруднике | ||||
account_id | integer | ID клиента | ||||
product_id | integer | ID продукта | ||||
responsible_product_manager_id | integer | ID ответственного сотрудника в рамках продукта | ||||
manager_product_role_id | integer | ID роли сотрудника в рамках продукта | ||||
created_at | date | Дата и время создания записи об ответственном сотруднике | ||||
updated_at | date | Дата и время последнего обновления записи об ответственном сотруднике | ||||
self_registration | bool | Признак того, что клиент зарегистрировался в платформе самостоятельно через Панель управления Клиента:
| ||||
default_payment_model | string | Модель оплаты по умолчанию для данного клиента. Возможные значения:
| ||||
account_type | object | Информация о типе клиента (см. Типы клиентов) | ||||
id | integer | ID типа клиента | ||||
name | string | Имя типа клиента | ||||
created_at | date | Дата и время создания типа клиента | ||||
updated_at | date | Дата и время последнего обновления типа клиента | ||||
reseller_id | integer | ID реселлера, к которому относится тип клиента | ||||
name_pattern | string | Шаблон отображения имени клиента в платформе | ||||
primary_name | string | Название поля с основным именем клиента. Например, для типа клиента Юридическое лицо это может быть Название компании | ||||
key | string | Ключ типа клиента | ||||
default_payment_method_id | integer | ID способа оплаты (см. Способы оплаты), который используется по умолчанию для данного типа клиентов | ||||
ancestry | integer | ID родительского типа клиента | ||||
account_class | object | Информация о правиле обслуживания клиента (см. Правила обслуживания) | ||||
id | integer | ID правила обслуживания | ||||
reseller_id | integer | ID реселлера, к которому относится правило обслуживания | ||||
name | string | Название правила обслуживания | ||||
created_at | date | Дата и время создания правила обслуживания | ||||
updated_at | date | Дата и время последнего обновления правила обслуживания | ||||
financial_blocking_threshold | float | Величина порога срабатывания финансовой блокировки, заданная на уровне правила обслуживания | ||||
due_order_period | integer | Период отсрочки оплаты заказа по предоплате в днях | ||||
subzero_period | integer | Разрешенный период отрицательного баланса в днях. Значение -1 подразумевает бесконечный период | ||||
stop_subscription_type | string | Способ остановки подписок клиента при переходе клиента в статус Финансовая блокировка (список способов остановки подписок см. в Создание правила обслуживания) | ||||
key | string | Ключ правила обслуживания. Ключ может быть использован при обращении к правилу обслуживания через API или при настройке событий уведомлений | ||||
color | string | Цвет метки в списке клиентов, который используется для клиентов, обслуживаемых по данному правилу | ||||
guaranteed_payment_limit | integer | Лимит (максимальная величина) обещанного платежа | ||||
guaranteed_payment_period | integer | Период обещанного платежа в днях | ||||
delete_subscription_type | string | Способ удаления подписок клиента (список способов удаления подписок см. в Создание правила обслуживания) | ||||
denominated | bool | Признак выполнения деноминации правила обслуживания:
| ||||
buy_with_negative_balance | bool | Признак доступности оплаты с отрицательным балансом по предоплате:
| ||||
receipt_day | integer | День выставления счетов (поле устарело и не используется) | ||||
payment_model | string | Модель оплаты:
| ||||
default | bool | Признак правила обслуживания по умолчанию для новых клиентов:
| ||||
due_payment_period | integer | Период отсрочки платежа по постоплате в днях | ||||
subscription_credit_limit | float | Величина кредитного лимита по подписке, заданная на уровне правила обслуживания | ||||
relationships | object | Информация о связанных объектах | ||||
subscriptions | object | Информация о связанных подписках | ||||
data | array | Информация о подписке | ||||
id | integer | ID подписки | ||||
type | string | Тип данных |
Пример запроса
GET /api/v3/resellers/1/accounts/505
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": {
"id": "505",
"type": "accounts",
"attributes": {
"created_at": "2019-10-15T13:08:36.440+03:00",
"updated_at": "2020-07-07T11:06:27.264+03:00",
"reseller_id": 1,
"name": "Marcelo Ivanou",
"account_class_id": 1,
"primary_name": "Test api doc",
"first_name": "Marcelo",
"middle_name": "",
"last_name": "Ivanou",
"country": "BY",
"region": "Минская область",
"city": "Минск",
"street": "Lenina",
"building": "1",
"office": "",
"zip": "220007",
"phone": "+375295555555",
"email": "test@example.com",
"status": "active",
"balance": "380.39",
"usable_balance": "380.39",
"current_debt": 0.0,
"subscription_credit_limit": 11000.0,
"financial_blocking_threshold": 0.0,
"account_type_id": 1,
"manager_id": 50,
"owner_id": 874,
"tech_user_id": 874,
"bill_user_id": 874,
"custom_attributes": {
"birth_date": "10.08.2016",
"dns": "",
"invoice": "",
"passport_date_of_issue": "01.07.2016",
"passport_issued_by": "Goverment",
"passport_number": "1124111111122",
"personal_number": "A4411111BB1199"
},
"manager": {
"created_at": "2016-11-30T13:16:27.169+03:00",
"updated_at": "2019-11-22T14:13:28.970+03:00",
"reseller_id": 1,
"id": 50,
"name": "Sales Manager",
"status": "active",
"email": "test@gmail.com",
"role": "sales",
"custom_attributes": {
"ManagerString": "Test"
}
},
"owner": {
"created_at": "2016-10-26T17:38:37.551+03:00",
"updated_at": "2016-12-23T15:04:48.172+03:00",
"email": "owner@example.by",
"account_status": "active",
"global_status": "active",
"first_name": "Alex",
"middle_name": "",
"last_name": "Owner"
},
"account_product_managers": [
{
"id": 431,
"account_id": 710,
"product_id": 400,
"responsible_product_manager_id": 3,
"manager_product_role_id": 2,
"created_at": "2020-12-09T06:15:52.348+03:00",
"updated_at": "2020-12-16T15:38:56.541+03:00"
},
{
"id": 9,
"account_id": 710,
"product_id": 400,
"responsible_product_manager_id": 1,
"manager_product_role_id": 1,
"created_at": "2020-12-09T06:13:40.744+03:00",
"updated_at": "2020-12-16T15:38:56.533+03:00"
}
],
"self_registration": false,
"default_payment_model": "postpay",
"account_type": {
"id": 1,
"name": "Personal BLR",
"created_at": "2016-08-25T09:26:12.658+03:00",
"updated_at": "2021-03-04T06:12:01.425+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personalblr",
"default_payment_method_id": 2,
"ancestry": null,
"use_by_default": true
},
"account_class": {
"id": 1,
"reseller_id": 1,
"name": "Default",
"created_at": "2016-08-25T09:26:12.820+03:00",
"updated_at": "2020-09-05T10:29:21.844+03:00",
"financial_blocking_threshold": "0.0",
"due_order_period": 90,
"subzero_period": 0,
"stop_subscription_type": "automatically",
"key": "default",
"color": "grey",
"guaranteed_payment_limit": 1000,
"guaranteed_payment_period": 7,
"delete_subscription_type": "automatically",
"denominated": false,
"buy_with_negative_balance": false,
"receipt_day": null,
"payment_model": "postpay",
"default": true,
"due_payment_period": 3,
"subscription_credit_limit": "222.0"
}
},
"relationships": {
"subscriptions": {
"data": [
{
"id": "3005863",
"type": "subscriptions"
},
{
"id": "3005862",
"type": "subscriptions"
},
{
"id": "3005749",
"type": "subscriptions"
},
{
"id": "3005691",
"type": "subscriptions"
},
{
"id": "3006017",
"type": "subscriptions"
},
{
"id": "3005871",
"type": "subscriptions"
},
{
"id": "3005868",
"type": "subscriptions"
},
{
"id": "3006016",
"type": "subscriptions"
},
{
"id": "3005870",
"type": "subscriptions"
},
{
"id": "3005869",
"type": "subscriptions"
},
{
"id": "3005867",
"type": "subscriptions"
},
{
"id": "3005865",
"type": "subscriptions"
},
{
"id": "3005875",
"type": "subscriptions"
},
{
"id": "3005866",
"type": "subscriptions"
},
{
"id": "3005864",
"type": "subscriptions"
},
{
"id": "3005861",
"type": "subscriptions"
},
{
"id": "3006034",
"type": "subscriptions"
}
]
}
}
}
}