Document data (array of XDoc objects)

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

Table 0 - Response parameters description

Parameter	Format	Description
items	List<XDoc>	array of objects; list of documents
totalCount	int	documents amount

Table 1 - Parameters description of object XDoc

Parameter	Format	Description
	Object XDoc
body	XDocBodyForms	object; documents body
attachments	List <XDocAttachment>	array of objects; attachments (may not be used)
comments	XDocCommentsList	object (include an array of objects); list of comments
doc_id	long	document id
doc_uuid	UUID	unique document/ticket ID
uuidSender	String	unique sender ID
uuidReceiver	String	the unique identifier of the recipient
uuidReceivers	List<String>	an array of unique recipient IDs
docNumber	String	document number
dateCreated	long	document creation date (unix timestamp)
dateChanged	long	date of last document change (unix timestamp)
dateRead	long	document read date (unix timestamp)
docDate	long	document date specified in the document
chain_id	long	document chain id
chain_uuid	UUID	a unique document chain identifier
family	int	service 1 - EDI 2 - UZD 4 - CERTIFICATS 6 - ATS 7 - ETTN 8 - DISTRIBUTION 9 - SIMPLEDOC (Vilnyi) 10 - TENDER 11 - AGREEMENT 12 - OPENPRICE (Have Product)
hash	String	hash value obtained as a result of processing
type	XDocType	object; document type
status	XDocStatus	object; the status of a pair of documents from the sender and recipient
exchange_status	String	document substatus (more)
is_archive	boolean	document marked as Archived
signInfo	XDocSignInfo	object; signature data
chain	XChain	object; data of related chains
extraFields	Map <String, String>	array of objects; set of indexes (analog of index tables)
tags	List <XTag>	array of objects; attached tags
statuses	List <XStatus>	array of objects; sent documents processing statuses
multiExtraFields	Map<String, List<String>>	array of objects; multiindex. Example: {‘key1’: [‘val1’, ‘val2’], ‘key2’: [‘val1’, ‘val2’]}. Used, for example, to process the transmitted string => break the string condition => index each piece

Table 2 - Parameters description of object XTag

Parameter	Format	Description
	Object XTag
id	long	tag id
name	String	tag content
shortName	String	tag short name

Table 3 - Parameters description of object XStatus

Parameter	Format	Description
	Object XStatus
docId	long	document/chain id
date	long	status date; unix timestamp format
type	int	status type: 101 - positive (accepted) 102 - negative (rejected)
text	String	status content

Table 4 - Parameters description of object XDocSignInfo

Parameter	Format	Description
	Object XDocSignInfo
doc_id	long	document/chain id
date	long	signing date; unix timestamp format
count	short	amount of signatures
info	String	additional information
hash	String	the hash value obtained as a result of processing

Table 5 - Parameters description of object XDocCommentsList

Parameter	Format	Description
	Object XDocCommentsList
XDocCommentsList	List<XDocComment>	array of objects; comments to the document

Table 6 - Parameters description of object XDocComment

Parameter	Format	Description
	Object XDocComment
id	long	comment id
docUUID	UUID	unique document ID
createTimestamp	long	the date of comment creation in timestamp format
authorLogin	String	comment author
comment	String	comment content

Table 7 - Parameters description of object XDocAttachment

Parameter	Format	Description
	Object XDocAttachment
id	long	attachment id
docUUID	UUID	unique document ID
attachmentUUID	UUID	unique attachment ID
fileName	String	file name
createDate	long	attachment date creation; unix timestamp format
type	String	attachment type
base64content	String	attachment content in BASE64
content	byte[]	attachment content in integer form
signs	List<XDocAttachmentSign_>	array of objects; attachment signatures (files)
signHash	String	signature hash

Table 8 - Parameters description of object XDocBodyForms

Parameter	Format	Description
	Object XDocBodyForms
forms	HashMap<String, XDocBody>	array of objects; document body

Table 9 - Parameters description of object XDocBody

Parameter	Format	Description
	Object XDocBody
type	XDocBodyType	object; document body type: CONTENT = 1 - content in bytes; JSON = 2 - content in json; SIGN = 3 - signature content; STAMP = 4; CRYPTED = 5 - content in encrypted form; UZDRESPONSE = 6
base64content	String	document body content in BASE64

Table 10 - Parameters description of object XDocBodyType

Parameter	Format	Description
	Object XDocBodyType
id	int	document body type id
name	String	document body type name

Table 11 - Parameters description of object XDocType

Parameter	Format	Description
	Object XDocType	param-desc_
type	int	document / ticket type id
title	String	document / ticket name
description	String	document / ticket description

Table 12 - DocType description (object XDocType)

Type	Name	Description
0	all	all
1	invoice	Invoice
2	orders	Order
3	recadv	Receipt notification
4	desadv	Shipment notification
5	ordrsp	Order confirmation
6	pricat	Price List
7	comdis	Commercial discussion
10	declar	Tax invoice
11	insdes	Delivery instructions
13	slsrpt	Sales report
14	invrpt	Inventory report
15	coacsu	The act of mutual reconciliation
17	iftmin	Інструкція про транспортування
18	retann	Return notification
19	iftmbf	Application for transportation
20	partin	Contractor information for the supplier
21	mscons	Report on provided services
25	retins	Return instructions
28	comdoc	Commercial document
29	declarj12	Adjustments to the tax invoice
30	condra	Unstructured document
35	metro7a	Annex to the contract 7A
39	metro7b	Annex to the contract 7B
40	prodlist	Electronic specification
41	agreem	Commodity coordination
42	iftmbc	Confirmation of the application for transportation
59	documentinvoice	Consignment note
67	doccorinvoice	Adjustment to the consignment note
98	quotes	Addition to the Shipment Notice
111	transhipment	The act of goods reloading
117	acceptance	Act of acceptance-transfer
113	booking	Application for transportation
114	bookingconfirmation	Confirmation of transportation
112	completion	Act of work performed
118	docinvoiceact	Act of provided services (Metro)
119	discrepancy	The act of disagreement
120	contrl	Shipment report
121	ttn	Electronic consignment note (e-TTN)
122	simple_doc	Vilnyi service document
123	reload	Act of overload
124	disagreement	Act of disagreement to e-TTN
125	adjustment	Act of adjustment
126	warehouse_change	Act of change of destination
127	unload_storage	Act of unloading at the intermediate warehouse
128	load_storage	Act of loading in the intermediate warehouse
129	ettn_stop	Act of forced termination of TTN
130	resealing	The act of resealing
131	load_reject	Act of refusal to download
132	ttn_ecmr	ETTN (v3)
133	reload_ecmr	Act of overload (v3)
134	disagreement_ecmr	Act of disagreements (v3)
135	consignee_change_ecmr	Act of change of destination (v3)
136	storage_delivery_ecmr	Act of unloading at an intermediate warehouse (v3)
137	adjustment_ecmr	Act of adjustment (v3)
138	storage_pickup_ecmr	Act of loading in intermediate storage (v3)
139	resealing_ecmr	Act of resealing (v3)
140	load_reject_ecmr	Act of load rejection (v3)
141	stop_ecmr	Act of forced termination of e-ttn (v3)

Table 13 - Parameters description of object XDocStatus

Parameter	Format	Description
	Object XDocStatus	more
state	int	status id
title	String	status

Table 14 - DocStatus description (object XDocStatus)

Status id	Status
0	ALL - any status
1	OPEN - draft (sender)
2	SENT - sent (sender)
3	DELIVERED - delivered (sender)
4	INBOX - incoming (recipient)
5	READ - read (recipient)
6	ERROR - error
7	DELETED - deleted