Постановка задач на отправку черновиков ЭТрН¶

Запрос: POST documents/etrn/send/draft

HTTP-заголовки:

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

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

{
    "OperatorId": "string",                     // идентификатор оператора ЭДО
    "Drafts": [                                 // список документов для отправки
        {
            "Id": "guid",                       // идентификатор документа
            "MinTransId": "string",             // идентификатор в ГИС ЭПД
            "ContentFileName": "string",        // имя файла документа с расширением
            "ContentLinkId": "string",          // ссылка на контент документа в архиве
            "Commentary": "string",             // комментарий к документу
            "Number": "string",                 // наименование документа
            "Date": "YYYY-MM-DD",               // дата документа
            "CargoSender": {                    // сведения о грузоотправителе
            },
            "CargoLoader": {                    // сведения о лице, осуществляющем погрузку
            },
            "CargoReceiver": {                  // сведения о грузополучателе
            },
            "CargoTransporter": {               // сведения о грозоперевозчике
            }
        }
    ]
}

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

Запрос позволяет поставить одну или несколько задач на отправку черновиков ЭТрН одному оператору ЭДО, который задается полем OperatorId.

Для операторов ЭДО OperatorId - это код оператора, присвоенный ФНС (например, «2AL», «2AE», «2BM», и т.д.).

Адресация документа¶

Каждый документ содержит адресную информацию: от кого и кому он отправляется.

Отправитель задается идентификатором ящика в поле CargoSender и, опционально, идентификатором подразделения. Структура CargoSender:

{
    "BoxId": "string",          // идентификатор ящика отправителя
    "DepartmentId": "string"    // идентификатор подразделения отправителя
}

Идентификатор подразделения указывается, если пакет нужно отправить из подразделения, а не из головной организации отправителя. Ящик отправителя должен быть подключен и настроен в Продукте (см. Операторы).

Лицо, осуществляющее погрузку, получатель и перевозчик задаются в полях CargoLoader, CargoReceiver и CargoTransporter, соответственно. Для задания каждого из полей необходимо заполнить структуру:

{
    "BoxId": "string",          // идентификатор ящика получателя
    "DepartmentId": "string"    // идентификатор подразделения получателя
    "FnsId": "string",          // ФНС-идентификатор получателя
    "Inn": "string",            // ИНН получателя
    "Kpp": "string"             // КПП получателя
}

Для адресации получателя существует три способа:

Указать идентификатор ящика получателя в поле BoxId и, опционально, идентификатор подразделения в поле DepartmentId. Идентификатор подразделения указывается, если пакет нужно отправить в подразделение, а не в головную организацию получателя.
Указать ФНС-идентификатор получателя в поле FnsId.
Указать ИНН и КПП получателя в полях Inn и Kpp. КПП не указывается, если получатель - ИП.

Примечание

Указывать адресную информацию получателя нужно одним из трех способов. Использовать более одного способа нельзя.

Идентификаторы ящиков, подразделений и ФНС-идентификаторы¶

Идентификатор ящика - это идентификатор учетной записи организации в сервисе оператора ЭДО. Формат идентификаторов ящиков и подразделений зависит от выбранного оператора.

ФНС-идентификатор - это идентификатор участника ЭДО. Он выдается оператором при подключении организации и указывается в атрибутах ИдФайл формализованных вложений. Обычно ФНС-идентификатор - это строка вида «код оператора + guid».

В общем случае идентификатор ящика и ФНС-идентификатор - это разные данные. В частном случае они могут совпадать.

Структура данных черновика¶

Для каждого черновика в поле Id задается его идентификатор документа в системе, которая выполняет отправку, имя файла с расширением и имя файла подписи.

Примечание

Имя файла должно быть сформировано из значения атрибута ИдФайл плюс расширение xml.

Содержимое документа передается по ссылке, которая указана в поле ContentLinkId. Содержимое должно быть предварительно сохранено в архиве.

Для каждого черновика может быть задано поле MinTransId - идентификатор документа в ГИС ЭПД Минтранса России.

Вместе с черновиком можно передать произвольный текстовый комментарий к нему в поле Comment. Комментарий не должен быть длинее 2000 символов. Он будет передан получателю, только если сервис выбранного оператора поддерживает передачу комментариев. В противном случае значение поля будет проигнорировано.

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

Запрос ставит задачи на отправку интеграционному модулю Продукта и возвращает идентификаторы поставленных задач в виде коллекции:

[
    1,
    2,
    3,  // и т. д.
]

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