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

Опубликовано 24.07.2017 - 19:55 пользователем admin

Адрес: 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.
  • Kind - Фильтр по виду декларации (возможные значения). Если параметр отсутствует (или равен нулю), возвращается список из всех деклараций, подпадающих под остальные условия.
  • Note - Фильтр по полю "Примечание" (доступное для редактирования декларантами через веб-интерфейс).
  • ApiNote - Фильтр по полю "ApiNote" (недоступное для редактирования декларантами через веб-интерфейс, заполняется при создании декларации через API).

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

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