BreakWithCounteragent (V2)
Разрывает партнерские отношения с контрагентом, а также отзывает или отклоняет приглашения к партнерству без вложения.
Чтобы отозвать приглашение с вложением, сгенерируйте запрос методом GenerateRevocationRequestXml (V2) и отправьте его методом PostMessagePatch (V4).
POST /V2/BreakWithCounteragent
Параметры запроса
myBoxId— идентификатор ящика организации, от имени которой производится разрыв отношения партнерства, в формате GUID.counteragentBoxId— идентификатор ящика организации контрагента в формате GUID.comment— текст комментария к операции. Необязательный параметр, длина не более 5000 символов.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к списку контрагентов организации с предоставленным авторизационным токеном запрещен или у пользователя нет права работать со списками контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).405— используется неподходящий HTTP-метод.409— метод используется для отзыва приглашения с вложением.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Метод доступен только сотрудникам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.
Метод работает по следующим правилам:
- Если между организациями
myBoxIdиcounteragentBoxIdесть действующее отношение партнерства (контрагентcounteragentBoxIdнаходится в статусеIsMyCounteragent), оно разрывается. КонтрагентcounteragentBoxIdпереходит в статусIsRejectedByMe. - Если организация
counteragentBoxIdотправила запрос на установление отношения партнерства к организацииmyBoxId(контрагентcounteragentBoxIdнаходится в статусеInvitesMe), то этот запрос отклоняется. КонтрагентcounteragentBoxIdпереходит в статусIsRejectedByMe. - Если организация
myBoxIdотправила запрос на установление отношения партнерства к организацииcounteragentBoxId(контрагентcounteragentBoxIdнаходится в статусеIsInvitedByMe), то выполняется отзыв этого запроса. Статус контрагентаcounteragentBoxIdменяется на статус, который был до отправки запроса. - Если партнерских отношений между организациями
myBoxIdиcounteragentBoxIdнет или они уже разорваны, то после вызова метода ничего не произойдет.
Примеры использования
Пример HTTP-запроса:
POST /V2/BreakWithCounteragent?myBoxId={{myBoxId}}&counteragentBoxId={{counteragentBoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
См. также
Инструкции:
Методы для работы со списком контрагентов:
- AcquireCounteragent (V3) — отправляет контрагенту приглашение к партнерским отношениям
- AcquireCounteragentResult (V3) — возвращает результат приглашения контрагента к партнерским отношениям
- BreakWithCounteragent (V2) — разрывает партнерские отношения с контрагентом
- GetCounteragents (V3) — выполняет поиск контрагентов по указанным параметрам