Дані документа (об’єкт XDoc)

JSON:

{
  "body": {
    "forms": {
      "json": {
        "type": {
          "id": 2,
          "name": "json"
        }
      }
    }
  },
  "attachments": [],
  "comments": [],
  "doc_id": 829,
  "doc_uuid": "e64a304b-b0c0-454b-a361-5dc5d6987952",
  "uuidSender": "0855e1ce-46ed-4995-83b6-356127b95226",
  "uuidReceiver": "97bd6618-71b1-45a2-91b2-fe7b888ca00d",
  "uuidReceivers": [
    "97bd6618-71b1-45a2-91b2-fe7b888ca00d",
    "c2394341-85f0-4b8c-8ea9-ff8d3c6c119c"
  ],
  "docNumber": "Пибип0",
  "dateCreated": 1589960680,
  "dateChanged": 1589960680,
  "dateRead": 0,
  "docDate": 1587513600,
  "chain_id": 0,
  "family": 7,
  "hash": "65CC9A9F335B5AE07D9E3CD47C55063C",
  "type": {
    "type": 109,
    "title": "ettn",
    "description": "ЕТТН"
  },
  "status": {
    "status": 1,
    "title": "open"
  },
  "exchange_status": "000000000000000000000000",
  "is_archive": false,
  "extraFields": {
    "sub_status_date": "1587548202",
    "carrier_b_uuid": "97bd6618-71b1-45a2-91b2-fe7b888ca00d",
    "doc_num": "Пибип0",
    "car_number": "BB1234BB",
    "doc_date": "1587513600",
    "consignor_b_uuid": "0855e1ce-46ed-4995-83b6-356127b95226",
    "customer_b_uuid": "0855e1ce-46ed-4995-83b6-356127b95226",
    "driver_b_uuid": "09f4c632-5c37-45ac-a68a-0acfdc157194",
    "gross_weight": "1.0",
    "consignee_b_uuid": "c2394341-85f0-4b8c-8ea9-ff8d3c6c119c"
  },
  "tags": [],
  "statuses": [],
  "multiExtraFields": {
    "ettn_delivery_koatuu": [
      "1413566500"
    ],
    "ettn_dispatch_koatuu": [
      "8000000000"
    ]
  }
}

Таблиця 1 - Опис параметрів об’єкта XDoc

Параметр

Формат

Опис

Об’єкт XDoc

body

XDocBodyForms

об’єкт; тіла документів

attachments

List<XDocAttachment>

масив об’єктів; вкладення (може не використовуватися)

comments

XDocCommentsList

об’єкт (в якому масив об’єктів); список коментарів

doc_id

long

id документа

doc_uuid

UUID

унікальний ідентифікатор документа/квитанції

uuidSender

String

унікальний ідентифікатор відправника

uuidReceiver

String

унікальний ідентифікатор одержувача

uuidReceivers

List<String>

масив унікальних ідентифікаторів одержувачів

docNumber

String

номер документа

dateCreated

long

дата створення документа (unix timestamp)

dateChanged

long

дата останньої зміни документа (unix timestamp)

dateRead

long

дата прочитання документа (unix timestamp)

docDate

long

дата документа, зазначена в документі

chain_id

long

id ланцюжка документів

chain_uuid

UUID

унікальний ідентифікатор ланцюжка документів

family

int

сімейство

  • 1 - EDI

  • 6 - ATS

  • 7 - ETTN

  • 8 - DISTRIBUTION

  • 9 - SIMPLEDOC (Вільний)

  • 12 - OPENPRICE (Є-Товар)

hash

String

хеш-значення, отримане в результаті обробки

type

XDocType

об’єкт; тип документа

status

XDocStatus

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

exchange_status

String

сабстатус документа (детальніше)

is_archive

boolean

відмітка; Архівний документ чи ні

signInfo

XDocSignInfo

об’єкт; дані про підписи

chain

XChain

объект; дані пов’язаних ланцюжків

extraFields

Map<String, String>

масив об’єктів; набір індексів (аналог індексних таблиць)

tags

List<XTag>

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

statuses

List<XStatus>

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

multiExtraFields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

Таблиця 2 - Опис параметрів об’єкта XDocStatus

Параметр

Формат

Опис

Об’єкт XDocStatus

детальніше

state

int

id статусу

title

String

статус

Таблиця 3 - Опис параметрів об’єкта XTag

Параметр

Формат

Опис

Об’єкт XTag

id

long

id тега

name

String

зміст тега

shortName

String

коротка назва тега

Таблиця 4 - Опис параметрів об’єкта XStatus

Параметр

Формат

Опис

Об’єкт XStatus

docId

long

id документа/квитанції

date

long

дата статусу; формат unix timestamp

type

int

тип статусу

  • 101 - документ без помилок (статус);

  • 102 - документ з помилками (статус)

text

String

текстовий коментар

Таблиця 5 - Опис параметрів об’єкта XDocSignInfo

Параметр

Формат

Опис

Об’єкт XDocSignInfo

doc_id

long

id документа/квитанції

date

long

дата підписання; формат unix timestamp

count

short

кількість підписів

info

String

додаткова інформація

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 6 - Опис параметрів об’єкта XDocCommentsList

Параметр

Формат

Опис

Об’єкт XDocCommentsList

XDocCommentsList

List<XDocComment>

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

Таблиця 7 - Опис параметрів об’єкта XDocComment

Параметр

Формат

Опис

Об’єкт XDocComment

id

long

id коментаря

docUUID

UUID

унікальний ідентифікатор документа

createTimestamp

long

дата створення коментаря у форматі timestamp

authorLogin

String

автор коментаря

comment

String

зміст коментаря

Таблиця 8 - Опис параметрів об’єкта XDocAttachment

Параметр

Формат

Опис

Об’єкт XDocAttachment

id

long

id вкладення

docUUID

UUID

унікальний ідентифікатор документа

attachmentUUID

UUID

унікальний ідентифікатор вкладення

fileName

String

найменування файлу

createDate

long

дата створення вкладення; формат unix timestamp

type

String

тип вкладення

base64content

String

зміст вкладення в BASE64

content

transient byte[]

байтовий масив контенту

signs

List<XDocAttachmentSign>

масив об’єктів; підписи вкладень (файлів)

signHash

String

хеш підпису

Таблиця 9 - Опис параметрів об’єкта XDocBodyForms

Параметр

Формат

Опис

Об’єкт XDocBodyForms

forms

HashMap<String, XDocBody>

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

Таблиця 10 - Опис параметрів об’єкта XDocBody

Параметр

Формат

Опис

Об’єкт XDocBody

type

XDocBodyType

об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6

base64content

String

зміст тіла документа в BASE64

Таблиця 11 - Опис параметрів об’єкта XDocBodyType

Параметр

Формат

Опис

Об’єкт XDocBodyType

id

int

id типу тіла документа

name

String

назва типу тіла документа

Таблиця 12 - Опис DocStatus параметрів (об’єкт XDocStatus)

id статусу

статус

0

ALL - будь-який статус

1

OPEN - чернетка (відправник)

2

SENT - відправлений (відправник)

3

DELIVERED - доставлений (відправник)

4

INBOX - вхідний (одержувач)

5

READ - прочитаний (одержувач)

6

ERROR - помилка

7

DELETED - видалений

Таблиця 13 - Опис параметрів об’єкта XDocType

Параметр

Тип [1]_

Формат

Опис

Об’єкт XDocType

опис_параметрів

type

int

id типу документа/квитанції

title

String

назва документа/квитанции

description

String

опис документа/квитанції (найменування кирилицею)

Таблиця 14 - Опис 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

Універсальний документ

35

metro_7a

Додаток до договору 7А

39

metro_7b

Додаток до договору 7Б

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

Електронна товарно-транспортна накладна (е-ТТН)

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

Акт відмови завантаження

Таблиця 15 - Опис параметрів об’єкта XDocAttachmentSign

Параметр

Формат

Опис

Об’єкт XDocAttachmentSign

attachmentId

long

id вкладення

identifierId

long

id запису

crc32hash

long

хеш контрольної суми підпису (CRC32 кодування)

signerUUID

String

унікальний ідентифікатор підписанта

signBody

transient byte[]

байтовий масив тіла підпису

Таблиця 16 - Опис полей екстрапараметрів

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 статусу документа (детальніше); характеризує стан ланцюжка документів

13

action

VARCHAR

статус/стан документа за здійсненими діями користувача;

Для EDI:

ORDER (тип документа):

  • 0 - оригінал (O)

  • 1 - заміна (R)

  • 2 - видалення (D)

  • 3 - фіктивність замовлення (F)

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

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) для сервісу Е-Специфікація. Також для 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

дата документа-підстави

summ_without_tax

INT

сума без ПДВ

tax_summ

INT

сума ПДВ

summ

INT

сума з ПДВ

129

receiving_note_number

VARCHAR

Номер повідомлення про прийом (DOCUMENTINVOICE…ReceivingAdviceNumber)

137

branch_uuid

VARCHAR

uuid «гілки поставки» (АТБ COMDOC+DESADV)

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 ТТН документа в ЦБД

Таблиця 17 - Опис підтипів COMDOC

Підтип комерційного документа

sub_doc_type_id

Назва та опис документа

001

1

Договір (COMDOC_001)

005

5

Акт про виявлені недоліки (COMDOC_005)

006

6

Видаткова накладна (COMDOC_006)

007

7

Прибуткова накладна (COMDOC_007)

008

8

Товарна специфікація (COMDOC_008)

009

9

Акт невідповідності (COMDOC_009)

011

11

Повідомлення про повернення (COMDOC_011)

012

12

Накладна на повернення (COMDOC_012)

013

13

Акт виконаних робіт (COMDOC_013)

015

15

Акт взаємозаліку (COMDOC_015)

016

16

Рахунок-фактура (COMDOC_016)

018

18

Акт наданих послуг (COMDOC_018)

019

19

Анулювання (COMDOC_019)

021

21

Повідомлення про відмову від підписання документу (COMDOC_021)

022

22

Накладна на переміщення (COMDOC_022)

023

23

Специфікація послуг перевізника (COMDOC_023)

024

24

Звіт комітенту по еквайрингу (COMDOC_024)

025

25

Рахунок по еквайрингу (COMDOC_025)

026

26

Зведена специфікація послуг (COMDOC_026)

027

27

Товарна накладна (COMDOC_027)

028

28

Заявка на транспортно-експедиційне обслуговування (COMDOC_028)

029

29

Акт звірки зведений (COMDOC_029)

030

30

Претензія (COMDOC_030)

031

31

Накладна на зворотну тару (COMDOC_031)

032

32

Акт приймання-передачі (додаток 8) (COMDOC_032)

033

33

Акт приймання-передачі (додаток 9) (COMDOC_033)

034

34

Акт приймання товару до АПП (COMDOC_034)

035

35

Акт приймання товару до ВН (COMDOC_035)