# API сервісу Вільний

# Перелік методів API сервісу Вільний

<p class="callout info">Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: [https://edo-v2.edin.ua](https://edo-v2.edin.ua/)</p>

<p class="callout warning">Для роботи з цими методами користувач повинен бути [авторизованим](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi).</p>

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

<table border="1" id="bkmrk-%D0%A1%D1%82%D0%B2%D0%BE%D1%80%D0%B8%D1%82%D0%B8-%D1%81%D0%B5%D1%80%D1%82%D0%B8%D1%84%D1%96%D0%BA%D0%B0%D1%82-" style="width: 98.9286%;"><tbody><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Створити документ з метаданими (чернетку)

</td><td style="width: 40.9029%;">[POST /api/sd/eds/doc](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-dokument-z-metadanimi-cernetku-post-apisdedsdoc)</td></tr><tr><td style="width: 59.0631%;">Отримати документ

</td><td style="width: 40.9029%;">[GET /api/sd/eds/doc](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dokument-get-apisdedsdoc)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Редагувати метадані документа (чернетка)

</td><td style="width: 40.9029%;">[PATCH /api/sd/eds/doc](https://wiki-v2.edin.ua/books/robota-z-api/page/redaguvati-metadani-dokumenta-cernetka-patch-apisdedsdoc)</td></tr><tr><td style="width: 59.0631%;">Видалити документ (чернетку)

</td><td style="width: 40.9029%;">[DELETE /api/sd/eds/doc](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-dokument-cernetku-delete-apisdedsdoc)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Відхилити вхідний документ

</td><td style="width: 40.9029%;">[POST /api/sd/eds/doc/decline](https://wiki-v2.edin.ua/books/robota-z-api/page/vidxiliti-vxidnii-dokument-post-apisdedsdocdecline)</td></tr><tr><td style="width: 59.0631%;">Завантажити документ (zip-архів)

</td><td style="width: 40.9029%;">[GET /api/sd/eds/doc/zip](https://wiki-v2.edin.ua/books/robota-z-api/page/zavantaziti-dokument-zip-arxiv-get-apisdedsdoczip)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Отримати метадані документа

</td><td style="width: 40.9029%;">[GET /api/sd/eds/doc/body](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-metadani-dokumenta-get-apisdedsdocbody)</td></tr><tr><td style="width: 59.0631%;">Відправити документ (чернетку)

</td><td style="width: 40.9029%;">[PATCH /api/sd/eds/doc/send](https://wiki-v2.edin.ua/books/robota-z-api/page/vidpraviti-dokument-cernetku-patch-apisdedsdocsend)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Відмітити документа, як «важливий» / «звичайний»

</td><td style="width: 40.9029%;">[PATCH /api/sd/eds/doc/important](https://wiki-v2.edin.ua/books/robota-z-api/page/vidmititi-dokument-iak-vazlivii-zvicainii-patch-apisdedsdocimportant)</td></tr><tr><td style="width: 59.0631%;">Отримати список документів

</td><td style="width: 40.9029%;">[POST /api/sd/eds/docs/search](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-spisok-dokumentiv-post-apisdedsdocssearch)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;"><span class="doc">Додати отримувача до відправленого документа</span>

</td><td style="width: 40.9029%;">[PATCH /api/sd/eds/doc/send/recipients](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-otrimuvaca-do-vidpravlenogo-dokumenta-patch-apisdedsdocsendrecipients)</td></tr></tbody></table>

##### **Робота з файлами (вкладення до документа)**

<table border="1" id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-%D0%BC%D0%B5%D1%82%D0%B0%D0%B4%D0%B0%D0%BD%D1%96-%D0%B4%D0%BE" style="width: 98.9286%;"><tbody><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Додати файл до документа-чернетки

</td><td style="width: 40.9029%;">[POST /api/sd/eds/doc/attachment](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-fail-do-dokumenta-cernetki-post-apisdedsdocattachment)</td></tr><tr><td style="width: 59.0631%;">Отримати файл-вкладення

</td><td style="width: 40.9029%;">[GET /api/sd/eds/doc/attachment](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-fail-vkladennia-get-apisdedsdocattachment)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Видалити файл-вкладення (чернетка)

</td><td style="width: 40.9029%;">[DELETE /api/sd/eds/doc/attachment](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-fail-vkladennia-cernetka-delete-apisdedsdocattachment)</td></tr></tbody></table>

##### **Підписання**

<table border="1" id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-%D0%BC%D0%B5%D1%82%D0%B0%D0%B4%D0%B0%D0%BD%D1%96-%D0%B4%D0%BE-2" style="width: 98.9286%;"><tbody><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Підписати документ</td><td style="width: 40.9029%;">[POST /api/sd/eds/doc/sign](https://wiki-v2.edin.ua/books/robota-z-api/page/pidpisati-dokument-post-apisdedsdocsign)</td></tr><tr><td style="width: 59.0631%;">Отримати дані про підписання файлу-вкладення</td><td style="width: 40.9029%;">[GET /api/sd/eds/doc/sign](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dani-pro-pidpisannia-failu-vkladennia-get-apisdedsdocsign)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Створення та відправка документа (без створення чернетки)</td><td style="width: 40.9029%;">[POST /api/sd/eds/doc/create\_and\_send](https://wiki-v2.edin.ua/books/robota-z-api/page/stvorennia-ta-vidpravka-dokumenta-bez-stvorennia-cernetki-post-apisdedsdoccreate-and-send)</td></tr></tbody></table>

##### **Робота з довідниками**

<table border="1" id="bkmrk-%D0%92%D1%96%D0%B4%D0%BC%D1%96%D1%82%D0%B8%D1%82%D0%B8-%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%2C-2" style="width: 98.9286%;"><tbody><tr style="background-color: rgb(236, 240, 241);"><td style="width: 67.2162%;">Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону

</td><td style="width: 32.7597%;">[GET /api/oas/v2/employees/search](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimannia-danix-kontragenta-za-imiam-ipn-email-jedrpou-nomerom-telefonu-get-apioasv2employeessearch)</td></tr></tbody></table>

##### **Контрагенти**

<table border="1" id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-%D0%BC%D0%B5%D1%82%D0%B0%D0%B4%D0%B0%D0%BD%D1%96-%D0%B4%D0%BE-4" style="width: 98.9286%;"><tbody><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Додати в сервіс дані нового контрагента / Редагувати дані контрагента</td><td style="width: 40.9029%;">[POST/api/oas/partner](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-v-servis-dani-novogo-kontragenta-redaguvati-dani-kontragenta-postapioaspartner)</td></tr><tr><td style="width: 59.0631%;">Отримати дані контрагента (розділ «Контрагенти»)</td><td style="width: 40.9029%;">[GET /api/oas/partner](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-dani-kontragenta-rozdil-kontragenti-get-apioaspartner)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Завантажити в сервіс список контрагентів з Excel</td><td style="width: 40.9029%;">[POST /api/oas/partners](https://wiki-v2.edin.ua/books/robota-z-api/page/zavantaziti-v-servis-spisok-kontragentiv-z-excel-post-apioaspartners)</td></tr><tr><td style="width: 59.0631%;">Отримати список контрагентів (розділ «Контрагенти»)</td><td style="width: 40.9029%;">[GET /api/oas/partners](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-spisok-kontragentiv-rozdil-kontragenti-get-apioaspartners)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Відправити запрошення контрагентам</td><td style="width: 40.9029%;">[POST /api/eds/doc/statuses](https://wiki-v2.edin.ua/books/robota-z-api/page/vidpraviti-status-dokumenta-post-apiedsdocstatuses)</td></tr></tbody></table>

##### **Робота з тегами**

<table border="1" id="bkmrk-%D0%92%D1%96%D0%B4%D1%85%D0%B8%D0%BB%D0%B8%D1%82%D0%B8-%D0%B2%D1%85%D1%96%D0%B4%D0%BD%D0%B8%D0%B9-%D0%B4%D0%BE" style="width: 98.9286%;"><tbody><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Створити новий тег</td><td style="width: 40.9029%;">[POST /api/sd/eds/employee/tags](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-novii-teg-post-apisdedsemployeetags)</td></tr><tr><td style="width: 59.0631%;">Отримати теги</td><td style="width: 40.9029%;">[GET /api/sd/eds/employee/tags](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-tegi-get-apisdedsemployeetags)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Редагувати тег</td><td style="width: 40.9029%;">[PUT /api/sd/eds/employee/tags](https://wiki-v2.edin.ua/books/robota-z-api/page/redaguvati-teg-put-apisdedsemployeetags)</td></tr><tr><td style="width: 59.0631%;">Видалити тег</td><td style="width: 40.9029%;">[DELETE /api/sd/eds/employee/tags](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-teg-delete-apisdedsemployeetags)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td style="width: 59.0631%;">Додати теги до документа</td><td style="width: 40.9029%;">[POST /api/sd/eds/doc/tags](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-tegi-do-dokumenta-post-apisdedsdoctags)</td></tr><tr><td style="width: 59.0631%;">Вилучити теги з документа</td><td style="width: 40.9029%;">[DELETE /api/sd/eds/doc/tags](https://wiki-v2.edin.ua/books/robota-z-api/page/viluciti-tegi-z-dokumenta-delete-apisdedsdoctags)</td></tr></tbody></table>

# Помилки при роботі з API

Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за [посиланням](https://wiki-v2.edin.ua/books/robota-z-api/page/zagalni-pomilki-pri-roboti-z-api-vsi-servisi-edin-SLH).

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

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-d"><table class="colwidths-given docutils align-default" style="width: 97.381%;"><colgroup><col style="width: 18.5126%;"></col><col style="width: 81.4552%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>DELETE

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/tags**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (обов’язково) UUID - унікальний ідентифікатор користувача

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

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту передається масив об’єктів: [тегів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xtag) для видалення.

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Додати теги до документа POST /api/sd/eds/doc/tags

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 97.7381%;"><colgroup><col style="width: 18.5126%;"></col><col style="width: 81.4552%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/tags**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (обов’язково) UUID - унікальний ідентифікатор користувача

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

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту передається масив об’єктів: [тегів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xtag) для додавання.

</td></tr></tbody></table>

</div>**RESPONSE**

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

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

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-d"><table class="colwidths-given docutils align-default" style="width: 97.619%;"><colgroup><col style="width: 18.5126%;"></col><col style="width: 81.4552%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>DELETE

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/employee/tags**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (обов’язково) UUID - унікальний ідентифікатор користувача

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту передається масив ідентифікаторів тегів до видалення.

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

```json
[2, 10, 12]
```

</td></tr></tbody></table>

</div>**RESPONSE**

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

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

<p class="callout info">Назва тегу повинна бути унікальною й довжиною не більше 20 символів.</p>

<div class="document" id="bkmrk-request-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section"><div class="admonition important">**REQUEST**</div><div class="wy-table-responsive"><table class="colwidths-given docutils align-default" style="width: 99.6429%;"><colgroup><col style="width: 17.7689%;"></col><col style="width: 82.2002%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>PUT

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/employee/tags**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (обов’язково) UUID - унікальний ідентифікатор користувача

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту (json) передається масив об’єктів: [тегів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xtag) з відредагованими назвами.

</td></tr></tbody></table>

</div></div></div></div>**RESPONSE**

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

<div class="document" id="bkmrk-" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section" id="bkmrk--1"></div></div></div>

# Отримати теги GET /api/sd/eds/employee/tags

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default" style="width: 97.381%;"><colgroup><col style="width: 16.7662%;"></col><col style="width: 83.2093%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/employee/tags**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (обов’язково) UUID - унікальний ідентифікатор користувача

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

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передається список (масив) [тегів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xtag).

# Створити новий тег POST /api/sd/eds/employee/tags

<p class="callout info">Назва тегу повинна бути унікальною й довжиною не більше 20 символів.</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 99.0476%;"><colgroup><col style="width: 18.5126%;"></col><col style="width: 81.4552%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/employee/tags**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (обов’язково) UUID - унікальний ідентифікатор користувача

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

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

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

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

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передається масив [створених тегів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xtag).

# Отримати список контрагентів (розділ «Контрагенти») GET /api/oas/partners

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/partners**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**limit** (опціонально) int - ліміт вибірки (за замовчуванням=50);

**offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0);

**pattern** (опціонально) String - пошукове значення (фільтр по даним контрагентів);

**registration\_status** (опціонально) int - статус реєстрації; 0 - незарестрований, 1 - зареєстрований;

**invitation\_status** (опціонально) int - статус запрошення; 0 - запрошення не відправлено, 1 - запрошення відправлено

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається [масив об’єктів з даними контрагентів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-partner-dani-kontragentiv).

# Завантажити в сервіс список контрагентів з Excel POST /api/oas/partners

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 78.5714%;"><colgroup><col style="width: 19.802%;"></col><col style="width: 80.1599%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/partners**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-odd"><td>**REQUEST**

</td><td> </td></tr><tr class="row-even"><td>JSON Body

</td><td>В тілі запиту передається [масив об’єктів з даними контрагентів](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-partner-dani-kontragentiv)

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передаються [завантажені в сервіс контрагенти та контрагенти з помилковими даними (потребують правок)](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-partner-dani-kontragentiv).

# Отримати дані контрагента (розділ «Контрагенти») GET /api/oas/partner

**REQUEST**

<div class="document" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section"><div class="wy-table-responsive"><table class="colwidths-given docutils align-default" style="width: 79.0476%;"><colgroup><col style="width: 21.1201%;"></col><col style="width: 79.0005%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/partner**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**partner\_id** int(10) - id контрагента

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div></div></div></div>**RESPONSE**

В тілі **відповіді** (json) передається [об’єкт з даними контрагента](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-partner-dani-kontragentiv).

<div class="document" id="bkmrk-" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section" id="bkmrk--1"></div></div></div>

# Додати в сервіс дані нового контрагента / Редагувати дані контрагента POST/api/oas/partner

<p class="callout info">Вибір дії (додавання або редагування): якщо в тілі запиту (json) присутній ідентифікатор контрагента (параметр **id**), то такий контрагент підлягає редагуванню (дані оновляться). Відсутність в запиті параметра **id** веде до створення (додавання в сервіс) нового контрагента.</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 80.2381%;"><colgroup><col style="width: 22.2127%;"></col><col style="width: 77.7446%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/partner**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-odd"><td>**REQUEST**

</td><td> </td></tr><tr class="row-even"><td>JSON Body

</td><td>В тілі запиту передається [об’єкт з даними контрагента](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-partner-dani-kontragentiv)

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передається [об’єкт з даними контрагента](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-partner-dani-kontragentiv).

# Отримання даних контрагента за ім’ям / ІПН / email / ЄДРПОУ / номером телефону GET /api/oas/v2/employees/search

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default" style="width: 97.7381%;"><colgroup><col style="width: 16.3074%;"></col><col style="width: 83.6642%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/v2/employees/search**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**query** (обов’язково) String - текст пошуку (ім’я / ІПН / email / ЄДРПОУ / номер телефону)

**by\_company** (опціонально) int - фільтр пошуку:

- 0 - пошук серед контрагентів компанії;
- 1 - пошук серед контрагентів компанії і її співробітників

**by\_alias** (опціонально) int - фільтр пошуку:

- 0 - пошук контрагентів без аліасів;
- 1 - пошук контрагентів включаючи аліаси

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** передається масив з даними про контрагентів (об’єктів [Employee](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-employee) ).

# Створення та відправка документа (без створення чернетки) POST /api/sd/eds/doc/create_and_send

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 100%;"><colgroup><col style="width: 14.5306%;"></col><col style="width: 85.4455%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/create\_and\_send**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>[multipart/form-data](https://tools.ietf.org/html/rfc7578)

</td></tr><tr class="row-odd"><td>**REQUEST**

</td><td> </td></tr><tr class="row-even"><td>JSON Body

</td><td>В тілі запиту методу обов’язково передаються два файли (+ додатково можуть передаватись підписи):

- **Тіло документа** - json файл, що містить дані про отримувачів, тему документа, повідомлення. Назва файлу повинна бути з префіксом *\_doc\_body\_*, наприклад: **\_doc\_body\_vilniy-doc.json**. Детальніше: [Метадані документа](https://wiki-v2.edin.ua/books/robota-z-api/page/metadani-dokumenta);
- **Файли для відправки** - не більше 10 файлів в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/CSV/TXT/XML/P7S з розміром файлу не більше 5 Мб. Назви файлів повинні бути з префіксом *\_doc\_file\_*, наприклад: **\_doc\_file\_dogovir.txt**;
- **Підписи** - підписи до файлів (опціонально). Назви файлів підписів повинні бути з префіксом *\_doc\_sign\_file\_name*, де *file\_name* - це назва файлу, до якого відноситься підпис, наприклад: **\_doc\_sign\_dogovir.txt1.p7s** та **\_doc\_sign\_dogovir.txt2.p7s**.

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Отримати дані про підписання файлу-вкладення GET /api/sd/eds/doc/sign

**REQUEST**

<div class="document" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section"><div class="wy-table-responsive"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/sign**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**attachment\_uuid** (обов’язково) UUID - ідентифікатор файла-вкладення;

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div></div></div></div>**RESPONSE**

В тілі **відповіді** (json) передається список uuid-ів Відправника і Отримувачів документа з масивами [даних про підписи](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-exendusersigninfo-dani-pidpisantiv-dokumenta) для кожного uuid відповідно.

<div class="document" id="bkmrk-" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section" id="bkmrk--1"></div></div></div>

# Підписати документ POST /api/sd/eds/doc/sign

<p class="callout info">Для підписання документ повинен містити файл/файли.</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/sign**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа;

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа;

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту (json) передається список uuid-ів вкладених файлів з масивом підписів (BASE64) для підписання цих файлів.

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

```json
{
  "6616bce2-2b48-4f24-b636-652c3da0a853": [
    "MIIORwYJK...yBXJjg="
  ],
  "5152f5d1-e1e4-4a60-be5c-b8118d93d594": [
    "MIIOR...I0lU="
  ]
}
```

</td></tr></tbody></table>

</div>**RESPONSE**

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

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

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-d"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>DELETE

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/attachment**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**attachment\_uuid** (обов’язково) UUID - ідентифікатор файла-вкладення

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

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

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

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/attachment**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**attachment\_uuid** (обов’язково) UUID - ідентифікатор файла-вкладення;

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

**response\_type** (опціонально) String - формат очікуваної відповіді сервера; можливі варіанти:

- bytes - файл передається в бінарному вигляді;
- file - відповідь передається у вигляді файла з розширенням;
- base64 - файл в форматі Base64;
- pdf - файл в форматі pdf;
- zip - архів, який містить файл;
- print - прінт-форма файла

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

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

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

<p class="callout info">Один документ може містити не більше 10 файлів в наступних форматах: PDF/JPG/JPEG/PNG/BMP/DOC/DOCX/XLS/XLSX/PPT/PPTX/CSV/TXT/XML/P7S (попередній перегляд працює лише для PDF/JPG/JPEG/PNG/BMP/TXT/XML) з розміром файлу не більше 5 Мб. Назва файла не повинна перевищувати 100 символів.</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 99.7619%;"><colgroup><col style="width: 14.0943%;"></col><col style="width: 85.8819%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/attachment**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>multipart/form-data

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>Form-data

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

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

```json
boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="222"; filename="1613574143975.png"
Content-Type: image/png

(data)
----WebKitFormBoundary7MA4YWxkTrZu0gW
```

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передаються [дані файла-вкладення](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdocattachment) (об'єкт XDocAttachment).

<div class="document" id="bkmrk-" itemscope="itemscope" itemtype="http://schema.org/Article" role="main"><div itemprop="articleBody"><div class="section" id="bkmrk--1"></div></div></div><footer id="bkmrk--2"><div aria-label="Footer" class="rst-footer-buttons" role="navigation">  
</div></footer>

# Додати отримувача до відправленого документа PATCH /api/sd/eds/doc/send/recipients

<p class="callout info">Лише Відправник документа має можливість додавати нових контрагентів. Додавання отримувачів до вже відправленого документа можливо поки документ (оригінал) знаходиться в статусі **Очікує підпису** / **Підписано частково** ([детальніше про статуси документів](https://wiki.edin.ua/uk/latest/Vilnyi/Work_with_Vilnyi.html#doc-statuses)).</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 100%;"><colgroup><col style="width: 14.7743%;"></col><col style="width: 85.2019%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>PATCH

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/send/recipients**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>**REQUEST**

</td><td> </td></tr><tr class="row-even"><td>JSON Body

</td><td>В тілі запиту (json) передається:

- масив UUID користувачів (нових отримувачів): `<span class="pre">['92e62300-74bd-43e8-9db7-48481cd5bbbc']</span>`

АБО

- масив e-mail адрес для незареєстрованих на платформі EDIN користувачів: `<span class="pre">['fff@lll.com','ukr@ukr.ukr']</span>`

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Отримати список документів POST /api/sd/eds/docs/search

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/docs/search**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту (json) передаються [дані для фільтрації (об’єкт StorageQuery)](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-storagequery-dani-dlia-filtraciyi)

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передається масив з [відібраними документами](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdoc).

# Відмітити документ, як «важливий» / «звичайний» PATCH /api/sd/eds/doc/important

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>PATCH

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/important**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа;

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа;

**important** (обов’язково) boolean:

- true - відмітити документ, як важливий
- false - відмітити документ, як звичайний

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Відправити документ (чернетку) PATCH /api/sd/eds/doc/send

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 78.6905%;"><colgroup><col style="width: 23.3171%;"></col><col style="width: 76.6423%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>PATCH

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/send**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Отримати метадані документа GET /api/sd/eds/doc/body

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/body**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа;

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа;

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

- **bytes** (за замовчуванням)
- **file**
- **base64**

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** (json) передаються [метадані документа](https://wiki-v2.edin.ua/books/robota-z-api/page/metadani-dokumenta).

# Завантажити документ (zip-архів) GET /api/sd/eds/doc/zip

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/zip**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконується обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** передається документ (zip-архів). Детальніше про [завантаження](https://wiki.edin.ua/uk/latest/Vilnyi/Work_with_Vilnyi.html#mass-operations).

# Відхилити вхідний документ POST /api/sd/eds/doc/decline

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 97.7381%;"><colgroup><col style="width: 18.2193%;"></col><col style="width: 81.749%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc/decline**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту передається текст причини відхилення.

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

```
Невірно складений договір, орфографічні помилки
```

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Видалити документ (чернетку) DELETE /api/sd/eds/doc

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-d"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>DELETE

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

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

# Редагувати метадані документа (чернетка) PATCH /api/sd/eds/doc

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 99.7619%;"><colgroup><col style="width: 14.3329%;"></col><col style="width: 85.6432%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>PATCH

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>multipart/form-data

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту передається json файл з [метаданими документа](https://wiki-v2.edin.ua/books/robota-z-api/page/metadani-dokumenta)

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

```json
boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="acceptance.json"
Content-Type: application/json

{"receivers":["831714cf-064b-4ce9-bdc4-b6a79784639c"],"title":"rock&roll123","text":"text povidomlennya"}
----WebKitFormBoundary7MA4YWxkTrZu0gW
```

</td></tr></tbody></table>

</div><div class="highlight-json notranslate" id="bkmrk-"><div class="highlight"></div></div>**RESPONSE**

В тілі **відповіді** (json) передається **doc\_uuid** - унікальний ідентифікатор документа:

```
{"doc_uuid":"023403f8-9201-41f2-8c18-cf4777a058fc"}
```

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

**REQUEST**

<table class="colwidths-given docutils align-default" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**doc\_uuid** (обов’язково) UUID - ідентифікатор документа

**employee\_uuid** (опціонально) UUID - ідентифікатор співробітника, під яким виконуються обробка документа

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

**RESPONSE**

В тілі **відповіді** (json) передаються [дані документа](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdoc) (об'єкт XDoc).

# Створити документ з метаданими (чернетку) POST /api/sd/eds/doc

**REQUEST**

<table class="colwidths-given docutils align-default" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p" style="width: 98.3333%;"><colgroup><col style="width: 15.8793%;"></col><col style="width: 84.0965%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/sd/eds/doc**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>multipart/form-data

</td></tr><tr class="row-odd"><td>**REQUEST**

</td><td> </td></tr><tr class="row-even"><td>JSON Body

</td><td>В тілі запиту передається json файл з [метаданими документа](https://wiki-v2.edin.ua/books/robota-z-api/page/metadani-dokumenta)

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

```json
boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="acceptance.json"
Content-Type: application/json

{"receivers":["831714cf-064b-4ce9-bdc4-b6a79784639c"],"title":"rock&roll123","text":"text povidomlennya"}
----WebKitFormBoundary7MA4YWxkTrZu0gW
```

</td></tr></tbody></table>

**RESPONSE**

В тілі **відповіді** (json) передається **doc\_uuid** - унікальний ідентифікатор документа:

```
{"doc_uuid":"023403f8-9201-41f2-8c18-cf4777a058fc"}
```