CreateCounteragentGroup
Создает группу контрагентов.
POST /CreateCounteragentGroup
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать структуру CounteragentGroupToCreate:
message CounteragentGroupToCreate {
required string Name = 1;
optional DepartmentsInGroup Departments = 2;
}
Name— название группы контрагентов. Должно быть уникальным в рамках одного ящика. Длина не должна превышать 1024 символов.Departments— список подразделений, в которые контрагенты группы могут отправлять документы. Представлен структурой DepartmentsInGroup. В списке может быть не больше 419 подразделений. Если список пуст, контрагенты из группы могут отправлять документы в любое подразделение.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.404— не найдено подразделение с указанным идентификатором.405— используется неподходящий HTTP-метод.409— группа контрагентов с указанным названием уже существует.415— тип содержимого запроса не поддерживается.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру CounteragentGroup.
Метод доступен только администраторам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.
Примеры использования
Пример HTTP-запроса:
POST /CreateCounteragentGroup?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json
Пример тела запроса:
{
"Name": "Группа",
"Departments": {
"DepartmentIds": [
"6d710055-9b5d-4bc0-ba2f-9e54adda034e"
]
}
}
Пример ответа:
{
"CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
"Name": "Группа",
"Departments": {
"DepartmentIds": [
"6d710055-9b5d-4bc0-ba2f-9e54adda034e"
]
}
}
См. также
Инструкции:
Методы для работы с группами контрагентов:
- AddCounteragentToGroup — добавляет контрагента в группу
- CreateCounteragentGroup — создает группу контрагентов
- DeleteCounteragentGroup — удаляет группу контрагентов
- GetCounteragentGroup — возвращает данные группы контрагентов по указанному идентификатору
- GetCounteragentGroups — возвращает список групп контрагентов
- GetCounteragentsFromGroup — возвращает список контрагентов, состоящих в указанной группе
- UpdateCounteragentGroup — изменяет данные группы контрагентов