Отримання списку ланцюжків документів сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту	HTTP GET
Content-Type	application/json (тіло запиту/відповіді в json форматі)
URL запиту	{url серверу} /api/ettn/eds/chains/search
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_uuid - ідентифікатор компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передаються дані для фільтрації (об’єкт StorageQuery)

Таблиця 2 - Опис json-параметрів (фільтр) запиту методу API

Параметр	Обов’язкове / необов’язкове поле	Формат	Опис
		Об’єкт StorageQuery
extraParams		List<ExtraQueryParameters>	масив об’єктів;
multiExtraParams		List<ExtraQueryParameters>	масив об’єктів;
type	О	List<XDocType>	масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа
statuses	О	List<Integer>	масив; список статусів (станів) документів, за якими буде відбуватися відбір: 0 - все 1 - open 2 - sent 3 - delivered 4 - inbox 5 - read 6 - error 7 - deleted
tags		List<Long>	масив; тег
exchangeStatus	Н	List<Integer>	масив; статус документообігу
docs		List<Long>	масив; документи
direction	О	Direction	об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів
limit	Н	Limitation	объект; фільтр відбору (налаштування виводу даних)
number	Н	String	номер документа
family	Н	int	сімейство (EDI / UZD); можливі значення: 1 - edi
partnerId		Long	id роздрібної мережі
chainHash		String	хеш-значення, отримане в результаті обробки ланцюжка
docHash		String	хеш-значення, отримане в результаті обробки документа
docDate	Н	DateTimeRange	об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по
docCreate	Н	DateTimeRange	об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по
docRead	Н	DateTimeRange	об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по
docChanged	Н	DateTimeRange	об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по
archive		Boolean	відмітка наявності архівної ознаки документа
important		boolean	відмітка важливий документ
visible		boolean	відмітка видимості
loadBody		boolean	відмітка наявності тіла документа
loadComments		boolean	відмітка наявності коментарів до документа
loadStatuses		boolean	відмітка наявності статусів документа
loadTags		boolean	відмітка наявності тегів документа
loadChain		boolean	відмітка наявності ланцюжка документів

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

Параметр	Обов’язкове / необов’язкове поле	Формат	Опис
		Об’єкт ExtraQueryParameters
operator		enum (AND, OR)
type	О	enum (EQUALS, EQUALS_UUID, EQUALS_MD5, LIKE, MORE, MORE_EQ, LESS, LESS_EQ, IN)
fieldName		String	найменування параметру
value		String	id параметра

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

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

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

Параметр	Обов’язкове / необов’язкове поле	Формат	Опис
		Об’єкт Limitation
offset	Н	int	зміщення першого елемента списку щодо верхньої межі вибірки (за замовчуванням 0)
count	Н	int	ліміт вибірки (кількість)

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

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

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

Параметр	Тип	Формат	Опис
		Об’єкт XDocType	опис_параметрів
type		int	id типу документа/квитанції
title		String	назва документа/квитанции
description		String	опис документа/квитанції (найменування кирилицею)

Таблиця 8 - Опис fieldName параметрів (объект ExtraQueryParameters)

id параметра	Найменування параметра	Обов’язкове / необов’язкове поле	Формат	Опис параметра
1	created_from		UUID	ідентифікатор документа або ланцюжка
2	is_signed		TINYINT	відмітка про підписання
3	encrypted		TINYINT	відмітка про шифрування
4	comdoc_reestr_id		INT	id факторингового Реєстру на підставі комерційного документа
5	comdoc_reestr_is_active		TINYINT	відмітка про активність факторингового договору
6	ftpex_file_name		VARCHAR	найменування файлу, відправленого по FTP
7	ftpex_file_date		INT	дата/час відправки документа по FTP
8	inv_date		INT	дата документа invrpt (Звіт про інвентаризацію)
9	inv_num		VARCHAR	номер документа invrpt (Звіт про інвентаризацію)
11	sub_doc_type_id		INT	id підтипу документа
12	sub_status_id		INT	id статусу документа (стан ланцюжка документів)
13	action		VARCHAR	статус документа за здійсненими діями користувача
14	buyer_uuid		VARCHAR	відправник документа
15	consignee_uuid		VARCHAR	вантажоодержувач
16	consignor_uuid		VARCHAR	вантажовідправник
17	customer_uuid		VARCHAR	покупець
18	performer_uuid		VARCHAR	виконавець
19	supplier_uuid		VARCHAR	постачальник
20	delivery_place_uuid		VARCHAR	місце доставки
21	contract_date		VARCHAR	дата договору
22	contract_number		VARCHAR	номер договору
23	delivery_date	M	INT	дата доставки
24	order_number	M	VARCHAR	номер замовлення
25	order_date		INT	дата замовлення
26	return_date		INT	дата повернення
27	summ		VARCHAR	сума з ПДВ
28	parent_chain_hash		MD5	хеш ланцюжка
29	period		VARCHAR	крайня дата підпису документа
31	trans_id		VARCHAR	id транзакції
32	ttn		VARCHAR	номер накладної
33	doc_start_date		VARCHAR	початок терміну підписання документа
34	doc_end_date		VARCHAR	закінчення терміну підписання документа
35	delivery_note_number		VARCHAR	номер накладної
42	contract_gln		VARCHAR	GLN місце доставки при товарному узгодженні (Agreem-> Comdoc)
43	doc_date		INT	дата з документа
44	delivery_agreement_number		VARCHAR	кількість узгоджень
45	delivery_agreement_date		INT	дата узгодження
46	varn		VARCHAR	ЮЗД id документа
47	other_info		TEXT	додаткові дані
48	sub_doc_date		INT	дата підтипу документа
49	sub_doc_number		VARCHAR	номер підтипу документа
50	doc_error		TEXT	помилка при роботі з документом
51	doc_info		TEXT	коментар до документа
52	old_doc_id		INT	id документа
53	sub_status_date		INT	дата статусу документа (стан ланцюжка документів)
54	from_doc_id		INT	порядковий номер документа в ланцюжку
56	doc_num		VARCHAR	номер документа
57	sender		VARCHAR	GLN відправника
58	recipient		VARCHAR	GLN одержувача
59	file_name		VARCHAR	найменування прикладаємого (вкладення) файлу
60	xml_hash		VARCHAR	хеш змісту документа
61	answer_doc_id		INT	id COMDOC документа відправленного у відповідь
80	identifier		VARCHAR	ідентифікатор документа в системі клієнта
82	compound_number		VARCHAR	складовий номер
85	doc_process		TINYINT
87	users		VARCHAR
88	basis_doc_subtype		INT	підтип документа-підстави
89	basis_doc_number		INT	номер документа-підстави
90	basis_doc_date		INT	дата документа-підстави

Таблиця 9 - Опис DocType параметрів (объект XDocType)

Тип	Назва	Опис (найменування кирилицею)
0	all	всі
1	invoice	Рахунок
2	orders	Замовлення
3	recadv	Повідомлення про прийом
4	desadv	Повідомлення про відвантаження
5	ordrsp	Підтвердження замовлення
6	pricat	Прайс-лист
10	declar	Податкова накладна
11	insdes	Інструкція з доставки
13	slsrpt	Звіт про продажі
14	invrpt	Звіт про інвентаризацію
15	coacsu	Акт звірки взаєморозрахунків
16	actset	Акт взаємозаліку
17	iftmin	Інструкція про транспортування
18	retann	Повідомлення про повернення
19	iftmbf	Замовлення транспортування
21	mscons	Звіт про надані послуги
25	retins	Інструкція з повернення
28	comdoc	Комерційний документ
29	declarj12	Коригування до податкової накладної
30	condra	Не структурований документ
42	iftmbc	Підтвердження замовлення транспортування
59	documentinvoice	Товарна накладна
67	doccorinvoice	doccorinvoice
75	waybill	Товарно-транспортна накладна (ТТН)
79	addbill	addbill
98	quotes	Додаток до Повідомлення про відвантаження

RESPONSE

У відповідь передається масив ланцюжків документів (об’єкт XChain).

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

Параметр	Формат	Опис
	Об’єкт XChain
id	long	ID шарда
uuid	UUID	UUID ланцюжка документів
packageID	long	ID пакета
type	XDocType	об’єкт; тип документа
docsCount	int	кількість документів в ланцюжку
lastInDocID	long	id останнього вхідного документа в ланцюжку
lastOutDocID	long	id останнього вихідного документа в ланцюжку
partnerId	long	id роздрібної мережі
important	boolean	відмітка важливий документ
status	XChainStatus	об’єкт; статус пари документів у відправника і одержувача
visualStatus	int	номер іконки
archive	boolean	відмітка; Архівний документ чи ні
childs	List< XDoc >	масив об’єктів; дані документів/квитанцій
chainsInPackage	List<XChain>	масив об’єктів; дані пов’язаних ланцюжків
hash	String	хеш-значення, отримане в результаті обробки

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

Параметр	Формат	Опис
	Об’єкт XChainStatus
state	int	id статусу
title	String	статус

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}