Получение Cписка клиентов по ID пользователя

Метод Get List of Accounts by User ID возвращает список Клиентов, с которыми связан Пользователь, указанный по ID.

 

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

Аргументы

Название

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

Тип данных

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

Описание

user_id

path

integer

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

ID пользователя

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

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

Название

Тип данных

Описание

idintegerУникальный идентификатор Клиента
namestringИмя Клиента
account_class_idintegerУникальный идентификатор Правила обслуживания Клиента (см. Правила обслуживания)
account_classstring

Наименование Правила обслуживания, по которому будет обслуживаться данный Клиент

primary_namestringОсновное название Клиента (например, название организации для юридических лиц)
first_namestringИмя лица, уполномоченного на заключение договора
middle_namestringОтчество лица, уполномоченного на заключение договора
last_namestringФамилия лица, уполномоченного на заключение договора
countrystringКонтакты: Код страны ISO 3166-1 alpha-2
regionstringКонтакты: Область
citystringКонтакты: Город
streetstringКонтакты: Улица
buildingstringКонтакты: Номер дома
officestringКонтакты: Номер офиса
zipstringКонтакты: Индекс
phonestring

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

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

Адрес электронной почты

statusstring

Текущий статус Клиента:

balancefloatТекущее состояние Баланса Клиента
account_type_idinteger

Уникальный идентификатор Типа клиента (см. Типы клиентов)

account_typestringНаименование Типа клиента

default_payment_model

string

Модель оплаты по умолчанию для данного Клиента, заданная в Правиле обслуживания. Возможные значения:

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

current_debt

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

financial_blocking_threshold_use_system

bool

Использование системного значения Порога срабатывания финансовой блокировки:

  • true – используется системное значение кредитного лимита из Правила обслуживания.
  • false – используется значение, переопределенное на уровне Клиента.

financial_blocking_threshold

floatВеличина Порога срабатывания финансовой блокировки, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента, если не используется системное значение кредитного лимита (financial_blocking_threshold_use_system = false)

subscription_credit_limit_use_system

bool

Использование системного значения Кредитного лимита по подписке:

  • true – используется системное значение кредитного лимита из Правила обслуживания или переопределенное на уровне Клиента.
  • false – используется значение, переопределенное на уровне Подписки.

subscription_credit_limit

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

ID Сотрудника Оператора, который будет прикреплен к данному Клиенту.

owner_idinteger

ID Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_first_name

stringИмя созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_last_name

stringФамилия созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_middle_name

stringОтчество созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента

new_owner_email

stringEmail созданного Пользователя, который связан с данным Клиентом и имеет уровень доступа Владелец в Панель управления Клиента
tech_user_idintegerID Пользователя, который является техническим контактом
bill_user_idintegerID Пользователя, который является финансовым контактом
custom_attributesarray

Дополнительные параметры позволяют добавлять в ActivePlatform дополнительную информацию (см. Настройка дополнительных параметров)


namestringИмя дополнительного параметра

valueЗависит от атрибутаЗначение дополнительного параметра
created_atdateДата и время создания Клиента
updated_atdateДата и время последнего изменения информации о Клиенте

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

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

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

[
    {
        "id": 457,
        "name": "John Doe",
        "account_class_id": 1,
        "account_class": "Default",
        "primary_name": "John Doe",
        "first_name": "John",
        "middle_name": "",
        "last_name": "Doe",
        "country": "BY",
        "region": "BY",
        "city": "Minsk",
        "street": "Lenina 1",
        "building": "",
        "office": "",
        "zip": "220000",
        "phone": "+375225555555",
        "email": "John.Doe@example.com",
        "status": "active",
        "balance": "366.0",
        "account_type_id": 1602,
        "account_type": "Юридическое лицо",
        "default_payment_model": "prepay",
        "current_debt": 448.02,
        "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": 837,
        "new_owner_first_name": null,
        "new_owner_last_name": null,
        "new_owner_middle_name": null,
        "new_owner_email": null,
        "tech_user_id": 837,
        "bill_user_id": 837,
        "custom_attributes": [
            {
                "name": "Личный номер",
                "value": "A4411111BB1122"
            },
            {
                "name": "Дата рождения",
                "value": "10.08.2016"
            },
            {
                "name": "Дата выдачи",
                "value": "01.07.2016"
            },
            {
                "name": "Номер паспорта",
                "value": "1124111111122"
            },
            {
                "name": "Кем выдан",
                "value": "Government"
            }
        ],
        "created_at": "2019-09-16T10:46:25.667+03:00",
        "updated_at": "2019-10-15T17:33:38.172+03:00"
    },
    {
        "id": 452,
        "name": "ActivePlatform Development",
        "account_class_id": 1,
        "account_class": "Default",
        "primary_name": "ActivePlatform Development",
        "first_name": "Jack",
        "middle_name": "",
        "last_name": "Black",
        "country": "RU",
        "region": "Московская",
        "city": "Москва",
        "street": "Дербеневская набережная",
        "building": "7",
        "office": "",
        "zip": "115114",
        "phone": "+375291234567",
        "email": "test@testqwe.com",
        "status": "active",
        "balance": "2990073.5",
        "account_type_id": 1602,
        "account_type": "Юридическое лицо",
        "default_payment_model": "prepay",
        "current_debt": 0.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": 831,
        "new_owner_first_name": null,
        "new_owner_last_name": null,
        "new_owner_middle_name": null,
        "new_owner_email": null,
        "tech_user_id": 831,
        "bill_user_id": 831,
        "custom_attributes": [
            {
                "name": "Личный номер",
                "value": "A4411111BB1123"
            },
            {
                "name": "Дата рождения",
                "value": "10.08.2016"
            },
            {
                "name": "Дата выдачи",
                "value": "01.07.2016"
            },
            {
                "name": "Номер паспорта",
                "value": "1124111111123"
            },
            {
                "name": "Кем выдан",
                "value": "Government"
            }
        ],
        "created_at": "2019-04-02T11:31:06.805+03:00",
        "updated_at": "2019-08-14T01:17:51.214+03:00"
    }
]