GetCounteragentsFromGroup¶
Метод GetCounteragentsFromGroup
возращает список контрагентов, состоящих в указанной в группе.
- GET /GetCounteragentsFromGroup¶
- Query Parameters:
boxId – идентификатор ящика организации.
counteragentGroupId – идентификатор группы контрагентов
afterIndexKey – уникальный ключ, позволяющий итерироваться по списку контрагентов. Необязательный параметр.
count – максимальное количество контрагентов в ответе. Может принимать значения от 1 до 100. Необязательный параметр. По умолчанию равен 100.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
или в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у организации с указанным идентификатором
boxId
закончилась подписка на API.403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.
404 Not Found – не найдена группа контрагентов с идентификатором
CounteragentGroupId
.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
— ключ для постраничного получения списка контрагентов.
Получить список контрагентов в группе может только администратор ящика с разрешением CanManageCounteragents
, позволяющим видеть списки контрагентов и работать с ними.
Метод вернет только идентификаторы контрагентов со статусом CounteragentStatus = IsMyCounteragent
. Узнать статус контрагента можно с помощью метода GetOrganizationsByInnList.
См. также
- Другие методы для работы с группой контрагентов:
AddCounteragentToGroup — добавляет контрагентов в группу
CreateCounteragentGroup — создает группу контрагентов
DeleteCounteragentGroup — удаляет группу контрагентов
GetCounteragentGroup — возвращает информацию о группе контрагентов
GetCounteragentGroups — возвращает список групп контрагентов
UpdateCounteragentGroup — редактирует группу контрагентов