GetCounteragentsFromGroup

Возращает список контрагентов, состоящих в указанной группе.

GET /GetCounteragentsFromGroup
Query Parameters:

  • boxId – идентификатор ящика организации.

  • counteragentGroupId – идентификатор группы контрагентов

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

  • count – максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных контрагентов CounteragentFromGroupResponse.TotalCount. Принимает значения от 1 до 100, по умолчанию равен 100. Необязательный параметр.

Request Headers:
Status Codes:

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

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

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

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

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

  • 404 Not Found – не найдена группа контрагентов с указанным идентификатором.

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

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

Response Body:

Тело ответа содержит структуру CounteragentFromGroupResponse:

message CounteragentFromGroupResponse {
    repeated string CounteragentBoxId = 1;
    required int32 TotalCount = 2;
    optional string AfterIndexKey = 3;
}

  • CounteragentBoxId — список идентификаторов ящиков контрагентов.

  • TotalCount — количество найденных контрагентов в группе.

  • AfterIndexKey — ключ для постраничного получения списка найденных контрагентов. Его можно передавать в качестве параметра afterIndexKey в метод GetCounteragentsFromGroup: ключ может содержать недопустимые символы, поэтому при вызове метода должен быть закодирован в URL-формат.

Метод доступен только администраторам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.

Метод вернет только идентификаторы контрагентов со статусом CounteragentStatus = IsMyCounteragent. Узнать статус контрагента можно с помощью метода GetOrganizationsByInnList (V2).

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

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

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

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

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

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

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

Примеры использования

Пример HTTP-запроса:

GET /GetCounteragentsFromGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

{
    "CounteragentBoxId": [
        "1f208d03-2a60-4f64-91b1-b7aad54cfaf3"
    ],
    "TotalCount": 1,
    "AfterIndexKey": "08DCA6534D6F9E72038D201F602A644F91B1B7AAD54CFAF3"
}

См. также

Инструкции:
Методы для работы с группами контрагентов: