Перейти к основному содержимому

UpdateCounteragentGroup

Изменяет данные группы контрагентов.

POST /UpdateCounteragentGroup

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.
  • counteragentGroupId — идентификатор группы контрагентов.

Заголовки запроса

Тело запроса

Тело запроса должно содержать структуру 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 подразделений.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат, или отсутствуют обязательные параметры, или невозможно изменить наименование группы по умолчанию.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.
  • 404 — не найдена группа контрагентов с указанным идентификатором или не найдено подразделение с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 409 — группа контрагентов с указанным названием уже существует.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

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

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

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

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

POST /UpdateCounteragentGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Изменить список подразделений, в которые группа может отправлять документы, можно одним из способов:

  1. Передайте структуру CounteragentGroupDepartmentPatch с признаком AnyDepartment = false и списком подразделений, чтобы:

    • задать список подразделений для группы, которая сейчас может отправлять документы в любое подразделение,
    • изменить список подразделений для группы с уже указанными подразделениями.

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

    {
    "Name": "Новое имя",
    "GroupDepartments":
    {
    "AnyDepartment": "false",
    "Departments": {
    "DepartmentIds": [
    "b651ed54-04d8-4ca8-99b5-960fba733147",
    "32cb2cd3-ed3a-403a-b220-7dfd59c757db"
    ]
    }
    }
    }

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

    {
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
    "Name": "Новое имя",
    "Departments": {
    "DepartmentIds": [
    "b651ed54-04d8-4ca8-99b5-960fba733147",
    "32cb2cd3-ed3a-403a-b220-7dfd59c757db"
    ]
    }
    }
  2. Передайте структуру CounteragentGroupDepartmentPatch только с признаком AnyDepartment = true, чтобы изменить список подразделений на «любое подразделение», .

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

    {
    "Name": "Новое имя",
    "GroupDepartments":
    {
    "AnyDepartment": "true"
    }
    }

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

    {
    "CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
    "Name": "Новое имя"
    }

См. также

Инструкции:

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

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года