Дані документів (масив об’єктів XDoc)

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": {}
        }
    ]
}

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

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

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

Параметр	Формат	Опис
	Об’єкт XDoc
body	XDocBodyForms	об’єкт; тіла документів
attachments	List<XDocAttachment>	масив об’єктів; вкладення (може не використовуватися)
comments	XDocCommentsList	об’єкт (в якому масив об’єктів); список коментарів
doc_id	long	id документа
doc_uuid	UUID	унікальний ідентифікатор документа/квитанції
uuidSender	String	унікальний ідентифікатор відправника
uuidReceiver	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“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

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

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

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

Параметр	Формат	Опис
	Об’єкт XStatus
docId	long	id документа/квитанції
date	long	дата статусу; формат unix timestamp
type	int	тип статусу: 0 - позитивний (прийнято) 1 - негативний (відхилено) 5 - Отримувач відхиляє документ 6 - Ініціатор відхиляє документ 8 - е-ТТН відхилено Вантажовідправником 9 - е-ТТН відхилено Водієм / Перевізником
text	String	зміст статусу

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

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

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

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

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

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

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

Параметр	Формат	Опис
	Об’єкт XDocAttachment
id	long	id вкладення
docUUID	UUID	унікальний ідентифікатор документа
attachmentUUID	UUID	унікальний ідентифікатор вкладення
identifierId	long	ідентифікатор (id запису)
fileName	String	найменування файлу
createDate	long	дата створення вкладення; формат unix timestamp
type	String	тип вкладення; це може бути числове значення (1-25) з довідника DICT.01.10
status	int	статус реєстрації в ЦБД 1 - WAIT_FOR_REGISTRATION - очікує на реєстрацію в ЦБД МІУ; 2 - ON_REGISTRATION (зараз не використовується); 3 - REGISTERED - зареєстровано в ЦБД МІУ; 4 - REGISTRATION_ERROR - помилка реєстрації в ЦБД МІУ;
creatorUUID	UUID	GLN, від імені якого додається вкладення
base64content	String	зміст вкладення в BASE64
content	transient byte[]	байтовий масив контенту
signs	List<XDocAttachmentSign>	масив об’єктів; підписи вкладень (файлів)
signHash	String	хеш тіла вкладення (в base64) для формування підпису

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

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

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

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

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

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

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

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

Таблиця 12 - Опис 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)

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

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

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

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

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

Параметр	Формат	Опис
	Об’єкт XDocAttachmentSign
attachmentId	long	id вкладення
identifierId	long	id запису
crc32hash	long	хеш контрольної суми підпису (CRC32 кодування)
signerUUID	String	унікальний ідентифікатор підписанта
signBody	transient byte[]	байтовий масив тіла підпису