Skip to main content

Додаткові поля

Опис json-параметрів

Найменування

Формат

Опис

extra_fields

Map<String, String>

масив об’єктів; набір індексів

multi_extra_fields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка
Опис extra_fields параметрів

id параметра

Найменування параметра

Обов’язкове / необов’язкове поле

Формат

Опис параметра

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 підтипу документа ( опис_підтипів )

12

sub_status_id

  

INT

id статусу документа (опис + опис для ETTN v3); характеризує стан ланцюжка документів

для 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

О

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

процес, що здійснюється з документом даним учасником

для Погодження:

  • 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 документів. Поле заповнюється при відправці е-ТТН чи фомується автоматично платформою 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) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 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"
  }
}

 

Back to top