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

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

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

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

page[size]

query

integer

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

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

page[number]

query

integer

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

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

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] — дата и время менее, чем указанные.

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

Название

Тип данных

Описание

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


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

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



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


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

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

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



buy_with_negative_balancebool

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

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



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



payment_modelstring

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

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



defaultbool

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

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



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



subscription_credit_limit

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

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


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



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




idintegerID Подписки




typestringТип данных
linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

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

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

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

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

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

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

GET /api/v3/resellers/1/child_reseller_accounts/?page[size]=2&page[number]=87
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "167",
            "type": "accounts",
            "attributes": {
                "created_at": "2017-08-16T12:48:21.629+03:00",
                "updated_at": "2020-03-02T01:18:33.431+03:00",
                "reseller_id": 1,
                "name": "John New",
                "account_class_id": 1,
                "primary_name": "",
                "first_name": "John",
                "middle_name": "",
                "last_name": "New",
                "country": "BY",
                "region": "1",
                "city": "Brest",
                "street": "Main",
                "building": "",
                "office": "29",
                "zip": "200000",
                "phone": "+375292000000",
                "email": "example@gmail.com",
                "status": "active",
                "balance": "123423.0",
                "current_debt": 0.0,
                "subscription_credit_limit": 0.0,
                "financial_blocking_threshold": 100.0,
                "account_type_id": 1,
                "manager_id": 50,
                "owner_id": 447,
                "tech_user_id": 447,
                "bill_user_id": 447,
                "custom_attributes": {
                    "passport_number": "12345678",
                    "passport_issued_by": "432",
                    "passport_date_of_issue": "22.08.2017",
                    "personal_number": "1234123",
                    "birth_date": "03.08.1977",
                    "invoice": "0",
                    "dns": "0"
                },
                "manager": {
                    "created_at": "2016-11-30T13:16:27.169+03:00",
                    "updated_at": "2019-05-29T10:24:04.734+03:00",
                    "reseller_id": 1,
                    "id": 50,
                    "name": "Sales Manager",
                    "status": "active",
                    "email": "test@gmail.com",
                    "role": "sales",
                    "custom_attributes": {
                        "manager": "",
                        "m_anager": "",
                        "manager_attribute": "1"
                    }
                },
				"owner": {
	                "created_at": "2020-11-19T11:42:21.421+03:00",
    	            "updated_at": "2020-11-19T11:42:21.421+03:00",
        	        "email": "kristoffer.haag@example.com",
            	    "account_status": "active",
                	"global_status": "active",
                	"first_name": "Carlo",
                	"middle_name": "",
                	"last_name": "Yundt"
            	},
				"account_product_managers": [],
				"self_registration": false,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 1,
                    "name": "Personal BLR",
                    "created_at": "2016-08-25T09:26:12.658+03:00",
                    "updated_at": "2019-05-08T07:21:42.843+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": false
                },
                "account_class": {
                    "id": 1,
                    "reseller_id": 1,
                    "name": "Default",
                    "created_at": "2016-08-25T09:26:12.820+03:00",
                    "updated_at": "2019-09-20T10:45:48.595+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": false,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3002319",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        },
        {
            "id": "174",
            "type": "accounts",
            "attributes": {
                "created_at": "2017-08-31T16:36:02.991+03:00",
                "updated_at": "2019-02-01T16:51:37.442+03:00",
                "reseller_id": 1,
                "name": "younes  pak",
                "account_class_id": 1,
                "primary_name": "",
                "first_name": "younes",
                "middle_name": "",
                "last_name": "pak",
                "country": "BY",
                "region": "minsk",
                "city": "minsk",
                "street": "minskaya",
                "building": "123",
                "office": "29",
                "zip": "213451",
                "phone": "+375290000000",
                "email": "example@example.com",
                "status": "inactive",
                "balance": "20000.0",
                "current_debt": 0.0,
                "subscription_credit_limit": 0.0,
                "financial_blocking_threshold": 100.0,
                "account_type_id": 1564,
                "manager_id": null,
                "owner_id": 467,
                "tech_user_id": 467,
                "bill_user_id": 467,
                "custom_attributes": {},
                "manager": null,
				"owner": {
	                "created_at": "2020-11-19T11:42:21.421+03:00",
    	            "updated_at": "2020-11-19T11:42:21.421+03:00",
        	        "email": "kristoffer.haag@example.com",
            	    "account_status": "active",
                	"global_status": "active",
                	"first_name": "Carlo",
                	"middle_name": "",
                	"last_name": "Yundt"
            	},
				"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"
                },
                "account_class": {
                    "id": 1,
                    "reseller_id": 1,
                    "name": "Default",
                    "created_at": "2016-08-25T09:26:12.820+03:00",
                    "updated_at": "2019-09-20T10:45:48.595+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": false,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3002151",
                            "type": "subscriptions"
                        },
                        {
                            "id": "3002152",
                            "type": "subscriptions"
                        },
                        {
                            "id": "3002150",
                            "type": "subscriptions"
                        },
                        {
                            "id": "3002154",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/accounts?page%5Bnumber%5D=87&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/accounts?page%5Bnumber%5D=86&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/accounts?page%5Bnumber%5D=88&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/accounts?page%5Bnumber%5D=153&page%5Bsize%5D=2"
    }
}