Критерії пошуку/фільтрації довідника специфікацій/контрактів (об’єкт XSearchContractsQuery)

JSON приклади:

Отримати всі завершені контракти / специфікації для Отримувача «13200665»

{
  "contractGlnId": [],
  "productBarcode": [],
  "buyerArticle": [],
  "contractStatus": [],
  "productStatus": [],
  "direction": {
    "type": "EQ",
    "recipient": [
      13200665
    ]
  },
  "expireDate": {
    "startTimestamp": 1631353973
  }
}

Таблиця 1 - Опис параметрів

Параметр	Формат	Опис
	Об’єкт XSearchContractsQuery
direction	Direction	об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів
contractGlnId	List<Long>	масив; id Gln-у контракту/специфікації
contractGln	List<String>	масив; Gln-у контракту/специфікації
productBarcode	List<String>	масив; список товарних штрихкодів
buyerArticle	List<String>	масив; артикул продавця
retailerId	Long	id мережі (ритейлера)
retailers	List<Long>	масив; список мереж (ритейлерів)
contractStatus	List<Integer>	масив; список статусів контрактів: 1 - активний, 2 - неактивний / видалений
productStatus	List<Integer>	масив; список статусів товарів: 1 - активний, 2 - неактивний / видалений
number	String	номер специфікації
subContractNumber	String	номер договору
expireDate	DateTimeRange	об’єкт; дата закінчення специфікації (в форматі UNIX-timestamp) з / по
subContractExpireDate	DateTimeRange	об’єкт; дата договору (в форматі UNIX-timestamp) з / по
changeDate	DateTimeRange	об’єкт; дата зміни специфікації (в форматі UNIX-timestamp) з / по
limit	Limitation	об’єкт; фільтр відбору (налаштування виводу даних)

Таблиця 2 - Опис параметрів об’єкта Direction

Параметр	Формат	Опис
	Об’єкт Direction
type	enum (EQ, OR, IN)	тип вибірки EQ - відбираються тільки документи в яких збігаються зазначені і sender, і receiver; OR - відбираються документи в яких збігаються АБО sender, АБО receiver; IN - відбираються документи в яких sender або receiver один з тих, які вказані в масивах sender і receiver
sender	List<String>	масив; id GLN відправників - обов’язковий, але може бути порожнім якщо зазначені інші параметри
senderGln	List<String>	масив; GLN відправників - обов’язковий, але може бути порожнім якщо зазначені інші параметри
recipient	List<String>	масив; id GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначені інші параметри
recipientGln	List<String>	масив; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначені інші параметри

Таблиця 3 - Опис параметрів об’єкта Limitation

Параметр	Тип [1]_	Формат	Опис
		Об’єкт Limitation
offset	O	int	зміщення першого елемента списку щодо верхньої межі вибірки (за замовчуванням 0)
count	O	int	ліміт вибірки (кількість); за замовчуванням 20

Таблиця 4 - Опис параметрів об’єкта DateTimeRange

Параметр	Тип [1]_	Формат	Опис
		Об’єкт DateTimeRange
startTimestamp		long	початок часового діапазону
finishTimestamp		long	закінчення часового діапазону