Skip to main content

Робота з квитанціями

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

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

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

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/tickets?doc_uuid=533c45ec-f51a-456a-a0f2-ba7b17f3b95b&gln=9864067620417&family=edi&file_name=155151&type=zip&loadBody=loadBody

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/signers

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/signers?gln=9864065160861&doc_uuid=1e55d353-89ac-4a3b-8419-ed540a534761&transaction_type=2

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/v2/eds/doc/signers

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/doc/signers?gln=9864065160861&doc_uuid=1e55d353-89ac-4a3b-8419-ed540a534761&transaction_type=1&transaction_type=2&transaction_type=11&transaction_type=12

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/ticket/body

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/eds/doc/ticket/body?doc_uuid=533c45ec-f51a-456a-a0f2-ba7b17f3b95b&transaction_type=1&body_type=-1&gln=9864067620417&family=edi

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/repeal

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

REQUEST

URL

  

Метод запиту

GET

URL запиту

/api/v2/eds/doc/repeal?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82

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_019 для анулювання Комерційних документів (COMDOC)

  • DOCUMENTINVOICE з DocumentFunctionCode=RPLN і сегментом Repealer для анулювання накладних DOCUMENTINVOICE

  • TRANSPORTATIONORDER для анулювання «Заявки на транспортування» / «Підтвердження заявки на транспортування»

в 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?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82

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)».

Створення на сервері квитанції «Повідомлення про відмову від підписання документу» (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?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82

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 для анулювання Комерційних документів (COMDOC)

  • DOCUMENTINVOICE з DocumentFunctionCode=CNCL і сегментом Repealer для анулювання накладних DOCUMENTINVOICE

  • TRANSPORTATIONORDER для анулювання «Заявки на транспортування» / «Підтвердження заявки на транспортування»

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

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

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

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/ticket?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

URL параметри

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

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

Headers

  

Authorization

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

Content-Type

application/json

REQUEST

  

JSON Body

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

RESPONSE

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

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

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

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

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

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

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

  • відкликаний (в документа є квитанція №14)

  • відмовлений (в документа є квитанція №13)

  • анульований (в документа є квитанція №12)

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

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

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/accept?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

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"
}
Створення квитанції №11 (запит на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER)
POST /api/v2/eds/doc/repeal

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

  • відкликаний (в документа є квитанція №14)

  • відмовлений (в документа є квитанція №13)

  • запрошено анулювання (в документа є квитанція №11)

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

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/repeal?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

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"
}
Створення квитанції №12 (прийняття запиту на анулювання COMDOC/DOCUMENTINVOICE/TRANSPORTATIONORDER)
POST /api/v2/eds/doc/repeal/accept

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

  • анульовано (у документа є квитанція №12)

  • відсутнє запрошення анулювання (в документа відсутня квитанція №11)

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

REQUEST

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/doc/repeal/accept?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

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"
}

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

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

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

  • відкликаний (в документа є квитанція №14)

  • відмовлений (в документа є квитанція №13)

  • анульований (в документа є квитанція №12)

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

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

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

Варіант 1:

URL

  

Метод запиту

POST

URL запиту

/api/v2/eds/comdoc/reject?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

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?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&autoGenerate

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"
}
Створення квитанції №14 (відкликати підписання документа COMDOC/TRANSPORTATIONORDER)

 

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

 

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

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

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

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

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

  • відкликаний (в документа є квитанція №14)

  • відмовлений (в документа є квитанція №13)

  • анульований (в документа є квитанція №12)

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

Значення [ЕлектроннийДокумент/Відхилив/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?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&autoGenerate

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"
}

Back to top