Створення чернетки документа

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою 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

XDocBodyForms_

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

attachments

List<XDocAttachment_>

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

comments

XDocCommentsList_

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

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

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“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка


Приклади


Приклад тіла запиту (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"
}