BreakWithCounteragent (V2)
Разрывает партнерские отношения с контрагентом, а также отзывает или отклоняет приглашения к партнерству без вложения.
Чтобы отозвать приглашение с вложением, сгенерируйте запрос методом GenerateRevocationRequestXml (V2) и отправьте его методом PostMessagePatch (V3) или PostMessagePatch (V4).
- POST /V2/BreakWithCounteragent
- Query Parameters:
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у указанного ящика закончилась подписка на API.
403 Forbidden – доступ к списку контрагентов организации с предоставленным авторизационным токеном запрещен или у пользователя нет права работать со списками контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).
405 Method Not Allowed – используется неподходящий HTTP-метод.
409 Conflict – метод используется для отзыва приглашения с вложением.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
Метод доступен только сотрудникам с доступом к ящику и разрешением 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}}
См. также
- Инструкции:
- Методы для работы с контрагентами:
AcquireCounteragent (V3) — отправляет контрагенту приглашение к партнерским отношениям
AcquireCounteragentResult (V2) — возвращает результат приглашения контрагента к партнерским отношениям
BreakWithCounteragent (V2) — разрывает партнерские отношения с контрагентом
GetCounteragent (V3) — возвращает данные контрагента по указанному идентификатору
GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента
GetCounteragents (V3) — выполняет поиск контрагентов по указанным параметрам
- Устаревшие версии метода: