Получение информации о клиенте

Метод Get account используется для получения информации о клиенте текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

account_id

pathintegerОбязательный

ID клиента

Модель ответа

Название

Тип данных

Описание

dataobjectДанные ответа


id

integer

ID клиента

typestringТип данных

attributesobjectИнформация о клиенте


created_at

date

Дата и время создания клиента


updated_at

date

Дата и время последнего обновления клиента


reseller_idintegerID реселлера, к которому относится клиент


namestringИмя клиента


account_class_idintegerID правила обслуживания клиента


primary_namestringОсновное имя клиента (например, название компании для юридического лица)


first_name

string

Имя лица, уполномоченного на заключение договора


middle_name

string

Отчество лица, уполномоченного на заключение договора


last_name

string

Фамилия лица, уполномоченного на заключение договора


countrystringКонтакты: Код страны ISO 3166-1 alpha-2


regionstringКонтакты: Регион


citystringКонтакты: Город


streetstringКонтакты: Улица


buildingstringКонтакты: Дом


officestringКонтакты: Номер офиса


zipstringКонтакты: Почтовый индекс


phonestring

Контакты: Телефон в международном формате:

  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


email

string

Email лица, уполномоченного на заключение договора


status

string

Статус клиента (см. Просмотр и обновление информации о клиенте)



balancestringПолный баланс клиента как сумма свободных средств (см. usable_balance) и всех заблокированных списаний


usable_balancestringСвободные средства на балансе клиента


current_debt

floatВеличина текущей задолженности по всем подпискам клиента с моделью оплаты Постоплата


subscription_credit_limit

floatВеличина кредитного лимита по подписке, заданная на уровне правила обслуживания или переопределенная на уровне клиента


financial_blocking_threshold

floatВеличина порога срабатывания финансовой блокировки, заданная на уровне правила обслуживания или переопределенная на уровне клиента


account_type_idintegerID типа клиента (см. Просмотр списка типов клиентов)


manager_idintegerID Сотрудника, к которому относится клиент 


owner_idintegerID пользователя с правами Владелец для клиента


tech_user_idintegerID пользователя, указанного как Технический контакт (см. Просмотр и обновление информации о клиенте)


bill_user_idintegerID пользователя, указанного как Финансовый контакт (см. Просмотр и обновление информации о клиенте)


custom_attributes

object

Дополнительные параметры клиента (см. Настройка дополнительных параметров)




attributes.custom-attributes['custom-attribute-key']stringЗначение дополнительного параметра


managerobjectИнформация о менеджере, к которому относится клиент (см. Просмотр и обновление информации о сотруднике)



created_atdateДата и время создания менеджера



updated_atdateДата и время последнего изменения менеджера



reseller_idintegerID реселлера, к которому относится менеджер



idintegerID менеджера



namestringИмя менеджера



statusstring

Статус менеджера:

  • active — доступ в Панель управления Оператора разрешен.
  • inactive — доступ в Панель управления Оператора заблокирован.



emailstringАдрес email менеджера, который используется для входа в Панель управления Оператора



rolestringУровень доступа менеджера в Панель управления Оператора (список ролей см. в Роли сотрудников)



custom_attributes

object

Перечень дополнительных параметров менеджера (см. Просмотр списка Дополнительных параметров)




manager.custom-attributes['custom-attribute-key']stringЗначение параметра


ownerobjectИнформация о связанном пользователе с правами Владелец для клиента



created_at

stringДата и время создания пользователя с правами Владелец для клиента



updated_at

stringДата и время последнего изменения пользователя с правами Владелец для клиента



email

stringE-mail пользователя с правами Владелец для клиента



account_status

stringТекущий статус пользователя для выбранного клиента (подробнее о статусах см. Управление пользователями клиента)



global_status

stringГлобальный статус пользователя с правами Владелец для клиента




string

Имя пользователя с правами Владелец для клиента




middle_namestringОтчество пользователя с правами Владелец для клиента



last_namestringФамилия пользователя с правами Владелец для клиента


account_product_managers

array of objectsОтветственные сотрудники для клиента (см. Управление ответственными сотрудниками)



idintegerID записи об ответственном сотруднике



account_idintegerID клиента



product_idintegerID продукта



responsible_product_manager_id

integerID ответственного сотрудника в рамках продукта



manager_product_role_id

integerID роли сотрудника в рамках продукта



created_at

dateДата и время создания записи об ответственном сотруднике



updated_at

dateДата и время последнего обновления записи об ответственном сотруднике


self_registration

bool

Признак того, что клиент зарегистрировался в платформе самостоятельно через Панель управления Клиента:

  • true — клиент зарегистрировался в платформе самостоятельно через Панель управления Клиента.
  • false — клиент создан сотрудником через Панель управления Оператора или API.


default_payment_model

string

Модель оплаты по умолчанию для данного клиента. Возможные значения:

  • prepay Предоплата.
  • postpay Постоплата.


account_typeobjectИнформация о типе клиента (см. Типы клиентов)



id

integer

ID типа клиента



namestringИмя типа клиента



created_at

date

Дата и время создания типа клиента



updated_at

date

Дата и время последнего обновления типа клиента



reseller_idintegerID реселлера, к которому относится тип клиента



name_patternstringШаблон отображения имени клиента в платформе



primary_namestringНазвание поля с основным именем клиента. Например, для типа клиента Юридическое лицо это может быть Название компании



keystringКлюч типа клиента



default_payment_method_idinteger

ID способа оплаты (см. Способы оплаты), который используется по умолчанию для данного типа клиентов




ancestryintegerID родительского типа клиента


account_classobjectИнформация о правиле обслуживания клиента (см. Правила обслуживания)



idintegerID правила обслуживания



reseller_idintegerID реселлера, к которому относится правило обслуживания



namestringНазвание правила обслуживания



created_atdateДата и время создания правила обслуживания



updated_atdateДата и время последнего обновления правила обслуживания



financial_blocking_threshold

floatВеличина порога срабатывания финансовой блокировки, заданная на уровне правила обслуживания



due_order_periodintegerПериод отсрочки оплаты заказа по предоплате в днях



subzero_periodintegerРазрешенный период отрицательного баланса в днях. Значение -1 подразумевает бесконечный период



stop_subscription_typestringСпособ остановки подписок клиента при переходе клиента в статус Финансовая блокировка (список способов остановки подписок см. в Создание правила обслуживания)



keystringКлюч правила обслуживания. Ключ может быть использован при обращении к правилу обслуживания через API или при настройке событий уведомлений



colorstringЦвет метки в списке клиентов, который используется для клиентов, обслуживаемых по данному правилу



guaranteed_payment_limitintegerЛимит (максимальная величина) обещанного платежа



guaranteed_payment_periodintegerПериод обещанного платежа в днях



delete_subscription_typestringСпособ удаления подписок клиента (список способов удаления подписок см. в Создание правила обслуживания)



denominatedbool

Признак выполнения деноминации правила обслуживания:

  • false — деноминация правила обслуживания не выполнялась.
  • true — деноминация правила обслуживания выполнена.



buy_with_negative_balancebool

Признак доступности оплаты с отрицательным балансом по предоплате:

  • false — оплата с отрицательным балансом недоступна.
  • true — оплата с отрицательным балансом доступна.



receipt_dayintegerДень выставления счетов (поле устарело и не используется)



payment_modelstring

Модель оплаты:

  • postpay Постоплата.
  • prepay Предоплата.



defaultbool

Признак правила обслуживания по умолчанию для новых клиентов:

  • false — правило обслуживания не используется по умолчанию для новых клиентов.
  • true — правило обслуживания используется по умолчанию для новых клиентов.



due_payment_periodintegerПериод отсрочки платежа по постоплате в днях



subscription_credit_limit

floatВеличина кредитного лимита по подписке, заданная на уровне правила обслуживания

relationshipsobjectИнформация о связанных объектах


subscriptionsobjectИнформация о связанных подписках



dataarrayИнформация о подписке




idintegerID подписки




typestringТип данных

Пример запроса

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"
                    }
                ]
            }
        }
    }
}