AcquireCounteragentResult (V2)
Метод устарел и будет удален из API после 1 мая 2027 года. Подробнее в истории изменений. Используйте актуальную версию метода — AcquireCounteragentResult (V3).
Метод AcquireCounteragentResult возвращает результат приглашения контрагента к партнерским отношениям, выполненного методом AcquireCounteragent (V3).
GET /V2/AcquireCounteragentResult
Параметры запроса
taskId— идентификатор операции, полученный методом AcquireCounteragent (V3).
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.204— операция еще не завершена. В HTTP-заголовке ответаRetry-Afterуказано время в секундах, через которое нужно повторить запрос.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.403— доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя недостаточно прав для доступа ко всем документам организации.404— не найдена операция с указанным идентификатором.405— используется неподходящий HTTP-метод.409— не удалось выполнить запрос на приглашение контрагента.500— при обработке запроса возникла непредвиденная ошибка.
Заголовки ответа
Retry-After— если в ответе содержится HTTP-заголовокRetry-After, то операция с указанным идентификатором еще не завершена. В этом случае повторите вызов через указанное в заголовке время (в секундах).
Тело ответа
Тело ответа содержит результат приглашения организации к партнерским отношениям, представленный структурой AcquireCounteragentResultV2.
Если отправить приглашение контрагенту не удалось, то метод вернет ошибку 409 (Conflict). Возможные причины ошибки:
- не удалось создать организацию, если приглашение отправлялось в незарегистрированную организацию;
- не удалось проверить подпись, если приглашение отправлялось с вложенным файлом.
Примеры использования
Пример HTTP-запроса:
GET /V2/AcquireCounteragentResult?taskId={{taskId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"BoxId": "1f208d03-2a60-4f64-91b1-b7aad54cfaf3",
"InvitationDocumentId": {
"MessageId": "88d108be-27ec-4808-8a38-8062e7cf4988",
"EntityId": "ce1d22da-f9e8-4c4c-af34-09bc94ad1fdd"
}
}
См. также
Инструкции:
Методы для работы со списком контрагентов:
- AcquireCounteragent (V3) — отправляет контрагенту приглашение к партнерским отношениям
- AcquireCounteragentResult (V3) — возвращает результат приглашения контрагента к партнерским отношениям
- BreakWithCounteragent (V2) — разрывает партнерские отношения с контрагентом
- GetCounteragents (V3) — выполняет поиск контрагентов по указанным параметрам