Критерії пошуку/фільтрації «Товарних узгоджень» (AGREEM) (об’єкт XSearchDocsQuery)

JSON приклади:

Отримати 20 останніх неархівних (необроблених) «Товарних узгоджень» (AGREEM) для Відправника «13200665»

{
  "indexes": [],
  "types": [],
  "statuses": [],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "archive": false,
  "limit": {
    "count": 20,
    "offset": 0
  }
}

Отримати 20 останніх важливих завершених «Товарних узгоджень» (AGREEM) типу «Промо ціна» для Відправника «13200665»

{
  "indexes": [
    {
      "operator": "AND",
      "type": "EQUALS",
      "fieldName": "isFavorite",
      "value": "true"
    }
  ],
  "types": [
    2
  ],
  "statuses": [
    7
  ],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "limit": {
    "count": 20,
    "offset": 0
  }
}

Отримати 20 останніх оброблених (архівних) «Товарних узгоджень» (AGREEM) типу «Регулярна ціна» для Відправника «13200665» з датою документа за період 2021-07-01-2021-07-27

{
  "indexes": [],
  "types": [
    1
  ],
  "statuses": [],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "archive": true,
  "docDate": {
    "startTimestamp": 1625086800,
    "finishTimestamp": 1627419599
  },
  "limit": {
    "count": 20,
    "offset": 0
  }
}

Отримати 40 останніх необроблених (неархівних) «Товарних узгоджень» (AGREEM) для Відправника «13200665» з номером контракту «666.333333»

{
  "indexes": [],
  "types": [],
  "statuses": [],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "archive": false,
  "contractNumber": {
    "operator": "AND",
    "type": "EQUALS",
    "value": "666.333333"
  },
  "limit": {
    "count": 40,
    "offset": 0
  }
}

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

Параметр	Формат	Опис
	Об’єкт XSearchDocsQuery
indexes	List<Index>	масив об’єктів; індекси
direction	Direction	об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів
retailerId	Long	id мережі (ритейлера)
retailers	List<Long>	масив; список мереж (ритейлерів)
statuses	List<Integer>	масив; статус документа 1 - Чернетка (на стороні постачальника) 2 - Відправлено (на стороні постачальника) 3 - На узгодженні (на стороні постачальника) 4 - Відхилено (на стороні постачальника) 5 - Підписання постачальником (на стороні постачальника) 6 - 2 підписання постачальником (на стороні постачальника) 7 - Завершено (на стороні постачальника) 11 - Відхилено (на стороні мережі) 12 - На узгодженні (на стороні мережі) 13 - Підготовлено (на стороні мережі) 14 - Готовий до підписання (на стороні мережі) 15 - Погоджено (на стороні мережі) 16 - Підписано (на стороні мережі) 17 - Перевірено (на стороні мережі) 18 - Підтверджено (на стороні мережі) 19 - Підписання постачальником (на стороні мережі) 20 - Підписання мережею (на стороні мережі)
types	List<Integer>	масив; тип документа 1 - Регулярна ціна; 3 - Комерційна пропозиція; 2 - Промо ціна; 5 - Промо ціна - Компенсація; 6 - Промо ціна - Комбо
contractGlnIDs	List<Integer>	масив; id Gln-нів контрагентів
contractNumber	Field	об’єкт; номер контракту/специфікації
contractDescription	Field	об’єкт; опис контракту/специфікації
dateCreated	DateTimeRange	об’єкт; дата створення документа (в форматі UNIX-timestamp) з / по
dateChanged	DateTimeRange	об’єкт; дата зміни документа (в форматі UNIX-timestamp) з / по
docDate	DateTimeRange	об’єкт; дата документа (в форматі UNIX-timestamp) з / по
limit	Limitation	об’єкт; фільтр відбору (налаштування виводу даних)
docNumber	String	номер документа
archive	Boolean	відмітка про те, що документ оброблений (архівний)
withChilds	Boolean	відмітка про наявність дочірніх документів

Таблиця 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	закінчення часового діапазону

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

Параметр	Формат	Опис
	Об’єкт Index
operator	enum (AND, OR)	тип оператора; AND - відбираються всі документи, в яких збігаються всі зазначені параметри type + fieldName + value OR - відбираються документи, в яких збігаються АБО fieldName АБО value
type	enum (MORE, EQUALS, LIKE)	тип документа; LIKE - Пошук по повному або частковому збігу. Для часткового пошуку, використовуеться символ „+“. Приклад: „Номер: 123+“ - будуть знайдені всі документи які починаються з 123 EQUALS - відбираються тільки документи в яких збігаються зазначені значення параметрів fieldName + value MORE - відбираються документи з числовим значенням value більше вказаного
fieldName	String	назва параметра, за яким буде здійснюватись фільтрація isComments (boolean) - документ має коментар/-і; isSigns (boolean) - документ має підписи; rejected (0-ні, 1-так) - пропозиція з відхиленими позиціями; count (число) - кількість товарних позицій; isRead (boolean) - докумнт прочитаний; isAttaches (boolean) - є вкладення; isTags (boolean) - має теги; attacheMime (MIME типізація); attacheName (String) - назва вкладення, наприклад, 12345.jpeg; increase (0-ні, 1-так) - є підвищення ціни; discount_increase (0-ні, 1-так) - є підвищення ціни зі знижкою; confirmed (0-ні, 1-так) - документ прийнятий; decrease (0-ні, 1-так) - немає підвищення ціни; discount_decrease (0-ні, 1-так) - немає підвищення ціни зі знижкою; isFavorite (boolean) - документ важливий; flag (0-ні, 1-так) - мітка зафарбований флажок; lastSignDate () - дата останнього підписання; newDatePrice (YYYY-MM-DD) - дата початку дії нової ціни; afterDeadline (boolean) - Заявка на участь в акції була подана після встановленого дедлайну; rejection_reason (String) - причина відхилення; acceptation_message (String) - коментар при прийнятті
value	String	значення поля fieldName

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

Параметр	Формат	Опис
	Об’єкт Field
operator	enum (AND, OR)	тип оператора; AND - відбираються всі документи, в яких збігаються всі зазначені параметри type + value OR - відбираються документи, в яких збігаються АБО fieldName АБО value
type	enum (MORE, EQUALS, LIKE)	тип документа; LIKE - Пошук по повному або частковому збігу. Для часткового пошуку, використовуеться символ „+“. Приклад: „Номер: 123+“ - будуть знайдені всі документи які починаються з 123 EQUALS - відбираються тільки документи в яких збігаються зазначені значення параметрів value MORE - відбираються документи з числовим значенням value більше вказаного
value	String	значення поля