AcquireCounteragentResult (V3)

Возвращает результат приглашения контрагента к партнерским отношениям, выполненного методом AcquireCounteragent (V3).

GET /V3/AcquireCounteragentResult
Query Parameters:

  • myBoxId – идентификатор ящика организации, из которого отправляли приглашение, в формате GUID.

  • taskId – идентификатор операции, полученный методом AcquireCounteragent (V3).

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 204 No Content – операция еще не завершена. В HTTP-заголовке ответа Retry-After указано время в секундах, через которое нужно повторить запрос.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен, или у пользователя недостаточно прав для доступа ко всем документам организации, или у пользователя нет права работать со списком контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).

  • 404 Not Found – не найдена операция с указанным идентификатором в ящике.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – не удалось выполнить запрос на приглашение контрагента.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Headers:

  • Retry-After – если в ответе содержится HTTP-заголовок Retry-After, то операция с указанным идентификатором еще не завершена. В этом случае повторите вызов через указанное в заголовке время (в секундах).

Response Body:

Тело ответа содержит результат приглашения организации к партнерским отношениям, представленный структурой AcquireCounteragentResultV2.

Метод доступен только сотрудникам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.

Метод позволяет получить результат приглашения контрагента только сотрудникам того ящика, из которого было отправлено приглашение. Если операция с идентификатором taskId была запущена из другого ящика, метод вернет ошибку 404 (Not Found).

Если отправить приглашение контрагенту не удалось, то метод вернет ошибку 409 (Conflict). Возможные причины ошибки:

  • не удалось создать организацию, если приглашение отправлялось в незарегистрированную организацию;

  • не удалось проверить подпись, если приглашение отправлялось с вложенным файлом.

Примеры использования

Пример HTTP-запроса:

GET /V3/AcquireCounteragentResult?myBoxId={{boxId}}&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) — выполняет поиск контрагентов по указанным параметрам