GetCounteragents

Метод GetCounteragents осуществляет поиск контрагентов по указанным параметрам.

Версии метода:

  • v2 — не возвращает список подразделений контрагента.

  • v1 — возвращает список подразделений контрагента.

v2

GET /V2/GetCounteragents
Query Parameters:

  • myOrgId – идентификатор организации, для которой осуществляется поиск контрагентов.

  • counteragentStatus – статус контрагента. Необязательный параметр, используется для фильтрации результатов поиска.

  • afterIndexKey – уникальный ключ для постраничного получения списка контрагентов, удовлетворяющих фильтру. Необязательный параметр.

  • query – текстовая строка для поиска организации по краткому или полному наименованию ящика контрагента или ИНН. Нельзя указывать одновременно с afterIndexKey.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором myOrgId закончилась подписка на API.

  • 403 Forbidden – доступ к списку контрагентов организации myOrgId с предоставленным авторизационным токеном запрещен.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит список контрагентов организации myOrgId, находящихся в статусе counteragentStatus. Список представлен структурой CounteragentList. В поле TotalCount указано количество всех контрагентов, удовлетворяющих запросу.

Пользователь может запрашивать и производить действия со списком контрагентов организации myOrgId, если у него есть доступ к ящику этой организации.

Список CounteragentList.Counteragents может содержать не более 100 элементов. Чтобы получить остальные элементы, вызовите метод GetCounteragents с теми же параметрами и дополнительно укажите параметр afterIndexKey. В зависимости от значения параметра afterIndexKey метод работает следующим образом:

  • Если в запросе отсутствует параметр afterIndexKey, метод вернет начало списка контрагентов, удовлетворяющих фильтру. Если в списке контрагентов меньше 100 элементов, метод вернет список полностью.

  • Если в запросе указан параметр afterIndexKey, метод вернет список контрагентов, следующих за контрагентом с параметром afterIndexKey. Контрагент с параметром afterIndexKey в этот список не попадает. Ключ контрагента указан в поле IndexKey структуры Counteragent.

Параметр counteragentStatus предназначен для фильтрации результатов поиска. Если параметр counteragentStatus не задан, метод вернет весь список контрагентов. Значения статусов контрагента описаны в перечислении CounteragentStatus. В качестве параметра counteragentStatus можно передавать следующие значения:

  • IsMyCounteragent,

  • InvitesMe,

  • IsInvitedByMe,

  • Rejected.

Во вложенной структуре Counteragent.Organization поле Departments будет пустым.

v1

GET /GetCounteragents
Query Parameters:

  • myOrgId – идентификатор организации, для которой осуществляется поиск контрагентов.

  • counteragentStatus – статус контрагента. Необязательный параметр, используется для фильтрации результатов поиска.

  • afterIndexKey – уникальный ключ, позволяющий итерироваться по всему списку контрагентов, удовлетворяющих фильтру. Необязательный параметр.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором myOrgId закончилась подписка на API.

  • 403 Forbidden – доступ к списку контрагентов организации myOrgId с предоставленным авторизационным токеном запрещен.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит список контрагентов организации myOrgId, находящихся в статусе counteragentStatus, представленный структурой CounteragentList. В поле CounteragentList.TotalCount указано количество всех контрагентов, удовлетворяющих запросу.

Пользователь имеет право запрашивать и производить действия со списком контрагентов организации myOrgId, если у него есть доступ к ящику этой организации.

Список CounteragentList.Counteragents может содержать не более 100 элементов. Чтобы получить остальные элементы, вызовите метод GetCounteragents с теми же параметрами и с указанием afterIndexKey. В зависимости от значения параметра afterIndexKey метод работает следующим образом:

  • Если в запросе отсутствует параметр afterIndexKey, то метод вернет начало списка контрагентов, удовлетворяющих фильтру.

  • Если в запросе указан параметр afterIndexKey, то возвращенный список начнется с контрагента, следующего за контрагентом с ключом afterIndexKey; контрагент с ключом afterIndexKey в этот список не попадает. Ключ контрагента указан в поле Counteragent.IndexKey.

Параметр counteragentStatus предназначен для фильтрации результатов поиска. Если параметр counteragentStatus не задан, метод вернет весь список контрагентов. Значения статусов контрагента описаны в перечислении CounteragentStatus. В качестве параметра counteragentStatus можно передавать следующие значения:

  • IsMyCounteragent,

  • InvitesMe,

  • IsInvitedByMe,

  • Rejected.