Запрос R4: Список деклараций в виртуальном офисе (с возможностью поиска по полям)

• Входные параметры
• Параметры JSON-ответа

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

Список деклараций в Виртуальном Офисе.

Этот запрос используется для поиска деклараций или для получения их списка по определённым критериям, например по дате декларации. Для получения подробных сведений о конкретной декларации используется запрос R5.

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

• SessionKey – сессионный ключ, полученный из запроса R1. Обязательный параметр.
• DateFrom – Фильтр по дате подачи декларации: выгружаются все декларации с датой большей или равной DateFrom. Обязательный параметр (должен быть задан или параметр DateFrom, или CustomsPermissionDateFrom, или оба сразу). Формат: YYYY-MM-DD.
• DateTo – Фильтр по дате подачи декларации: выгружаются все декларации с датой меньшей или равной DateTo. Обязательный параметр (должен быть задан или параметр DateTo, или CustomsPermissionDateTo, или оба сразу). Формат: YYYY-MM-DD.
• PreviousDocumentNumber – поиск по Графе 40 “Предшествующий документ” (обычно в этой графе номер “В-эшки”). Может быть задан как короткий номер документа (например “В003828”), так и полный номер (например, “06542/200717/В003828”). Можно передавать несколько значений, разделённых символом “|” (“вертикальная палка”, например “В003828|06542/200717/В003821|06542/210717/В003818”). При использовании этого параметра указание диапазона дат декларации является не обязательным.
• CustomsRegistrationNumber – поиск по регистрационному номеру декларации. Можно искать по короткому номеру (например, “0817234”) и по полному номеру(например, “06649/030718/0817234”). Ищутся только точные совпадения.
• CustomsPermissionNumber – поиск по номеру разрешения на выпуск. Можно искать по короткому номеру (например, “52066210”) и по полному номеру (например, “06649/52066210”). Ищутся только точные совпадения. Если передать специальное значение “*”, будут искаться все декларации с заполненным номером разрешения на выпуск товаров.
• CustomsPermissionDateFrom – Фильтр по дате разрешения на выпуск: выгружаются все декларации с датой разрешения большей или равной CustomsPermissionDateFrom. Формат: YYYY-MM-DD.
• CustomsPermissionDateTo – Фильтр по дате: выгружаются все декларации с датой разрешения меньшей или равной CustomsPermissionDateTo. Формат: YYYY-MM-DD.
• VdtCustomsRegistrationNumber – поиск по регистрационному номеру заявления ВДТ. Можно искать по короткому номеру (например, “В001291”) и по полному номеру(например, “06533/040320/В001291”). Ищутся только точные совпадения. Обратите внимание, что сначала производится отбор по дате декларации (либо по дате разрешения на выпуск), а уже потом среди результатов выполняется поиск по регистрационному номеру заявления ВДТ.
• Kind – Фильтр по виду декларации (возможные значения). Если параметр отсутствует (или равен нулю), возвращается список из всех деклараций, подпадающих под остальные условия.
• Note – Фильтр по полю “Примечание” (доступное для редактирования декларантами через веб-интерфейс).
• ApiNote – Фильтр по полю “ApiNote” (недоступное для редактирования декларантами через веб-интерфейс, заполняется при создании декларации через API).

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

• Count – количество деклараций, отвечающих условиям отбора.
• List – список деклараций. Каждый элемент списка имеет следующие поля:
  • ID – внутренний ID декларации в Системе TWS (например, для использования в запросе R5).
  • Number – исходящий номер декларации.
  • Date – дата декларации. Формат: YYYY-MM-DD.
  • Kind – вид декларации (возможные значения).
  • SdType – тип статистической декларации (возможные значения). Поле добавляется только для Статистических деклараций.
  • SrcPartner – отправитель. Полное наименование.
  • DstPartner – получатель. Полное наименование.
  • Sum – полная сумма декларации. Выгружается только в том случае, если декларация рассчитана. Иначе сюда попадает null. Для расчёта декларации её необходимо запросить при помощи запроса R5.
  • Currency – код валюты декларации.
  • PreviousDocumentNumber – графа 40 “Предшествующий документ”, если заполнена. Обычно тут номер “В-эшки”. CustomsRegistrationNumber - Регистрационный номер, присвоенный таможней, если заполнено.
  • CustomsPermissionNumber – номер разрешения на выпуск, если заполнено.
  • CustomsPermissionDate – дата разрешения на выпуск, если заполнено. Формат: YYYY-MM-DD.
  • CustomsAcceptanceStatus – статус принятия документа (возможные значения). Заполняется для документов, в которых не применяется номер разрешения на выпуск, например ЭПИ или Транзитные декларации.
  • CustomsAcceptanceMessage – сообщение, полученное вместе со статусом принятия документа, если оно заполнено.
  • VdtCustomsRegistrationNumber – регистрационный номер заявления на выпуск товаров до подачи декларации, присвоенный таможней, если поле заполнено.
  • Owner – владелец декларации (исполнитель). Не путать с графой 54.
  • Note – примечание к декларации, доступное для редактирования декларантами через веб-интерфейс.
  • ApiNote – примечание к декларации, заполняемое при создании декларации через API.