CreateCounteragentGroup

Создает группу контрагентов.

POST /CreateCounteragentGroup
Query Parameters:

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

Request Headers:
Request Body:

Тело запроса должно содержать структуру CounteragentGroupToCreate:

message CounteragentGroupToCreate {
    required string Name = 1;
    optional DepartmentsInGroup Departments = 2;
}

  • Name — название группы контрагентов. Должно быть уникальным в рамках одного ящика. Длина не должна превышать 1024 символов.

  • Departments — список подразделений, в которые контрагенты группы могут отправлять документы. Представлен структурой DepartmentsInGroup. В списке может быть не больше 419 подразделений. Если список пуст, контрагенты из группы могут отправлять документы в любое подразделение.

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-метод.

  • 409 Conflict – группа контрагентов с указанным названием уже существует.

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

Response Body:

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

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

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

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

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

Пример тела запроса:

{
    "Name": "Группа",
    "Departments": {
        "DepartmentIds": [
            "6d710055-9b5d-4bc0-ba2f-9e54adda034e"
        ]
    }
}

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

{
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
    "Name": "Группа",
    "Departments": {
        "DepartmentIds": [
            "6d710055-9b5d-4bc0-ba2f-9e54adda034e"
        ]
    }
}

См. также

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