Skip to main content

Погодження

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

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

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

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

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/approval/scenario?gln=9864232319979&name=chupakabra

URL параметри

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

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

Headers

 

Authorization

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

Content-Type

application/json

REQUEST

 

JSON Body

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

RESPONSE

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

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

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

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

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/eds/doc/approval/scenario?gln=9864232319979&id=12345

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

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

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

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

PUT

URL запиту

/api/eds/doc/approval/scenario?gln=9864065732181&id=67

URL параметри

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

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

Headers

 

Authorization

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

Content-Type

application/json

REQUEST

 

JSON Body

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

RESPONSE

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

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

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

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

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

POST

URL запиту

/api/eds/doc/approval/step?gln=9864232319979&doc_uuid=b48aae9a-003a-453f-a40d-46d90181cdc7

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

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

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

REQUEST

URL

https://edo-v2.edin.ua

Метод запиту

GET

URL запиту

/api/eds/doc/approval/step?gln=9864232319979&doc_uuid=b48aae9a-003a-453f-a40d-46d90181cdc7

URL параметри

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

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

Headers

 

Authorization

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

Content-Type

application/json

RESPONSE

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