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

Метод Get a List of the Reseller's Accounts используется для получения списка Клиентов текущего Реселлера или любого из его нижестоящих Реселлеров.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
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ОпциональныйПредназначен для фильтрации списка Клиентов по дате и времени создания в формате RFC 3339 (например, 2019-05-29T15:12:01.558009+03:00 или 2019-05-29)Для указания диапазона используются следующие фильтры:
  • filter[created_at][gt] — дата и время более, чем указанные.
  • filter[created_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"
    }
}