AcquireCounteragent (V2)
Метод устарел и будет удален из API после 10 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — AcquireCounteragent (V3).
Метод AcquireCounteragent отправляет контрагенту приглашение к партнерским отношениям. С помощью этого метода можно добавить организацию в список контрагентов.
POST /V2/AcquireCounteragent
Параметры запроса
myOrgId— идентификатор организации, от имени которой производится инициация отношения партнерства.myDepartmentId— идентификатор подразделения, от имени которого производится инициация отношения партнерства. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать структуру AcquireCounteragentRequest:
message AcquireCounteragentRequest {
optional string OrgId = 1;
optional string Inn = 2;
optional string MessageToCounteragent = 3;
optional InvitationDocument InvitationDocument = 4;
}
message InvitationDocument {
required Events.SignedContent SignedContent = 1;
required string FileName = 2;
optional bool SignatureRequested = 3 [default = false];
}
OrgId— идентификатор организации контрагента.Inn— ИНН организации контрагента.MessageToCounteragent— текст сообщения для контрагента. Длина не должна превышать 2000 символов.InvitationDocument— вложенный файл, представленный структуройInvitationDocumentс полями:SignedContent— содержимое файла документа с электронной подписью, представленное структурой SignedContent.FileName— имя файла.SignatureRequested— признак того, что от контрагента требуется ответная подпись.
При заполнении структуры руководствуйтесь следующими рекомендациями:
- Если организация контрагента зарегистрирована в Диадоке, укажите параметр
OrgIdконтрагента. ПолучитьOrgIdорганизации можно с помощью метода GetOrganizationsByInnKpp. - Если организация контрагента не зарегистрирована в Диадоке и у нее нет параметра
OrgId, укажите параметрInn. Если организация с таким ИНН существует в ЕГРЮЛ, то для нее в Диадоке будет создан ящик. В этот ящик будет помещено приглашение к партнерству. Организация получит приглашение, когда сотрудник организации с сертификатом КЭП войдет в Диадок. Таким способом можно отправить запрос только в головную организацию: в филиал организации отправить запрос нельзя.
Если для поиска организации контрагента вы указываете ИНН и при этом будет найдено несколько организаций с таким ИНН, то приглашение будет отправлено в организацию, созданную последней.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомmyOrgIdзакончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен, или у пользователя недостаточно прав для доступа ко всем документам организации, или у пользователя нет права работать со списком контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).404— в указанном ящике нет документов с указанными идентификаторами.405— используется неподходящий HTTP-метод.409— требуется заявка на роуминг для отправки приглашения роуминговому контрагенту (подробнее https://www.diadoc.ru/roaming).500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит идентификатор операции taskId в структуре AsyncMethodResult. По этому идентификатору с помощью метода AcquireCounteragentResult (V2) можно узнать результат обработки запроса.
Метод доступен только сотрудникам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.
В случае с роуминговым оператором используйте метод GetRoamingOperators, чтобы узнать, поддерживает ли он автоматическую обработку приглашений.
Отправка приглашений с вложением роуминговым контрагентам невозможна. В случае, если вы отправляете роуминговому контрагенту приглашение с вложенным документом, то такой документ не будет отправлен, а контрагент его не получит и не сможет подписать. При этом метод не сообщит об ошибке.
Метод работает по следующим правилам:
- Если между организациями
myOrgIdи контрагентом нет действующего отношения партнерства, то от имени организацииmyOrgIdбудет отправлен запрос на установление отношения партнерства в адрес организации контрагента. Контрагент перейдет в статусIsInvitedByMe. - Если в индексе отношений есть входящий запрос на установление отношения партнерства от организации контрагента к организации
myOrgId(то есть контрагент находится в статусеInvitesMe), то этот запрос будет подтвержден, и между организациямиmyOrgIdи контрагентом установится действующее отношение партнерства. Контрагент перейдет в статусIsMyCounteragent.- Принять приглашение без вложенного документа или приглашение со вложенным документом, не требующим подписи, можно отправкой взаимного запроса без вложенного документа.
- Нельзя принять приглашение с помощью взаимного запроса со вложенным документом.
- Нельзя принять приглашение с вложением, требующим подписи, с помощью взаимного запроса. Для принятия такого приглашения через API нужно подписать вложенный документ с помощью метода PostMessagePatch (V3). После подписания вложенного документа будет установлено отношение партнерства.
- Если между организациями
myOrgIdи контрагентом отношение партнерства уже установлено или есть исходящий запрос от организацииmyOrgIdк организации контрагента, то в результате выполнения метода ничего не произойдет.