Дані для фільтрації (об’єкт StorageQuery)¶
JSON:
Отримати всі вхідні ланцюжки документів (масив statuses «4,5») сервісу «ЕТТН», в яких є документ з номером «100500»¶
{
"archive": false,
"direction": {
"receiver": ["0855e1ce-46ed-4995-83b6-356127b95226"],
"sender": [],
"type": "EQ"
},
"exchangeStatus": [],
"extraParams": [
{
"fieldName": "doc_num",
"operator": "AND",
"type": "EQUALS",
"value": "100500"
}
],
"family": 7,
"limit": {
"count": 21,
"offset": "0"
},
"multiExtraParams": [],
"statuses": [4,5],
"tags": [],
"type": [
{
"type": 0
}
]
}
Отримати всі документи окрім чернеток(масив statuses не містить «1»), в яких отримувачем є GLN 9864232304302¶
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
]
}
Отримати всі документи окрім чернеток(масив statuses не містить «1»), в яких відправником є GLN 9864232304302¶
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
]
}
Отримати всі вхідні документи (GLN отримувача 9864232304302)¶
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["4","5","6"],
"type": [
{
"type": "0"
}
]
}
Отримати всі відправлені документи (GLN відправника 9864232304302)¶
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","6"],
"type": [
{
"type": "0"
}
]
}
Отримати документи з номером рівним значенню «1001» (пошук серед усіх документів окрім чернеток), в яких отримувачем є GLN 9864232304302¶
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"number": "1001",
"type": [
{
"type": "0"
}
]
}
Отримати всі документи окрім чернеток для GLN відправника 9864232304302, що створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp)¶
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
],
"docDate": {
"startTimestamp": "1556668800",
"finishTimestamp": "1559347199"
}
}
Таблиця 2 - Опис параметрів об’єкта StorageQuery
Параметр |
Обов’язкове / необов’язкове поле |
Формат |
Опис |
---|---|---|---|
Об’єкт 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 |
О |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
limit |
Н |
объект; фільтр відбору (налаштування виводу даних) |
|
number |
Н |
String |
номер документа |
family |
Н |
int |
сімейство
|
partnerId |
Long |
id роздрібної мережі |
|
chainHash |
String |
хеш-значення, отримане в результаті обробки ланцюжка |
|
docHash |
String |
хеш-значення, отримане в результаті обробки документа |
|
docDate |
Н |
об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по |
|
docCreate |
Н |
об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по |
|
docRead |
Н |
об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по |
|
docChanged |
Н |
об’єкт; дата останньої зміни документа (у форматі 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) |
|
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 |
О |
INT |
дата доставки |
24 |
order_number |
О |
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 |
|
7 |
comdis |
|
10 |
declar |
|
11 |
insdes |
|
13 |
slsrpt |
|
14 |
invrpt |
|
15 |
coacsu |
|
17 |
iftmin |
|
18 |
retann |
|
19 |
iftmbf |
|
20 |
partin |
|
21 |
mscons |
|
25 |
retins |
|
28 |
comdoc |
|
29 |
declarj12 |
|
30 |
condra |
|
40 |
prodlist |
|
41 |
agreem |
|
42 |
iftmbc |
|
59 |
documentinvoice |
|
67 |
doccorinvoice |
|
98 |
quotes |
|
111 |
transhipment |
|
117 |
acceptance |
|
113 |
booking |
|
114 |
bookingconfirmation |
|
112 |
completion |
|
118 |
docinvoiceact |
|
119 |
discrepancy |
|
120 |
contrl |
|
121 |
ttn |