API сервісу EDI Network

Перелік методів API сервісу EDI Network

Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua

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

Робота з документами

Створити чернетку документа / Клонувати відправлений документ (COMDOC)

 POST /api/v2/eds/doc

Відправити чернетку

 PATCH /api/eds/doc/send

Відправити документ (без створення чернетки)

 POST /api/eds/doc/create_and_send

Пошук документів (з фільтрацією), вибір списку документів

 POST /api/eds/docs/search

Отримати інформацію (мета-дані) про документ

 GET /api/eds/doc

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

 GET /api/eds/chain

Отримати ланцюжки вхідних документів

 POST /api/eds/chains/search

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

 GET /api/eds/doc/body

Отримати XML контенту документа

 GET /api/eds/doc/xml

Завантажити тіло документа/підпису

 GET /api/eds/doc/download

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

 POST /api/eds/doc/statuses

Отримати статус документа

 GET /api/eds/doc/statuses

Редагувати чернетку документа

 PUT /api/eds/doc

Заповнити індекси (додавання / оновлення полів екстрапараметрів)

 PUT /api/eds/doc/extra_fields

Архівувати / Розархівувати ланцюжок документів

 PATCH /api/eds/chain/archive

Отримати реєстр документів в xls форматі

 GET /api/eds/doc/reports/doctype

Отримати інформацію про підпис/підписантів

 GET /api/eds/doc/attachment/sign/info

Видалити документи-чернетки

 PATCH /api/eds/docs

Отримати тіло документів (json) за вказаними UUID

 POST /api/v2/eds/doc/content

Відправити транзакції до «Резерву товару» PRDRSRVN (зміни в табличній частині)

 POST /api/eds/doc/prdrsrvn/transaction

Одночасне прийняття, підписання та відправка двох пов’язаних документів

 POST /api/eds/docs_and_tickets

Отримати статус документа

 POST /api/v2/eds/docs/state
Робота з "Універсальним/неструктурованим документом" (CONDRA)

Завантажити «Неструктурований (універсальний) документ» (CONDRA) у вигляді архіву

 GET /api/eds/doc/condra/body

Відправити «Неструктурований (універсальний) документ» (CONDRA)

 PATCH /api/eds/doc/condra/send

Створити чернетку «Універсального/неструктурованого документа» (CONDRA)

 POST /api/v2/eds/doc/condra/create

Створити і відправити «Універсальний/неструктурований документ» (CONDRA) без створення чернетки

 POST /api/v2/eds/doc/condra/create_and_send

Додати файл-вкладення (для CONDRA)

 POST /api/eds/doc/body

Створити чернетку документа (для CONDRA)

 POST /api/eds/doc

Отримати UUID (для CONDRA)

 GET /api/office/uuid

Підписати файл (для CONDRA)

 POST /api/eds/doc/body

Відхилити «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №13

 PATCH /api/v2/eds/condra/reject

Відкликати «Універсальний/неструктурований документ» (CONDRA). Створення квитанції №14

 PATCH /api/v2/eds/condra/withdraw

Прийняти «Універсальний/неструктурований документ» (CONDRA)

 PATCH /api/v2/eds/condra/confirm/send
Робота з файлами (вкладення до документа)

Додати файл до документа-чернетки

 POST /api/eds/doc/attachment

Отримати файл-вкладення

 GET /api/eds/doc/attachment

Видалити файл-вкладення (чернетка)

 DELETE /api/eds/doc/attachment

Роздрукувати вкладення документа

 GET /api/eds/doc/print

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

 POST /api/eds/doc/attachment/sign

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

 GET /api/eds/doc/attachment/sign/hash
Робота з квитанціями

Отримати всі квитанції вказаного документа

 GET /api/eds/doc/tickets

Отримати інформацію про підписантів

 GET /api/eds/doc/signers

Отримати інформацію про підписантів за всіма вказаними транзакціями документа

 GET /api/v2/eds/doc/signers

Отримати дані/контент квитанції

 GET /api/eds/doc/ticket/body

Створити на сервері квитанцію «Анулювання»

 GET /api/v2/eds/doc/repeal

Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC/TRANSPORTATIONORDER документів

 GET /api/v2/eds/comdoc/reject

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

 GET /api/v2/eds/doc/reject

Створити квитанцію №1 (підпис чернетки)

 POST /api/v2/eds/doc/ticket

Створити квитанцію №2 (прийняття документа COMDOC)

 POST /api/v2/eds/comdoc/accept

Створити квитанцію №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER)

 POST /api/v2/eds/doc/repeal

Створити квитанцію №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER)

 POST /api/v2/eds/doc/repeal/accept

Створити квитанцію №13 (відхилення документа COMDOC/TRANSPORTATIONORDER)

 POST /api/v2/eds/comdoc/reject

Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER)

 POST /api/v2/eds/comdoc/revoke

Створити квитанцію №15 (відмова від анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER)

 POST /api/v2/eds/doc/repeal/reject

Відправити відмову від підписання (створення квитанції №13)

 POST /api/v2/eds/doc/reject

Створити на сервері квитанцію «Відкликання підписання документа» (COMDOC_021)

 GET /api/v2/eds/doc/revoke

Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER)

 POST /api/v2/eds/doc/revoke
Робота з тегами

Створити новий тег (мітку)

 POST /api/eds/tags

Отримати список тегів (міток)

 GET /api/eds/tags

Редагувати тег

 PUT /api/eds/tags

Видалити теги

 DELETE /api/eds/tags

Прив'язати тег до документа

 POST /api/eds/doc/tags

Вилучити теги з документа

 DELETE /api/eds/doc/tags
Погодження

Створити сценарій погодження документів

 POST /api/eds/doc/approval/scenario

Отримати сценарій/-ії (на рівні GLN)

 GET /api/eds/doc/approval/scenario

Редагувати / видалити сценарій погодження документів

 PUT /api/eds/doc/approval/scenario

Запуск документа на погодження / Зміна статуса кроку погодження

 POST /api/eds/doc/approval/step

Отримати кроки погодження за документом

 GET /api/eds/doc/approval/step
Робота з подіями
  1. Обираєте ідентифікатор документу, з якого Ви плануєте розпочати отримувати всі наступні події.
  2. Надсилаєте запит на отримання останнього ідентифікатора події за документом.
  3. В отриманному у відповідь об'єкті XEvent зберігаєте значення параметра id.
  4. Надсилаєте запит для пошуку подій. В об'єкті запиту EventsStorageQuery, в параметрі fromId вказуєте ідентифікатор події, який Ви отримали в пункті 3.
  5. З отриманного у відповідь об'єкта EventsStorageQueryResult зберігаєте значення параметра lastEventId замість того, що зберегли в пункті 3.
  6. Опрацьовуєте документи в EventsStorageQueryResult.
  7. Якщо кількість значень в параметрі items об'єкта EventsStorageQueryResult:
    • дорівнює вказаному ліміту (limit) або рівне 100, то повторюйте операції з 4 по 7.
    • меньше вказаного ліміту (limit) або менше 100, то необхідно зробити паузу (1 хвилина) для подальшого виконання операцій з 4 по 7.
Отримати останню подію за документом
 GET /api/eds/docs/event/last
Отримати список подій
 GET /api/eds/docs/events
Пошук подій
 POST /api/eds/docs/events

Алгоритми обміну документами (API)

Basic_002.png

Алгоритм «Прайс-лист» (PRICAT)
PRICAT

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку МЕРЕЖА
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа   extra
1.3 Відправка чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка документа без створення чернетки
  ПОСТАЧАЛЬНИК
2.1 Авторизація
2.2 Отримання контента документа

[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:

  1. Авторизація
  2. Знайти чернетки документів для редагування
  3. Отримати тіло чернетки-документа для редагування
  4. Редагувати чернетку документа
  5. Змінити індекси (оновлення полів екстрапараметрів)
Алгоритм «Замовлення» (ORDER)
ORDER

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку МЕРЕЖА
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа   extra
1.3 Відправка чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка документа без створення чернетки
  ПОСТАЧАЛЬНИК
2.1 Авторизація
2.2 Отримання контента документа

[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:

  1. Авторизація
  2. Знайти чернетки документів для редагування
  3. Отримати тіло чернетки-документа для редагування
  4. Редагувати чернетку документа
  5. Змінити індекси (оновлення полів екстрапараметрів)
Алгоритм «Підтвердження замовлення» (ORDRSP)
ORDRSP

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку МЕРЕЖА
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа   extra
1.3 Відправка чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка документа без створення чернетки
  ПОСТАЧАЛЬНИК
2.1 Авторизація
2.2 Отримання контента документа

[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:

  1. Авторизація
  2. Знайти чернетки документів для редагування
  3. Отримати тіло чернетки-документа для редагування
  4. Редагувати чернетку документа
  5. Змінити індекси (оновлення полів екстрапараметрів)
Алгоритм «Повідомлення про відвантаження» (DESADV)
DESADV

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку МЕРЕЖА
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа   extra
1.3 Відправка чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка документа без створення чернетки
  ПОСТАЧАЛЬНИК
2.1 Авторизація
2.2 Отримання контента документа

[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:

  1. Авторизація
  2. Знайти чернетки документів для редагування
  3. Отримати тіло чернетки-документа для редагування
  4. Редагувати чернетку документа
  5. Змінити індекси (оновлення полів екстрапараметрів)
Алгоритм «Повідомлення про прийом» (RECADV)
RECADV

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку МЕРЕЖА
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа   extra
1.3 Відправка чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка документа без створення чернетки
  ПОСТАЧАЛЬНИК
2.1 Авторизація
2.2 Отримання контента документа

[extra] - В алгоритмах з початковим створенням чернетки можливо організувати додаткову перевірку і редагування чернетки документа (за необхідності) іншими співробітниками Вашої компанії:

  1. Авторизація
  2. Знайти чернетки документів для редагування
  3. Отримати тіло чернетки-документа для редагування
  4. Редагувати чернетку документа
  5. Змінити індекси (оновлення полів екстрапараметрів)
Алгоритм «Видаткова накладна» (COMDOC_006)
COMDOC_006

COMDOC_006_API_work_001.png

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку ПОСТАЧАЛЬНИК
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа
1.3 Підписання чернетки документа
1.4 Відправка підписаної чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка вже підписаного документа (.p7s) без створення чернетки
1.5* Відкликання підписання COMDOC документа
  МЕРЕЖА
2.1 Авторизація
2.2 Отримання контента документа
2.3 Підписання вхідного документа
2.3* Відхилення підписання COMDOC документа

ІНІЦІАТОР АНУЛЮВАННЯ
3.1* Авторизація Ініціатора
3.2* Створення запиту на анулювання COMDOC документа Ініціатором

ОТРИМУВАЧ АНУЛЮВАННЯ
4.1 Авторизація Отримувача
4.2 Відмова від анулювання COMDOC документа Отримувачем
4.2* Приймання анулювання COMDOC документа Отримувачем

Додаткові методи API

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

COMDOC_005_API_work_001.png

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку ПОСТАЧАЛЬНИК
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа
1.3 Підписання чернетки документа
1.4 Відправка підписаної чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка вже підписаного документа (.p7s) без створення чернетки
1.5* Відкликання підписання COMDOC документа
  МЕРЕЖА
2.1 Авторизація
2.2 Отримання контента документа
2.3 Підписання вхідного документа
2.3* Відхилення підписання COMDOC документа

ІНІЦІАТОР АНУЛЮВАННЯ
3.1* Авторизація Ініціатора
3.2* Створення запиту на анулювання COMDOC документа Ініціатором

ОТРИМУВАЧ АНУЛЮВАННЯ
4.1 Авторизація Отримувача
4.2 Відмова від анулювання COMDOC документа Отримувачем
4.2* Приймання анулювання COMDOC документа Отримувачем

Додаткові методи API

Алгоритм «Коригування видаткової накладної» (COMDOC_038)
COMDOC_038

COMDOC_038_API_work_001.png

Можливо налаштувати процес відправки документа з окремою дією створення чернетки або без неї:

№ кроку ПОСТАЧАЛЬНИК
1.1 Авторизація
а) Варіант 1: Відправка документа зі створенням чернетки
1.2 Створення чернетки документа
1.3 Підписання чернетки документа
1.4 Відправка підписаної чернетки документа
б) Варіант 2: Відправка документа без створення чернетки
1.2 Відправка вже підписаного документа (.p7s) без створення чернетки
1.5* Відкликання підписання COMDOC документа
  МЕРЕЖА
2.1 Авторизація
2.2 Отримання контента документа
2.3 Підписання вхідного документа
2.3* Відхилення підписання COMDOC документа

ІНІЦІАТОР АНУЛЮВАННЯ
3.1* Авторизація Ініціатора
3.2* Створення запиту на анулювання COMDOC документа Ініціатором

ОТРИМУВАЧ АНУЛЮВАННЯ
4.1 Авторизація Отримувача
4.2 Відмова від анулювання COMDOC документа Отримувачем
4.2* Приймання анулювання COMDOC документа Отримувачем

Додаткові методи API

Опис помилок сервісу «EDI Network»

На цій сторінці наданий опис специфічних помилок сервісу «EDI Network». Опис загальних помилок для всіх сервісів EDIN можна  знайти за посиланням.

Код відповіді

Індекс помилки

Текст помилки

Опис

400

ERR_EDI-1

Validation document errors: [%s]

Документ містить помилки: [%s]

Помилка при перевірці обов'язкових тегів в xml - в дужках перелік незаповнених/некоректно заповнених полів

400

ERR_EDI-2

XSD Validation document error: [%s]

Помилка валідації документа за XSD: [%s]

Помилка при валідації по xsd - в дужках вказується конкретна причина помилки

400

ERR_EDI-3

Business logic validation document errors: [%s]

Документ містить помилки згідно бізнес-логіки: [%s]

Помилка при перевірці обов'язкових тегів в xml згідно бізнес-логіки - в дужках перелік незаповнених/ некоректно заповнених полів

400

ERR_EDI-4

Unknown or unsupported document type: [%s]

Невідомий або непідтримуваний тип документа: [%s]

Помилка виникає тільки в 1-му випадку: при спробі відправити документ CONDRA методом create_and_send

400

ERR_EDI-5

  

Помилка виникає при перевірці підпису, якщо позначка часу створена офлайн

400

ERR_EDI-6

Data should contain [%s] marker

Данні мають містити [%s] маркер

Помилка виникає при спробі дешифрування даних, якщо дані не містять крипто-заголовки (CERTCRYPT або UA1_CRYPT)

400

ERR_EDI-7

Data should be enveloped (crypted)

Дані повинні бути захищені (зашифровані)

Помилка виникає при спробі дешифрування даних, якщо дані не зашифровані

400

ERR_EDI-8

Decription failed - [%s]

Не вдалося розшифрувати - [%s]

Помилка виникає при спробі дешифрування даних, якщо при дешифруванні виникає помилка - в дужках причина

400

ERR_EDI-9

The data is not signed or contains an incorrect signature

Дані не підписані або містять некоректний підпис

Помилка виникає коли клієнт передав не підписані або не коректно підписані дані, коли вони мають бути підписані (наприклад, роут create_and_send при відправці p7s-ки, вказуючи content-type = application/pkcs7-signature)

400

ERR_EDI-10

You cannot send a document signed only with a seal

Ви не можете надіслати документ, підписаний тільки печаткою

  

400

ERR_EDI-11

GLN from request [%s] should match sender’s GLN from body [%s]

GLN із запиту [%s] має збігатися з GLN відправника з тіла [%s]

Помилка виникає в create_and_send або роуті створення документа через API, коли є невідповідність GLN-ів, який був переданий в url-параметрі і GLN відправника в тілі документа

400

ERR_EDI-12

Sender GLN cannot be same as recipient GLN

GLN відправника не може збігатись з GLN отримувача

Помилка виникає в методі create_and_send, коли клієнти відправляють документи самі собі

400

ERR_EDI-13

Branch uuid [%s] already revoked

UUID [%s] гілки уже відкликано

  

400

ERR_EDI-14

COMDOC [019/021] not yet supported.

COMDOC [019/021] ще не підтримується.

Помилка виникає тільки в 1-му випадку: при спробі відправити цей підтип COMDOC методом create_and_send

400

ERR_EDI-15

Doc is not in open status

Документ не в статусі - чернетка

Помилка виникає у випадках, коли клієнт хоче додати/видалити вкладення у документа не чернетки (CONDRA)

400

ERR_EDI-16

Document already revoked, current status: [%s]

Документ уже відкликано, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-17

Document already signed, current status: [%s]

Документ уже підписаний, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-18

Document already both signed, current status: [%s]

Документ уже підписаний двома сторонами, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-19

Document already сanceled, current status: [%s]

Документ уже анульовано, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-20

Document already repealed, current status: [%s]

Документ уже скасовано, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-21

Document already has repeal request, current status: [%s]

Документ уже має запит на скасування, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-22

Document has no repeal request, current status: [%s]

Документ не має запиту на скасування, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-23

Document’s repeal already rejected, current status: [%s]

Скасування документа уже відхилено, поточний статус: [%s]

Помилка виникає при спробі відправити тікет (прийняти COMDOC, підписати DOCINVOICE і т.д.), що протирічить логіці документообігу

400

ERR_EDI-24

DocumentInvoice parties do not contain certificate’s EDRPOU: [%s]

Сторони DocumentInvoice не містять ЄДРПОУ з сертифіката: [%s]

  

400

ERR_EDI-25

DocumentInvoice parties do not contain certificate’s DRFO: [%s]

Сторони DocumentInvoice не містять ДРФО з сертифіката: [%s]

  

400

ERR_EDI-26

There is no EDRPOU/DRFO code in the signature certificate

У сертифікаті підпису відсутні коди ЄДРПОУ/ДРФО

  

400

ERR_EDI-27

COMDOC parties do not contain certificate’s EDRPOU: [%s]

Сторони COMDOC не містять ЄДРПОУ з сертифіката: [%s]

  

400

ERR_EDI-28

The signing key is not on a secure medium. Please select a different key and try again

Ключ для підписання, що використовується, знаходиться не на захищеному носії. Виберіть, будь ласка, інший ключ і спробуйте ще раз

  

400

ERR_EDI-29

There is no signer position in the key. Please select a different key and try again

У ключі немає посади підписувача. Виберіть, будь ласка, інший ключ і спробуйте ще раз

  

400

ERR_EDI-30

The document does not contain sender’s signatures. Change the settings of your signature module to create a signature online. Or contact technical support for advice.

Документ не містить підписів відправника. Змініть налаштування свого модуля підписання для створення підпису онлайн. Або зверніться до служби технічної підтримки для консультації.

  

400

ERR_EDI-31

[signs] is empty

[signs] порожній

Помилка виникає в роутах при роботі з тікетами (створення, відхилення документа, прийняття COMDOC і т.д.), у разі якщо клієнт користується застарілим способом передачі тіла, використовуючи об'єкт TicketRequestData і не передавши в json-і [signs]

400

ERR_EDI-32

Field [%s] is required

Поле [%s] є обов’язковим

Помилка виникає тільки в роуті POST /api/eds/doc/archive, якщо в об’єкті DocumentStorageQuery не передано - direction або type, або docDate

400

ERR_EDI-33

Expected non-empty list of uuids

Cписок uuid не може бути пустим

Помилка виникає тільки в роуті - /api/v2/eds/doc/content, якщо список uuid-ів порожній

400

ERR_EDI-34

The size of the list cannot be more than [%s]

Розмір списку не може перевищувати [%s]

Помилка виникає тільки в роуті /api/v2/eds/doc/content, якщо в списку значень UUID більше ніж 50

400

ERR_EDI-35

Report’s start date [%s] cannot be more than end date [%s]

Дата початку звіту [%s] не може перевищувати дату завершення [%s]

Помилка виникає в роутах формування звітів

400

ERR_EDI-36

Date range (from [%s] to [%s]) cannot be more than 31 days

Діапазон дат (від [%s] до [%s]) не може перевищувати 31 день

Помилка виникає в роутах формування звітів

400

ERR_EDI-37

Report can be created based on only one parameter: sender OR recipient OR partner

Звіт можна створити лише за одним параметром: sender OR recipient OR partner

Помилка виникає в роутах формування звітів

400

ERR_EDI-38

Content from request does not match original content, actual_hash:[%s] request_hash:[%s], actualContentHash

Контент запиту не відповідає оригінальному контенту, actual_hash:[%s] request_hash:[%s], actualContentHash

Помилка виникає, якщо хеш контенту в eds не відповідають хешу контенту з тіла запиту (це про підписання документів у відповідь)

400

ERR_EDI-39

Signs count should be more than parent data signs count

Кількість підписів повинна бути більшою, ніж у батьківській квитанції

  

400

ERR_EDI-40

[subjEDRPOUCode] from sign does not match any of [КодКонтрагента] or [ІПН] from XML

[subjEDRPOUCode] із підпису не відповідає жодному з [КодКонтрагента] або [ІПН] із XML

  

400

ERR_EDI-41

Incorrect document family. One of [%s] is expected

Некоректний family документа. Очікується один з наступних: [%s]

  

400

ERR_EDI-42

Handling sign failed - [%s]

Не вдалося опрацювати підпис - [%s]

Помилка виникає при опрацюванні p7s, зазвичай ці помилки пов’язані з ІІТ бібліотекою

400

ERR_EDI-43

Ticket with transaction type [%s] not found

Квитанцію з типом транзакції [%s] не знайдено

Помилка виникає в роутах при отриманні інформації по підписантам в тікеті

400

ERR_EDI-44

XSLT for document type [%s] not found

XSLT для типу документа [%s] не знайдено

Не знайдено карту конвертації

400

ERR_EDI-45

Can’t define recipient GLN

Неможливо визначити GLN одержувача

Не вдалось визначити отримувача при відправці DOCCORINVOICE

400

ERR_EDI-46

The document can only be signed by one party

Документ може бути підписаний тільки однією стороною

Відправлений COMDOC містить поле «ОдностороннєПідписання»

Отримати кроки погодження за документом GET /api/eds/doc/approval/step

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/approval/step

URL параметри

gln (обов’язково) String - GLN власної Компанії

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передаються дані кроків погодження (об’єкт з масивами об’єктів XDocApprovalStep).

Приклад відповіді:

{
  "1": [
    {
      "docId": 3580,
      "scenarioId": 9,
      "stepId": 1,
      "userId": 60215367,
      "stepStatus": 0,
      "operationType": 0,
      "dateChanged": 1674072579
    }
  ],
  "2": [
    {
      "docId": 3580,
      "scenarioId": 9,
      "stepId": 2,
      "userId": 50206653,
      "stepStatus": 0,
      "operationType": 0,
      "dateChanged": 1674072579
    }
  ],
  "3": [
    {
      "docId": 3580,
      "scenarioId": 9,
      "stepId": 3,
      "userId": 60215367,
      "stepStatus": 0,
      "operationType": 0,
      "dateChanged": 1674072579
    }
  ]
}

 

Запуск документа на погодження / Зміна статуса кроку погодження POST /api/eds/doc/approval/step

Для запуску документа на погодження в методі потрібно передавати опціональний параметр scenario_id!

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/approval/step

URL параметри

gln (обов’язково) String - GLN власної Компанії

doc_uuid (обов’язково) UUID - ідентифікатор документа

scenario_id (обов’язково / опціонально) long - ідентифікатор документа (обов’язково при запуску документа на погодження)

id (опціонально) long - номер кроку погодження із сценарію

status (опціонально) long - ідентифікатор статусу:

  • 0 - на погодженні

  • 1 - погоджено

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

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

При відхиленні (status=2) в тілі запиту методу потрібно передавати текстовий коментар - причину відхилення.

RESPONSE

Код сервера 200 (ok).

Редагувати / видалити сценарій погодження документів PUT /api/eds/doc/approval/scenario

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/eds/doc/approval/scenario

URL параметри

gln (обов’язково) String - GLN власної Компанії

id (обов’язково) long - ідентифікатор сценарію до редагування

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані кроків за сценарієм (об’єкт з масивами об’єктів XDocApprovalScenario)

RESPONSE

Код сервера 200 (ok).

Отримати сценарій/-ї (на рівні GLN) GET /api/eds/doc/approval/scenario

Метод може бути використаний для отримання всіх сценаріїв (на рівні GLN) або конкретного, якщо в методі передається опціональний параметр id!

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/approval/scenario

URL параметри

gln (обов’язково) String - GLN власної Компанії

id (опціонально) long - ідентифікатор сценарію

auto (опціонально) boolean - автоматичний запуск погодження (false за замовчуванням). При auto=true повертаються тільки сценарії з автозапуском.

doc_type (опціонально) int - тип документа для автопогодження (повертаються сценарії тільки за обраним типом документа). Відпрацьовує лише у зв’язці із auto=true. Можливі значення:

  • 28 - COMDOC:

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

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

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

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

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

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

    • Акт наданих послуг (Логістика) (COMDOC_037)

  • 118 - Акт приймання наданих послуг (DOCINVOICEACT)

  • 115 - Повідомлення про штрафні санкції (ORDRPT)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передаються дані сценарію/-їв (об’єкт / масив об’єктів XDocApprovalScenario).

Створити сценарій погодження документів POST /api/eds/doc/approval/scenario

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/approval/scenario

URL параметри

gln (обов’язково) String - GLN власної Компанії

name (обов’язково) int - назва сценарію

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані кроків за сценарієм (об’єкт з масивами об’єктів XDocApprovalScenario)

RESPONSE

В тілі відповіді передаються дані сценарію (об’єкт XDocApprovalScenario).

Вилучити теги з документа DELETE /api/eds/doc/tags

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/eds/doc/tags

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

doc_id (обов’язково) long - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається масив об’єктів: тегів для видалення з документа.

RESPONSE

Код сервера 200 (ok).

Прив'язати тег до документа POST /api/eds/doc/tags

REQUEST

URL

Метод запиту

POST

URL запиту

/api/eds/doc/tags

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

doc_id (обов’язково) long - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається масив обʼєктів XTag

 

Приклад:

 

[
  {
    "id": "ід тега",
    "name": "назва тега"
  },
  {
    "id": "ід тега",
    "name": "назва тега"
  }
]

RESPONSE

У відповіді повертається повідомлення та статус: 

STATUS Message Коментар
200 Запит успішно опрацьовано Статус заявки змінено на вказаний
500 Internal Server Error. Chanel ID: 123456 Непередбачена внутрішня помилка. Необхідно звернутись до тех. підтримки для зʼясування причини помилки.

 

Видалити теги DELETE /api/eds/tags

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/eds/tags

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається масив ідентифікаторів тегів до видалення, наприклад: [2, 10, 12].

RESPONSE

Код сервера 200 (ok).

Редагувати тег PUT /api/eds/tags

Назва тегу повинна бути унікальною й довжиною не більше 20 символів.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/eds/tags

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається масив об’єктів: тегів з відредагованими назвами/короткими назвами.

RESPONSE

Код сервера 200 (ok).

Отримати список тегів (міток) GET /api/eds/tags

REQUEST

URL

 https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/eds/tags

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

search (опціонально) String - пошук за назвою тега

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в json форматі передається масив тегів (Обʼєкт XTag), що відповідають пошуковому запиту

[
  {
    "id": "ід тега",
    "name": "назва тега"
  },
]

 

Створити новий тег (мітку) POST /api/eds/tags

REQUEST

URL

Метод запиту

POST

URL запиту

/api/eds/tags

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії

HEADERS

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту (json) передається список (масив) назв тегів у вигляді масиву.

 

Назва тегу (мітки) повинна бути унікальною й довжиною не більше 20 символів.

 

Приклад:

["Ken", "json", "Stethem"]

RESPONSE

В тілі відповіді в json форматі передається масив створених тегів (Обʼєкт XTag)

[
  {
    "id": "ід тега",
    "name": "назва тега"
  },
]

 

Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/doc/revoke

Відкликати підписання документа COMDOC/TRANSPORTATIONORDER може лише відправник документа до того, як документ змінить свій стан на:

Значення [ЕлектроннийДокумент/Відхилив/GLN] має відповідати параметру gln в запиті. ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в блоці [ЕлектроннийДокумент/Відхилив]

Метод може бути використаний для відправки Відкликання підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).

Для DOCUMENTINVOICE та DOCCORINVOICE (і лише для цих документів) метод може бути виконаний в режимі автоматичного формування і відправки «Повідомлення про відмову від підписання документа» (COMDOC_021) при наявності autoGenerate параметра. За наявності параметра autoGenerate тіло квитанції формується автоматично, але без підпису.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/revoke

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта

doc_uuid (обов’язково) UUID - ідентифікатор документа;

лише для DOCUMENTINVOICE/DOCCORINVOICE: autoGenerate (опціонально) - параметр (без значення), що вказує на автоматичне генерування квитанції Відкликання підписання

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json або application/xml (запит містить autoGenerate параметр) або application/pkcs7-signature (запит без autoGenerate параметра)

REQUEST

  

Body

В тілі запиту методу обов’язково передається:

  • текст причини відкликання документа (коли запит містить autoGenerate параметр);

АБО

  • підписаний p7s файл квитанції Відкликання підписання - запит без autoGenerate параметра.

RESPONSE

В тілі відповіді передаються:

  • chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

  • doc_uuid - ідентифікатор документа, якому належить квитанція

  • ticket_uuid - ідентифікатор квитанції

JSON приклад відповіді:

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Створити на сервері квитанцію «Відкликання підписання документа» (COMDOC_021) GET /api/v2/eds/doc/revoke

Цей метод може бути використаний для Відкликання підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/doc/revoke

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа

reason - text; текст причини відкликання

response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:

  • json (за замовчуванням)

  • xml

  • json_base64

  • xml_base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається тіло згенерованого COMDOC_021 в json форматі або форматі, обраному в запиті response_type (приклади відповіді + специфікація COMDOC_021).

Відправити відмову від підписання (створення квитанції №13) POST /api/v2/eds/doc/reject

Метод може бути використаний для відправки Відмови від підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).

Для DOCUMENTINVOICE та DOCCORINVOICE (і лише для цих документів) метод може бути виконаний в режимі автоматичного формування і відправки «Повідомлення про відмову від підписання документа» (COMDOC_021) при наявності autoGenerate параметра. За наявності параметра autoGenerate тіло квитанції формується автоматично, але без підпису.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/reject

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0

doc_uuid (обов’язково) UUID - ідентифікатор документа;

лише для DOCUMENTINVOICE/DOCCORINVOICE: autoGenerate (опціонально) - параметр (без значення), що вказує на автоматичне генерування xml Повідомлення про відмову від підписання документа (COMDOC_021)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json (запит містить autoGenerate параметр) або application/pkcs7-signature (запит без autoGenerate параметра)

REQUEST

  

Body

В тілі запиту методу обов’язково передається:

  • текст причини відмови від підписання документа (коли запит містить autoGenerate параметр);

АБО

  • підписаний p7s файл Повідомлення про відмову від підписання документа (COMDOC_021) - запит без autoGenerate параметра.

RESPONSE

В тілі відповіді передаються:

JSON приклад відповіді:

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Створити квитанцію №15 (відмова від анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal/reject

Виконати «Відмову від анулювання» документа може лише отримувач «Запиту на анулювання» (є квитанція №11) до того, як документ змінить свій стан на «анульовано» (в документа є квитанція №12).

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/repeal/reject

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/xml

REQUEST

  

JSON Body

В тілі запиту методу передається непідписаний xml (COMDOC_021 з даними документа підстави і причиною відмови від анулювання в полі «Текст») в бінарному вигляді. Тіло можливо створити методом GET /api/v2/eds/doc/reject

RESPONSE

В тілі відповіді передаються:

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

doc_uuid - ідентифікатор документа, якому належить квитанція

ticket_uuid - ідентифікатор квитанції

Приклад (JSON):

{
  "chain_uuid": "d47a29f6-b208-41a1-bb6e-8f5fc58745cd",
  "doc_uuid": "38e37759-825a-4774-a3c3-d77f241253a8",
  "ticket_uuid": "111aaeaa-3601-49d9-a5e5-fe2aaebdacdb"
}

 

Створити квитанцію №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/comdoc/revoke

Наполегливо рекомендуємо використовувати замість даного методу новий метод /api/v2/eds/doc/revoke за посиланням.

Відкликати підписання документа COMDOC/TRANSPORTATIONORDER може лише відправник документа до того, як документ змінить свій стан на:

Значення [ЕлектроннийДокумент/Відхилив/GLN] має відповідати параметру gln в запиті. ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в блоці [ЕлектроннийДокумент/Відхилив]

Цей метод може бути виконаний двома способами, що відрізняються набором вхідних параметрів і потребою в передаванні тіла запиту:

Спосіб № 1:

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/revoke

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/pkcs7-signature or application/xml

REQUEST

  

JSON Body

В тілі запиту методу можуть передаватись:

  • при Content-Type=application/pkcs7-signature підписані дані p7s в бінарному вигляді;

  • при Content-Type=application/xml непідписаний xml (COMDOC_021) в бінарному вигляді.

Спосіб № 2:

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/revoke

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

autoGenerate - параметр (без значення), що вказує на автоматичне генерування квитанції

Headers

  

Authorization

SID - токен, отриманий при авторизації

REQUEST

  

Body

В тілі запиту методу обов’язково передається текст причини відкликання документа.

RESPONSE

В тілі відповіді передаються:

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

doc_uuid - ідентифікатор документа, якому належить квитанція

ticket_uuid - ідентифікатор квитанції

JSON приклад:

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

Створити квитанцію №13 (відхилення документа COMDOC/TRANSPORTATIONORDER) POST /api/v2/eds/comdoc/reject

Наполегливо рекомендуємо використовувати замість даного методу новий метод /api/v2/eds/doc/reject за посиланням.

Відхилити документ COMDOC може лише отримувач документа до того, як документ змінить свій стан на:

Значення [ЕлектроннийДокумент/Відхилив/GLN] має відповідати параметру gln в запиті. ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в блоці [ЕлектроннийДокумент/Відхилив]

Цей метод може бути виконаний двома способами, що відрізняються набором вхідних параметрів і потребою в передаванні тіла запиту:

Спосіб № 1:

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/reject

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/pkcs7-signature or application/xml

REQUEST

  

JSON Body

В тілі запиту методу можуть передаватись:

  • при Content-Type=application/pkcs7-signature підписані дані p7s в бінарному вигляді;

  • при Content-Type=application/xml непідписаний xml (COMDOC_021) в бінарному вигляді.

Спосіб № 2:

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/reject

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі;

doc_uuid - рядок; UUID документа COMDOC

autoGenerate - параметр (без значення), що вказує на автоматичне генерування квитанції

Headers

  

Authorization

SID - токен, отриманий при авторизації

REQUEST

  

Body

В тілі запиту методу обов’язково передається текст причини відхилення документа

RESPONSE

В тілі відповіді передаються:

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

doc_uuid - ідентифікатор документа, якому належить квитанція

ticket_uuid - ідентифікатор квитанції

JSON приклад:

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

Створити квитанцію №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal/accept

Підтвердити (прийняти) запит на анулювання документа неможливо, якщо документ:

ЄДРПОУ в підписі має відповідати ЄДРПОУ, зазначеному в документі (наприклад, для COMDOC: [КодКонтрагента] або [ІПН] в одному з блоків [ЕлектроннийДокумент/Сторони/Контрагент])

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/repeal/accept

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/pkcs7-signature

REQUEST

  

JSON Body

В тілі запиту методу передаються підписані дані p7s в бінарному вигляді. Тобто передається підписане з Вашої сторони вхідне тіло документа до анулювання.

RESPONSE

В тілі відповіді передаються:

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

doc_uuid - ідентифікатор документа, якому належить квитанція

ticket_uuid - ідентифікатор квитанції

 JSON приклад:

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Створити квитанцію №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER) POST /api/v2/eds/doc/repeal

Створити запит на анулювання документа неможливо, якщо документ знаходиться в стані:

ЄДРПОУ в підписі має відповідати ЄДРПОУ, зазначеному в документі (наприклад, для COMDOC: [КодКонтрагента] або [ІПН] в одному з блоків [ЕлектроннийДокумент/Сторони/Контрагент])

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/repeal

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/pkcs7-signature

REQUEST

  

JSON Body

В тілі запиту методу передаються підписані дані p7s в бінарному вигляді. Тобто передається підписане xml тіло, отримане в результаті виконання методу GET /api/v2/eds/doc/repeal)

RESPONSE

В тілі відповіді передаються:

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

doc_uuid - ідентифікатор документа, якому належить квитанція

ticket_uuid - ідентифікатор квитанції

JSON приклад: 

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Створити квитанцію №2 (прийняття документа COMDOC) POST /api/v2/eds/comdoc/accept

Прийняти документ COMDOC може лише отримувач документа до того, як документ змінить свій стан на:

ЄДРПОУ в підписі має відповідати [КодКонтрагента] або [ІПН] в одному з блоків [ЕлектроннийДокумент/Сторони/Контрагент]

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/accept

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/pkcs7-signature

REQUEST

  

JSON Body

В тілі запиту методу передаються підписані дані p7s в бінарному вигляді

RESPONSE

В тілі відповіді передаються:

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

doc_uuid - ідентифікатор документа, якому належить квитанція

ticket_uuid - ідентифікатор квитанції

Приклад (JSON):

{
  "chain_uuid": "7b6aef20-9f42-460e-9031-bb81c91e3b03",
  "doc_uuid": "e013510a-4267-4553-80f0-eb5ebabdfd05",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Створити квитанцію №1 (підпис чернетки) POST /api/v2/eds/doc/ticket

За допомогою цього методу можливо підписати чернетку документа (COMDOC, DECLAR, DECLARJ12, DOCUMENTINVOICE, KORINVOICE, DOCCORINVOICE, TRANSPORTATIONORDER).

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/ticket

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

doc_uuid (обов’язково) String - унікальний ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються дані для здійснення операції підписання

RESPONSE

JSON приклад відповіді:

{
  "chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
  "doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) GET /api/v2/eds/doc/reject

Метод GET api/v2/eds/doc/reject може бути використаний для Відмови від підписання : Комерційних документів (сімейство COMDOC), Накладних (DOCUMENTINVOICE), Додаток до договору 7А (METRO_7A), Додаток до договору 7Б (METRO_7B), Додаток до договору 7Ц (METRO_7C), «Заявка на транспортування» / «Підтвердження заявки на транспортування» (TRANSPORTATIONORDER).

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/doc/reject

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

reason - text; текст причини відмови/анулювання

response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:

  • json (за замовчуванням)

  • xml

  • json_base64

  • xml_base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається тіло згенерованого:

в json форматі або форматі, обраному в запиті response_type (приклади відповіді).

Створити на сервері квитанцію «Повідомлення про відмову від підписання документу» (COMDOC_021) для COMDOC/TRANSPORTATIONORDER документів GET /api/v2/eds/comdoc/reject

Наполегливо рекомендуємо використовувати замість даного методу новий метод /api/v2/eds/doc/reject за посиланням.

За допомогою GET методу api/v2/eds/comdoc/reject можливо створити документ COMDOC-відмову.

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/comdoc/reject

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

reason - text; текст причини відмови/анулювання

response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:

  • json (за замовчуванням)

  • xml

  • json_base64

  • xml_base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається тіло згенерованого COMDOC_021 в json форматі або форматі, обраному в запиті response_type (приклади відповіді + специфікація COMDOC_021)».

Створити на сервері квитанцію «Анулювання» GET /api/v2/eds/doc/repeal

За допомогою цього методу можливо створити квитанцію для подальшого запуску «Анулювання».

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/doc/repeal

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта;

doc_uuid - рядок; UUID документа, до якого потрібно виконати анулювання;

reason - text; текст причини відмови/анулювання;

response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:

  • json (за замовчуванням)

  • xml

  • json_base64

  • xml_base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається тіло згенерованого:

в json форматі або форматі обраному в запиті response_type (приклади відповіді).

Отримати дані/контент квитанції GET /api/eds/doc/ticket/body

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/ticket/body

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі

doc_uuid - рядок; UUID документа

transaction_type - число; тип транзакції

  • 1 - документ підписаний однією стороною (одним контрагентом)

  • 2 - документ підписаний з обох сторін (двома контрагентами)

  • 11 - запит на анулювання

  • 12 - підтвердження анулювання

  • 13 - відмова від підписання (з указуванням причини відмови)

body_type - число; тип тіла квитанції (індекс контента)

  • 1 - зміст підпису (контент в base64 форматі)

family (опціонально) - сімейство; можливі значення: edi

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/octet-stream

RESPONSE

В тілі відповіді в залежності від параметра body_type передаються дані підпису (json) або контент підпису (base64).

Отримати інформацію про підписантів за всіма вказаними транзакціями документа GET /api/v2/eds/doc/signers

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/doc/signers

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) String - унікальний ідентифікатор організації в системі;

doc_uuid (обов’язково) String - UUID документа;

transaction_type (обов’язково) int - тип транзакції (параметр можливо передавати списком):

  • 1 - документ підписаний однією стороною (одним контрагентом)

  • 2 - документ підписаний з обох сторін (двома контрагентами)

  • 11 - запит на анулювання

  • 12 - підтвердження анулювання

  • 13 - відмова від підписання (з указуванням причини відмови)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про підписантів (об’єкт, що містить перелік номерів вказних в запиті транзакцій та масив об’єктів ExEndUserSignInfo з даними підписантів до кожної вказаної транзакції).

Отримати інформацію про підписантів GET /api/eds/doc/signers

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/signers

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі

doc_uuid - рядок; UUID документа

transaction_type - число; тип транзакції

  • 1 - документ підписаний однією стороною (одним контрагентом)

  • 2 - документ підписаний з обох сторін (двома контрагентами)

  • 11 - запит на анулювання

  • 12 - підтвердження анулювання

  • 13 - відмова від підписання (з указанням причини відмови)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo ).

Якщо в квитанції відсутнє тіло з типом транзакції 1 і більше, то у відповіді методу передається порожній масив підписантів (наприклад, при відкликанні підписання документа COMDOC).

Отримати всі квитанції вказаного документа GET /api/eds/doc/tickets

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/tickets

URL параметри

gln (обов’язково) - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) - рядок; унікальний ідентифікатор організації в системі

doc_uuid (обов’язково) - рядок; UUID документа

loadBody (опціонально) - отримати квитанції разом з їх тілами; можливі значення: loadBody

type (опціонально) - тип отримання даних; можливі значення: zip - у вигляді архіву (при цьому обов’язково вказується назва архіву - параметр file_name)

file_name - назва архіву (вказується при наявності параметра type)

family (опціонально) - сімейство; можливі значення: edi

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json or application/zip

RESPONSE

В тілі відповіді в залежності від наявності параметра type передаються масив об’єктів (квитанції вказаного документа) в json форматі чи у вигляді zip-архіву.

Отримати хеш вкладення (контейнера) документа для підписання GET /api/eds/doc/attachment/sign/hash

Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/attachment/sign/hash

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в текстовому вигляді передається хеш вкладення (контейнера) документа для підписання:

mIDIAXJ6vWVwiuQ1LZ7pNxjOO1b/JuevNmRzfrUtpjU=

 

Додати підпис до вкладень документа-чернетки POST /api/eds/doc/attachment/sign

Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/attachment/sign

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається файл підпису p7s в base64 форматі.

RESPONSE

Код сервера 200 (ok).

Роздрукувати вкладення документа GET /api/eds/doc/print

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/print

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

doc_uuid (обов’язково) - рядок; UUID документа

response_type (опціонально) - MIME типізація згідно типу файлу-вкладення

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

MIME типізація згідно типу файлу-вкладення

RESPONSE

В тілі відповіді передається принт-форма вкладення документа.

Видалити файл-вкладення (чернетка) DELETE /api/eds/doc/attachment

Кожен раз при видаленні одного вкладення підписи всіх інших вкладень документа видаляються.

REQUEST

URL

  

Метод запиту

DELETE

URL запиту

/api/eds/doc/attachment

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла)

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

Код сервера 200 (ok).

Отримати файл-вкладення GET /api/eds/doc/attachment

Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/attachment

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

MIME типізація згідно типу файлу-вкладення

RESPONSE

В тілі відповіді передається файл-вкладення.

Додати файл до документа-чернетки POST /api/eds/doc/attachment

Реалізовано на даний момент для наступних документів: Універсальний/неструктурований документ (CONDRA)

Один документ може містити не більше 10 файлів в наступних форматах: PDF/XLS/XLSX/DOC/DOCX/ODT/PPT/PPTX/JPG/BMP/PNG/XML/P7S з розміром файлу не більше 5 Мб. Назва файла не повинна перевищувати 100 символів. Кожен раз при додаванні нового вкладення підписи всіх інших вкладень документа видаляються.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/attachment

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

Form-data

В тілі запиту передається 1 файл.

Приклад запиту:

boundary=----15217883902974046383107741460

----15217883902974046383107741460
Content-Disposition: form-data; name="file"; filename="name.pdf"
Content-Type: application/pdf

(data)
----15217883902974046383107741460

 

Прийняти документ (CONDRA) PATCH /api/v2/eds/condra/confirm/send

Підтвердити можна лише вхідний документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!

URL

  

Метод запиту

PATCH

URL запиту

/api/v2/eds/condra/confirm/send

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

doc_uuid - рядок; UUID документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA).

RESPONSE

Код сервера 200 (ok).

Відкликати документ (CONDRA). Створення квитанції №14. PATCH /api/v2/eds/condra/withdraw

Відкликати можна лише надісланий документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/v2/eds/condra/withdraw

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA).

RESPONSE

В тілі відповіді передаються дані створеної квитанції документа (об’єкт XTicket).

Відхилити документ (CONDRA). Створення квитанції №13. PATCH /api/v2/eds/condra/reject

Відхилити можливо лише вхідний документ, за яким ще не відбувалось Підтвердження / Відхилення / Відкликання!

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/v2/eds/condra/reject

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі;

doc_uuid (обов’язково) UUID - ідентифікатор документа

message (обов’язково) String - причина відхилення документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/xml

REQUEST

  

JSON Body

В тілі запиту методу передається тіло документа в xml форматі (специфікація документа CONDRA).

RESPONSE

В тілі відповіді передаються дані створеної квитанції документа (об’єкт XTicket ).

Підписати файл (для CONDRA) POST /api/eds/doc/body

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/body

URL параметри

gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта

АБО

guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0

doc_uuid (обов’язково) UUID - ідентифікатор документа

family (опціонально) int - сервіс (сімейство); допустимі значення:

  • edi

  • uzd

content_type (обов’язково) String – тип тіла контента; можливі значення: hash_sign (константа)

body_type (обов’язково) String - тип тіла документа; можливі значення:

  • content - base64 контент без підписів/печаток;

  • json - json документа;

  • sign - base64 тіло підпису;

  • xml - тіло документа в xml форматі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

text/plain

REQUEST

  

Body

В тілі запиту методу передається p7s файл підпису в бінарному вигляді.

RESPONSE

Код сервера 200 (ok).

Отримати UUID (для CONDRA) GET /api/office/uuid

За допомогою GET методу /api/office/uuid генерується один UUID. Для створення CONDRA потрібно запускати метод двічі.

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/office/uuid

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді в текстовому вигляді передається uuid - сгенерований унікальний ідентифікатор:

c48f97e9-8d98-4c52-8635-675a6145f570

 

Створити чернетку документа (для CONDRA) POST /api/eds/doc

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта АБО guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0

doc_type (обов’язково) String - тип документа (опис параметру)

doc_number (обов’язково) String - номер документа

doc_date (обов’язково) число - дата документа (в форматі UNIX-timestamp)

recipient (обов’язково) String (13) - gln отримувача

family (обов’язково) String (13) - сервіс (сімейство); допустимі значення:

  • edi

  • uzd

  • ettn

created_from (опціонально) String - ідентифікатор документа або ланцюжка

created_from_doc_id (опціонально) String - ідентифікатор документа-підстави (документа, на основі якого буде створено новий)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається документ у форматі JSON (XML специфікації EDI документів + XML специфікації ETTN документів). Приклад тіла запиту для створення CONDRA.

RESPONSE

В тілі відповіді в текстовому вигляді передається doc_uuid - унікальний ідентифікатор документа:

e64a304b-b0c0-454b-a361-5dc5d6987952

 

Додати файл-вкладення (для CONDRA) POST /api/eds/doc/body

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/body

URL параметри

gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта

АБО

guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0

doc_uuid (обов’язково) UUID - ідентифікатор документа

family (опціонально) int - сервіс (сімейство); допустимі значення:

  • edi

  • uzd

body_type (обов’язково) String - тип тіла документа; можливі значення:

  • content - base64 контент без підписів/печаток;

  • json - json документа;

  • sign - base64 тіло підпису;

  • xml - тіло документа в xml форматі

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/pkcs7-signature – для p7s файла

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet – для Excel

… etc MIME типізація

REQUEST

  

JSON Body

В тілі запиту методу передається тіло файла в бінарному вигляді.

RESPONSE

Код сервера 200 (ok).

Створити й відправити «Універсальний/неструктурований документ» (CONDRA) без створення чернетки POST /api/v2/eds/doc/condra/create_and_send

За допомогою цього методу відбувається одночасне створення та відправка «Універсального/неструктурованого документа» (CONDRA).

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/condra/create_and_send

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

recipient (обов’язково) String (13) - GLN отримувача

number (обов’язково) String (32) - номер документа

date (обов’язково) YYYY-MM-DD - дата документа

doctype (обов’язково) String (1000) - код підтипа документа

contractNumber (опціонально) String (16) - номер договору

contractDate (опціонально) YYYY-MM-DD - дата договору

summ (опціонально) Число десяткове - сума документа

delivery (опціонально) String (13) - GLN місця доставки

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу передаються підписані чи непідписані файли-вкладення (не більше 10 файлів з розміром файлу не більше 5 Мб) в їх нативному форматі (розширення файлу змінювати не потрібно). Приклади запитів + специфікація документа CONDRA.

RESPONSE

doc_uuid - ідентифікатор документа на платформі EDIN 2.0;

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ.

JSON приклад відповіді:

{
   "doc_uuid": "0ca98f00-6988-4aac-a660-8f289a24fe2d",
   "chain_uuid": "4838e8fe-c0aa-4fe9-ad78-74832d9e2b59"
}

 

Створити чернетку «Універсального/неструктурованого документа» (CONDRA) POST /api/v2/eds/doc/condra/create

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/condra/create

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

recipient (обов’язково) String (13) - GLN отримувача

number (обов’язково) String (32) - номер документа

date (обов’язково) YYYY-MM-DD - дата документа

doctype (обов’язково) String (1000) - код підтипа документа

contractNumber (опціонально) String (16) - номер договору

contractDate (опціонально) YYYY-MM-DD - дата договору

summ (опціонально) Число десяткове - сума документа

delivery (опціонально) String (13) - GLN місця доставки

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу передаються підписані чи непідписані файли-вкладення (не більше 10 файлів з розміром файлу не більше 5 Мб) в їх нативному форматі (розширення файлу змінювати не потрібно). Приклади запитів + специфікація документа CONDRA.

RESPONSE

doc_uuid - ідентифікатор документа на платформі EDIN 2.0;

JSON приклад відповіді:

{
   "doc_uuid": "a066f658-e7fa-407d-b4bf-4b044fe5cc88"
}

 

Відправити «Неструктурований (універсальний) документ» (CONDRA) PATCH /api/eds/doc/condra/send

Наявність ритейлера при документообізі автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера).

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/eds/doc/condra/send

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта АБО guid - рядок; унікальний ідентифікатор організації в системі

doc_uuid - рядок; UUID документа

doc_hash (опціонально) - рядок; хеш документа

chain_hash (опціонально) - рядок; хеш ланцюжка

chain_uuid (опціонально) - рядок; ID ланцюжка

partner_id (опціонально) - число; id торгової мережі (можливо отримати з довідника торгових мереж)

chain_type (опціонально) - число; тип ланцюжка документів;

  • 0 - звичайний

  • 2 - особлива схема - MATCH INVOICE (ТМ Фоззі)

  • 3 - особлива схема - не MATCH INVOICE (ТМ Фоззі)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

text/plain; charset=UTF-8

RESPONSE

Код сервера 200 (ok).

Завантажити «Неструктурований (універсальний) документ» (CONDRA) в вигляді архіву GET /api/eds/doc/condra/body

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/condra/body

URL параметри

gln (обов’язково) String - GLN власної Компанії

doc_uuid (обов’язково) UUID - ідентифікатор документа

file_name (обов’язково) String - назва файлу документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/octet-stream

RESPONSE

У тілі відповіді передається архів (.zip), що містить тіло документа CONDRA (.xml), файли-вкладення (оригінали або контейнери тіл підпису (.p7s) + листи підписання кожного вкладення (.pdf), якщо вкладення з підписами).

Отримати статус документа POST /api/v2/eds/docs/state

Метод дозволяє користувачеві отримати статус вхідного/відправленого документа (документів).

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/docs/state

URL параметри

gln (обов’язково) String - GLN власної Компанії

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

Масив UUID документів через кому, наприклад:

 

["44f3cf03-e2a3-4f8b-aae1-cafeb28fe699", "fb56e025-9c4d-4936-b889-087c6d5c837d"]

 RESPONSE

В тілі відповіді передається інформація про стан документа (exchange_status і де можливо: sub_status_id).

JSON приклад відповіді:

{
"44f3cf03-e2a3-4f8b-aae1-cafeb28fe699": {
    "sub_status_id": "1",
    "exchange_status": "000000000000000000000001"
    },
"fb56e025-9c4d-4936-b889-087c6d5c837d": {
    "sub_status_id": "1",
    "exchange_status": "000000000000000000000001"
    }
}

 

Одночасне прийняття, підписання та відправка двох пов’язаних документів POST /api/eds/docs_and_tickets

Даний метод однією дією (одночасно) виконує Прийняття «Акта приймання-передачі (додаток 8)» (COMDOC_032) (створення квитанції) та Відправку пов’язаного «Акта приймання-передачі (додаток 8)» (COMDOC_033) без чернетки (подібно до послідовного виконання /api/v2/eds/comdoc/accept та /api/eds/doc/create_and_send).

Якщо під час виконання методу під час перевірок буде виявлена логічна помилка на будь-якому етапі, то жодні дії не будуть виконані. Тобто або підписуються обидва документа, або жоден.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/docs_and_tickets

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу передаються два файли-вкладення пов’язаних документів (рекомендовано в p7s форматі (в бінарному вигляді чи в base64)) та їх дані в об’єкті DocumentRequest

Повний приклад запиту:

POST /api/eds/docs_and_tickets?gln=9864066822430 HTTP/1.1
Host: localhost:8084
Authorization: 9e04baf1-f33b-4e76-8657-5212bae7a9z5
Content-Length: 590
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="comdoc_32_from_atb.p7s"
Content-Type: <Content-Type header here>

(data)
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="documents"

{"documents":[{"fileName":"comdoc_32_from_atb.p7s","type":"comdoc"},{"fileName":"comdoc_33_from_atb.p7s","type":"comdoc"}]}
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="comdoc_33_from_atb.p7s"
Content-Type: <Content-Type header here>

(data)
----WebKitFormBoundary7MA4YWxkTrZu0gW

RESPONSE

doc_uuid - ідентифікатор документа на платформі EDIN 2.0;

chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ;

ticket_uuid - ідентифікатор квитанції.

JSON приклад відповіді:

{
   "comdoc_32_from_atb.p7s": {
      "doc_uuid": "fdae7e57-3706-4599-90e2-1a5ebee71512",
      "chain_uuid": "d62f1b6e-7400-4bc3-ba5b-7e5d7931adbc",
      "ticket_uuid": "411f23ee-ab07-472f-a1e2-7155a7631ff8"
   }, - це для тікета
   "comdoc_33_from_atb.p7s": {
      "doc_uuid": "b45f5906-9a6b-45d9-adb1-0cc527d260c4",
      "chain_uuid": "d62f1b6e-7400-4bc3-ba5b-7e5d7931adbc"
   } - це для документа
}

 

 

Відправити транзакції до «Резерву товару» PRDRSRVN (зміни в табличній частині) POST /api/eds/doc/prdrsrvn/transaction

Виконувати дії з документом можливо на будь-якому етапі, однак поки оригінальний документ не буде старше 5 днів.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/prdrsrvn/transaction

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid (опціонально) UUID - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json або application/xml

REQUEST

  

JSON Body

В тілі запиту методу передається тіло документа (контент) в json/xml форматі (xml-специфікація документа Резерв товару (PRDRSRVN))

RESPONSE

Код сервера 200 (ok).

Отримати тіло документів (json) за вказаними UUID POST /api/v2/eds/doc/content

Обмеження: не більше 50 документів одним запитом!

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/content

URL параметри

gln (обов’язково) String - GLN власної Компанії

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

Масив UUID документів через кому

Приклад запиту:

["8b441f1f-a209-4331-b848-5d01766f3a5c", "07d369fe-6f17-4d7a-94d4-9fe0ccad9379"]

 

RESPONSE

В тілі відповіді передаються дані тіл документів в json форматі.

JSON приклад відповіді:

{
    "07d369fe-6f17-4d7a-94d4-9fe0ccad9379": "{\"DATE\":\"2023-05-16\",\"HEAD\":[{\"SENDER\":\"9864065732181\",\"POSITION\":[{\"POSITIONNUMBER\":1,\"PRODUCT\":\"1231231002\",\"QUANTITYOFCUINTU\":45,\"QUANTITY\":\"10\",\"PRODUCTIDBUYER\":\"11111\",\"DELIVERYPLACE\":\"9864065732211\"}],\"RECIPIENT\":\"9864065732211\",\"SUPPLIER\":\"9864065732181\",\"DELIVERYPLACE\":\"9864065732211\",\"BUYER\":\"9864065732211\"}],\"NUMBER\":\"1111\",\"ORDERNUMBER\":\"1111111\",\"ORDERDATE\":\"2023-05-01\",\"DELIVERYDATE\":\"2023-05-02\",\"AMOUNT\":\"100000\",\"CURRENCY\":\"UAH\",\"DELIVERYINFO\":\"доп\"}",
    "8b441f1f-a209-4331-b848-5d01766f3a5b": "{\"title\":{\"number\":\"17301/1010101\",\"type\":\"Акт виконаних робіт\",\"code\":\"013\",\"date\":\"2023-05-18\",\"place_of\":\"м. Київ\",\"doc_basis\":[{\"number\":\"111\",\"type\":\"Договір\",\"code\":\"001\",\"date\":\"2023-05-01\"}]},\"parties\":{\"partners\":[{\"status\":\"Продавець\",\"type\":\"Юридична\",\"name\":\"Товариство з обмеженою відповідальністю \\\"Імпульс Схід\\\"\",\"code\":\"40824037\",\"inn\":\"408240313043\",\"gln\":\"9864065732181\"},{\"status\":\"Покупець\",\"type\":\"Юридична\",\"name\":\"ПрАТ \\\"Монделіс Україна\\\"\",\"code\":\"00382220\",\"inn\":\"003822218163\",\"gln\":\"9864065732211\"}]},\"table\":{\"position\":[{\"position_number\":\"1\",\"description\":\"Відшкодування витрат за гарантії\",\"qty_received\":1.0,\"unit\":\"послуга\",\"price_base\":21309.99,\"vat\":0.0,\"price\":21309.99,\"total\":{\"sum_without_vat\":21309.99,\"sum_vat\":0.0,\"sum\":21309.99},\"id\":\"1\"}]},\"total\":{\"sum_without_vat\":21309.99,\"vat\":0.0,\"sum\":21309.99}}"
}

 

Видалити документи-чернетки PATCH /api/eds/docs

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/eds/docs

URL параметри

gln (обов’язково) String - GLN власної Компанії;

family (опціонально) UUID - сервіс/сімейство документів; можливі значення: edi

detailed_response (опціонально) boolean - false за замовчуванням; при detailed_response = true, то у відповідь повернеться додатково статус видалення по кожному документу (success/failed)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається масив ідентифікаторів документів-чернеток до видалення, наприклад: [«345b68bb-552b-4d0e-8091-a5991f16250c»,«a751981c-1abf-4268-afac-c2389948fe54»]

RESPONSE

Код сервера 200 (ok).

Отримати інформацію про підпис/підписантів GET /api/eds/doc/attachment/sign/info

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/attachment/sign/info

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

attachment_uuid (обов’язково) UUID - ідентифікатор файла-вкладення (параметр attachmentUUID в тілі відповіді при додаванні файла)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається інформація про підписантів (масив об’єктів ExEndUserSignInfo).

Отримати реєстр документів в xls форматі GET /api/eds/doc/reports/doctype

Обмеження! Реєстр можливо отримати за період, що не перевищує 31 добу та лише для певних типів документів.

Перелік типів документів, для яких можна отримати реєстр:

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/reports/doctype

URL параметри

gln (обов’язково) - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid (обов’язково) - рядок; унікальний ідентифікатор організації в системі

doc_type_id (обов’язково) - число; id типу документа. Доступні значення: 1,2,3,4,5,28,59,67

sub_doc_type_id (опціонально) - число; id підтипу документа

date_from (опціонально) - початок періоду виборки в UNIX-форматі (якщо не вказано, то поточна дата мінус 31 день)

date_to (опціонально) - кінець періоду виборки в UNIX-форматі (якщо не вказано, то поточна дата)

sender (обов’язково) - рядок (13); номер GLN відправника документів АБО recipient (обов’язково) - рядок (13); номер GLN отримувача документів АБО partner (обов’язково) - id рітейлера (торгової мережі)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

У тілі відповіді передається звіт у вигляді xlsx-файлу з даними документів.

Архівувати / Розархівувати ланцюжок документів PATCH /api/eds/chain/archive

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

api/eds/chain/archive

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

chain_uuid (обов’язково) String - унікальний ідентифікатор ланцюжка документів;

archive (обов’язково) boolean - визначає дію:

  • true - Архівувати (перенести в Архів);

  • false - Розархівувати (винести з архіву)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

Код сервера 200 (ok).

Заповнити індекси (додавання / оновлення полів екстрапараметрів) PUT /api/eds/doc/extra_fields

Заповнення індексів необхідно для коректного відображення та пошуку документів. По факту це повтор «Створення CONDRA», але з іншими полями. Якщо на попередньому кроці отримали помилку, то необхідно переривати подальше виконання запитів.

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/eds/doc/extra_fields

URL параметри

gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта

АБО

guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0

doc_uuid (обов’язково) UUID - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються додаткові поля (поля екстрапараметрів). Приклад індексації CONDRA та TRANSPORTATIONORDER

RESPONSE

Код сервера 200 (ok).

Редагувати чернетку документа PUT /api/eds/doc

REQUEST

URL

  

Метод запиту

PUT

URL запиту

/api/eds/doc

URL параметри

gln (обов’язково) Число (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта

doc_uuid (обов’язково) UUID - унікальний ідентифікатор документа

doc_number (обов’язково) String - номер документа

doc_date (обов’язково) Число - дата документа (в форматі UNIX-timestamp)

recipient (опціонально) Число (13) - GLN отримувача

family (опціонально) String (13) - сервіс (сімейство); допустимі значення:

  • edi

  • uzd

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається документ у форматі JSON (XML специфікації EDI документів + XML специфікації ETTN документів). Приклад тіла запиту для редагування CONDRA.

RESPONSE

Код сервера 200 (ok).

Отримати статус документа GET /api/eds/doc/statuses

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/statuses

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі

doc_uuid - рядок; UUID документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

У тілі відповідь передається статус вказаного документа (об’єкт XStatus ).

Відправити статус документа POST /api/eds/doc/statuses

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/statuses

URL параметри

gln (обов’язково) рядок (13) - номер GLN власної Компанії;

doc_uuid (обов’язково) рядок - UUID документа;

type (обов’язково) число - статус документа;

  • 0 - позитивний (прийнято)

  • 1 - негативний (відхилено)

  • 5 - Отримувач відхиляє документ

  • 6 - Ініціатор відхиляє документ

sub_status (опціонально) число - сабстатус документа (не використовується для ТТН v3 та пов’язаних Актів):

  • 5 - Отримувач відхиляє документ, наприклад:

    • Перевізник відхиляє Заявку на транспортування

  • 6 - Ініціатор відхиляє документ, наприклад:

    • Замовник відхиляє Заявку на транспортування

    • Перевізник відхиляє Підтвердження заявки на транспортування

Взаємовиключаючі параметри:

  • recipient (опціонально) рядок (13) - gln Відправника документа. Якщо Отримувач документа відправляє запит без recipient параметра, то цей статус буде відображатись лише на стороні ініціатора запиту (Отримувача документа);

  • for_all (опціонально) - якщо параметр передається, то статус створиться для всіх учасників документа.

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається вільний текст (причина, наприклад, для відхилення/відмови/анулювання)

RESPONSE

Код сервера 200 (ok).

Завантажити тіло документа/підпису GET /api/eds/doc/download

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/download

URL параметри

gln - String (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - String; GUID організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - UUID; UUID документа

file_name (опціонально) - String; назва файлу для завантаження

format (опціонально) - String; формат файлу для завантаження (якщо не вказано - ZIP); можливі варіанти:

  • XLS

  • PDF

  • XML

  • P7S

  • ZIP

response_type (опціонально) - String; формат відповіді сервера (якщо не вказано - file); можливі варіанти:

  • bytes - відповідь передається в бінарному вигляді;

  • file - відповідь передається у вигляді файла з розширенням

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/octet-stream

RESPONSE

У тілі відповідь передається тіло вказаного документа/підпису чи архів з усіма доступними форматами файлів.

Отримати XML контент документа GET /api/eds/doc/xml

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/xml

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа

response_type (опціонально) - формат очікуваної відповіді; можливі варіанти:

  • bytes - xml файл (за замовчуванням)

  • zip - архів, який містить xml файл і всі супровідні до нього файли (якщо документ типу COMDOC, то в архіві буде xml файл і всі його підписи)

  • base64 - xml файл в форматі Base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається XML контента документа (специфікації документів).

Отримати контент документа GET /api/eds/doc/body

За допомогою цього методу можливо швидко отримати контент документа без підписів/печаток, а також тіло підпису, тіло печатки.

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/body

URL параметри

gln (обов’язково) String (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні аккаунта

АБО

guid (обов’язково) String - унікальний ідентифікатор організації на платформі EDIN 2.0

doc_uuid (обов’язково) UUID - ідентифікатор документа;

body_type (обов’язково) String - тип тіла документа; можливі значення:

  • content - base64 контент без підписів/печаток;

  • json - json документа;

  • sign - base64 тіло підпису;

  • xml - тіло документа в xml форматі;

response_type (опціонально) String - формат очікуваної відповіді; можливі варіанти:

  • bytes (за замовчуванням)

  • file

  • base64

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається тіло документа в форматі, що визначається значенням параметра body_type.

Отримати ланцюжки вхідних документів POST /api/eds/chains/search

За допомогою цього методу можна зробити пошук ланцюжків по заданих критеріях.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/chains/search

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

status_id (опціонально) int - id папки документів:

  • 0 - Всі

  • 1 - Вхідні

  • 2 - Надіслані

  • 3 - Архівні

  • 4 - Чернетки

  • 5 - Важливі.

family (опціонально) String - назва сімейства документів:

  • edi

  • uzd

  • certificats

  • ats

  • ettn

  • distribex (Маркет)

  • simple-doc (Вільний)

  • tender

  • agreement

  • openprice (Є-Товар).

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації

RESPONSE

В тілі відповіді передається масив об’єктів XChain.

Отримати конкретний ланцюжок документів GET /api/eds/chain

Документи пов’язуються в один ланцюжок в тому випадку, якщо у них ідентичні значення полів Відправник, Одержувач, Покупець, Точка доставки (GLN-и) і Номер замовлення (якщо відсутній, то Номер документа).

EdsChain_01.png

За допомогою методу api/eds/chain і заданих параметрів можливо отримати (вивантажити) необхідні дані вказаного ланцюжка документів.

URL

  

Метод запиту

GET

URL запиту

/api/eds/chain

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

chain_uuid - рядок; ID ланцюжка

Опціональні url-параметри (boolean фільтри):

load_docs - чи завантажувати документи, що відносяться до ланцюжка

load_bodies - чи завантажувати тіла документів

load_package - чи завантажувати пакети

load_comments - чи завантажувати коментарі

load_tags - чи завантажувати теги до документів

load_statuses - чи завантажувати статуси до документів

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

Приклади url-запитів:

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=false&load_package=false&load_comments=false&load_tags=false&load_statuses=false

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=true&load_package=false&load_comments=true&load_tags=false&load_statuses=false

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=false&load_package=true&load_comments=false&load_tags=true&load_statuses=false

https://edo-v2.edin.ua/api/eds/chain?gln=9864232304302&chain_uuid=0fe60377-51db-4b7a-b7eb-cdf5fa91a46a&load_docs=true&load_bodies=false&load_package=false&load_comments=false&load_tags=false&load_statuses=true

RESPONSE

В тілі відповіді передається ланцюжок документів (об’єкт XChain).

Отримати інформацію (мета-дані) про документ GET /api/eds/doc

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта; АБО guid - рядок; унікальний ідентифікатор організації в системі

doc_uuid - рядок; UUID документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

У тілі відповідь передаються дані вказаного документа (об’єкт XDoc ).

Пошук документів (з фільтрацією), вибір списку документів POST /api/eds/docs/search

За допомогою цього методу можна зробити пошук по заданих критеріях, наприклад, отримати список документів з певним статусом або за проміжок часу.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/docs/search

URL параметри

gln (обов’язково) String - GLN власної Компанії АБО guid (обов’язково) String - унікальний ідентифікатор власної організації на платформі

status_id (опціонально) int - id папки документів:

  • 0 - Всі

  • 1 - Вхідні;

  • 2 - Надіслані;

  • 3 - Архівні;

  • 4 - Чернетки;

  • 5 - Важливі.

family (опціонально) String - назва сімейства документів:

  • edi

  • uzd

  • certificats

  • ats

  • ettn

  • distribex (Маркет)

  • simple-doc (Вільний)

  • tender

  • agreement

  • openprice (Є-Товар)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються обов’язкові та додаткові критерії пошуку/фільтрації

RESPONSE

В тілі відповіді передається масив документів.

Відправити документ (без створення чернетки) POST /api/eds/doc/create_and_send

Метод є універсальним для різних типів документів і дозволяє одночасно створити та відправити документ без створення чернетки.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/eds/doc/create_and_send

URL параметри

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_type - рядок; тип документа (опис параметру)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

multipart/form-data

REQUEST

  

JSON Body

В тілі запиту методу передєються тільки один файл-вкладення в форматі application/json чи application/xml чи application/pkcs7-signature (приклади запитів + специфікації документів)

При вказуванні application/pkcs7-signature доступна можливість обробки BASE64 формату.

RESPONSE

  • chain_uuid - ідентифікатор ланцюжка, в якому знаходиться документ

  • doc_uuid - ідентифікатор документа на платформі EDIN 2.0;

  • ticket_uuid - ідентифікатор квитанції

Параметр ticket_uuid система повертає тільки у випадках, коли на існуючий документ намагаються створити додатковий тікет (підписання у відповідь, відмова від підпису, запит на анулювання). Тобто, якщо документ новий, система поверне у відповідь тільки chain_uuid та doc_uuid.

Приклад відповіді (JSON):

{
  "chain_uuid": "7ccff78e-ea42-47ea-81e4-5508ed4fbd51",
  "doc_uuid": "3698b501-e1ef-464d-a71a-58066f556114",
  "ticket_uuid": "1003706c-3656-497b-9438-c6f33e27c36d"
}

 

Відправити чернетку PATCH /api/eds/doc/send

За допомогою цього методу можлива відправка чернетки (з додатковими особливостями відправки).

Наявність ритейлера при документообігу автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера).

REQUEST

URL

  

Метод запиту

PATCH

URL запиту

/api/eds/doc/send

URL параметри

gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії;

doc_uuid (обов’язково) String - унікальний ідентифікатор документа;

doc_hash (опціонально) - рядок; хеш документа;

chain_hash (опціонально) - рядок; хеш ланцюжка документів;

chain_uuid (опціонально) - рядок; ID ланцюжка документів;

partner_id (опціонально) - число; id торгової мережі (можливо отримати з довідника торгових мереж);

chain_type (опціонально) - число; тип ланцюжка документів;

  • 0 - звичайний

  • 2 - особлива схема - MATCH INVOICE (ТМ Фоззі)

  • 3 - особлива схема - не MATCH INVOICE (ТМ Фоззі)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу опціонально передаються додаткові поля

Виняток: при відправці

  • «Заявки на транспортування» / «Підтвердження транспортування» (TRANSPORTATIONORDER)

  • «Комерційних документів» (COMDOC)

  • «Накладних» (DOCUMENTINVOICE)

  • «Коригування до накладної» (DOCCORINVOICE)

в тілі запиту обов’язково передається параметр sub_status_id.

Приклад для відправки «Заявки на транспортування» / «Підтвердження транспортування» (TRANSPORTATIONORDER):

{"extra_fields":{"sub_status_id":"1"}}

RESPONSE

Код сервера 200 (ok).

Створити чернетку документа / Клонувати відправлений документ (COMDOC) POST /api/v2/eds/doc

За допомогою цього методу можливо створити чернетку документа (передається тіло документа) зазначеного типу (параметр doc_type) для вказаного одержувача АБО можливо клонувати відправлений документ (передається параметр clone_from_doc_uuid) в чернетку.

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc

URL параметри

gln (обов’язково) рядок (13) - номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_type (обов’язково/-) рядок - тип створюваного документа (опис параметру); даний параметр не передається при клонуванні документа (коли передається clone_from_doc_uuid параметр);

clone_from_doc_uuid (обов’язково/-) рядок - унікальний ідентифікатор вже відправленого документа (COMDOC) для клонування в чернетку (при цьому тіло передавати не обов’язково, а Content-Type=application/json); даний параметр не передається при створенні чернетки документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json або application/xml або application/pkcs7-signature

REQUEST

  

JSON Body

При створенні чернетки в тілі запиту методу передається документ у форматі JSON або XML або P7S в бінарному вигляді (приклад запиту (в тому числі й для створення CONDRA та TRANSPORTATIONORDER) + специфікації документів)

RESPONSE

В тілі відповіді передаються дані створеного документа (об’єкт XDoc ).

Отримати останню подію за документом GET /api/eds/docs/event/last

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/event/last

URL параметри

gln (обов’язково) String - GLN власної Компанії

doc_id (обов’язково) - ідентифікатор документа

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається остання подія за документом (об'єкт XEvent).

Отримати список подій GET /api/eds/docs/events

REQUEST

URL

  

Метод запиту

GET

URL запиту
/api/eds/docs/events

URL параметри

gln (обов’язково) String - GLN власної Компанії

from_id (обов'язково) long - ідентифікатор події, після якої (починаючи з наступної) необхідно отримати список наступних подій
grouped (опціонально) boolean:
  • true - згрупувати події за документами;
  • false - не групувати (за замовчуванням)

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

RESPONSE

В тілі відповіді передається список подій за документами (масив об'єктів XEvent).

Пошук подій POST /api/eds/docs/events

REQUEST

URL

  

Метод запиту

POST

URL запиту
/api/eds/docs/events

URL параметри

gln (обов’язково) String - GLN власної Компанії

Headers

  

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передаються параметри пошуку подій за документами

RESPONSE

В тілі відповіді передаються результати пошуку подій за документами (об’єкт EventsStorageQueryResult).