Пошук документів (з фільтрацією), вибір списку документів

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

За допомогою методу api/eds/docs/search можливо швидко зробити пошук по заданим критеріям, наприклад, отримати список документів з певним статусом, або за проміжок часу.

Метод запиту	HTTP POST
Content-Type	application/json (тіло HTTP запиту / відповіді в json форматі)
URL запиту	https://edo-v2.edin.ua/api/eds/docs/search?gln=9864065702429
Параметри, що передаються в URL (разом з адресою методу)	У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри: gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта {«…»} - тіло http запиту - json з критеріями пошуку (Таблиця_2)

Увага: У запиті в тілі json присутні обов’язкові (повинні передаватися) і опціональні параметри (колонка Тип).

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edin.ua/api/eds/docs/search?gln=9864065702429“ -d {json с критериями поиска(Таблиця_2)} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

---

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

---

REQUEST

---

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

Параметр	Тип	Формат	Опис
		Об’єкт StorageQuery
extraParams		List<ExtraQueryParameters>	масив об’єктів;
multiExtraParams		List<ExtraQueryParameters>	масив об’єктів;
type	M	List<XDocType>	масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа
statuses	M	List<Integer>	масив; список статусів (станів) документів, за якими буде відбуватися відбір: 0 - all (всі) 1 - open (чернетки) 2 - sent (відправлені-Відправник) 3 - delivered (доставлені-Відправник) 4 - inbox (вхідні-Отримувач) 5 - read (прочитані-Отримувач) 6 - error (помилка) 7 - deleted (видалені)
extraStatuses		List<Integer>	масив; список екстрастатусів
tags		List<Long>	масив; тег
exchangeStatus	O	List<Integer>	масив; статус документообігу
docs		List<Long>	масив; документи
docUUIDs		List<UUID>	масив; унікальні ідентифікатори документів
partners		List<Long>	масив; ідентифікатори контрагентів
families		List<Integer>	масив; ознака сервісу (сімейство) 1 - EDI+ЮЗД 7 - ЕТТН
direction	M	Direction	об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів
limit	O	Limitation	об’єкт; фільтр відбору (налаштування виводу даних)
orderBy	Н	OrderBy	фільтрувати по даті чи опису документа
groupBy	Н	String	об’єднані по id ланцюжка/документа
number	O	String	номер документа
family	O	int	сімейство 1 - EDI 2 - UZD 4 - CERTIFICATS 6 - ATS 7 - ETTN 8 - DISTRIBUTION 9 - SIMPLEDOC (Вільний) 10 - TENDER 11 - AGREEMENT 12 - OPENPRICE (Є-Товар)
partnerId		Long	id роздрібної мережі
chainHash		String	хеш-значення, отримане в результаті обробки ланцюжка
docHash		String	хеш-значення, отримане в результаті обробки документа
docDate	O	DateTimeRange	об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по
docCreate	O	DateTimeRange	об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по
docRead	O	DateTimeRange	об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по
docChanged	O	DateTimeRange	об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по
archive		Boolean	відмітка наявності архівної ознаки документа
important		boolean	відмітка важливий документ
visible		boolean	відмітка видимості
loadBody		boolean	відмітка наявності тіла документа
loadComments		boolean	відмітка наявності коментарів до документа
loadStatuses		boolean	відмітка наявності статусів документа
loadTags		boolean	відмітка наявності тегів документа
loadChain		boolean	відмітка наявності ланцюжка документів
loadAttachments		boolean	відмітка наявності вкладень

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

Параметр	Тип	Формат	Опис
		Об’єкт ExtraQueryParameters
operator		enum (AND, OR)
type	M	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	M/O	List<String>	масив; відправники; GLN відправників - обов’язковий, але може бути порожнім якщо зазначений масив GLN одержувачів (receiver)
receiver	M/O	List<String>	масив; одержувачі; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначений масив GLN відправників (sender)

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

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

Таблиця 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	відмітка про підписання; 0 - без підпису; 1 - підписано
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 (Звіт про інвентаризацію)
10	error_code		INT	код помилки документообігу
11	sub_doc_type_id		INT	id підтипу документа ( опис_підтипів )
12	sub_status_id		INT	id статусу документа (опис + опис для ETTN v3); характеризує стан ланцюжка документів
13	action		VARCHAR	статус/стан документа за здійсненими діями користувача; Для EDI: ORDER (тип документа): 0 для ORDER.DOCTYPE = PO / O / F / OS (Попереднє замовлення (PO), Оригінал замовлення (O), Фіктивність замовлення (F), Замовлення на послугу / маркетинг (OS)) 1 для ORDER.DOCTYPE = R (Заміна (R)) 2 для ORDER.DOCTYPE = D (Видалення (D)) та всіх пов’язаних документів з ORDER.DOCTYPE = PO / O / F / OS, що йому передували 3 для всіх пов’язаних документів з ORDER.DOCTYPE = PO / O / F / OS, що передували документу ORDER.DOCTYPE = R RETANN: 1 - документ RETANN відправлено 2 - у відповідь відправлено RETINS PRICAT (тип документа): 9 - прайс-лист (повний) 13 - запит прайс-листа EDIN 15 - для сервісу EDIN Distribution 19 - запит прайс-листа EDIN 2.0 51 - відповідь на прайс-лист 21 - доповнення існуючого прайс-листа 99 - відмова на прайс-лист COACSU (тип документа): 49E - оригінал документа 397 - документ у відповідь CONDRA: 1 - відправлено 2 - прийнято іншою стороною 3 - відхилено іншою стороною 4 - відкликано відправником Для Вільний: 0 - Очікує на підпис одержувача 1 - Частково підписано (для Відправника) 1 - Очікує на підпис одержувача (для Отримувача) 1 - Підписано (для Отримувача, якщо в документі присутній параметр is_signed = 1) 2 - Підписано 3 - Відхилено отримувачем 4 - Відхилено відправником 5 - Завершено Копія - sub_status_id = 1 Для ЕТТН: 101 - документ без помилок (статус); 102 - документ з помилками (статус) blocked_for_update - відмітка в шарді відправника транзакції, при наявності якої даному учаснику(ролі) заборонено створювати чернетку транзакції до ТТН
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	О	INT	дата доставки
24	order_number	О	VARCHAR	номер замовлення
25	order_date		INT	дата замовлення
26	return_date		INT	дата повернення
27	summ		decimal	сума з ПДВ / загальна сума штрафу (ORDRPT)
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) для сервісу Е-Специфікація. Також для EDI сервісу в нього пишеться поле ContractGLN з документа Метро 7а
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	дата документа-підстави
116	ready_for_sign		INT	відмітка готовності до підписання (0-ні; 1-так)
118	ready_for_send		INT	відмітка готовності до відправки (0-ні; 1-так)
95	summ_without_tax		decimal	сума без ПДВ
	tax_summ		decimal	сума ПДВ
129	receiving_note_number		VARCHAR	Номер повідомлення про прийом (DOCUMENTINVOICE…ReceivingAdviceNumber)
137	branch_uuid		VARCHAR	uuid «гілки поставки» для мережі АТБ (документи однієї поставки). Використовується для COMDOC та ETTNv3 документів. Поле заповнюється при відправці е-ТТН чи фомується автоматично платформою EDI Network на підставі даних з документа-основи: «Повідомлення про відвантаження» (DESADV.NUMBER + DESADV.DATE + DESADV.ORDERNUMBER + DESADV.ORDERDATE).
	parent_doc_uuid		VARCHAR	uuid початкового документа (записується також при заміні відправленої чернетки)
139	format_version		VARCHAR	номер версії (поле C_DOC_VER) з Податкової накладної (DECLAR) чи Коригування до податкової накладної (DECLARj12)
142	parent_docs_match		INT	0 - comdoc_007 зі зміненими даними для звірки по desadv; 1 - comdoc_007 з коректними / не зміненими даними для звірки по desadv
149	post_start_date		[yyyy-MM-dd]	дата дедлайну для документів Метро 7а
153	review_deadline_date		[yyyy-MM-dd]	термін подачі на перегляд для документів Метро 7b (ReviewDeadlineDate)
	sign_hash		VARCHAR	хеш підпису
	draft_date_created		INT	дата створення чернетки
	carrier_b_uuid		BINARY	ідентифікатор перевізника
	consignee_b_uuid		BINARY	ідентифікатор вантажоодержувача
	consignor_b_uuid		BINARY	ідентифікатор вантажовідправника
	external_doc_id		INT	id ТТН документа в ЦБД
	orderpartner_uuid		BINARY	ідентифікатор замовника (для документа ORDER з поля ORDERPARTNER)
	invoicepartner_uuid		BINARY	ідентифікатор платника (для документа ORDER з поля INVOICEPARTNER)
	finalrecipient_uuid		BINARY	ідентифікатор кінцевого консигнатора (для документів ORDER та DESADV з поля FINALRECIPIENT)
	is_offline_sign		INT	документ з офлайн підписом (мітка часу не підтверджена); 0-ні / 1-так
	car_number		VARCHAR	номер авто
	carrier		VARCHAR	GLN перевізника
	carrier_signed		INT	відмітка підписання перевізником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7))
	consignee		VARCHAR	GLN вантажоодержувача
	consignee_signed		INT	відмітка підписання вантажоодержувачем (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7))
	consignor		VARCHAR	GLN вантажовідправника
	consignor_signed		INT	відмітка підписання вантажовідправником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7))
	customer		VARCHAR	GLN замовника
	driver		VARCHAR	GLN водія
	driver_signed		INT	відмітка підписання водієм (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7))
	expeditor_signed		INT	відмітка підписання експедитором (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7))
	gross_weight		INT	маса брутто (кг)
	load_point		VARCHAR	GLN пункту завантаження
	sub_status_next		INT
	trailer_number		VARCHAR	номер причіпа
	unload_point		VARCHAR	GLN пункту розвантаження
	family		INT	сімейство 1 - EDI 2 - UZD 4 - CERTIFICATS 6 - ATS 7 - ETTN 8 - DISTRIBUTION 9 - SIMPLEDOC (Вільний) 10 - TENDER 11 - AGREEMENT 12 - OPENPRICE (Є-Товар)
	hash		VARCHAR	хеш документа
	is_archive		VARCHAR	документ перенесено в архів (true / false)
	user_status		INT	список користувачів із відповідним статусом погодження (сценарії) в форматі: userID:statusID, де statusID: 0 - на погодженні 1 - очікує мого погодження 2 - сценарій завершено
	ettn_process_act		INT	Присутність значення свідчить про створений Акт до ТТН v3: 1 - ТТН v3 заблоковано від певних дій (Акт знаходиться в опрацьовуванні (життєвий цикл Акта не завершено)
	ettn_process_act_type		INT	ідентифікатор типу (doc_type) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 133,134,135,136,137,138,139,140,141. За наявності цього параметра блокуються дії: Зберігання змін в ТТН v3 Підписання ТТН v3 Надсилання транзакції ТТН v3 Створення нового коригувального Акту до ТТН v3 Відправка з Чернеток коригувального Акта до ТТН v3 Розблокування дій з ТТН виконується автоматично після завершення життєвого циклу Акта.
	carrier_uuid		VARCHAR	GLN перевізника (він же sender Акта наданих послуг (Логістика))
	driver_switch_uuid		VARCHAR	GLN нового водія (Акт перевантаження)
	driver_uuid		VARCHAR	Водій
	expeditor_uuid		VARCHAR	Експедитор
	load_place_uuid		VARCHAR	Місце завантаження (COMDOC_027/МісцеНавантаження/GLN)
	ettn_onstorage		INT	ідентифікатор статусу документа: Вантаж розвантажено та отримувач підписав Акт перевантаження на проміжному складі
	track_number		VARCHAR	Номер рейсу (може вказуватись Вантажовідправником для ТТН v2)
	last_trans_id		VARCHAR	Ідентифікатор останньої транзакції (додається після реєстрації транзакції або при створенні документа з нуля)
	finalised		INT	Відмітка про фіналізацію замовлення в сервісі Маркет (0-ні, 1-так)
237	is_unilateral_signing		INT	Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так

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

Тип	Назва (doc_type)	Опис (найменування кирилицею)
0	all	всі
1	invoice	Рахунок
2	orders	Замовлення
3	recadv	Повідомлення про прийом
4	desadv	Повідомлення про відвантаження
5	ordrsp	Підтвердження замовлення
6	pricat	Прайс-лист
7	comdis	Комерційна дискусія
10	declar	Податкова накладна
11	insdes	Інструкція з доставки
13	slsrpt	Звіт про продажі
14	invrpt	Звіт про інвентаризацію
15	coacsu	Акт звірки взаєморозрахунків
17	iftmin	Інструкція про транспортування
18	retann	Повідомлення про повернення
19	iftmbf	Заявка на транспортування
20	partin	Інформація про контрагента для постачальника
21	mscons	Звіт про надані послуги
22	transportationorder	Заявка на транспортування / Підтвердження заявки на транспортування
25	retins	Інструкція з повернення
28	comdoc	Комерційний документ
29	declarj12	Коригування до податкової накладної
30	condra	Універсальний документ
35	metro7a	Додаток до договору 7А
39	metro7b	Додаток до договору 7Б
40	prodlist	Електронна специфікація
41	agreem	Товарне узгодження
42	iftmbc	Підтвердження заявки на транспортування
59	documentinvoice	Товарна накладна
67	doccorinvoice	Коригування до товарної накладної
72	metro7c	Додаток до договору 7Ц
98	quotes	Додаток до Повідомлення про відвантаження
111	transhipment	Акт перевантаження товарів
117	acceptance	Акт приймання-передавання
113	booking	Заявка на транспортування
114	bookingconfirmation	Підтвердження транспортування
115	ordrpt	Повідомлення про штрафні санкції
112	completion	Акт виконаних робіт
118	docinvoiceact	Акт приймання наданих послуг (Метро)
119	discrepancy	Акт розбіжностей
120	contrl	Звіт про відвантаження
121	ttn	Електронна товарно-транспортна накладна (е-ТТН)
122	simple_doc	Документ сервісу «Вільний»
123	reload	Акт перевантаження
124	disagreement	Акт розбіжностей до е-ТТН
125	adjustment	Акт коригування
126	warehouse_change	Акт про заміну пункту призначення вантажу
127	unload_storage	Акт розвантаження на проміжному складі
128	load_storage	Акт завантаження на проміжному складі
129	ettn_stop	Акт примусового завершення ТТН
130	resealing	Акт переопломбування
131	load_reject	Акт відмови завантаження
132	ttn_ecmr	ETTN (v3)
133	reload_ecmr	Акт перевантаження (v3)
134	disagreement_ecmr	Акт розбіжностей (v3)
135	consignee_change_ecmr	Акт зміни пункту призначення (v3)
136	storage_delivery_ecmr	Акт розвантаження на проміжному складі (v3)
137	adjustment_ecmr	Акт коригування (v3)
138	storage_pickup_ecmr	Акт завантаження на проміжному складі (v3)
139	resealing_ecmr	Акт перепломбування (v3)
140	load_reject_ecmr	Акт відмови завантаження (v3)
141	stop_ecmr	Акт примусового завершення е-ттн (v3)

*Тип* поля: M - mandatory (обов’язкове до заповнення), O - optional (опціональне)

---

RESPONSE

---

Таблиця 10 - Опис json-параметрів, які можуть передаватися в відповіді на метод API

Параметр	Формат	Опис
items	List<XDoc>	масив об’єктів; перелік документів

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

Параметр	Формат	Опис
	Об’єкт XDocStatus	детальніше
state	int	id статусу
title	String	статус

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

Параметр	Формат	Опис
	Об’єкт XDoc
body	XDocBodyForms	об’єкт; тіла документів
attachments	List<XDocAttachment_>	масив об’єктів; вкладення (може не використовуватися)
comments	XDocCommentsList	об’єкт (в якому масив об’єктів); список коментарів
doc_id	long	id документа
doc_uuid	UUID	унікальний ідентифікатор документа/квитанції
uuidSender	String	унікальний ідентифікатор відправника
uuidReceiver	String	унікальний ідентифікатор одержувача
uuidReceivers	List<String>	масив унікальних ідентифікаторів одержувачів
docNumber	String	номер документа
dateCreated	long	дата створення документа (unix timestamp); після відправки: дата відправки/отримання документа
dateChanged	long	дата останньої зміни документа (unix timestamp)
dateRead	long	дата прочитання документа (unix timestamp)
docDate	long	дата документа, зазначена в документі
chain_id	long	id ланцюжка документів
chain_uuid	UUID	унікальний ідентифікатор ланцюжка документів
family	int	сімейство 1 - EDI 2 - UZD 4 - CERTIFICATS 6 - ATS 7 - ETTN 8 - DISTRIBUTION 9 - SIMPLEDOC (Вільний) 10 - TENDER 11 - AGREEMENT 12 - OPENPRICE (Є-Товар)
hash	String	хеш-значення, отримане в результаті обробки
type	XDocType	об’єкт; тип документа
status	XDocStatus	об’єкт; статус пари документів у відправника і одержувача
exchange_status	String	сабстатус документа (детальніше)
is_archive	boolean	відмітка; Архівний документ чи ні
signInfo	XDocSignInfo	об’єкт; дані про підписи
chain	XChain	об’єкт; дані пов’язаних ланцюжків
extraFields	Map<String, String>	масив об’єктів; набір індексів (аналог індексних таблиць)
tags	List<XTag>	масив об’єктів; прикріплені теги
statuses	List<XStatus>	масив об’єктів; статуси обробки відправлених документів
multiExtraFields	Map<String, List<String>>	масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

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

Параметр	Формат	Опис
	Об’єкт XTag
id	long	id тега
name	String	зміст тега
shortName	String	коротка назва тега

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

Параметр	Формат	Опис
	Об’єкт XStatus
docId	long	id документа/квитанції
date	long	дата статусу; формат unix timestamp
type	int	тип статусу 101 - документ без помилок (статус); 102 - документ з помилками (статус)
text	String	текстовий коментар

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

Параметр	Формат	Опис
	Об’єкт XDocSignInfo
doc_id	long	id документа/квитанції
date	long	дата підписання; формат unix timestamp
count	short	кількість підписів
info	String	додаткова інформація
hash	String	хеш-значення, отримане в результаті обробки

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

Параметр	Формат	Опис
	Об’єкт XDocCommentsList
XDocCommentsList	List<XDocComment>	масив об’єктів; коментарі до документа

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

Параметр	Формат	Опис
	Об’єкт XDocComment
id	long	id коментаря
docUUID	UUID	унікальний ідентифікатор документа
createTimestamp	long	дата створення коментаря у форматі timestamp
authorLogin	String	автор коментаря
comment	String	зміст коментаря

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

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

Параметр	Формат	Опис
	Об’єкт XDocBodyForms
forms	HashMap<String, XDocBody>	масив об’єктів; тіло документа

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

Параметр	Формат	Опис
	Об’єкт XDocBody
type	XDocBodyType	об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6
base64content	String	зміст тіла документа в BASE64

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

Параметр	Формат	Опис
	Об’єкт XDocBodyType
id	int	id типу тіла документа
name	String	назва типу тіла документа

Таблиця 22 - Опис DocStatus параметрів (об’єкт XDocStatus)

id статусу	статус
0	ALL - будь-який статус
1	OPEN - чернетка (відправник)
2	SENT - відправлений (відправник)
3	DELIVERED - доставлений (відправник)
4	INBOX - вхідний (одержувач)
5	READ - прочитаний (одержувач)
6	ERROR - помилка
7	DELETED - видалений

Таблиця 23 - Опис підтипів документів

---

Приклади (json)

---

Отримати всі вхідні (отримані) документи на певний GLN без чернеток (масив statuses не містить «1»)

{
    "direction": {
        "sender": [],
        "receiver": [
            "9864232304302"
        ],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ]
}

Отримати всі вхідні (відправлені) документи на певний GLN без чернеток (масив statuses не містить «1»)

{
    "direction": {
        "sender": [
            "9864232304302"
        ],
        "receiver": [],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ]
}

Отримати всі вхідні (отримані) документи на певний GLN без чернеток (масив statuses не містить «1»), у яких номер містить підрядок «1001»

{
    "direction": {
        "sender": [],
        "receiver": [
            "9864232304302"
        ],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "number": "1001",
    "type": [
        {
            "type": "0"
        }
    ]
}

Отримати всі вихідні (відправлені) документи по GLN без чернеток (масив statuses не містить «1»), які створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp)

{
    "direction": {
        "sender": [
            "9864232304302"
        ],
        "receiver": [],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ],
    "docDate": {
        "startTimestamp": "1556668800",
        "finishTimestamp": "1559347199"
    }
}

---

Приклад тіла відповіді (json):

{
    "items": [
        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 1017,
            "doc_uuid": "e18a05d5-983b-4ebc-95f3-c35eccc7d611",
            "uuidSender": "4820128010004",
            "uuidReceiver": "9864065702429",
            "docNumber": "8663c3f48bea4f96a281238e847b1639",
            "dateCreated": 1549961913,
            "dateChanged": 1549961913,
            "dateRead": 0,
            "docDate": 1547503200,
            "chain_id": 1006,
            "chain_uuid": "60e487d3-871f-4b3a-9254-1d3f0e7a032f",
            "family": 1,
            "hash": "30745386780343D0C2F4C65C7F06D60F",
            "type": {
                "type": 1,
                "title": "invoice",
                "description": "Счет"
            },
            "status": {
                "status": 4,
                "title": "inbox"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "order_date": "1551477600",
                "delivery_date": "1547503200",
                "ftpex_file_name": "highload_invoice_test.xml",
                "sender": "4820128010004",
                "buyer_uuid": "4820128010004",
                "doc_num": "8663c3f48bea4f96a281238e847b1639",
                "order_number": "747401",
                "doc_date": "1547503200",
                "recipient": "9864065702429",
                "ftpex_file_date": "1549961913",
                "supplier_uuid": "9864065702429",
                "delivery_place_uuid": "4820128019007"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        }
    ]
}