.. _Integration_IntegrationApi_WorkingWithContractors_SendingInvitations:

Отправка приглашений
####################

| Запрос: ``POST /v2/invitations/send``
| HTTP-заголовки:

.. code-block::

    Authorization: Bearer access_token
    Content-Type: application/json
    Accept: application/json

Тело запроса:

.. code-block:: JSON

    [                                           // одно или несколько приглашений
        {
            "BoxId": "string",                  // "наш" ящик, из которого мы отправляем приглашение
            "ContractorOperatorId": "string",   // идентификатор оператора контрагента, если приглашение отправляется в роуминг
            "ContractorFnsId": "string",        // ФНС-идентификатор контрагента
            "ContractorInn": "string",          // ИНН контрагента
            "ContractorKpp": "string",          // КПП контрагента
            "ContractorEmail": "string"         // адрес электронной почты контактного лица контрагента
        }
    ]

Описание запроса
****************

Запрос позволяет отправить приглашение к ЭДО одному или нескольким контрагентам.

Приглашение отправляется из какого-то "нашего" ящика, т. е. ящика, :ref:`настроенного <Setup_Integration_BasicSetup_Operators>` в Продукте.
Идентификатор "нашего" ящика задается в поле ``BoxId``.

Контрагент, которому отправляется приглашение, определяется одним из двух способов.

Если известен **ФНС-идентификатор** контрагента, то он указывается в поле ``ContractorFnsId``.
Если ФНС-идентификатор принадлежит другому оператору, то приглашение будет отправлено в роуминг.

Если известны **ИНН и КПП** контрагента, то указываются поля ``Inn`` и ``Kpp``.
Для контрагентов-ИП поле ``Kpp`` не заполняется: оно должно отсутствовать или содержать значение ``null``.
При таком способе для отправки приглашения в роуминг нужно передать код роумингового оператора в поле ``ContractorOperatorId``.

Дополнительно нужно передать адрес электронной почты контактного лица контрагента, если этого требует оператор.

| См. также:
| :ref:`Integration_IntegrationApi_Helpers_WorkingWithReferences_GettingOperatorFeatures`

Когда можно отправлять запрос
*****************************

Отправлять приглашение можно в одном из трех случаев:

* данные контрагента отсутствуют в Продукте;
* текущий статус отношений партнерства с контрагентом не определен;
* текущий статус отношений партнерства с контрагентом - "Отношение партнерства не установлены" (``CX``).

Для получения статуса следует запросить данные контрагента.

Ответ на запрос
***************

Отправка приглашений выполняется асинхронно.
В случае успешного выполнения запроса для каждого контрагента в запросе ставится задача на отправку приглашения.
Идентификаторы задач не возвращаются.

Статус задачи
*************

Отдельный запрос для получения статуса задачи на отправку не предусмотрен.

При обработке задачи будет создан контрагент с переданными в приглашении данными (идентификатора участника ЭДО, либо ИНН/КПП).
Контрагент будет привязан к тому же оператору, к которому привязан "наш" ящик.
Другие данные контрагента будут пустыми. Они будут дозаполнены значениями, полученными от оператора, если контрагент будет найден в сервисе оператора.

По результатам обработки задачи интеграционным модулем для контрагента поступит новый статус.
Для получения статуса следует повторно запросить данные контрагента.

| Если задача была обработана успешно, то поступит статус "Приглашение отправлено" (код статуса ``CS``).
| Если задача была обработана с ошибкой, то поступит статус "Ошибка" (код статуса ``E``).