Дані для фільтрації (об’єкт StorageQuery)

JSON:

Отримати всі вхідні «Видаткові накладні», що знаходяться в статусі «Потребує підписання отримувачем»

{
  "statuses": [4, 5, 6],
  "type": [
    {
      "type": 28
    }
  ],
  "limit": {
    "offset": "0",
    "count": 21
  },
  "exchangeStatus": [
    1
  ],
  "extraParams": [
    {
      "operator": "AND",
      "type": "EQUALS",
      "value": "6",
      "fieldName": "sub_doc_type_id"
    },
    {
      "operator": "AND",
      "type": "EQUALS",
      "value": "1",
      "fieldName": "sub_status_id"
    }
  ],
  "tags": [],
  "archive": false,
  "direction": {
    "type": "EQ",
    "receiver": [
      "9864066822430"
    ],
    "sender": []
  },
  "family": 1
}

Отримати всі документи окрім чернеток (масив 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 за київським часом відносно UTC)

{
    "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 - all (всі)

  • 1 - open (чернетки)

  • 2 - sent (відправлені-Відправник)

  • 3 - delivered (доставлені-Відправник)

  • 4 - inbox (вхідні-Отримувач)

  • 5 - read (прочитані-Отримувач)

  • 6 - error (помилка)

  • 7 - deleted (видалені)

tags

List<Long>

масив; тег

exchangeStatus

Н

List<Integer>

масив; статус документообігу

docs

List<Long>

масив; документи

direction

О

Direction

об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів

limit

Н

Limitation

объект; фільтр відбору (налаштування виводу даних)

orderBy

Н

OrderBy

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

groupBy

Н

String

об’єднані по id ланцюжка/документа

number

Н

String

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

family

Н

int

сімейство

  • 1 - EDI

  • 6 - ATS

  • 7 - ETTN

  • 8 - DISTRIBUTION

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

partnerId

Long

id роздрібної мережі

chainHash

String

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

docHash

String

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

docDate

Н

DateTimeRange

об’єкт; дата зазначена в документі (в форматі UNIX-timestamp за київським часом відносно UTC) з / по

docCreate

Н

DateTimeRange

об’єкт; дата створення документа (у форматі UNIX-timestamp за київським часом відносно UTC) з / по

docRead

Н

DateTimeRange

об’єкт; дата прочитання документа (у форматі UNIX-timestamp за київським часом відносно UTC) з / по

docChanged

Н

DateTimeRange

об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp за київським часом відносно UTC) з / по

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)

fieldName

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

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

Для 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 - Підписано

  • 2 - Відхилено

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)

149

post_start_date

[yyyy-MM-dd]

дата дедлайну для документів Метро 7а

Таблиця 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

Інструкція з доставки

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А

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

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

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

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

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

5

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

6

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

7

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

8

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

9

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

11

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

12

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

13

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

15

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

16

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

18

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

19

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

21

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

22

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

23

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

24

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

25

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

26

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

27

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

28

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

29

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

30

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

31

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

32

Акт приймання товару (складська логістика) (COMDOC_032)

33

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

34

Акт розбіжностей до АПП (COMDOC_034)