GetCounteragentGroup

Метод GetCounteragentGroup возвращает информацию о группе контрагентов.

GET /GetCounteragentGroup
Query Parameters:

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

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

Request Headers:
Status Codes:

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

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

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

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

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

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

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

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

Response Body:

Тело ответа содержит структуру CounteragentGroup.

Получить информацию о группе контрагентов может только сотрудник организации с разрешением CanManageCounteragents, позволяющим видеть списки контрагентов и работать с ними.

См. также

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