Відправка чернетки¶
Для роботи з цим методом користувач повинен бути авторизованим .
За допомогою методу /api/eds/doc/send можлива відправка чернетки в певний ланцюжок.
Метод запиту |
HTTP PATCH |
---|---|
Content-Type |
application/json (тіло HTTP запиту / відповіді в json форматі) |
URL запиту |
|
Параметри, що передаються в URL (разом з адресою методу) |
У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри: gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_uuid - рядок; UUID документа doc_hash - рядок; хеш документа chain_hash - рядок; хеш ланцюжка (можливо взяти з відповіді методу api/eds/chains/search ) chain_uuid - рядок; ID ланцюжка |
Примітка
Наявність ритейлера при документообігу автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера)
Увага: У запиті в тілі json присутні обов’язкові (повинні передаватися) і опціональні параметри (колонка Тип).
Підказка
Також можливо виконати запит у вигляді curl-рядка:
curl -X PATCH „https://edo-v2.edi-n.com/api/eds/doc/send?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&doc_hash=704DD5F0A71FCB730D2B1AEA84FEE3FB&chain_hash=704DD5F0A71FCB730D2B1AEA84FEE3FB&chain_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&partner_id=11“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html
JSON-параметри в тілі HTTP запиту/відповіді
REQUEST
Таблиця 1 - Опис json-параметрів (фільтр) запиту методу API
Найменування |
Формат |
Опис |
|
---|---|---|---|
extra_fields |
Map<String, String> |
масив об’єктів; набір індексів |
|
multi_extra_fields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка |
Таблиця 2 - Опис extra_fields параметрів
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 |
статус документа за здійсненими діями користувача |
|
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 |
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) |
|
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 |
дата документа-підстави |
Тип поля: M - mandatory (обов’язкове до заповнення), O - optional (опціональне)
RESPONSE
У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
Приклади
Приклад тіла запиту (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"
}
}
Приклад тіла відповіді (json):
У цьому методі json-тіло відповіді відсутнє.
Повертаємий текст – «OK»