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

Запрос: POST /documents/waybill/receiver/accept/cargo/content

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

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

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

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

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

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

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

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

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

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

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

Примечание

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

Примечание

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

Параметры генерации титула грузоплучателя¶

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

{
    "DocumentId": "guid",
    "Accepted": true,
    "RejectionReason": "string",
    "ActualArrivalDateTime": "2022-11-25T13:38:24.371Z",
    "ActualDepartureDateTime": "2022-11-25T13:38:24.371Z",
    "DeclaredArrivalDateTime": "2022-11-25T13:38:24.371Z",
    "AcceptedPackagesCount": 0,
    "GeneralInformation": "string",
    "AcceptedCargoGrossWeight": 0,
    "DeliveryAddress": {
        "Postcode": "string",
        "RegionCode": "string",
        "District": "string",
        "City": "string",
        "Locality": "string",
        "Street": "string",
        "House": "string",
        "Building": "string",
        "Flat": "string"
  }
}

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

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

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