Створення чернетки документа¶
Для роботи з цим методом користувач повинен бути авторизованим .
За допомогою POST методу api/eds/doc можливо швидко створити чернетку документа конкретного зазначеного типу для конкретного одержувача.
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло HTTP запиту / відповіді в json форматі) |
URL запиту |
https://edo-v2.edi-n.com/api/v2/eds/doc?gln=9864065702429&doc_type=orders |
Параметри, що передаються в URL (разом з адресою методу) |
У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри: gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта doc_type - рядок; конкретний тип документа (опис_параметрів) |
Підказка
Також можливо виконати запит у вигляді curl-рядка:
curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/doc?gln=9864065702429&doc_type=orders“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html
JSON-параметри в тілі HTTP запиту/відповіді
REQUEST
У цьому методі в json-тілі запиту передаються поля документа (зі специфікацією документів ви можете ознайомитися у відповідному розділі).
RESPONSE
Таблиця 1 - Опис json-параметрів, що можуть передаватися у відповідь (об’єкт створеного документа-чернетки) на метод API.
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDoc |
||
body |
об’єкт; тіла документів |
|
attachments |
List<XDocAttachment> |
масив об’єктів; вкладення (може не використовуватися) |
comments |
об’єкт (в якому масив об’єктів); список коментарів |
|
doc_id |
long |
id документа |
doc_uuid |
UUID |
унікальний ідентифікатор документа/квитанції |
uuidSender |
String |
унікальний ідентифікатор відправника |
uuidReceiver |
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 |
сімейство (EDI / UZD) |
hash |
String |
хеш-значення, отримане в результаті обробки |
type |
об’єкт; тип документа |
|
status |
об’єкт; статус пари документів у відправника і одержувача |
|
exchange_status |
String |
сабстатус документа |
is_archive |
boolean |
відмітка; Архівний документ чи ні |
signInfo |
об’єкт; дані про підписи |
|
chain |
XChain |
объект; дані пов’язаних ланцюжків |
extraFields |
Map<String, String> |
масив об’єктів; набір індексів (аналог індексних таблиць) |
tags |
List<XTag> |
масив об’єктів; прикріплені теги |
statuses |
List<XStatus> |
масив об’єктів; статуси обробки відправлених документів |
multiExtraFields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка |
Таблиця 2 - Опис параметрів об’єкта XTag
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XTag |
||
id |
long |
id тега |
name |
String |
зміст тега |
shortName |
String |
коротка назва тега |
Таблиця 3 - Опис параметрів об’єкта XStatus
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XStatus |
||
docId |
long |
id документа/квитанції |
date |
long |
дата статусу; формат unix timestamp |
type |
int |
тип статусу |
text |
String |
зміст статусу |
Таблиця 4 - Опис параметрів об’єкта XDocSignInfo
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocSignInfo |
||
doc_id |
long |
id документа/квитанції |
date |
long |
дата підписання; формат unix timestamp |
count |
short |
кількість підписів |
info |
String |
додаткова інформація |
hash |
String |
хеш-значення, отримане в результаті обробки |
Таблиця 5 - Опис параметрів об’єкта XDocCommentsList
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocCommentsList |
||
XDocCommentsList |
List<XDocComment> |
масив об’єктів; коментарі до документа |
Таблиця 6 - Опис параметрів об’єкта XDocComment
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocComment |
||
id |
long |
id коментаря |
docUUID |
UUID |
унікальний ідентифікатор документа |
createTimestamp |
long |
дата створення коментаря у форматі timestamp |
authorLogin |
String |
автор коментаря |
comment |
String |
зміст коментаря |
Таблиця 7 - Опис параметрів об’єкта XDocAttachment
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocAttachment |
||
id |
long |
id вкладення |
docUUID |
UUID |
унікальний ідентифікатор документа |
fileName |
String |
найменування файлу |
createDate |
long |
дата створення вкладення; формат unix timestamp |
type |
String |
тип вкладення |
base64content |
String |
зміст вкладення в BASE64 |
content |
byte[] |
зміст вкладення в цілочисельному вигляді |
Таблиця 8 - Опис параметрів об’єкта XDocBodyForms
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBodyForms |
||
forms |
HashMap<String, XDocBody> |
масив об’єктів; тіло документа |
Таблиця 9 - Опис параметрів об’єкта XDocBody
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBody |
||
type |
об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6 |
|
base64content |
String |
зміст тіла документа в BASE64 |
Таблиця 10 - Опис параметрів об’єкта XDocBodyType
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBodyType |
||
id |
int |
id типу тіла документа |
name |
String |
назва типу тіла документа |
Таблиця 11 - Опис параметрів об’єкта XDocType
Параметр |
Тип |
Формат |
Опис |
---|---|---|---|
Об’єкт XDocType |
|||
type |
int |
id типу документа/квитанції |
|
title |
String |
назва документа/квитанции |
|
description |
String |
опис документа/квитанції (найменування кирилицею) |
Таблиця 12 - Опис DocType параметрів (об’єкт XDocType)
Тип |
Назва |
Опис (найменування кирилицею) |
---|---|---|
0 |
all |
всі |
1 |
invoice |
|
2 |
orders |
|
3 |
recadv |
|
4 |
desadv |
|
5 |
ordrsp |
|
6 |
pricat |
|
7 |
comdis |
|
9 |
act |
|
10 |
declar |
|
11 |
insdes |
|
12 |
desscc |
|
13 |
slsrpt |
|
14 |
invrpt |
|
15 |
coacsu |
|
16 |
actset |
|
17 |
iftmin |
|
18 |
retann |
|
19 |
iftmbf |
|
20 |
partin |
|
21 |
mscons |
|
25 |
retins |
|
28 |
comdoc |
|
29 |
declarj12 |
|
30 |
condra |
|
32 |
reestr |
|
40 |
prodlist |
|
41 |
agreem |
|
42 |
iftmbc |
|
59 |
documentinvoice |
|
67 |
doccorinvoice |
|
98 |
quotes |
|
109 |
ettn |
|
111 |
transhipment |
|
117 |
acceptance |
|
113 |
booking |
|
114 |
bookingconfirmation |
|
112 |
completion |
|
118 |
docinvoiceact |
|
119 |
discrepancy |
|
120 |
contrl |
Таблиця 13 - Опис параметрів об’єкта XDocStatus
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocStatus |
||
state |
int |
id статусу |
title |
String |
статус |
Таблиця 14 - Опис DocStatus параметрів (об’єкт XDocStatus)
id статусу |
статус |
---|---|
0 |
ALL - будь-який статус |
1 |
OPEN - чернетка (відправник) |
2 |
SENT - відправлений (відправник) |
3 |
DELIVERED - прочитаний (відправник) |
4 |
INBOX - доставлений / вхідний (одержувач) |
5 |
READ - прочитаний (одержувач) |
6 |
ERROR - помилка |
7 |
DELETED - видалений |
Приклади
Приклад тіла запиту (json):
{
"NUMBER": "6422722fb78c4509b06eac43758e1545",
"DATE": "2019-02-15",
"TIME": "00:00",
"ORDERNUMBER": "6422722fb78c4509b06eac43758e1545",
"ORDERDATE": "2019-02-15",
"DELIVERYDATE": "2019-02-30",
"DELIVERYTIME": "10:00",
"CAMPAIGNNUMBER": "334455",
"CURRENCY": "UAH",
"LIMES": [],
"HEAD": [
{
"BUYER": "4820128010004",
"SUPPLIER": "9864065702429",
"DELIVERYPLACE": "4820128019007",
"INVOICEPARTNER": "4820128010004",
"SENDER": "4820128010004",
"RECIPIENT": "9864065702429",
"POSITION": [
{
"POSITIONNUMBER": "1",
"PRODUCT": "5029053540900",
"PRODUCTIDBUYER": "527209",
"DESCRIPTION": "пироженко",
"PRICE": 510,
"PRICEWITHVAT": 571.2,
"VAT": "12.00",
"AMOUNT": 0,
"AMOUNTWITHVAT": 0,
"ORDEREDQUANTITY": 64,
"ACCEPTEDQUANTITY": 64,
"PRODUCTTYPE": "1"
},
{
"POSITIONNUMBER": "2",
"PRODUCT": "5029053540924",
"PRODUCTIDBUYER": "527215",
"DESCRIPTION": "мороженко",
"PRICE": 510,
"PRICEWITHVAT": 571.2,
"VAT": "12.00",
"AMOUNT": 0,
"AMOUNTWITHVAT": 0,
"ORDEREDQUANTITY": 32,
"ACCEPTEDQUANTITY": 32,
"PRODUCTTYPE": "1"
},
...
{
"POSITIONNUMBER": "48",
"PRODUCT": "5029053543987",
"PRODUCTIDBUYER": "100307632",
"DESCRIPTION": "водочка",
"PRICE": 1751.6,
"PRICEWITHVAT": 1961.79,
"VAT": "12.00",
"AMOUNT": 0,
"AMOUNTWITHVAT": 0,
"ORDEREDQUANTITY": 12,
"ACCEPTEDQUANTITY": 12,
"PRODUCTTYPE": "1"
}
]
}
],
"ACTION": "29"
}
Приклад тіла відповіді (json):
Повертаємий текст - об’єкт створеного документа-чернетки:
{
"attachments": [],
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
}
}
},
"chain_id": 0,
"comments": [],
"dateChanged": 0,
"dateCreated": 1574421527,
"dateRead": 0,
"docDate": 1565211600,
"docNumber": "2019-08-08-TEST-001",
"doc_id": 143,
"doc_uuid": "6ffc8dfa-1cd5-4137-82cf-29b5969c2e74",
"extraFields": {
"basis_doc_date": "1565211600",
"basis_doc_number": "1",
"basis_doc_subtype": "007",
"doc_date": "1565211600",
"doc_num": "2019-08-08-TEST-001",
"order_number": "1",
"recipient": "9864232319979",
"sender": "9864232319962",
"sub_doc_type_id": "006"
},
"family": 1,
"hash": "D4733FDDDEBE23B4E38DC5F257604234",
"is_archive": false,
"multiExtraFields": {},
"status": {
"status": 1,
"title": "open"
},
"statuses": [],
"tags": [],
"type": {
"description": "Коммерческий документ",
"title": "comdoc",
"type": 28
},
"uuidReceiver": "9864232319979",
"uuidSender": "9864232319962"
}