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

Метод Get List of Accounts возвращает список всех Клиентов.

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

Аргументы

Название

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

Тип данных

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

Описание

page

query

integer

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

Возвращается список Клиентов по указанному номеру страницы

per_page

query

integer

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

Установка числа элементов на странице

sorting[field]

query

string

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

Сортировка списка по указанному полю

sorting[reversed]

query

string

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

Установка режима обратной сортировки по указанному полю:

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

filters[created_at]

query

date

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

Фильтрация списка по дате создания

filters[updated_at]

query

date

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

Фильтрация списка по дате обновления

filters[status]

query

string

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

Фильтрация списка по статусу

filters[email]

query

string

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

Фильтрация списка по email

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

Название

Тип данных

Описание

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

Email лица, уполномоченного на заключение договора

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Величина Порога срабатывания финансовой блокировки, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента

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/accounts.json?api_token=vY5fwetestK3gJXZH5uHCw&per_page=2&page=4&sorting[field]=id&sorting[reversed]=true&filters[status]=deleted

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

[
    {
        "id": 486,
        "name": "John  Doe",
        "account_class_id": 1,
        "account_class": "Default",
        "primary_name": "",
        "first_name": "John",
        "middle_name": "",
        "last_name": "Doe",
        "country": "US",
        "region": "NY",
        "city": "Brooklyn",
        "street": "Westminster ave.",
        "building": "",
        "office": "",
        "zip": "11230",
        "phone": "+5554000",
        "email": "test@example.com",
        "status": "deleted",
        "balance": "8.22",
        "account_type_id": 1564,
        "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": 846,
        "new_owner_first_name": null,
        "new_owner_last_name": null,
        "new_owner_middle_name": null,
        "new_owner_email": null,
        "tech_user_id": 846,
        "bill_user_id": 846,
        "custom_attributes": {},
        "created_at": "2019-12-04T13:55:12.585+03:00",
        "updated_at": "2019-08-19T15:09:25.104+03:00"
    },
    {
        "id": 300,
        "name": "Kate S Closecharges",
        "account_class_id": 1180,
        "account_class": "By Default new",
        "primary_name": "",
        "first_name": "Kate",
        "middle_name": "S",
        "last_name": "Closecharges",
        "country": "BY",
        "region": "4",
        "city": "grodno",
        "street": "Lenina",
        "building": "13",
        "office": "",
        "zip": "123456",
        "phone": "+375444444444",
        "email": "example@gmail.com",
        "status": "deleted",
        "balance": "0.0",
        "account_type_id": 1,
        "account_type": "Personal BLR",
        "default_payment_model": "prepay",
        "current_debt": 0.0,
        "financial_blocking_threshold_use_system": true,
        "financial_blocking_threshold": 0.0,
        "subscription_credit_limit_use_system": true,
        "subscription_credit_limit": 0.0,
        "manager_id": null,
        "owner_id": 679,
        "new_owner_first_name": null,
        "new_owner_last_name": null,
        "new_owner_middle_name": null,
        "new_owner_email": null,
        "tech_user_id": 679,
        "bill_user_id": 679,
        "custom_attributes": {
            "passport_date_of_issue": "01.07.2018",
            "personal_number": "3213213",
            "invoice": "0",
            "dns": "0",
            "passport_issued_by": "Gov",
            "birth_date": "",
            "passport_number": "32323233",
            "tenantname": "",
            "tenantID": ""
        },
        "created_at": "2018-08-18T14:51:48.394+03:00",
        "updated_at": "2019-02-01T16:51:38.008+03:00"
    }
]