Дані для фільтрації (об’єкт StorageQuery)
JSON:
Отримати всі Надіслані документи («statuses»: 2,3)
{
"archive": false,
"statuses": [
2,
3
],
"type": [
{
"type": 0,
"title": "all",
"description": "all"
},
{
"type": 0,
"title": "all",
"description": "all"
}
],
"exchangeStatus": [],
"extraParams": [],
"tags": [],
"loadComments": true,
"loadTags": true,
"loadStatuses": true,
"direction": {
"type": "EQ",
"sender": [
"9864066822430"
],
"receiver": []
},
"family": 12
}
Отримати всі Вхідні документи («statuses»: 4,5) від вказаного відправника/-ів (sender:gln)
{
"archive": false,
"statuses": [
4,
5
],
"type": [
{
"type": 0,
"title": "all",
"description": "all"
},
{
"type": 0,
"title": "all",
"description": "all"
}
],
"exchangeStatus": [],
"extraParams": [],
"tags": [],
"loadComments": true,
"loadTags": true,
"loadStatuses": true,
"direction": {
"type": "EQ",
"sender": [
"9864067620417"
],
"receiver": [
"9864066822430"
]
},
"family": 12
}
Отримати всі Архівні документи. Оскільки архівними стають Вхідні та Надіслані документи, то вказуються всі статуси, отримувач/відправник=власний GLN
{
"archive": true,
"statuses": [
2,
3,
4,
5,
6
],
"type": [
{
"type": 0,
"title": "all",
"description": "all"
},
{
"type": 0,
"title": "all",
"description": "all"
}
],
"exchangeStatus": [],
"extraParams": [],
"tags": [],
"loadComments": true,
"loadTags": true,
"loadStatuses": true,
"direction": {
"type": "OR",
"sender": [
"9864066822430"
],
"receiver": [
"9864066822430"
]
},
"family": 12
}
Таблиця 2 - Опис параметрів об’єкта StorageQuery
Параметр |
Тип 1 |
Формат |
Опис |
---|---|---|---|
Об’єкт StorageQuery |
|||
extraParams |
List<ExtraQueryParameters> |
масив об’єктів; набір індексів |
|
multiExtraParams |
List<ExtraQueryParameters> |
масив об’єктів; мультиіндекс (може приймати масив параметрів з масивами значень для кожного з параметрів) |
|
type |
M |
List<XDocType> |
масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа |
statuses |
M |
List<Integer> |
масив; список статусів (станів) документів, за якими буде відбуватися відбір:
|
extraStatuses |
List<Integer> |
масив; список екстрастатусів |
|
tags |
List<Long> |
масив; тег |
|
exchangeStatus |
O |
List<Integer> |
масив; статус документообігу |
docs |
List<Long> |
масив; документи |
|
docUUIDs |
List<UUID> |
масив; унікальні ідентифікатори документів |
|
partners |
List<Long> |
масив; ідентифікатори контрагентів |
|
families |
List<Integer> |
масив; ознака сервісу (сімейство)
|
|
direction |
M |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
limit |
O |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
orderBy |
O |
OrderBy |
фільтрувати по даті чи опису документа |
groupBy |
O |
String |
об’єднані по id ланцюжка/документа |
number |
O |
String |
номер документа |
family |
O |
int |
сімейство
|
partnerId |
Long |
id роздрібної мережі |
|
chainHash |
String |
хеш-значення, отримане в результаті обробки ланцюжка |
|
docHash |
String |
хеш-значення, отримане в результаті обробки документа |
|
docDate |
O |
об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по |
|
docCreate |
O |
об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по |
|
docRead |
O |
об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по |
|
docChanged |
O |
об’єкт; дата останньої зміни документа (у форматі 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 |
О |
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 |
ліміт вибірки (кількість); за замовчуванням 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 |
відмітка про підписання;
|
|
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); характеризує стан ланцюжка документів для PRDRSRVN:
|
|
13 |
action |
VARCHAR |
статус/стан документа за здійсненими діями користувача; Для EDI:
Для Вільний:
Для ЕТТН:
|
|
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 |
сімейство
|
||
hash |
VARCHAR |
хеш документа |
||
is_archive |
VARCHAR |
документ перенесено в архів (true / false) |
||
user_status |
INT |
список користувачів із відповідним статусом погодження (сценарії) в форматі: userID:statusID, де statusID:
|
||
ettn_process_act |
INT |
Присутність значення свідчить про створений Акт до ТТН v3: 1 - ТТН v3 заблоковано від певних дій (Акт знаходиться в опрацьовуванні (життєвий цикл Акта не завершено) |
||
ettn_process_act_type |
INT |
ідентифікатор типу (doc_type) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 133,134,135,136,137,138,139,140,141. За наявності цього параметра блокуються дії:
Розблокування дій з ТТН виконується автоматично після завершення життєвого циклу Акта. |
||
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-так) |
||
236 |
currency |
VARCHAR |
Валюта; доступні значення:
|
|
237 |
is_unilateral_signing |
INT |
Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так |
|
cloned_from |
UUID |
унікальний ідентифікатор документа, з якого даний документ був клонований |
||
ttn_in_process |
INT |
індекси для доаткових ключів пошуку Заявки / Підтвердження:
|
||
invoice_exist |
INT |
відмітка існування Рахунку в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Рахунку)
|
||
act_exist |
INT |
відмітка існування Акта наданих послуг в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Акта наданих послуг)
|
Таблиця 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 |
|
12 |
desscc |
|
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 |
|
39 |
metro7b |
|
40 |
prodlist |
|
41 |
agreem |
|
42 |
iftmbc |
|
59 |
documentinvoice |
|
60 |
prdrsrvn |
|
67 |
doccorinvoice |
|
72 |
metro7c |
|
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) |
Таблиця 10 - Опис підтипів COMDOC
Підтип комерційного документа (COMDOC) |
sub_doc_type_id |
Назва та опис документа |
---|---|---|
001 |
1 |
|
005 |
5 |
|
006 |
6 |
|
007 |
7 |
|
008 |
8 |
|
009 |
9 |
|
011 |
11 |
|
012 |
12 |
|
013 |
13 |
|
015 |
15 |
|
016 |
16 |
|
018 |
18 |
|
019 |
19 |
|
021 |
21 |
Повідомлення про відмову від підписання документу (COMDOC_021) |
022 |
22 |
|
023 |
23 |
|
024 |
24 |
|
025 |
25 |
|
026 |
26 |
|
027 |
27 |
|
028 |
28 |
Заявка на транспортно-експедиційне обслуговування (COMDOC_028) |
029 |
29 |
|
030 |
30 |
|
031 |
31 |
|
032 |
32 |
|
033 |
33 |
|
034 |
34 |
|
035 |
35 |
|
036 |
36 |
|
037 |
37 |
|
038 |
38 |
|
040 |
40 |
|
Підтип накладної (DOCUMENTINVOICE.DocumentFunctionCode) |
sub_doc_type_id |
Назва та опис документа |
TN |
0 |
Товарна накладна / Накладна за кількістю (для Метро та Леруа Мерлен) |
TN |
1 |
|
PRN |
2 |
|
DRN |
3 |
|
TNN |
4 |
|
DTN |
5 |
|
APP |
6 |
|
NP |
7 |
|
Підтип коригування до накладної (DOCCORINVOICE.DocumentFunctionCode) |
sub_doc_type_id |
Назва та опис документа |
СTN |
0 |
|
CVN |
2 |
|
Підтип ТТН (DECLARHEAD.C_DOC) |
sub_doc_type_id |
Назва та опис документа |
T01 |
1 |
зовнішня ТТН |
T51 |
51 |
внутрішня ТТН |
T52 |
52 |
внутрішня ТТН (алкоголь) |
T53 |
53 |
внутрішня ТТН (тютюн) |
Підтип «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER.SUBDOCTYPE) |
sub_doc_type_id |
Назва та опис документа |
1 |
1 |
|
2 |
2 |
|
Підтип «Замовлення» (ORDER.DOCTYPE) |
sub_doc_type_id |
Назва та опис документа |
PO |
1 |
Попереднє замовлення |
O |
2 |
Оригінал замовлення |
OS |
3 |
Замовлення на послугу / маркетинг |
F |
4 |
Фіктивність замовлення |
R |
5 |
Заміна замовлення |
D |
6 |
Видалення |
- 1
Під визначенням колонки Тип поля мається на увазі скорочене позначення:
M (mandatory) — обов’язкові до заповнення поля;
O (optional) — необов’язкові (опціональні) до заповнення поля.