Получение списка клиентов

Метод Get list of accounts используется для получения списка клиентов текущего реселлера или любого из его нижестоящих реселлеров.

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

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

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

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

Аргументы

Название

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

Тип данных

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

Описание

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

page[size]

query

number

Опциональный

Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)

page[number]

query

number

Опциональный

Параметр постраничной навигации. Номер страницы ответа

filter[email]querystringОпциональныйПредназначен для фильтрации списка клиентов по указанному email лица, уполномоченного на заключение договора. Допускается указание нескольких значений, разделенных запятой
filter[user_email]querystringОпциональныйПредназначен для фильтрации списка клиентов по указанному email пользователя. Запрашивается список клиентов, с которыми у данного пользователя установлена связь (см. Управление пользователями)
filter[inn]querystringОпциональный

Предназначен для фильтрации списка клиентов по указанному ИНН. ИНН клиента задается в дополнительном параметре inn (см. Настройка дополнительных параметров)

filter[created_at]querystringОпциональныйПредназначен для фильтрации списка клиентов по дате и времени создания клиента в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[created_at][gt] — дата и время более, чем указанные.
  • filter[created_at][lt] — дата и время менее, чем указанные.
filter[updated_at]querystringОпциональныйПредназначен для фильтрации списка клиентов по дате и времени последнего обновления клиента в формате ГГГГ-ММ-ДД или ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[updated_at][gt] — дата и время более, чем указанные.
  • filter[updated_at][lt] — дата и время менее, чем указанные.
includequerystringОпциональный

Предназначен для включения в ответ дополнительной информации о связанных объектах. Поддерживается следующий объект:

ОбъектЗначение параметра
Подпискаsubscriptions

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

Название

Тип данных

Описание

dataarray of objectsДанные ответа


id

string

ID клиента

typestringТип данных

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


created_at

string

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


updated_at

string

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


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


namestringИмя клиента


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


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

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


subscription_credit_limit

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


financial_blocking_threshold

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


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


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


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


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


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


custom_attributes

object

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




attributes.custom-attributes['custom-attribute-key']string

Значение дополнительного параметра.

Например, ИНН клиента: inn



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



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



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



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



idnumberID менеджера



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_managersarrayОтветственные сотрудники для клиента (см. Управление ответственными сотрудниками)



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



account_idnumberID клиента



product_idnumberID продукта



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



manager_product_role_id

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



created_at

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



updated_at

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


self_registration

bool

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

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


default_payment_model

string

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

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


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



id

number

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



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



created_at

string

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



updated_at

string

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



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



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



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



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



default_payment_method_idnumber

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




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



used_by_defaultbool

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

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


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



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



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



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



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



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



financial_blocking_threshold

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



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



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



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



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



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



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



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



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



denominatedbool

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

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



buy_with_negative_balancebool

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

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



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



payment_modelstring

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

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



defaultbool

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

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



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



subscription_credit_limit

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

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


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



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




idstring
ID подписки




typestringТип данных
includedarray

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idstringID объекта
typestringТип данных
attributesobjectАтрибуты (состав данных см. ниже)

Для подписки:

НазваниеТип данныхОписание

created_at

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

updated_at

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

auto_renewal

bool

Признак автопродления подписки:

  • true — признак автопродления установлен.
  • false — признак автопродления не установлен.

billing_from

stringДата начала платного периода подписки

expiration_date

stringДата истечения подписки

name

stringНазвание подписки

renew_point_days

numberТочка автоматического продления подписки (в днях)

start_date

stringДата активации подписки

status

stringСтатус подписки (список статусов см. в Просмотр списка подписок)

payment_model

string

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

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

payment_model_parameters

objectПараметры модели оплаты подписки

credit_limitnumberВеличина кредитного лимита по подписке, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay

current_debtnumberВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay
linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу

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

GET /api/v3/resellers/1/accounts?page[size]=2&page[number]=1&filter[email]=test@example.com&include=subscriptions
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "487",
            "type": "accounts",
            "attributes": {
                "created_at": "2019-08-19T15:10:43.222+03:00",
                "updated_at": "2019-08-19T15:16:49.990+03:00",
                "reseller_id": 1,
                "name": "Vit August",
                "account_class_id": 1,
                "primary_name": "",
                "first_name": "Vit ",
                "middle_name": "",
                "last_name": "August",
                "country": "US",
                "region": "NY",
                "city": "Brooklyn",
                "street": "Westminster ave.",
                "building": "",
                "office": "",
                "zip": "11230",
                "phone": "+16030000000",
                "email": "test@example.com",
                "status": "deleted",
                "balance": "0.0",
                "usable_balance": "0.0",
                "current_debt": 0,
                "subscription_credit_limit": 0,
                "financial_blocking_threshold": 100,
                "account_type_id": 1564,
                "manager_id": 223,
                "owner_id": 847,
                "tech_user_id": 847,
                "bill_user_id": 847,
                "custom_attributes": {
                    "inn": "00012345678"
                },
                "manager": {
                    "created_at": "2020-04-01T11:14:21.837+03:00",
                    "updated_at": "2019-12-30T14:40:31.322+03:00",
                    "reseller_id": 1,
                    "id": 223,
                    "name": "Bill Toss",
                    "status": "active",
                    "email": "manager@example.by",
                    "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": [],
                "self_registration": false,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 1564,
                    "name": "Физическое лицо",
                    "created_at": "2017-03-20T16:34:28.163+03:00",
                    "updated_at": "2017-03-20T16:34:28.163+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personal",
                    "default_payment_method_id": null,
                    "ancestry": "1562",
                    "use_by_default": false
                },
                "account_class": {
                    "id": 1,
                    "reseller_id": 1,
                    "name": "Default",
                    "created_at": "2016-08-25T09:26:12.820+03:00",
                    "updated_at": "2019-10-27T10:58:46.758+03:00",
                    "financial_blocking_threshold": "100.0",
                    "due_order_period": 90,
                    "subzero_period": 1,
                    "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": "prepay",
                    "default": true,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3005606",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        },
        {
            "id": "503",
            "type": "accounts",
            "attributes": {
                "created_at": "2019-08-22T15:59:53.492+03:00",
                "updated_at": "2019-09-20T10:50:27.033+03:00",
                "reseller_id": 1,
                "name": "Vit  Ada",
                "account_class_id": 1687,
                "primary_name": "DepV0304-4",
                "first_name": "Vit",
                "middle_name": "",
                "last_name": "Ada",
                "country": "TW",
                "region": "Московская",
                "city": "Москва",
                "street": "Первая",
                "building": "",
                "office": "",
                "zip": "119002",
                "phone": "+74950000001",
                "email": "test@example.com",
                "status": "active",
                "balance": "-4.0",
                "usable_balance": "-4.0",
                "current_debt": 3,
                "subscription_credit_limit": 0,
                "financial_blocking_threshold": 10,
                "account_type_id": 1564,
                "manager_id": 223,
                "owner_id": 866,
                "tech_user_id": 866,
                "bill_user_id": 866,
                "custom_attributes": {},
                "manager": {
                    "created_at": "2020-04-01T11:14:21.837+03:00",
                    "updated_at": "2019-12-30T14:40:31.322+03:00",
                    "reseller_id": 1,
                    "id": 223,
                    "name": "Bill Toss",
                    "status": "active",
                    "email": "manager@example.by",
                    "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": [],
                "self_registration": false,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 1564,
                    "name": "Физическое лицо",
                    "created_at": "2017-03-20T16:34:28.163+03:00",
                    "updated_at": "2017-03-20T16:34:28.163+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personal",
                    "default_payment_method_id": null,
                    "ancestry": "1562",
                    "use_by_default": false
                },
                "account_class": {
                    "id": 1687,
                    "reseller_id": 1,
                    "name": "Prepay",
                    "created_at": "2019-02-09T10:23:10.267+03:00",
                    "updated_at": "2019-09-20T10:48:33.157+03:00",
                    "financial_blocking_threshold": "10.0",
                    "due_order_period": 8,
                    "subzero_period": 1,
                    "stop_subscription_type": "automatically",
                    "key": "Prepay",
                    "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": "prepay",
                    "default": false,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3005649",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": "3005606",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2019-08-19T15:12:05.525024+0300",
                "updated_at": "2019-08-19T15:12:05.525024+0300",
                "auto_renewal": false,
                "billing_from": null,
                "expiration_date": null,
                "name": "Office USA monthly",
                "renew_point_days": 0,
                "start_date": null,
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "3005649",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2019-08-22T15:59:54.138703+0300",
                "updated_at": "2019-09-20T10:47:07.896382+0300",
                "auto_renewal": false,
                "billing_from": "2019-08-22",
                "expiration_date": "2019-12-22",
                "name": "Auto provisioning with resources",
                "renew_point_days": 1,
                "start_date": "2019-08-22",
                "status": "waiting_for_manual_approve",
                "payment_model": "postpay",
                "payment_model_parameters": {
                    "credit_limit": 0,
                    "current_debt": 3
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/accounts?filter%5Bemail%5D=test%40example.com&include=subscriptions&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/accounts?filter%5Bemail%5D=test%40example.com&include=subscriptions&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/accounts?filter%5Bemail%5D=test%40example.com&include=subscriptions&page%5Bnumber%5D=1&page%5Bsize%5D=2"
    }
}