UpdateCounteragentGroup¶
Метод UpdateCounteragentGroup
позволяет редактировать группу контрагентов.
- POST /UpdateCounteragentGroup¶
- Query Parameters:
boxId – идентификатор ящика организации.
counteragentGroupId – идентификатор группы контрагентов.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Request Body:
Тело запроса должно содержать структуру
CounteragentGroupToUpdate
:message CounteragentGroupToUpdate { optional string Name = 1; optional CounteragentGroupDepartmentPatch GroupDepartments = 2; } message CounteragentGroupDepartmentPatch { required bool AnyDepartment = 1; optional DepartmentsInGroup Departments = 2; }
Name
— название группы контрагентов.GroupDepartments
— подразделения, в которые контрагенты группы могут отправлять документы. Представлены структуройCounteragentGroupDepartmentPatch
с полями:AnyDepartment
— флаг, указывающий, что документы можно отправлять в любое подразделение.Departments
— список подразделений, в которые контрагенты группы могут отправлять документы. Представлен структурой DepartmentsInGroup. Нельзя указывать одновременно сAnyDepartment = true
. В списке может быть не больше 419 подразделений.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры, или невозможно изменить наименование группы по умолчанию.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
или в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у организации с указанным идентификатором
boxId
закончилась подписка на API.403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.
404 Not Found – не найдена группа контрагентов с идентификатором
CounteragentGroupId
или не найдены подразделения с идентификаторомDepartmentId
.405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – группа контрагентов с наименованием
Name
уже существует.500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит структуру CounteragentGroup.
Изменить группу контрагентов может только администратор ящика с разрешением CanManageCounteragents
, позволяющим видеть списки контрагентов и работать с ними.
Изменить список подразделений, в которые группа может отправлять документы, можно одним из следующих способов:
Чтобы добавить или удалить подразделения, передайте структуру
CounteragentGroupDepartmentPatch
с флагомAnyDepartment = false
и обновленным списком подразделений.Чтобы изменить список подразделений на «любое подразделение», передайте структуру
CounteragentGroupDepartmentPatch
только с флагомAnyDepartment = true
.Чтобы указать список конкретных подразделений для группы с разрешением отправлять документы в любое подразделение, передайте структуру
CounteragentGroupDepartmentPatch
с флагомAnyDepartment = false
и списком подразделений.
См. также
- Другие методы для работы с группой контрагентов:
AddCounteragentToGroup — добавляет контрагентов в группу
CreateCounteragentGroup — создает группу контрагентов
DeleteCounteragentGroup — удаляет группу контрагентов
GetCounteragentGroup — возвращает информацию о группе контрагентов
GetCounteragentGroups — возвращает список групп контрагентов
GetCounteragentsFromGroup — возвращает список контрагентов в группе