Генерация вложений¶

Запрос: POST /document/waybill/transporter/address-changing/cargo/content

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

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

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

{
    "DocumentId": "guid",                   // идентификатор документа
    "Signer": {                             // подписант
    },
    "Parameters": [                         // параметры генерации титула переадресовки груза
    ],
    "SignerStatuses": [                     // статусы подписанта
    ],
    "Certificate": "base64"                 // открытая часть сертификата подписанта в Base64
}

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

Запрос ставит задачу на генерацию файла обмена информации о переадресовке груза.

Статусы подписантов¶

Статусы подписантов нужны для титулов ЭТрН:

{
    "DocumentId": "guid",                       // идентификатор документа
    "SignerStatus": 0                           // статус подписанта
}

Статусы передаются в разрезе документов: если в пакете несколько документов, то для каждого документа могут быть заданы свои значения. Если статусы для документа не переданы, то используются значения по умолчанию.

Значение поля SignerStatus является перечислением и определяется приказом ФНС.

Примечание

Статус подписанта передается в XML-элементе Подписант.

Примечание

В качестве значения по умолчанию используется статус, описывающий лицо, действующее от имени компании без доверенности.

Параметры генерации титула переадресовки¶

Параметры генерации титула переадресовки нужны для заполнения обязательных элементов содержимого файла:

{
    "DocumentId": "guid",
    "RedirectionDateTime": "2022-11-25T13:38:24.371Z",
    "RedirectionDocumentId": "string",
    "RedirectionDocumentFormerInn": "string",
    "DeliveryDateTime": "2022-11-25T13:38:24.371Z",
    "DeliveryAddress": {
        "Postcode": "string",
        "RegionCode": "string",
        "District": "string",
        "City": "string",
        "Locality": "string",
        "Street": "string",
        "House": "string",
        "Building": "string",
        "Flat": "string"
    }
    "ReceiverChange": true,
    "NewReceiverBoxId": "string",
    "NewReceiverName": "string",
    "NewReceiverInn": "string",
    "NewReceiverKpp": "string",
    "NewReceiverAddress": {
        "Postcode": "string",
        "RegionCode": "string",
        "District": "string",
        "City": "string",
        "Locality": "string",
        "Street": "string",
        "House": "string",
        "Building": "string",
        "Flat": "string"
    }
    "NewReceiverTelephone": "string"
}

Параметры передаются в разрезе документов: если в пакете несколько ЭТрН, то для каждого документа должны быть заданы свои значения. Параметры обязательны к заполнению: если они не переданы для каждой ЭТрН, то генерация завершится с ошибкой.

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

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