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

Метод Get Account Info by ID позволяет получить информацию о существующем Клиенте по ID данного Клиента.

GET /api/vendor/v1/accounts/{account_id}.json?api_token={api_token}

Аргументы

Название	Тип параметров	Тип данных	Обязательный/Опциональный	Описание
account_id	path	integer	Обязательный	ID Клиента
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

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

Название		Тип данных	Описание
id		integer	Уникальный идентификатор Клиента
name		string	Имя Клиента
account_class_id		integer	Уникальный идентификатор Правила обслуживания Клиента (см. Правила обслуживания)
account_class		string	Наименование Правила обслуживания, по которому будет обслуживаться данный Клиент
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	Контакты: Телефон в международном формате: + < код страны > < код города или сети > < номер телефона > 00 < код страны > < код города или сети > < номер телефона >
email		string	Адрес электронной почты
status		string	Текущий статус Клиента: active – для данного Клиента доступен заказ новых и использование существующих услуг. administrative hold – Клиент был заблокирован сотрудником Оператора (см. Административная блокировка Клиента). credit hold – Клиент был заблокирован автоматически из-за возникшей задолженности (см. Финансовая блокировка клиента). Условие блокировки Клиента задаются в Правиле обслуживания, к которому относится клиент (см. Правила обслуживания). deleted – Клиент был удален Сотрудником Оператора (см. Удаление клиента).
balance		float	Текущее состояние Баланса Клиента
account_type_id		integer	Уникальный идентификатор Типа клиента (см. Типы клиентов)
account_type		string	Наименование Типа клиента
default_payment_model		string	Модель оплаты по умолчанию для данного Клиента, заданная в Правиле обслуживания. Возможные значения: prepay – Предоплата. postpay – Постоплата.
current_debt		float	Величина текущей задолженности по всем Подпискам Клиента с моделью оплаты Постоплата
financial_blocking_threshold_use_system		bool	Использование системного значения Порога срабатывания финансовой блокировки: true – используется системное значение кредитного лимита из Правила обслуживания. false – используется значение, переопределенное на уровне Клиента.
financial_blocking_threshold		float	Величина Порога срабатывания финансовой блокировки, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента
subscription_credit_limit_use_system		bool	Использование системного значения Кредитного лимита по подписке: true – используется системное значение кредитного лимита из Правила обслуживания. false – используется значение, переопределенное на уровне Клиента.
subscription_credit_limit		float	Величина Кредитного лимита по подписке, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента
manager_id		integer	ID Сотрудника Оператора, который будет прикреплен к данному Клиенту
owner_id		integer	ID Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
new_owner_first_name		string	Имя созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
new_owner_last_name		string	Фамилия созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
new_owner_middle_name		string	Отчество созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
new_owner_email		string	Email созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
tech_user_id		integer	ID Пользователя, который является техническим контактом
bill_user_id		integer	ID Пользователя, который является финансовым контактом
custom_attributes		array	Дополнительные параметры позволяют добавлять в ActivePlatform дополнительную информацию (см. Настройка дополнительных параметров)
	name	string	Имя дополнительного параметра
	value	Зависит от атрибута	Значение дополнительного параметра
created_at		date	Дата и время создания Клиента
updated_at		date	Дата и время последнего изменения информации о Клиенте

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

GET /api/vendor/v1/accounts/431.json?api_token=vY5fwetestK3gJXZH5uHCw

Пример ответа

{
    "id": 431,
    "name": "Jane Lane",
    "account_class_id": 1,
    "account_class": "Default",
    "primary_name": "",
    "first_name": "Jane",
    "middle_name": "",
    "last_name": "Lane",
    "country": "BY",
    "region": "minski",
    "city": "minsk",
    "street": "minsk",
    "building": "",
    "office": "",
    "zip": "220000",
    "phone": "+375291234567",
    "email": "test@example.com",
    "status": "credit_hold",
    "balance": "453.2",
    "account_type_id": 1564,
    "account_type": "Физическое лицо",
    "default_payment_model": "prepay",
    "current_debt": 24.0,
    "financial_blocking_threshold_use_system": true,
    "financial_blocking_threshold": 100.0,
    "subscription_credit_limit_use_system": true,
    "subscription_credit_limit": 0.0,
    "manager_id": null,
    "owner_id": 23,
    "new_owner_first_name": null,
    "new_owner_last_name": null,
    "new_owner_middle_name": null,
    "new_owner_email": null,
    "tech_user_id": 23,
    "bill_user_id": 23,
    "custom_attributes": [
        {
            "name": "Личный номер",
            "value": "A4411111BB1123"
        },
        {
            "name": "Дата рождения",
            "value": "10.08.2016"
        },
        {
            "name": "Дата выдачи",
            "value": "01.07.2016"
        },
        {
            "name": "Номер паспорта",
            "value": "1124111111123"
        },
        {
            "name": "Кем выдан",
            "value": "Government"
        }
    ],
    "created_at": "2019-01-15T14:58:22.830+03:00",
    "updated_at": "2019-05-12T01:22:52.853+03:00"
}