Запрос R5: Загрузка декларации с подробностями

Адрес: https://www.tws.by/tws/api/r5

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

Также этот запрос позволяет забрать декларацию с учётом всех изменений, вносимых КДТ к этой декларации. Например, это позволяет учитывать скорректированные таможенные стоимости при приходе товара.

Входные параметры

  • SessionKey – сессионный ключ, полученный из запроса R1. Обязательный параметр.
  • ID – внутренний ID декларации в Системе TWS. Может быть получен запросом R4 (список деклараций) либо R6 (создание новой декларации). Обязательный параметр.
  • ApplyCorrections – передайте в этом параметре значение “1”, чтобы Система TWS применила к декларации все корректировки (КДТ) и отдала последнюю версию данных. Обратите внимание, что учитываются только принятые таможней корректировки. Необязательный параметр.

Параметры JSON-ответа

  • Declaration – описание конкретной декларации со следующими полями:
    • ID – внутренний ID декларации в Системе TWS.

    • Number – исходящий номер декларации.

    • Date – дата декларации. Формат: YYYY-MM-DD.

    • Kind – вид декларации (возможные значения).

    • SdType – тип статистической декларации (возможные значения). Поле добавляется только для Статистических деклараций.

    • Procedure – номер таможенной процедуры в соответствии с Классификатором видов таможенных процедур.

    • PreviousProcedure – номер предшествующей таможенной процедуры в соответствии с Классификатором видов таможенных процедур.

    • SrcPartner – отправитель. Полное наименование.

    • SrcPartnerID – отправитель. Внутренний ID-контрагента в Системе TWS.

    • DstPartner – получатель. Полное наименование.

    • DstPartnerID – получатель. Внутренний ID-контрагента в Системе TWS.

    • Sum – рассчитанная по всем товарным позициям сумма декларации.

    • Currency – код валюты декларации в соответствии с Классификатором валют.

    • SupplyConditions – условия поставки (в соответствии с Классификатором условий поставки).

    • DealCharacter – код характера сделки в соответствии с Классификатором характера сделки.

    • DealDetails – код особенности внешнеэкономической сделки в соответствии с Классификатором особенности внешнеэкономической сделки.

    • PreviousDocumentNumber – графа 40 “Предшествующий документ”, если заполнена.

    • CustomsRegistrationNumber – регистрационный номер, присвоенный таможней, если заполнено.

    • CustomsPermissionNumber – номер разрешения на выпуск, если заполнено.

    • CustomsPermissionDate – дата разрешения на выпуск, если заполнено. Формат: YYYY-MM-DD.

    • CustomsAcceptanceStatus – статус принятия документа (возможные значения). Заполняется для документов, в которых не применяется номер разрешения на выпуск, например ЭПИ или Транзитные декларации.

    • CustomsAcceptanceMessage – сообщение, полученное вместе со статусом принятия документа, если оно заполнено.

    • VdtCustomsRegistrationNumber – регистрационный номер заявления на выпуск товаров до подачи декларации, присвоенный таможней, если поле заполнено.

    • Owner – владелец декларации (исполнитель). Не путать с графой 54.

    • Note – примечание к декларации, доступное для редактирования декларантами. Максимальная длина 8000 символов.

    • ApiNote – произвольная строка, переданная при создании декларации запросом R6. Максимальная длина 8000 символов.

    • GoodPositions – список товарных позиций в декларации. Каждый элемент содержит следующие поля:

      • Position – номер товарной позиции.

      • Name – наименование товарной позиции (“лицо”). Не путать с названием товара (“обраткой”), которое выгружается в поле GoodsInfo.

      • SpecialDescription – спецописание товара, если оно было заполнено в отдельном поле. Примечание: т.к. спецописание автоматически дописывается в наименование товарной позиции, то оно будет присутствовать и в этом поле, и в поле Name.

      • Tnved – код ТНВЭД, если он задан. 10 цифр.

      • TnvedAddition – код дополнительной таможенной информации, если он задан. 4 цифры. Если значение отсутствует, то это поле не включается в ответ сервера.

      • Amount – количество товара в основной единице измерения.

      • Measure – основная единица измерения (краткое наименование, например “шт”).

      • MeasureCode – код основной единицы измерения в соответствии с Классификатором единиц измерения.

      • Manufacturer – производитель товара.

      • Trademark – товарный знак.

      • Price – стоимость товарной позиции в валюте декларации (графа 42).

      • CustomsCost – таможенная стоимость в национальной валюте (графа 45).

      • Brutto – вес брутто, кг (графа 35).

      • Netto – вес нетто 1, кг (графа 38).

      • Netto2 – вес нетто2, кг (графа 38-2).

      • AdditionalAmount – количество товара в дополнительное единице измерения. Если для кода ТНВЭД отсутствуют дополнительные единицы измерения, это поле не включается в ответ сервера.

      • AdditionalMeasure – дополнительная единица измерения (краткое наименование, например “шт”). Если для кода ТНВЭД отсутствуют дополнительные единицы измерения, это поле не включается в ответ сервера.

      • AdditionalMeasureCode – код дополнительной единицы измерения в соответствии с Классификатором единиц измерения. Если для кода ТНВЭД отсутствуют дополнительные единицы измерения, это поле не включается в ответ сервера.

      • OriginCountry – код страны происхождения товара (графа 34) в соответствии с Классификатором стран мира.

      • ExciseID – выбранный режима расчёта акциза. При необходимости ID режимов расчёта акциза можно получить запросом R12. Специальное значение “-1” означает “Акциз не начисляется”. Если код ТНВЭД товара не предусматривает уплату акцизов, то это поле будет пустым.

      • AntidumpingID – выбранный режим расчёта антидемпинговой пошлины. При необходимости ID режимов расчёта антидемпинговой пошлины можно получить запросом R12. Специальное значение “-1” означает “Антидемпинговая пошлина не начисляется”. Если код ТНВЭД товара не предусматривает уплату антидемпинговых пошлин, то это поле будет пустым.

      • GoodsInfo – список сведений о товаре в товарной позиции. Каждый элемент содержит следующие поля:

        • Name – наименование товара (“обратка”).
        • Mark – марка товара.
        • Model – модель товара.
        • VendorCode – артикул товара.
        • SerialNumber – серийный номер товара.
        • Amount – количество товара в основной единице измерения.
        • Cost – стоимость товара в валюте декларации.

        Поле Cost может отсутствовать в ответе сервера в случае ручного заполнения графы 42 декларации. Также при ручном заполнении цены товарной позиции сумма стоимостей товаров может ей не соответствовать. Значение поля Cost в таможню не отправляется, первичной считается цена товара из поля Price товарной позиции.

        • Note – поле “Примечание” из сведений о товарах. Заполняется значением поля “Примечание” спецификации. Может использоваться для “протягивания” через систему каких-то своих внутренних идентификаторов товара при интеграции. Если сведения о товарах создавались запросом R7, то в этом поле будут данные, переданные в поле ApiNote.
        • TwsApiParams – строка, которую будет необходимо передать Системе TWS в запросе R7 для сохранения настроек товарной позиции после очистки декларации.
      • CustomsPayments – список рассчитанных таможенных платежей для товарной позиции. Каждый элемент содержит следующие поля:

      • Documents – документы, добавленные в товарную позицию. Каждый элемент содержит следующие поля:

        • Code – код документа в соответствии с Классификатором видов документов и сведений.
        • Name – наименование документа, если поле заполнено.
        • Number – номер документа, если поле заполнено.
        • Date – дата документа, если поле заполнено. Формат: YYYY-MM-DD.
        • DateFrom – дата начала действия документа, если поле заполнено. Формат: YYYY-MM-DD.
        • DateTo – дата завершения действия документа, если поле заполнено. Формат: YYYY-MM-DD.
        • InfoUrl – ссылка на страницу с дополнительной информацией о документе. Если такой информации нету, ссылка отсутствует.
      • CreatedUserID – ID пользователя, создавшего товарную позицию. Поле отсутствует, если данных о пользователе уже нету в логе изменений.

      • CreatedUserFullName – полное имя пользователя, создавшего товарную позицию. Поле отсутствует, если данных о пользователе уже нету в логе изменений.

      • CreatedDate – дата и время создания товарной позиции. Формат YYYY-MM-DD hh:mm:ss. Поле отсутствует, если данных о пользователе уже нету в логе изменений.

    • CustomsPaymentTotals – список элементов с расчётами суммарных таможенных платежей для всей декларации. Каждый элемент содержит следующие поля:

    • CustomsCostAdditions – список включений в таможенную стоимость. Каждый элемент содержит следующие поля:

      • Kind – Тип включения. Возможные значения).
      • Sum – Сумма в валюте включения.
      • Currency – Код валюты, в которой указана сумма включения, в соответствии с Классификатором валют.
      • NationalCurrencySum – Сумма в национальной валюте (по курсу на дату декларации).
    • TaxPaymentOrders – список платёжных документов по оплате таможенных платежей (графа Б). Каждый элемент содержит следующие поля:.

    • GuarantyPaymentOrders – список платёжных документов по платежам обеспечения по декларации. Каждый элемент содержит следующие поля:

    • KDT – список корректировок декларации (КДТ). Каждый элемент содержит следующие поля:

      • ID – ID корректировки в Системе TWS (для использования в запросе R14).
      • Kind – тип корректировки. Возможные значения).
      • KindName – Краткое наименование типа корректировки (для отображения в списках, к примеру).
      • Date – дата корректировки. Формат: YYYY-MM-DD.
      • OutgoingNumber – Исходящий номер корректировки.
      • CustomsRegistrationNumber – Регистрационный номер КДТ в таможне. Внимание: это поле заполнено только в том случае, если декларант отметил корректировку, как “принятую таможней”.
    • Section54FullName – Полное имя лица, заполнившего декларацию (графа 54).

    • Section54RepresentativeContractDate – Дата договора поручения, если она указана в графе 54-1. Формат: YYYY-MM-DD.

    • Section54RepresentativeContractNumber – Номер договора поручения, если он указан в графе 54-1.

    • Dts1GoodsCount – Количество товаров в ДТС-1. Обращаем внимание, что это количество товаров, которые могут быть выгружены в ДТС. Наличие цифры в этом поле не означает, что ДТС вообще формировалась. В случае, когда ни один из товаров декларации не попадает в ДТС-1, этот параметр отсутствует в ответе сервера.

    • Dts2GoodsCount – Количество товаров в ДТС-2. Обращаем внимание, что это количество товаров, которые могут быть выгружены в ДТС. Наличие цифры в этом поле не означает, что ДТС вообще формировалась. В случае, когда ни один из товаров декларации не попадает в ДТС-1, этот параметр отсутствует в ответе сервера.

    • SrcLinks – Список исходящих связей между декларациями. Если исходящих связей для декларации нет, это поле отсутствует. Каждый элемент содержит следующие поля:

      • Kind – Тип связи. Возможные значения.
      • DeclarationID – внутренний ID связанной декларации в Системе TWS (например, для использования в запросе R5).
      • Note – Примечание к связи.
    • DstLinks – Список входящих связей между декларациями. Если входящих связей для декларации нет, это поле отсутствует. Каждый элемент содержит следующие поля:

      • Kind – Тип связи. Возможные значения.
      • DeclarationID – внутренний ID связанной декларации в Системе TWS (например, для использования в запросе R5).
      • Note – Примечание к связи.
    • CreatedUserID – ID пользователя, создавшего декларацию. Поле отсутствует, если данных о пользователе уже нету в логе изменений.

    • CreatedUserFullName – полное имя пользователя, создавшего декларацию. Поле отсутствует, если данных о пользователе уже нету в логе изменений.

    • CreatedDate – дата и время создания декларации. Формат: YYYY-MM-DD hh:mm:ss. Поле отсутствует, если данных о пользователе уже нету в логе изменений.

    • XmlUrl – Полная ссылка для скачивания XML-файла декларации. В ссылку добавляется token безопасности, благодаря чему файл можно скачать даже без авторизации на сайте.

    • PdfUrl – Полная ссылка для скачивания PDF-файла декларации (печатная форма). В ссылку добавляется token безопасности, благодаря чему файл можно скачать даже без авторизации на сайте.

Предупреждение о безопасности данных: по ссылкам из полей XmlUrl и PdfUrl доступ к файлу можно получить в обход авторизации на сайте tws.by. Внимательно отнеситесь к их обработке и хранению.