GetCounteragentGroups

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

GET /GetCounteragentGroups
Query Parameters:

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

  • page – номер страницы, которую нужно получить. По умолчанию равен 1. Необязательный параметр.

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

Request Headers:
Status Codes:

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

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

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

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

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

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

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

Response Body:

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

message CounteragentGroupsList {
    repeated CounteragentGroup Groups = 1;
    required int32 TotalCount = 2;
}

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

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

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

Метод не возвращает удаленные группы контрагентов.

Обратите внимание, что кроме созданных групп метод возвращает группу «По умолчанию» с идентификатором 00000000-0000-0000-0000-000000000000. Это созданная Диадоком группа, в которую автоматически добавляются все контрагенты организации. Ее нельзя удалить, для нее можно только настроить список подразделений, в которые контрагенты группы могут отправлять документы, — сделать это можно с помощью метода UpdateCounteragentGroup.

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

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

GET /GetCounteragentGroups?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

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

{
    "Groups": [
        {
            "CounteragentGroupId": "00000000-0000-0000-0000-000000000000",
            "Name": "По умолчанию"
        },
        {
            "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
            "Name": "Группа",
            "Departments": {
                "DepartmentIds": [
                    "6d710055-9b5d-4bc0-ba2f-9e54adda034e"
                ]
            }
        },
        {
            "CounteragentGroupId": "db0c29b8-bbd3-42a0-aa8b-beba1aeabdf4",
            "Name": "Группа2"
        }
    ],
    "TotalCount": 3
}

См. также

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