# Додаткові поля (extra_fields) ##### **Опис json-параметрів**
Найменування Формат Опис
extra\_fields Map<String, String> масив об’єктів; набір індексів
multi\_extra\_fields Map<String, List<String>> масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка
##### **Опис extra\_fields параметрів**
id параметра Найменування параметра Тип 1 Формат Опис параметра
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 підтипу документа ( [опис\_підтипів](https://wiki-v2.edin.ua/books/xml-specifikaciyi-dokumentiv/page/pidtipi-elektronnix-dokumentiv) )
12 sub\_status\_id INT id статусу документа ([опис](https://wiki-v2.edin.ua/books/robota-z-api/page/sabstatusi-kvitanciidokumentiv) + [опис для ETTN v3](https://wiki-v2.edin.ua/books/robota-z-api/page/opis-sabstatusiv-dokumentiv-dlia-ettn-v3-xdocextrafieldssub-status)); характеризує стан ланцюжка документів для PRDRSRVN: - 1 - потребує опрацювання зі сторони Постачальника; - 2 - всі позиції опрацьовані Постачальником (погоджено кількість або відхилено)
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 M INT дата доставки
24 order\_number M 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 процес, що здійснюється з документом даним учасником для Погодження: - 1- Погоджує - 2 - Підписує(тобто створюється чернетка тікета) - 3 - Підписує та надсилає - 4 - Завершено погодження
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 документів. Поле заповнюється при [відправці е-ТТН](https://wiki.edin.ua/uk/latest/API_ETTNv3_1/Methods/SendEcmrDoc.html) чи фомується автоматично платформою 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](https://wiki-v2.edin.ua/link/367#bkmrk-%D0%A2%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D1%8F-2.-%D0%9E%D0%BF%D0%B8%D1%81-%D1%82%D0%B8%D0%BF%D1%96)) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 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-так)
236 currency VARCHAR Валюта; доступні значення: - UAH - USD - EUR
237 is\_unilateral\_signing INT Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так
cloned\_from UUID унікальний ідентифікатор документа, з якого даний документ був клонований
ttn\_in\_process INT індекси для доаткових ключів пошуку Заявки / Підтвердження: - 0 - Заявка / підтвердження, що готові для формування рахунку - 1 - Заявка / підтвердження, що очікують на завершення перевезення по ТТН - 2 - Заявка / підтвердження, що готові для формування акта наданих послуг - 3 - Заявка / підтвердження, що очікують на завершення перевезення по ТТН
invoice\_exist INT відмітка існування Рахунку в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Рахунку) - 0 - відсутній сформований до TRANSPORTATIONORDER Рахунок або він був Анульований чи Відхилений - 1 - до TRANSPORTATIONORDER є сформований Рахунок не важливо в якому статусі
act\_exist INT відмітка існування Акта наданих послуг в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Акта наданих послуг) - 0 - відсутній сформований до TRANSPORTATIONORDER Акт наданих послуг або він був Анульований чи Відхилений - 1 - до TRANSPORTATIONORDER є сформований Акт наданих послуг не важливо в якому статусі
JSON приклад ``` { "extra_fields": { "sender": "4820128010004", "doc_num": "ORG00000014", "buyer_uuid": "4820128010004", "delivery_date": "1551477600", "order_number": "6422722fb78c4509b06eac43758e1545", "supplier_uuid": "9864065702429", "contract_number": "334455", "delivery_place_uuid": "4820128019007", "order_date": "1550181600", "doc_date": "1555432208", "action": "29" } } ```
--- \[1\] - Під визначенням колонки **Тип** мається на увазі скорочене позначення:
- M (mandatory) — обов’язкові до заповнення поля; - O (optional) — необов’язкові (опціональні) до заповнення поля.