CreateCounteragentGroup¶
Метод CreateCounteragentGroup
создает группу контрагентов.
- POST /CreateCounteragentGroup¶
- Query Parameters:
boxId – идентификатор ящика организации.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- 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 – у организации с указанным идентификатором
boxId
закончилась подписка на API.403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.
404 Not Found – не найдены подразделения с идентификатором
DepartmentId
или подразделение было удалено.405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – группа контрагентов с наименованием
name
уже существует.500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит структуру CounteragentGroup.
Создать группу контрагентов может только администратор ящика с разрешением CanManageCounteragents
, позволяющим видеть списки контрагентов и работать с ними.
См. также
- Другие методы для работы с группой контрагентов:
AddCounteragentToGroup — добавляет контрагентов в группу
DeleteCounteragentGroup — удаляет группу контрагентов
GetCounteragentGroup — возвращает информацию о группе контрагентов
GetCounteragentGroups — возвращает список групп контрагентов
GetCounteragentsFromGroup — возвращает список контрагентов в группе
UpdateCounteragentGroup — редактирует группу контрагентов