Перейти к основному контенту

Список агентов

POST /v2/agent/list
{
  "params": {
    "idAgent": 0,
    "sub": 0,
    "name": "string",
    "bin": "string",
    "address": "string",
    "idAgentSearch": 0,
    "idTerminal": 0,
    "login": "string",
    "cellPhone": "string",
    "columns": [
      "nowBalance",
      "credit",
      "rnn",
      "firstPaymentDate",
      "lastPaymentDate",
      "balancePlusSub",
      "blocked",
      "idParent",
      "namePrint",
      "leader",
      "email",
      "phone",
      "bbik",
      "bAccount",
      "contract",
      "ownerType"
    ],
    "format": "xlsx"
  }
}
  • idAgent - Идентификатор агента, под которым будет поиск агентов. Необязательное поле, по умолчанию берется авторизованный агент.
  • sub - 0 - только агент, 1 - только субагенты всех уровней, 2 - все, агент и субагенты всех уровней, 3 - только субагенты (следующего от агента уровня), 4 - агент и субагенты (следующего от агента уровня). Необязательное поле.
  • name - Наименование агента. Для поиска агента по имени или его части. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • bin - БИН агента. Для поиска агента по БИН. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • address - Адрес агента. Для поиска агента по адресу или его части. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • idAgentSearch - Идентификатор агента. Для поиска агента по номеру. Необязательное поле. Если параметра нет, то вернутся все агенты.
  • idTerminal - Идентификатор терминала. Для поиска агента по терминалу. Необязательное поле. 
  • login - Логин пользователя. Для поиска агента по логину пользователя. Можно указать часть логина. Необязательное поле. 
  • cellPhone - Телефон пользователя. Для поиска агента по телефону пользователя. Можно указать часть телефона. Необязательное поле.
  • columns - массив с перечислением дополнительных полей для каждого агента. Необязательное поле. Если параметра нет, то вернется только idAgent,agentName,parentName,agentAddress.
  • format - формат ответа. Не обязательное поле. По умолчанию обычный ответ в json. Доступен xlsx.

Доступны следующие значения для columns:

  • nowBalance - текущий баланс;
  • credit - кредитный лимит;
  • rnn - рнн;
  • bin - ИИН/БИН;
  • blocked - если true - агент заблокирован, нет или false - нормальный агент;
  • firstPaymentDate - дата первого платежа;
  • lastPaymentDate - дата последнего платежа;
  • balancePlusSub - "баланс включая субагентов" (рассчитывается как "баланс агента" + sum(NowBalance + Credit) по всей ветке дерева субагентов);
  • idParent - идентификатор агента родителя;
  • namePrint - Наименование агента для бух. документов;
  • leader - ФИО первого руководителя;
  • created - Дата регистрации, Дата создания агента в ПС;
  • email - E-mail субагента;
  • phone - Контактный телефон;
  • bbik - Банковские реквизиты, БИК банка;
  • bAccount - Банковские реквизиты, счет в банке;
  • contract - номер и дата договора субагента;
  • ownerType - Юридическая форма, Форма собственности: 0 - ИП, 1 - ТОО;

firstPaymentDate, lastPaymentDate и balancePlusSub - использовать только если действительно нужно - запрос будет работать дольше

 

Ответ:

{
  "code": 0,
  "message": "string",
  "data": [
    {
      "idAgent": 0,
      "agentName": "string",
      "parentName": "string",
      "agentAddress": "string",
      "nowBalance": 0,
      "credit": 0,
      "rnn": "string",
      "bin": "string",
      "blocked": false,
      "idParent": 0,
      "namePrint": "string",
      "leader": "string",
      "created": "20230901151244",
      "email": "string",
      "phone": "string",
      "bbik": "string",
      "bAccount": "string",
      "contract": "string",
      "ownerType": 0,
      "firstPaymentDate": "20230901151244",
      "lastPaymentDate": "20230901151244",
      "balancePlusSub": 0
    }
  ]
}
Наверх