AcquireCounteragent
Метод устарел и будет удален из API после 10 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — AcquireCounteragent (V3).
Метод AcquireCounteragent отправляет контрагенту приглашение к партнерским отношениям. С помощью этого метода можно добавить организацию в список контрагентов.
POST /AcquireCounteragent
Параметры запроса
myOrgId— идентификатор организации, от имени которой производится инициация отношения партнерства.counteragentOrgId— идентификатор организации контрагента.comment— текст сообщения для контрагента. Необязательный параметр, длина не более 2000 символов.myDepartmentId— идентификатор подразделения, от имени которого производится инициация отношения партнерства. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомmyOrgIdзакончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен, или у пользователя недостаточно прав для доступа ко всем документам организации, или у пользователя нет права работать со списком контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).404— в указанном ящике нет документов с указанными идентификаторами.405— используется неподходящий HTTP-метод.409— требуется заявка на роуминг для отправки приглашения роуминговому контрагенту (подробнее https://www.diadoc.ru/roaming).500— при обработке запроса возникла непредвиденная ошибка.
Метод доступен только сотрудникам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.
В случае с роуминговым оператором используйте метод GetRoamingOperators, чтобы узнать, поддерживает ли он автоматическую обработку приглашений.
Метод работает по следующим правилам:
- Если между организацией
myOrgIdи контрагентомcounteragentOrgIdнет действующего отношения партнерства, то от имени организацииmyOrgIdбудет отправлен запрос на установление отношения партнерства в адрес организации контрагента. Контрагент перейдет в статусIsInvitedByMe. - Если у организации
myOrgIdесть входящий запрос на установление отношения партнерства от организации контрагентаcounteragentOrgId(то есть контрагент находится в статусеInvitesMe), то этот запрос будет подтвержден, и между организациямиmyOrgIdи контрагентом установится действующее отношение партнерства. Контрагент перейдет в статусIsMyCounteragent. - Если между организацией
myOrgIdи контрагентомcounteragentOrgIdотношение партнерства уже установлено или есть исходящий запрос от организацииmyOrgIdк организации контрагента, то в результате выполнения метода ничего не произойдет.