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

GetCounteragents

warning

Метод устарел и будет удален из API после 10 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — GetCounteragents (V3).

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

GET /GetCounteragents

Параметры запроса

  • myOrgId — идентификатор организации, для которой осуществляется поиск контрагентов.
  • counteragentStatus — статус контрагента. Необязательный параметр, используется для фильтрации результатов поиска.
  • afterIndexKey — ключ для постраничного получения списка найденных контрагентов, указывающий на начало очередной страницы. Ключ может содержать недопустимые символы, поэтому должен быть закодирован в URL-формат. Необязательный параметр.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у организации с указанным идентификатором myOrgId закончилась подписка на API.
  • 403 — доступ к списку контрагентов организации myOrgId с предоставленным авторизационным токеном запрещен.
  • 405 — используется неподходящий HTTP-метод.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

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

Метод доступен только сотрудникам с доступом к ящику.

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

  • IsMyCounteragent,
  • InvitesMe,
  • IsInvitedByMe,
  • Rejected.

Список контрагентов Counteragents в ответе CounteragentList может содержать не больше 100 элементов. Поэтому:

  • Если найденных контрагентов меньше 100, то метод вернет их полностью.

  • Если найденных контрагентов больше 100, то в ответе Counteragents вернутся только первые 100 элементов. При этом параметр TotalCount будет содержать общее количество найденных контрагентов, а параметр TotalCountType покажет, точно ли посчитано значение TotalCount или подсчет был ограничен.

    В этом случае получить весь список найденных контрагентов можно постранично. Для этого вызывайте метод GetCounteragents с теми же параметрами запроса и с указанием параметра afterIndexKey до тех пор, пока список контрагентов не будет вычитан полностью. В качестве параметра afterIndexKey нужно указывать ключ контрагента из поля Counteragent.IndexKey, предварительно закодировав его в URL-формат.

В зависимости от значения параметра afterIndexKey метод работает следующим образом:

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

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года