EDIN | Електронний документообіг для бізнесу

Зміст:

Інструкції

Інструкція з авторизації

---

Зміст:

• Інструкція з авторизації

  • 1 Реєстрація користувача

  • 2 Авторизація

  • 3 Відновлення пароля

  • 4 Зміна пароля

  • 5 Зміна Email

---

Дана інструкція описує порядок реєстрації та авторизації на web-платформі EDIN-DOCflow, процедуру відновлення та зміни пароля, порядок зміни Email.

Примітка

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

1 Реєстрація користувача

Виберіть той спосіб реєстрації, який вам до вподоби.

Ви можете з легкістю зареєструватися на платформі за допомогою свого почтового аккаунта Gmail або Microsoft - для цього натисніть на відповідний значок Авторизація з Google або Авторизація з Microsoft на формі авторизації. Після завантаження платформи, для продовження роботи в сервісі підтвердіть згоду на обробку персональніх данних та створіть компанію за допомогою ЕЦП/КЕП або токена.

Зверніть увагу!

Email використовується платформою як унікальний логін користувача (один Email можна використати лише одноразово). Після того як ви зареєструвалися та створили компанію за допомогою Gmail, якщо при авторизації ви виберете інший поштовий аккаунт - на платформі створиться новий аккаунт без налаштувань.

Для реєстрації в сервісі перейдіть за посиланням http://doc.edin.ua. У формі авторизації натисніть «Зареєструватися»:

Далі заповніть форму реєстрації, що містить наступні поля:

• Email – обов’язкове для заповнення поле. На вказану адресу буде надіслано листа для підтвердження реєстрації. Вказаний Email в подальшому буде використовуватись як логін користувача. Якщо дане поле не заповнене, система повідомить про помилку.

• ПІБ (Прізвище, Ім’я, По-батькові) – обов’язкове для заповнення поле. Внесена інформація зберігається в особистому профілі користувача.

• Номер телефону* – обов’язкове для заповнення поле. Внесена інформація зберігається в особистому профілі користувача. Номер телефону користувача заповнюється у форматі +380 (00) 000-00-00.

Наступним кроком проставте відмітку у чекбоксі «Погоджуюся на обробку персональних даних та з умовами договору-оферти». Відповідно до Закону України «Про захист персональних даних» від 01.06.2010 No2297-VI, встановлення даної відмітки є обов’язковою передумовою для старту роботи на платформі.

Ви можете ознайотися з текстом Угоди перейшовши за посиланням в тексті «Погоджуюся на обробку персональних даних»:

Після заповнення форми реєстрації натисніть «Реєстрація»:

Система повідомить про відправку реєстраційного листа на вказану в полі Email адресу:

Для підтвердження реєстрації перейдіть за посиланням у реєстраційному листі. Відправник листа - noreply@edin.ua, тема – «EDIN-DOCFLOW Підтвердження реєстрації».

У формі продовження реєстрації, у полі ПІБ, вкажіть ім’я користувача (обов’язково), введіть і підтвердіть пароль. Для створення безпечного пароля дотримуйтесь наступних рекомендацій:

• мінімальна кількість символів – шість

• уникайте повторення того ж самого символу (для прикладу – аааааа, 11111)

• уникайте послідовностей літер або цифр (для прикладу 123456)

• не використовуйте особисту інформацію (для прикладу – ім’я, прізвище, рік народження)

• не використовуйте паролі до інших інтернет-сервісів.

Зверніть увагу!

Email використовується платформою як унікальний логін користувача (один Email можна використати лише одноразово).

У разі введення вже зареєстрованого Email система повідомить про помилку.

Після підтвердження пароля на формі активуються кнопки «Реєстрація» та «Реєстрація з ЕЦП»:

При натисканні на кнопку «Реєстрація» відбувається стандартний процес реєстрації, після чого користувач потрапляє на форму авторизації (п.2 даної інструкції). Кнопка «Реєстрація з ЕЦП/КЕП» дозволяє виконати всі налаштування, необхідні для старту роботи у сервісі (рекомендовано за наявності ЕЦП на момент реєстрації).

При натисканні на кнопку «Реєстрація з ЕЦП/КЕП» відкривається форма вибору ключа. Оберіть потрібний файл підпису в каталозі на жорсткому диску ПК чи на іншому носії та введіть пароль від нього. Зазвичай ключ - це файл у форматі dat (Key-6.dat), zs2, sk, jks, pk8, pfx:

Обраний ключ відобразиться на формі реєстрації. Водночас з’явиться можливість змінити ключ, натиснувши на відповідну кнопку. Наступним кроком проставте відмітку у чекбоксі «Погоджуюсь на умови «договору-оферти» і натисніть «Зчитати ключ»:

У разі успішного зчитування в окремому вікні відобразиться інформація про ключ:

Для закінчення реєстрації натисніть «Підтвердити». Перевагою вибору реєстрації з ЕЦП/КЕП буде автоматичне створення компанії і погодження з умовами договору-оферти, що є передумовою швидкого старту роботи у сервісі.

2 Авторизація

Для авторизації на платформі перейдіть за посиланням http://doc.edin.ua/auth, введіть свій логін = Email та натисніть «Далі», або натисніть Авторизація з Google та виберіть пошту за допомогою якої ви реєструвалися:

Наступним кроком встановіть відмітку «Я не робот», вкажіть пароль та натисніть кнопку «Увійти»:

Якщо логін або пароль вказаний невірно, система повідомить про помилку.

Зверніть увагу!

Відповідно до політики безпеки максимальна кількість спроб авторизації – три. Якщо логін або пароль тричі вказаний невірно, система заблокує користувача на 5 хвилин.

У сервісі також реалізована можливість встановити інший строк блокування користувача (мінімальне значення – 3 хвилини, максимальне – 24 години) у межах налаштування параметрів парольної політики. Детальніше про налаштування парольної політики в «Інструкції адміністратора користувачів».

3 Відновлення пароля

Для відновлення пароля натисніть на сторінці авторизації «Нагадати пароль»:

Далі вкажіть Email (логін користувача), встановіть відмітку «Я не робот» і натисніть «Відновити»:

Система повідомить про успішну відправку листа на вказану адресу Email.

Зверніть увагу!

Для відновлення пароля необхідно ввести Email (=логін), вказаний при реєстрації користувача.

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

Наступним кроком перейдіть за посиланням у листі, отриманому на вказану адресу. Відправник листа - noreply@edin.ua, тема – «EDIN-DOCFLOW Відновлення пароля».

Система відобразить вікно створення пароля. На формі двічі вкажіть новий пароль і натисніть «Зберегти»:

4 Зміна пароля

Для зміни пароля натисніть на логін користувача у верхньому правому куті інтерфейсу та натисніть кнопку «Скинути пароль»:

Система повідомить про успішне скасування пароля та відправить листа для генерації нового пароля на Email користувача.

Для зміни пароля перейдіть за посиланням у листі та вкажіть новий пароль (двічі):

Відправник: - noreply@edin.ua. Тема листа: «EDIN-DOCFLOW Відновлення пароля».

Зверніть увагу!

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

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

5 Зміна Email

Для зміни Email перейдіть на форму редагування облікового запису користувача (меню «Налаштування узгодження» - «Користувачі») і натисніть «Редагувати».

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

Зверніть увагу!

Після збереження змін доступ до сервісу під старим Email буде заблокований.

На нову адресу надійде лист з посиланням для підтвердження зміни Email та генерації пароля.

Для завершення процедури зміни Email перейдіть за посиланням у листі та вкажіть новий пароль у формі генерації пароля.

На стару адресу Email надійде інформаційне повідомлення про зміну електронної адреси. Відправник: - noreply@edin.ua, тема листа: «EDIN-DOCFLOW. Відновлення пароля».

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інструкція з налаштування ЕЦП/КЕП

---

Зміст:

• Інструкція з налаштування ЕЦП/КЕП

  • 1 Терміни та визначення

  • 2 Авторизація в системі

  • 3 Налаштування електронного підпису

  • 4 Налаштування Апаратного ключа (Токен)

---

Дана інструкція описує порядок завантаження та налаштування електронного цифрового підпису.

---

1 Терміни та визначення

Електронний цифровий підпис (ЕЦП/КЕП) — електронний цифровий підпис уповноважених осіб та окремий електронний цифровий підпис, що виконує функцію печатки (у разі наявності), з посиленим сертифікатом ключа, наданим акредитованими центрами сертифікації ключів (далі – АЦСК).

Токен – це носій інформації у формі флешки із захистом від несанкціонованого доступу при генерації секретних ключів, зберіганні цифрового підпису та підписанні електронних документів.

2 Авторизація в системі

Для авторизації на платформі перейдіть за посиланням https://doc.edin.ua/auth та введіть свої логін (email) і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Налаштування електронного підпису

Для підписання та шифрування документів необхідно, щоб у системі користувача були зчитані (завантажені) ключі підписів.

3.1 Зчитування ключа

Для налаштування ключів перейдіть до розділу «Налаштування ЕЦП/КЕП». Натискання ініціалізує бібліотеку підписання:

У формі налаштування ключів виберіть формат ключа - токен або файловий ключ. Спочатку додамо файловий ключ - для цього натисніть «Обрати файл»:

Наступним кроком виберіть файл підпису в каталозі на жорсткому диску ПК (чи на іншому носії) та натисніть «Відкрити»:

Система відобразить форму для вводу пароля до ЕЦП.

Після вводу пароля натисніть «Зчитати». У разі успішного зчитування ЕЦП/КЕП з’явиться відповідне повідомлення «Ключ зчитаний успішно»:

Ви можете переглянути детальнішу інформацію про підписанта й переконатися що завантажено вірний ключ.

Зчитування декількох підписів виконується по черзі, кожен файл підпису зчитується окремо.

3.2 Активація ЕЦП/КЕП для нової сесії

Згідно з політикою безпеки, паролі до ЕЦП/КЕП зберігаються лише упродовж сеансу роботи в браузері. Тобто при наступній роботі вам знову потрібно буде ввести пароль.

При повторному сеансі необхідно активувати ЕЦП/КЕП, вказавши пароль до ключа.

Для активації ключа натисніть на «Налаштування ЕЦП/КЕП». Також ви можете ввести пароль при безпосередньому підписанні документа.

Для активації ключа введіть пароль у відповідне поле та натисніть «Зчитати».

3.3 Скидання пароля та видалення ключа

Підписи зберігаються у локальному сховищі браузера. Для скидання пароля зчитаного та активованого ключа завершіть сеанс роботи в браузері або натисніть на іконку біля необхідного ключа для видалення, чи на кнопку «Скинути пароль» лише для видалення паролю.

Підписання за допомогою ЕЦП/КЕП

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

Після успішного процессу підписання, відобразиться Звіт про підписання документів, де вказано назву документу та кількість підписів, та сам результат підписання.

У разі неуспішного підписання також відобразиться Звіт про підписання документів, де вказано результат підписання «Помилка», а також з’явиться інформаційне вікно де вказано причину помилки, наприклад: Підпис вже використовується.

Результат підписання кількох документів в пакеті одночасно (якщо позначити галочкою декілька і натиснути кнопку Підписати виділені):

4 Налаштування Апаратного ключа (Токен)

В сервісі DOCflow реалізована можливість підписання документів використовуючи зовнішній Електронний USB-ключ, токен від виробника ТОВ “Автор” сумісні з АЦСК “Україна”: «Алмаз-1К» та «SecureToken-337М».

Токен – це носій інформації у формі флешки із захистом від несанкціонованого доступу при генерації секретних ключів, зберіганні цифрового підпису та підписанні електронних документів.

При підписанні документа, є можливість вибрати яким Електронним ключем підписати документ - за допомогою налаштованого КЕП/ЕЦП, чи USB-ключем.

До налаштування ПО для роботи з токеном, при переході на вкладку Токен відображення буде таким:

Усі пункти є робочими посиланнями з необхідною інформацією. Натиснувши Необхідне програмне забезпечення для ПК почнеться автоматичне завантаження програми для ПК.

Після скачування, переходимо встановлення программи.

Примітка

Для різних операційних систем процес може виглядати трохи інакше. Подальші дії для різних ОС також детально описані в «Інструкції по роботі з крипто бібліотеками і захищеним носієм» .

Натискаемо та посилання №3 «Web розширення для браузера, для роботи криптобібліотеки». Встановлюємо розширення.

Дозволяємо сайту доступ до Web розширення.

Обов’язково оновлюємо сторінку! Після чого знову відкриваємо віджет, вкладка Токен виглядає так:

Вибираємо токен зі списку, вводимо пароль, натискаемо Зчитати:

Після успішного зчитування з’являється інформація про ключ. Подивитися детальну інформацію можна натисканням на кнопку Детальніше:

Підписання за допомогою токена

У пакеті вибираємо документ і натискаємо на значок олівця для його підписання, відкривається вікно підписання. Переходимо на вкладку Токен. Так як він вже зчитаний, інформація про ключі відображається, кнопка Підписати активна:

За фактом підписання, відобразиться Звіт про підписання документів, де вказано назву документу та кількість підписів, та сам результат підписання, а також підсумок про кількість успішно підписаних документів по відношенню до загальної кількості документів, відправлених на підписання (якщо ви скористалися масовим підписанням).

У разі неуспішного підписання також відобразиться Звіт про підписання документів, де вказано результат підписання «Помилка», а також з’явиться інформаційне вікно де вказано причину помилки, наприклад: Підпис вже використовується.

Підписання шифрованих документів

Якщо при підписанні (натискання на іконку олівця біля документа), у документа встановлено шифрування, його слід розшифрувати. З’явиться відповідне вікно, переходимо на вкладку Токен та натискаємо Розшифрувати:

Після натискання на кнопку Розшифрувати відобразиться вікно підписання, а потім - звіт про підписання (як при звичайному підписанні).

При натисканні на кнопку +Додати в документі, у якого встановлено шифрування, відобразиться відповідне вікно підписання. При переході на вкладку Токен - інформація, що документ потребує шифрування:

Після натискання на кнопку Зашифрувати, відобразиться вікно завантаження файлу. У разі, якщо шифрування у документа не встановлено, відразу після натискання на кнопку Додати відобразиться вікно завантаження файлу:

Після натискання на кнопку вибору файлу і, відповідно, вибору файлу, у вікні відобразиться його назва та формат, та є можливість його видалити натисканням на корзинку:

Після натискання кнопки Зберегти:

Підписання в Завданнях

При натисканні на кнопку Підписати в завданні, або в списку завдань, відобразиться вікно підписання. При переході на вкладку Токен:

Підписання при створенні або підтвердженні компанії

У розділі «Налаштування компанії»-> «Мої компанії» натискаємо кнопку Створити і переходимо на вкладку Токен. Кнопка Створити неактивна, поки не налаштовано Токен (або КЕП/ЕЦП) та не відмічена галочка «Згоден з умовами договору оферти»:

Після налатування токена та встановлення галочки кнопка стає активною, та з’являється можливість створити компанію.

Зверніть увагу!

Більше неможливо створення компанії без ЕЦП / Токена, але якщо ви колись створили компанію без ЕЦП / Токена - вам необхідно їх підтвердити.

У вже створеній раніше компанії, якщо ви створювали її без ЕЦП або Токена, вам потрібно підтвердити компанію. При натисканні на кнопку Підтвердити з ЕЦП / КЕП, відкривається вікно, переходимо на вкладку Токен. Якщо токен не прочитано, його потрібно вибрати в списку, що випадає, ввести пароль і натиснути на кнопку Зчитати.

Якщо / коли токен зчитано, відображається інформація про ключі. Залишається тільки погодитися з умовами оферти і натиснути на кнопку Підтвердити:

З використанням апаратного ключа не потрібно проводити жодних налаштувань КЕП/ЕЦП!

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інструкція користування пошуком та фільтрами

---

Зміст:

• Інструкція користування пошуком та фільтрами

  • Пошук у розділі Зовнішні комплекти документів

  • Мої завдання

  • Контрагенти - Сценарії документообігу

  • Особистий кабінет - Рахунки та Журнал подій

---

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

Пошук у розділі Зовнішні комплекти документів

Для здійснення пошуку файлу за назвою, необхідно у полі Пошук файлу (1) ввести назву файлу. Для пошуку необхідно ввести мінімум 3 символа. При пошуку не повинно бути зайвих пробілів до чи після запиту!

Назва файлу - це назва прикладеного документу, назва відображається при Завантаженні файлів документів, також можна переглянути назву файлу всередині комплекту у вікні Документи.

Для розширеного пошуку за іншими параметрами, використовуйте функціонал Фільтр (2).

У формі Фільтр шукайте конкретний комплект у правильному вибраному розділі. Тобто, у розділі Вхідні пошук можливий лише серед вхідних комплектів документів, відповідно у розділі Вихідні пошук можливий лише серед відправлених вихідних комплектів.

Доступні наступні поля для фільтрації:

• Номер комплекту документів

• Статус (Надіслано, Прийнято, Додано документ)

• Дата

• Відправник

• Типи комплектів документів Відправника (комплекти налаштовані для компаніх у меню Налаштування комплектів документів, поле доступно лише якщо вибрано Відправника)

• Отримувач та

• Типи комплектів документів Отримувача (поле доступно лише якщо вибрано Отримувача)

• Обрати тег

• Додаткові атрибути (Користувацькi поля)

• Довiдник ( якщо у довідника є Значення, потрібно заповнити значення)

Будьте уважні! Залежно від напрямку (Вхідні чи Вихідні) Відправник та Отримувач відображається по різному - у розділі Вхідні для поля Відправник вибирається контрагент, а у розділі Вихідні - Відправником виступають ваші власні компанії.

Для пошуку за тегами необхідно вибрати з випадаючого списку тег за яким ви шукаете комплект. Головна умова - тег повинен бути створений раніше, а також доданий до комплекту документів або до сценарію з партнером.

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Пошук. Пошук здійсниться лише по заповненим параметрам - тобто, якщо заповнити лише поле Відправник, відобразиться вся вибірка типів комплектів цього Відправника.

Якщо ви бачите повідомлення «Комплекти документів відсутні», це означає що за заданими параметрами пошуку немає вхідних чи вихідних комплектів (залежно від того в якому розділі ви знаходитеся). Спробуйте перевірити введені дані та ,можливо, змінити деякі параметри пошуку.

Коли фільтр активний, кнопка Фільтр відображається у зеленому кольорі та на сторінці відображенно лише дані за вибіркою.

Для відображення усіх комплектів обов’язково натисніть у фільтрах кнопку Скинути.

У розділах Вхідні, Вихідні та Чернетки можливо створити ярлик, тобто постійний пошуковий запит за допомогою кнопки Додати ярлик та заповнивши поля фільтру для ярлика.

Обов’язкові поля для збереження ярлика:

• Створити назву

• Вибрати Тип періоду (поточний місяць, попередній місяць, фіксована дата або поточна дата мінус N-днів - вказується кількість днів).

• Обрати папку - Вхідні, Вихідні або Чернетки

Опціональні поля для ярлика:

• Номер комплекту документів

• Статус

• Відправник та Типи комплектів документів Відправника (доступно лише якщо вибрано відправника)

• Отримувач та Типи комплектів документів Отримувача (доступно лише якщо вибрано отримувача)

• Тег

• Довiдник та Значення

• Користувацькi поля

Створення та додавання тегів

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

Для початку створіть унікальні теги у меню Налаштування компанії - Керування тегами. Для цього натисніть Створити тег та придумайте назву, унікальний код тегу сформується автоматично.

Додавайте теги при створенні або редагуванні комплекту або присвойте сценарію при створенні або редагуванні.

Пошук за тегами можливий лише у Фільтрі у розділі Зовнішні комплекти документів, якщо тег додано або до сценарію або до комплекту. Можливо здійснювати пошук за більше ніж одним тегом.

Мої завдання

Якщо ви входите до групи виконавців узгодження комплектів або внутрішніх документів, знайти конкретне завдання серед списку вам допоможуть Фільтри завдань.

Пошук можливий за такими полями:

• Тип завдання - Узгодження; Підписання; Повідомлення;

• Статус завдання - До виконання, Виконано, Відхилено, Прострочена;

• Компанія відправник

• Компанія отримувач

• Тип документа - можливо вибрати серед тих типів, які є серед доданих до завдань;

• Дата створення завдання

• Строк виконання

• Напрямок - Вхідні або Вихідні завдання

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Пошук.

Для відображення усіх завдань обов’язково натисніть у фільтрах кнопку Скинути.

Контрагенти - Сценарії документообігу

Сценарій документообігу, або Контракт - спеціальний договір, форма зв’язку між партнерами, згідно з якою відбувається обмін комплектами документів. У сценарії визначається перелік вхідних та вихідних (по відношенню до власника сценарію) типів комплектів та довідники. Власник сценарію – ініціатор процесу обміну комплектами та є відправником сценарію.

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

• Назва сценарію - відображається у стовбці Назва сценарію, та у сценарії в блоці Дані

• Номер - номер сценарію, що відображається у контракті в блоці Дані

• Термін дії

• Клієнт - той хто отримав контракт, пошук за компанією, для розділів Вхідні та Вихідні відображаються різні компанії;

• Ініціатор - той хто надіслав контракт; власник сценарію;

• Статус - Новий; Прийнятий; Відхилений; Розірваний; Очікує підписання;

У розділах Вхідні та Вихідні контракти поля Клієнт та Ініціатор відрізняються - відображаються або внутрішні компанії або партнери, так як у вихідних контрактах власником-ініціатором є наші внутрішні компанії (що відображаються у меню Мої компанії).

Якщо ви бачите повідомлення «Контракти не знайдені», це означає що за заданими параметрами пошуку немає вхідних чи вихідних контрактів (залежно від того в якому розділі ви знаходитеся). Спробуйте перевірити введені дані та можливо змінити деякі параметри пошуку. Перевірте введені дані на наявність зайвих пробілів.

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Застосувати.

Для відображення усіх контрактів обов’язково натисніть у фільтрах кнопку Скинути.

Особистий кабінет - Рахунки та Журнал подій

У розділі Рахунки у вигляді таблиці відображені всі рахунки та акти по компаніях акаунта із виведенням такої інформації як Номер рахунку, Дата здійснення рахунку, Сума рахунку та Період оплати.

Для пошуку конкретного рахунку, або віведення рахунків лише за певний період часу скористайтеся фільтрами.

Фільтр Рахунки дозволяє пошук за такими полями:

• Номер

• Статус (оплачений / неоплачений)

• Дата рахунку

• Дата оплати

• Дата акту

• Наявність акту (акт сформовано/ не сформовано)

У поле Номер введіть точну та повну назву рахунку, відображену в стовбці Номер рахунку. Перевірте введені дані на наявність зайвих пробілів.

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Пошук.

Для відображення усіх контрактів обов’язково натисніть у фільтрах кнопку Скинути.

Журнал подій містить інформацію щодо змін і коментарів до документів та комплектів

Фільтр у Журналі подій

• Дата

• Пошук

• Дія

• Об’єкт

• Користувач

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Застосувати.

Для відображення усіх завдань обов’язково натисніть у фільтрах кнопку Скинути.

Для пошуку у розділі Білінг можливо здійснити пошук за такими параметрами:

• Компанія

• Тип транзакції

• Період

• Напрямок

Ообов’язково натисніть кнопку Пошук для здійснення пошуку.

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інструкція бізнес-адміністратора

---

Зміст:

• Інструкція бізнес-адміністратора

  • 1 Терміни та визначення

  • 2 Авторизація

  • 3 Створення / редагування компанії

  • 4 Налаштування довідників компанії

  • 5 Створення та налаштування типів документів

  • 6 Налаштування додаткових атрибутів

  • 7 Налаштування Доступу до комплектів

  • 8 Налаштування типу комплекта

  • 9 Налаштування зв’язку з контрагентами (Сценарій документообігу)

  • 10 Обробка вхідних сценаріїв документообігу

  • 11 Білінг

  • 12 Рахунки та акти

  • 13 Групи для узгодження

  • 14 Маршрути узгодження

  • 15 Аналітика

  • 16 Вибір тарифного плану

---

Дана інструкція описує порядок дій користувача, що виконує роль бізнес-адміністратора, на платформі DOCflow для виконання налаштувань, які є передумовою обміну комплектами документів.

1 Терміни та визначення

• Компанія – юридична чи фізична особа, яка використовує систему для виконання своїх процесів. До одного акаунта можливо прив’язати декілька компаній. Документи, довідники, типи комплектів, сценарії документообігу, сценарії доступу, налаштування узгодження створюються в межах компанії і закріплюються за нею.

• Сценарії документообігу (або Контракт) – форма налаштування зв’язку між партнерами, у відповідності до якої відбувається обмін комплектами документів.

• Власник (ініціатор) сценарію – організація, яка виступає ініціатором процесу обміну комплектами та відправником сценарію.

• Клієнт – організація-контрагент, яка виступає отримувачем сценарію.

• Тип комплекта – налаштування та параметри комплекта документів для обміну (являє собою перелік обов’язкових та необов’язкових типів документів для обміну в рамках комплекта, визначає необхідність шифрування, кількість підписів власника та клієнта).

• Сценарій доступу (або Маршрут) – операція визначення працівників отримувача, які будуть отримувати та обробляти комплекти документів. Сценарій доступу будується на основі переліку сценаріїв документообігу та типів комплектів, до яких буде надано доступ користувачеві.

• Довідник – прикладний об’єкт системи, який дозволяє зберігати дані, що мають однакову структуру та обліковий характер. Довідниками можуть бути, наприклад, типи операцій, регіони, види бізнесу тощо.

• Тип документа – спеціальний системний довідник, що містить дані за типами документів, якими виконуватиметься обмін між сторонами.

2 Авторизація

Для авторизації на платформі перейдіть за посиланням https://doc.edin.ua/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Створення / редагування компанії

Для створення чи редагування даних компанії перейдіть до розділу «Налаштування компанії» - «Мої компанії». В списку будуть відображені вже існуючі компанії.

3.1 Створення компанії

Для створення компанії натисніть кнопку «Створити компанію» (якщо жодна компанія ще не створена), або «Створити» (якщо потрібно додати нову компанію до переліку раніше створених):

Cтворення передбачає підтвердження компанії з «ЕЦП/КЕП». Підтвердження з «ЕЦП/КЕП» виконує автоматичне заповнення основних реєстраційних даних компанії із зчитаного електронного цифрового підпису компанії, тому вкажіть саме того користувача чиї данні будуть вказанні у данних компанії.

Для створення компанії «З ЕЦП/КЕП» попередньо завантажте і налаштуйте електронний цифровий підпис (детальніше в «Інструкції з налаштування ЕЦП»). Далі оберіть ЕЦП/КЕП з переліку зчитаних і натисніть «Створити»:

Після цього відкриється форма налаштування компанії:

При цьому відкриється форма налаштування компанії, заповнена даними з ЕЦП/КЕП. Зі зчитаного ключа береться наступна інформація: форма власності компанії, назва компанії, код ЄДРПОУ.

Зверніть увагу!

Інформація з ЕЦП/КЕП підтягується автоматично і не підлягає редагуванню.

Заповніть поля, що виділені червоним (обов’язкові параметри). Після внесення необхідних даних натисніть «Зберегти».

3.2 Підтвердження даних компанії з ЕЦП/КЕП

Якщо на момент створення компанії у користувача були відсутні ЕЦП/КЕП і компанія була створена звичайним способом, система дозволяє підтвердити внесені дані з ЕЦП/КЕП (автоматично оновити дані, внесені в форму, реєстраційними даними компанії, що містяться в електронному цифровому підписі).

Для підтвердження даних із ЕЦП/КЕП перейдіть в розділ меню «Налаштування компанії» – «Мої компанії» навігаційної панелі сервісу та оберіть потрібну компанію зі списку, натиснувши на її назву. Далі перейдіть до вкладки «Основна інформація» та натисніть кнопку «Підтвердити з ЕЦП/КЕП»:

У формі вибору ЕЦП/КЕП, що відкриється, оберіть потрібний електронний цифровий підпис і натисніть «Створити».

Зверніть увагу!

Код ЄДРПОУ підпису повинен відповідати коду ЄДРПОУ, вказаному у формі редагування компанії.

У разі успішного виконання підтвердження користувачеві буде відображене відповідне інформаційне повідомлення: «Компанія підтверджена успішно».

Зверніть увагу!

Кнопка «Підтвердити з ЕЦП/КЕП» наявна лише для компаній, створених звичайним способом.

3.3 Редагування та блокування компанії

Для редагування даних компанії перейдіть у розділ меню «Налаштування компанії» – «Мої компанії» та оберіть потрібну компанію зі списку, натиснувши на її назву. У формі, що відкриється, натисніть «Редагувати». Після чого дані за компанією будуть доступні для редагування. Для блокування компанії натисніть кнопку «Деактивувати» та підтвердіть дію у відповідному запиті системи:

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

3.4 Надання компанії статусу «Акаунт»

Акаунтом є головна компанія із групи компаній облікового запису, по якій здійснюватимуться платежі. У випадку, якщо жодну з компаній не обрано акаунтом, система автоматично призначить акаунтом компанію, що створена з ЕЦП, за умови підписаного договору з компанією-провайдером.

Для надання компанії статусу «акаунт» перейдіть в розділ меню «Особистий кабінет» – «Акаунт», заповніть основні реєстраційні данні або оберіть компанію з переліку у полі «Компанія» і натисніть «Зберегти».

Зверніть увагу!

У переліку будуть відображені лише компанії з типом створення «З ЕЦП/КЕП» та підписаним договором.

Форма «Акаунт» складається з декількох блоків даних. Поля, заповнені з ЕЦП («Назва», «ЄДРПОУ», т.д) не підлягають редагуванню.

• Реєстраційні дані – заповнюється автоматично даними компанії, що обрана акаунтом

• Адреса

• Банківські реквізити – заповнюється автоматично даними компанії, що обрана акаунтом

• Контакті дані

Зверніть увагу!

Заблокувати чи змінити компанію-акаунт після збереження данних неможливо. У переліку компаній (меню «Налаштування компанії» – «Мої компанії») напроти компанії із статусом «Акаунт» відсутній перемикач «активувати – деактивувати».

4 Налаштування довідників компанії

Для керування довідниками оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії». У формі редагування компанії перейдіть до вкладки «Довідники», де у формі списку будуть відображені довідники, вже закріплені за компанією. Для пошуку необхідного довідника введіть у поле пошуку 3 чи більше символів. Пошук виконується за назвою та кодом довідника.

4.1 Створення нового довідника

Для створення нового довідника натисніть кнопку «Додати». У формі створення довідника вкажіть назву та код довідника (може бути використаний для інтеграції з іншими системами). Для збереження внесених даних натисніть «Зберегти»:

Після цього можна буде вводити значення довідника. Для додання нових значень натисніть «Додати» і заповніть поля форми, що відкриється:

Зверніть увагу!

Код значення має бути унікальним у межах довідника. При введенні неунікального значення система повідомить про помилку: «Код значення довідника вже використовується».

Для збереження значення довідника натисніть Enter чи кнопку «Зберегти».

Для редагування довідника виберіть зі списку довідників потрібний і натисніть на його назву. Для редагування назви чи коду довідника натисніть «Редагувати».

Для редагування назви значення довідника натисніть на назву значення і введіть нове значення.

В меню «Довідники» є можливість створювати ієрархічні довідники у формі деревовидного списку 1.

Натиснувши кнопку Додати у значеннях довідника, є можливість додавати «дочірні» значення в довідник; кількість рівнів підлеглих значень у довіднику необмежена.

Зверніть увагу!

При блокуванні / активації материнського значення - блокуються активуються всі його дочірні значення.

Для блокування чи розблокування значення довідника переведіть у відповідне положення перемикач блокування:

4.2 Завантаження / вивантаження в Excel значень довідників

Для спрощення процесу введення значень довідника передбачена можливість завантажити / вивантажити значення довідника з таблиці Excel:

Завантаження / вивантаження доступно для кожного рівня ієрархічного довідника окремо. Для експорту значень довідника (на платформу) натисніть «Вивантажити» та оберіть каталог на жорсткому диску ПК або змінному носії для вибору файлу розміром до 5 МБ. Для імпорту значень довідника скористайтеся кнопкою «Завантажити».

5 Створення та налаштування типів документів

Для налаштування доступні документи для зовнішнього (договір, акт, рахунок), та для внутрішнього (заява на відпустку, тощо) документообігу.

5.1 Налаштування типів документів компанії для зовнішнього документообігу

Для налаштування типів документів оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії» перейдіть у вибрану компанію і перейдіть до вкладки «Документи». На вкладці у вигляді списку будуть відображені вже існуючі типи документів, що закріплені за компанією. Для пошуку необхідного документа введіть у поле пошуку 3 чи більше символів. Пошук виконується за назвою та кодом типу документа:

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

Для створення нового типу документа натисніть «Додати». У формі створення документа вкажіть назву (мінімум 4 символа),код і оберіть тип документа (неструктурований або структурований). Код типу документа створюється автоматичо, може бути використаний для інтеграції з іншими системами. Для збереження внесених даних натисніть «Зберегти»:

5.1.2 Завантаження / вивантаження типів документів в Excel

Для спрощення процесу налаштування типів документів у сервісі реалізована можливість завантаження та вивантаження їх переліку в форматі Excel:

Для вивантаження переліку типів документів натисніть «В Excel» та оберіть каталог на жорсткому диску ПК чи змінному носії для збереження файлу.

Для завантаження переліку типів документів з таблиці Excel натисніть «З Excel» та оберіть підготовлений файл розміром до 5 МБ.

Зверніть увагу!

Для успішного завантаження у файлі має бути щонайменше дві колонки (назва типу документа та код типу документа), файл не повинен містити формули, формат клітинок – загальний, перший рядок використовується як заголовок.

5.1.3 Редагування типу документа

Для редагування типу документа оберіть потрібний тип документа, натиснувши на його назву. Внесіть потрібні правки у формі редагування і натисніть «Зберегти».

Для блокування чи активації типу документа в списку типів документів переведіть перемикач у відповідне положення:

Для присвоєння додаткових користувацьких атрибутів натисніть на кнопку «Поля документа»:

У формі, що відкриється, будуть відображені вже присвоєні поля. Для додання поля із списку виберіть потрібне поле і натисніть «Додати атрибут. Для видалення зв’язку з полем натисніть «Кошик».

5.1.4 Налаштування зв’язку типу документа з довідником

За допомогою кнопки «Додати зв’язок з довідником» в меню «Документи» створюється зв’язок довідника з документом.

При натисканні на кнопку з’явиться форма зі списком доступних довідників для компанії. Після вибору довідника натисніть кнопку Зберегти.

До одного типу документа можна прив’язати один довідник; 1 довідник можна прив’язати до декількох документів; прив’язка здійснюється тільки до активних довідників.

Можливо редагувати довідники, прив’язані до типу документа, в комплекті. Довідники доступні до редагування тільки на стороні відправника комплекта і тільки до відправки комплекта (в статусі «Чернетка»).

5.2 Налаштування типів документів компанії для внутрішнього документообігу

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

Для налаштування типів документів оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії», перейдіть у вибрану компанію і перейдіть до вкладки «Внутрішні документи компанії».

Для створення нового типу документа натисніть «Додати». У формі створення документа вкажіть назву, код і оберіть тип документа (неструктурований, або структурований). Форма аналогічна формі створення типу зовнішнього документа.

Для збереження внесених даних натисніть «Зберегти».

Для спрощення процесу налаштування типів документів у сервісі реалізована можливість завантаження та вивантаження їх переліку в форматі Excel.

Для вивантаження переліку типів документів натисніть «В Excel» та оберіть каталог на жорсткому диску ПК чи змінному носії для збереження файлу.

Для завантаження переліку типів документів з таблиці Excel натисніть «З Excel» та оберіть підготовлений файл.

5.3 Відображення штамп ЕЦП у листі підписання

Для відображення інформації про підпис у документі PDF при скачуванні архіва, необхідно відкрити доступ провайдеру до документа. Щоб відкрити доступ провайдеру до зовнішнього або внутрішнього документа, натисніть відповідну кнопку навпроти документу - Відображати штамп ЕЦП.

Підтвердіть дозвіл на доступ до вмісту:

Аналогічні дії проведіть у розділі «Внутрішні документи компанії».

У документах з відкритим доступом та у форматі PDF відтепер буде відображено візуалізацію ЕЦП у листі підписання при скачуванні архіва.

Зверніть увагу!

Відмінити надання доступу до документу неможливо.

6 Налаштування додаткових атрибутів

Для налаштування додаткових атрибутів оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії». На формі редагування перейдіть до вкладки «Додаткові атрибути», де будуть відображені вже існуючі атрибути. Для пошуку необхідного атрибуту введіть у поле пошуку 3 чи більше символів. Пошук виконується за назвою та описом поля:

6.1 Створення користувацького поля

Для створення нового поля натисніть «Додати». На формі створення вкажіть назву поля, оберіть формат введення даних та введіть опис поля. Всі поля обов’язкові до заповнення. Для збереження внесених даних натисніть «Зберегти»:

6.2 Редагування користувацького поля

Для редагування поля оберіть потрібне поле в списку полів і натисніть на його назву. Внесіть необхідні правки у формі редагування і натисніть «Зберегти».

Для блокування чи активації поля переведіть перемикач у відповідне положення:

7 Налаштування Доступу до комплектів

Доступ до комплектів визначає перелік сценаріїв документообігу і типів комплектів, до яких буде надано доступ користувачеві. Сценарій доступу є прикріпленим до компанії. Для налаштування сценарію доступу перейдіть у розділ «Налаштування доступу» –> «Доступ до комплектів».

У розділі відображаються всі створені сценарії доступів. Для зручності реалізовано фільтр пошуку сценаріїв за компанією, до якої прикріплений сценарій доступу, за статусом (активний / заблокований), за назвою сценарію доступу:

Зверніть увагу!

Для користувача без ознаки «Власник акаунта» налаштування доступу є обов’язковою передумовою початку роботи.

7.1 Створення сценарію доступу

Для створення нового сценарію доступу натисніть «Створити». У формі створення обов’язково вкажіть назву і код сценарію доступу (заповниться самостійно), оберіть зі списку компанію, до якої буде прикріплений даний сценарій доступу, і визначте його напрямок (вхідний або вихідний) відносно типу комплекта. Для збереження внесених даних натисніть «Зберегти»:

Після збереження даних з’явиться можливість працювати з вкладками «Користувачі», «Сценарій документообігу» та «Типи комплектів» для остаточного налаштування доступу.

7.1.1 Налаштування зв’язку з користувачем

Для створення зв’язку сценарій доступу — користувач перейдіть до вкладки «Користувачі» форми редагування маршруту, оберіть користувача з випадаючого списку і натисніть «Додати користувача». Кількість користувачів не обмежується:

Для розірвання зв’язку «сценарій доступу — користувач» натисніть кнопку «Кошик».

7.1.2 Налаштування доступу до Сценарію документообігу

Для додання Сценарію документообігу в Сценарій доступу користувача, перейдіть до вкладки «Сценарій документообігу» форми редагування поруч і натисніть «Додати»:

У формі, що відкриється, оберіть потрібний сценарій документообігу зі списку і натисніть «Підтвердити». У полі вибору сценарію документообігу реалізовано пошук за назвою сценарію:

Для зручності реалізована можливість обрати всі сценарії. Для цього встановіть відмітку «Всі сценарії документообігу» та підтвердіть дію у відповідному запиті системи:

Користувачеві буде надано доступ до всіх сценаріїв документообігу, наявних на момент налаштування данного сценарію доступу, та всіх нових сценаріїв документообігу по мірі їх укладення.

Для обмеження доступу користувача до сценарію документообігу, встановіть відмітку напроти потрібного і натисніть «Видалити».

Для обмеження доступу до всіх сценаріїв документообігу зніміть відмітку «Всі сценарії документообігу» та підтвердіть дію у відповідному запиті системи.

7.1.3 Налаштування доступу до типів комплектів

Для додання типів комплектів у сценарій доступу користувача, перейдіть до вкладки «Типи комплектів» на формі редагування і натисніть «Додати»:

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

Після вибору компанії стане доступним поле для вибору типу комплекта за обраною компанією та активується кнопка «Додати».

Також для зручності реалізована можливість відкрити користувачеві доступ до всіх типів комплектів, встановивши відмітку «Всі типи комплектів».

Підтвердіть дію у відповідному запиті системи, натиснувши «Так». Користувачеві буде надано доступ до всіх типів комплектів.

Для обмеження доступу користувача до типу комплекта відмітьте потрібний тип у списку і натисніть «Видалити».

Для видалення доступу до всіх типів комплектів зніміть відмітку «Всі типи комплектів» і підтвердіть дію у відповідному запиті системи:

7.2 Блокування сценарію доступу

Для блокування сценарію доступу переведіть перемикач у відповідну позицію напроти потрібного сценарію доступу в списку «Налаштування доступу» – «Доступ до комплектів». Сценарію доступу буде надано статус «Заблокований»:

8 Налаштування типу комплекта

Для налаштування типу комплекта перейдіть до розділу «Налаштування компанії» - «Налаштування комплектів документів». У розділі будуть відображені вже існуючі типи комплектів. Система фільтрів дозволяє здійснювати пошук типу комплекта за його назвою, за компанією, до якої прикріплений комплект, за статусом типу комплекта:

8.1 Створення типу комплекта

Для створення типу комплекта натисніть «Створити». У формі створення введіть назву та код типу комплекта, а також оберіть компанію, до якої буде прикріплений тип комплекта. Всі поля є обов’язковими для заповнення. Чекбокс Автообробка комплекта - під «автообробкою» мається на увазі автоматичне прийняття або відхилення комплекта, якщо всі документи в ньому з відповідним статусом (Прийнято/Відхилено).

Для збереження внесених даних натисніть «Зберегти»:

Після цього з’явиться можливість налаштувати для типу комплекта документи, довідники і користувацькі поля у відповідних вкладках:

Після збереження типу комплекта буде надано статусу «Чернетка».

Зверніть увагу!

Типи комплекта у статусі «Чернетка» не відображаються у списку доступних при створенні комплекта. Для того, щоб тип комплекта став доступним для вибору, його потрібно активувати.

Зверніть увагу!

Активувати можна лише той тип комплекта, що містить хоча б один доданий тип документа (вкладка «Документи»).

8.2 Редагування типу комплекта

Для редагування типу комплекта оберіть потрібний комплект у списку і натисніть на його назву. Далі натисніть кнопку «Редагувати» і внесіть необхідні зміни. При редагуванні є можливість змінити назву та код типу комплекта, додати чи видалити зв’язки с типами документів, довідниками, користувацькими полями.

Для збереження внесених даних натисніть «Зберегти».

При редагуванні автоматично створюється нова версія типу комплекта в статусі «Чернетка». Для активації нової відредагованої версії натисніть «Активувати»:

При цьому попередня активна версія типу комплекта набуде статусу «Архів».

Для перегляду всіх версій типу комплекта натисніть кнопку «Показати всі версії» у формі редагування / перегляду типу комплекта:

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

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

8.3 Керування зв’язком з типами документів

Для керування зв’язком комплекта з типами документів перейдіть до вкладки «Документи» на формі редагування типу комплекта. На вкладці будуть відображені вже прикріплені типи документів з вказаними параметрами. Для створення нового зв’язку натисніть кнопку «Додати зв’язок з документом».

На формі редагування виберіть тип документа, визначте кількість необхідних ЕЦП з боку ініціатора та клієнта, встановіть ознаки обов’язковості та шифрування, за необхідності встановіть відмітку «Довкладення отримувача» та вкажіть допустиму кількість файлів (максимальне значення 10).

Зверніть увагу!

Якщо «Довкладення отримувача» позначене як обов’язкове, документ має бути завантажений на стороні отримувача комплекта. Також неможливо буде відмітити ознаку «Документ дозволений для редагування партнером» (і навпаки, при дозволі редагування неможливо використовувати довкладення).

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

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

Ви можете вказати термін підписання документа отримувачем у днях - якщо контрагент не обробить документ до закінчення терміну, підписати документ та комплект стане неможливо!

При відміченні документа як дозволеного для редагування, налаштування правил роботи, у тому числі термін підписання зберігається!

Для редагування даних натисніть кнопку «Олівець» напроти потрібного типу документа та внесіть необхідні зміни на формі редагування.

Зверніть увагу!

Зміна назви документа при редагуванні призведе до створення нового зв’язку.

Для збереження внесених даних натисніть «Зберегти».

Для розірвання зв’язку з типом документа натисніть кнопку «Кошик».

8.4 Керування зв’язком із довідниками

Для керування зв’язком із довідниками перейдіть до вкладки «Довідники» на формі редагування типу комплекта.

Для створення нового зв’язку довідника з типом комплекту натисніть «Додати». На формі редагування виберіть довідник зі списку, вкажіть тип заповнення («Заповнює клієнт», «Заповнює ініціатор», «Заповнюють обидва») та визначте ознаку обов’язковості:

На вкладці будуть відображені вже прикріплені довідники із вказаними параметрами:

Для редагування даних натисніть кнопку «Олівець». У формі, що відкриється, є можливість вибрати новий довідник, змінити тип заповнення та встановити чи зняти ознаку обов’язковості. Для збереження внесених змін натисніть «Зберегти».

Зверніть увагу!

Зміна назви довідника при редагуванні призведе до створення нового зв’язку.

Для розірвання зв’язку з довідником натисніть кнопку «Кошик».

8.5 Керування зв’язком з додатковими атрибутами

Для керування зв’язком з користувацькими полями перейдіть до вкладки «Додаткові атрибути» на формі редагування типу комплекта. На формі будуть відображені вже прикріплені поля з вказаними параметрами:

Для створення нового зв’язку натисніть «Додати зв’язок». На формі редагування виберіть поле, визначте тип заповнення поля («Заповнює ініціатор», «Заповнює клієнт», «Заповнюють обидва»), встановіть ознаку обов’язковості. Для збереження внесених даних натисніть «Зберегти».

Для редагування даних натисніть кнопку «Олівець» напроти потрібного поля у списку. У формі, що відкриється, внесіть необхідні зміни і натисніть «Зберегти».

Зверніть увагу!

Зміна назви поля при редагуванні призведе до створення нового зв’язку.

Для розірвання зв’язку з полем натисніть кнопку «Кошик».

9 Налаштування зв’язку з контрагентами (Сценарій документообігу)

• Сценарій документообігу – форма зв’язку між партнерами, у відповідності до якої відбувається обмін комплектами документів

• Власник Сценарію документообігу – організація (юридична особа), що ініціює процес обміну комплектами та є відправником Сценарію документообігу

• Клієнт – організація-контрагент, що є отримувачем Сценарію документообігу

• Тип комплекта – налаштування та параметри комплекта документів для обміну (перелік обов’язкових та необов’язкових типів документів у рамках комплекта, ознака шифрування, кількість підписів відправника комплекта та отримувача).

На рівні Сценарію документообігу визначається перелік вхідних та вихідних (по відношенню до власника сценарію) типів комплектів. Сценаріі документообігу зберігаються у розділі «Контрагенти» - «Сценарії документообігу» меню навігаційної панелі сервісу. Розділ складається з папок:

• Вхідні з переліком отриманих від контрагентів Сценаріїв документообігу

• Вихідні з переліком відправлених контрагентам Сценаріїв документообігу

• Чернетки з переліком створених Сценаріїв документообігу на етапі їх заповнення / налаштування (до моменту відправки)

9.1 Налаштування шаблона запрошень до документообігу

Для налаштування шаблона сценарію документообігу перейдіть до розділу «Контрагенти» - «Шаблони запрошень» навігаційної панелі сервісу. У розділі будуть відображені всі створені шаблони. Система фільтрів дозволяє виконувати пошук за назвою шаблона та назвою компанії-власника сценарію документообігу (у вигляді випадаючого списку).

Для видалення шаблона поставте відмітку напроти потрібного шаблона і натисніть кнопку «Кошик». Також реалізована можливість масового видалення шаблонів. Для масового видалення необхідно відмітити потрібний шаблон та натиснути кнопку «Видалити».

Для створення нового шаблона натисніть «Створити»:

У формі, що відкриється, заповніть поля і натисніть «Створити»:

Порядок заповнення полів:

• Назва – обов’язкове поле, допускається внесення літер, цифр та спеціальних символів; призначене для заповнення назви шаблона; якщо не задано інакше, внесене значення використовуватиметься як назва сценарію документообігу, створеного на основі даного шаблона

• Номер – поле, призначене для внесення номеру шаблона, допускається внесення літер, цифр та спеціальних символів; якщо не задано інакше, внесене значення використовуватиметься як номер сценарію документообігу

• Дата укладання - поле, що містить дату підписання сценарію документообігу

• Дата закінчення дії – поле, що містить дату закінчення дії сценарію документообігу

• Ініціатор – поле містить випадаючий список компаній, доступних користувачеві відповідно до налаштувань ролі

• Дод. інформація – поле, не обов’язкове до заповнення.

Після збереження, форма налаштування шаблона відкривається з автоматично заповненими полями «Назва», «Номер», «Дата укладання» та «Дата закінчення» сценарію документообігу із додатковими вкладками для налаштування зв’язку з довідниками і типами комплектів.

У разі необхідності змінити автоматично заповнені дані натисніть «Редагувати», внесіть потрібні правки і натисніть «Зберегти».

Для налаштування переліку вхідних та вихідних (по відношенню до власника) типів комплектів перейдіть до вкладки «Типи комплектів». Вкладка містить два розділи:

• Вихідні із переліком типів комплектів, доступних для відправлення власнику (ініціатору) сценарію документообігу

• Вхідні із переліком типів комплектів, доступних для відправлення клієнту

Для видалення типу комплекта з переліку натисніть кнопку «Кошик».

Для додання типу комплекта до переліку доступних (вхідних або вихідних) натисніть «Додати». При цьому відкриється форма зі списком доступних типів комплектів, що прикріплені до компанії-власника сценарію документообігу (перелік типів комплектів налаштовується у розділі «Налаштування компанії» – «Типи комплектів»):

Після вибору типу комплекта для збереження внесених даних натисніть «Зберегти».

Для зручності реалізована можливість додати в шаблон всі типи комплектів, прикріплені до компанії-власника сценарію документообігу, шляхом встановлення відмітки «Всі комплекти». Після встановлення відмітки «Всі комплекти» в обраному розділі («Вхідні» або «Вихідні») підтвердіть дію у відповідному запиті системи.

Для налаштування зв’язку з довідниками перейдіть до вкладки «Довідники», де зберігається перелік прикріплених до шаблона довідників та їх значень.

Для видалення зв’язку встановіть відмітку напроти потрібного запису і натисніть кнопку «Кошик».

Для формування нового зв’язку натисніть «Додати»:

При цьому відкриється форма із переліком доступних активних довідників, що пов’язані з компанією-власником Сценарію документообігу (перелік довідників заповнюється у розділі «Налаштування компанії» – «Мої компанії» – «Довідники»).

Після вибору довідника виберіть значення довідника і натисніть «Зберегти» для збереження внесених даних.

Для зміни значення необхідно спочатку видалити зв’язок з довідником, а потім додати новий із новим значенням.

Для пошуку довідника чи значення довідника введіть декілька початкових символів у пошукове поле.

9.2 Створення та відправка Сценарій документообігу

Для створення Сценарію документообігу перейдіть до розділу «Контрагенти» - «Сценарії документообігу» та натисніть кнопку «Створити»:

При цьому відкриється форма створення / редагування Сценарій документообігу з переліком обов’язкових для заповнення полів:

• Назва та номер (допускається внесення літер, цифр та спеціальних символів)

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

• Контрагент (поле для вибору компанії-контрагента, якій буде відправлено Сценарій документообігу на розгляд). В межах поля реалізований пошук за кодом ЄДРПОУ та назвою (для старту пошуку введіть будь-який символ)

• Мої компанії (поле для вибору однієї з компаній користувача, від імені якої буде відправлений Сценарій документообігу). В межах поля реалізований пошук за кодом ЄДРПОУ та назвою (для старту пошуку введіть будь-який символ)

Після заповнення обов’язкових полів натисніть «Створити». Сценарій документообігу буде збережений у статусі «Чернетка» і відкриються додаткові вкладки («Типи комплектів» та «Довідники») для остаточного налаштування Сценарію документообігу:

Далі налаштуйте зв’язок з Типами комплектів та Довідниками аналогічно як у шаблоні Сценарію документообігу.

9.2.1 Відправлення Сценарію документообігу

Для відправлення сценарію документообігу перейдіть до папки «Чернетки» розділу «сценарії документообігу», оберіть потрібний сценарій зі списку, натиснувши на його назву, і натисніть «Надіслати» у формі редагування:

Для масової відправки сценаріїв документообігу встановіть відмітки напроти потрібних сценаріїв і натисніть «Надіслати»:

Для відправки шаблону сценарію документообігу перейдіть до меню «Контрагенти» - «Шаблони запрошень», оберіть потрібний шаблон та натисніть кнопку «Надіслати»:

Наступним кроком необхідно обрати контрагентів-отримувачів та натиснути кнопку «Надіслати»:

Після обробки сценарію документообігу контрагентом, йому буде надано статус «Прийнятий» чи «Відхилений». Прийнятий сценарій можливо розірвати за допомогою відповідної кнопки у редагуванні вихідних сценаріїв:

Для швидкого пошуку необхідного Сценарію документообігу у розділі реалізовано фільтр.

Пошук виконується за наступними атрибутами:

• Назва та номер (для пошуку вкажіть хоча б один символ із назви / номера Сценарію документообігу)

• Клієнт (пошук можливий за кодом ЄДРПОУ і назвою)

• Ініціатор (пошук можливий за кодом ЄДРПОУ і назвою)

• Статус (поле містить системний перелік статусів у відповідності до обраної папки)

• Термін дії із можливістю вибрати дату дії Сценарію документообігу:

Для одночасного видалення всіх внесених в налаштування фільтра значень скористайтеся кнопкою «Скинути».

9.3 Запрошення контрагентів

Контрагент - організація (юридична особа), одна зі сторін у процесі обміну сценаріїв документообігу (власник або клієнт) та комплектами (відправник або отримувач).

Розділ «Мої контрагенти» містить перелік контрагентів користувача і призначений для відправлення запрошень до співпраці новим контрагентам.

Система фільтрів дозволяє здійснювати пошук контрагента за назвою та кодом ЄДРПОУ. Для старту пошуку достатньо ввести у пошукове поле початкові символи назви чи коду. В окремому полі реалізована можливість відфільтрувати контрагентів за ознакою реєстрації на платформі: всі /зареєстровані / незареєстровані. Перевірка реєстрації здійснюється за кодом ЄДРПОУ.

Інформація щодо контрагентів відображається на стартовій сторінці розділу у вигляді таблиці із наступними колонками:

• Код ЄДРПОУ

• Назва компанії

• ПІБ контактної особи

• Email контактної особи

• Номер телефону

• Ознака реєстрації на платформі — візуалізація у вигляді іконок

• Статус — поле містить інформацію щодо контрагента («Новий» при доданні контрагента вручну кнопкою «Додати контрагента») і дату відправлення запрошення

• Статус запрошення — відображає статус запрошення після обробки контрагентом, можливі значення: «Прийнято», «Розірвано», «Відхилено»

Для додання контрагента до переліку робочих контактів натисніть «Додати контрагента»:

У формі, що відкриється, заповніть поля «Код ЄДРПОУ», «Назва компанії», «ПІБ контактної особи», «Email контактної особи», «Номер телефону», «Коментар» і натисніть «Зберегти».

Зверніть увагу!

Кнопка «Зберегти» активується тільки після заповнення обов’язкових полів (виділені червоним).

Для прискорення процесу внесення нових контрагентів реалізована можливість завантажити список контрагентів з Excel (кнопка «Завантажити з Excel» 2). Для зручності заповнення реалізовано шаблон Excel (кнопка «Завантажити шаблон» 1).

Для відправлення запрошення оберіть потрібного контрагента зі списку, поставивши відмітку у чекбоксі, і натисніть на кнопку «Відправити запрошення»:

Відкриється форма, що містить перелік підготовлених шаблонів (налаштовуються і зберігаються у розділі «Контрагенти» - «Шаблони запрошень»).

Для вибору шаблона введіть початкові символи назви шаблона у поле пошуку і оберіть потрібний варіант. Для відправлення натисніть «Надіслати запрошення».

Зверніть увагу!

За один раз можна відправити лише одне запрошення (багатьом контрагентам). Для масової відправки шаблонів контрагенту(-там) перейдіть у розділ «Контрагенти» - «Шаблони запрошень».

Після натискання кнопки «Відправити запрошення» на підставі обраного шаблона будуть створені контракти і відправлені усім вибраним контрагентам. При цьому у колонці «Статус» на стартовій сторінці розділу «Мої контрагенти» з’явиться відповідне повідомлення.

Якщо контрагент не зареєстрований на платформі EDIN-DOCflow, у разі відправлення запрошення йому на пошту надійде лист із посиланням для реєстрації. Відправник листа - noreply@edin.ua, тема – «До уваги партнерів компанії N». В цьому випадку контрагентові необхідно перейти за посиланням для реєстрації на платформі, використовуючи свій ЕЦП/КЕП. При цьому, в рамках політики безпеки виконується перевірка ідентичності коду ЄДРПОУ компанії із запрошення та коду ЄДРПОУ ключа. Після успішної реєстрації, на основі даних з ЕЦП/КЕП контрагента буде створена компанія, а запрошення автоматично набуде статусу «Прийнято».

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

Під обробкою мається на увазі надання вхідному сценарію документообігу статусу «Прийнятий» або «Відхилений». Для обробки сценарію документообігу, що надійшов від контрагента, перейдіть до розділу «Контрагенти» - «Сценарії документообігу» та зайдіть у папку «Вхідні». В папці списком будуть відображені всі сценарії документообігу, надіслані партнерами. Необроблені сценарії документообігу будуть відображені зі статусом «Новий».

Для пошуку необхідного сценарію документообігу у розділі реалізовано фільтр із можливістю пошуку за назвою і номером, за назвою і кодом ЄДРПОУ компанії-ініціатора і клієнта, за статусом і терміном дії сценарію документообігу.

Для обробки обраного сценарію документообігу натисніть на його назву, після чого відкриється форма обробки з можливістю «Прийняти» або «Відхилити» сценарій.

На вкладці «Типи комплектів» відображається перелік вихідних та вхідних (підпапки «Вихідні» та «Вхідні» відповідно) типів комплектів, налаштованих власником (ініціатором) сценарію документообігу для обміну в межах даного сценарію. Натиснувши на назву типу комплекта, можна переглянути правила роботи с документами для даного типу комплекта:

Відображення розділу «Типи комплектів» у випадку, якщо власник встановив відмітку «Всі комплекти»:

При обробці нового сценарію документообігу реалізована можливість налаштувати зв’язок з довідниками. Для цього перейдіть на вкладку «Довідники» і натисніть «Додати». У формі, що відкриється, оберіть з випадаючого списку довідник і значення і натисніть «Зберегти». У списку для вибору будуть доступні довідники, додані в розділі «Налаштування компанії» - «Мої компанії» - «Довідники».

11 Білінг

Для перегляду інформації по транзакціях, що відбулися за компаніями акаунта, перейдіть до розділу «Особистий кабінет» - «Білінг»:

Транзакції відображаються списком із виведенням наступної інформації:

• Відправник — назва і код ЄДРПОУ компанії-відправника

• Отримувач — назва і код ЄДРПОУ компанії-отримувача

• Дата транзакції

• Тип транзакції — відправлення документа чи довкладення отримувача

• Напрямок — вхідна / вихідна

• Ознака тарифікації

• Номер комплекта — у вигляді посилання із можливістю перейти до перегляду комплекта

Система фільтрів дозволяє здійснювати пошук транзакцій за наступними параметрами:

• Компанія — вибір із випадаючого списку, де відображені всі компанії акаунта

• Тип транзакції — відправлення документа чи довкладення отримувача

• Період — обирається помісячно

• Напрямок

Реалізована можливість відфільтрувати транзакції за ознакою вхідна / вихідна / тарифікована. До тарифікованих транзакцій належать відправлення документа і довкладення отримувача. Тарифікація транзакцій відбувається згідно з обраним тарифним планом (налаштування в розділі «Особистий кабінет» - «Рахунки»).

12 Рахунки та акти

Для перегляду інформації по рахунках перейдіть до розділу «Особистий кабінет» - «Рахунки та акти». У розділі у вигляді таблиці будуть відображені всі рахунки та акти по компаніях акаунта із виведенням наступної інформації:

• Номер рахунку

• Дата здійснення рахунку

• Сума рахунку

• Період оплати

При цьому несплачені рахунки будуть розміщені на початку списку і підсвічені червоним, сплачені підсвічуватимуться зеленим.

У таблиці напроти рахунку реалізована можливість скачати рахунок і акт (за наявності).

Можливо скачати рахунок або акт як PDF файл, при натисканні на відповідні іконки «Завантажити рахунок» і «Завантажити акт». При наведені курсора на іконку з’явиться спливна підказка.

Система фільтрів дозволяє здійснювати пошук за наступними атрибутами:

• Номер рахунку

• Статус (сплачений / несплачений)

• Дата рахунку

• Дата оплати

• Дата акту

• Наявність акту

• Узгодження

13 Групи для узгодження

Групи користувачів необхідні для налаштування процесу узгодження. Інформація за групами користувачів доступна в розділі «Налаштування доступу» - «Групи для узгодження», де відображаються всі створені групи із можливістю фільтрації за компанією.

Для створення нової групи натисніть «Створити»:

У формі, що відкриється, введіть назву групи, оберіть з випадаючого списку компанію, у межах якої створено групу, після вибору компанії стане доступно поле для додавання користувачів. За потреби додайте коментар:

У списку для вибору будуть доступні всі користувачі, що закріплені за компанією. Для видалення користувача із групи натисніть позначку «хрестик» біля імені користувача.

Для редагування даних групи оберіть потрібну групу в переліку відображених у розділі і натисніть на її назву. У формі, що відкриється, натисніть «Редагувати», внесіть необхідні зміни і натисніть «Зберегти».

Для видалення групи натисніть кнопку «Кошик» біля назви групи.

14 Маршрути узгодження

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

Зверніть увагу!

Для створення маршруту узгодження, спочатку необхідно створити групу для узгодження з учасниками узгодження.

Для налаштування правил і послідовності процесу узгодження перейдіть до розділу «Налаштування узгодження» - «Узгодження». В розділі у вигляді списку будуть відображені вже створені процеси узгодження по всіх компаніях, доступних користувачеві за маршрутом і роллю.

Для додання нового маршруту узгодження натисніть «Створити».

У формі, що відкриється, введіть назву процесу узгодження і оберіть компанію, в межах якої налаштовується узгодження. Після збереження даних (кнопка «Зберегти») для роботи стануть доступні вкладки «Крок» і «Тип документа»:

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

• Номер кроку узгодження — заповнюється автоматично

• Пріоритет — виставляється користувачем і визначає черговість виконання кроків; чим більше значення, тим вищий пріоритет

• Група виконавців — визначає групу осіб, що виконуватимуть завдання; в полі реалізований вибір із випадаючого списку; список груп налаштовується в розділі «Налаштування узгодження» - «Групи», обмеження на додання груп - 5

• Завдання — визначає тип завдання для виконання: узгодження (надання статусу «Погоджено» або «Відхилено»), підписання, повідомлення (надання статусу «Ознайомлений»)

• Тип виконання — визначає кількість задіяних користувачів, варіанти вибору «до виконання всією групою» (кожен із учасників групи має виконати дію, визначену в полі «Завдання»), «до виконання одним із групи» (достатньо, аби дію виконав один із учасників групи). При наданні типу документа статусу «Відхилено» кимось із учасників групи документ вибуває з процесу узгодження, а завдання автоматично анулюється. При цьому обов’язково зазначається причина відхилення.

• Термін виконання — визначає термін виконання у днях.

Для редагування існуючого кроку узгодження натисніть кнопку «Олівець», внесіть необхідні зміни у форму налаштувань і натисніть «Зберегти». Для видалення кроку натисніть кнопку «Кошик».

Для додання типів документів до процесу узгодження перейдіть до вкладки «Тип документа». На вкладці у вигляді списку будуть відображені типи документів для узгодження за обраною компанією.

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

Відкриється форма з автоматично заповненим полем «Компанія» (відповідно до назви компанії, вказаної при створенні узгодження) і можливістю вибрати тип документа.

При додаванні типу документа на формі редагування налаштування узгодження, якщо до типу документа прив’язаний довідник - відобразиться поле для вибору значення цього довідника; Якщо довідник не містить значеннь - поле не відображається.

При виборі значення, яке містить «дочірні» значення, поля для вибору дочірніх значень виводяться аж до фінального «підлеглого» значення. Інформація по обраних значеннях довідника по типу документа відображається в списку прив’язаних до налаштування узгодження документів.

Довідники обов’язково заповнювати до фінального дочірнього значення. Довідники доступні до редагування тільки на стороні відправника комплекта.

Зверніть увагу!

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

На етапі відправлення комплекта із документами, що потребують узгодження, замість кнопки «Відправити» відображатиметься кнопка «Відправити на узгодження»:

Відправити комплект із документами, для яких процес узгодження не завершено, неможливо.

15 Аналітика

Розділ у якому можливо створити звіт про документообіг, відображається тільки користувачам з ввімкненими ролями на даний розділ (меню «Налаштування доступу» → «Ролі» → «Розділи»).

Розділ дозволяє «Створити звіт» по зовнішньому документообігу за обраний період часу по одній з «своїх» компаній (також можливо вибрати контрагента), а також звіт по завданням, де потрібно вказати компанію та користувача, а також тип та статус завдання.

В меню відображається: Період звіту, Мої компанії, Контрагенти, Дата і час створення звіту, кнопка «Завантажити» або статусний значок «звіт створюється», що означає «Звіт створюється, очікуйте повідомлення на електронну пошту».

Період часу вказується з календаря (мінімальне значення 1 день, максимальне - 31 день), «Компанія» вибирається з усіх (активних і заблокованих) компаній аккаунта, а «Контрагент» зі списку власників та клієнтів з контрактів. Вибірка формується за датою відправлення документу (а не створення), тобто для документів зі статусом відмінним від статусу Чернетка.

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

За фактом створення звіту буде надіслано повідомлення на Email адресу поточного користувача, також з’явиться кнопка для скачування навпроти відповідного запису з періодом звіту. Посилання на скачування звіту доступне 31 день, для скачування необхідно пройти авторизацію. Звіт доступний для скачування в форматі Excel (* .xls).

16 Вибір тарифного плану

Ви можете самостійно ознайомитися з доступними тарифними планами, вибрати підходящий саме для ваших цілей тариф та навіть сформувати ранунок на певний період.

Для цього перейдіть у розділ «Особистий кабінет» – «Тарифні групи», де ви можете ознайомитися з тарифними планами та дізнатися про переваги кожного:

Натисніть на кнопку «Детальніше» для ознайомлення з умовами тарифікації, який функціонал буде доступний після підключення тарифу, а також можливість створити рахунок:

Після натискання на кнопку Створити рахунок, відкривається вікно у якому можливо обрати період дії тарифу, а також встановити ознаку автопролонгації - тобто можливість автоматично формувати рахунок щомісяця:

Після вибору періоду, натисніть «Створити рахунок» знову - автоматично створится рахунок та відкриється вікно перегляду рахунків та актів:

Якщо ви не впевнені який тарифний план підходить саме для вашого бізнесу, ви можете лишити запит на консультацію - натисніть «Замовити консультацію» та лишіть свої контактні дані:

1

Ієрархічні деревовидні довідники — це багаторівневий деревовидний список з головними - материнськими, та підлеглими - дочірніми значеннями, що розкриваються послідовно.

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інструкція адміністратора користувачів

---

Зміст:

• Інструкція адміністратора користувачів

  • 1 Терміни та визначення

  • 2 Авторизація

  • 3 Створення облікового запису користувача

  • 4 Налаштування акаунта

  • 5 Створення ролі

  • 6 Керування розсилкою повідомлень

---

Дана інструкція описує порядок дій адміністратора користувачів зі створення, редагування ролей та облікових записів користувачів.

1 Терміни та визначення

• Компанія – юридична чи фізична особа, яка використовує систему для виконання своїх процесів. До одного акаунта можливо прив’язати декілька компаній. Документи, довідники, типи комплектів і контракти створюються в межах компанії і закріплюються за нею.

• Роль користувача – визначає обмеження доступу до розділів системи.

• Користувач – працівник, який буде створювати, редагувати, підписувати чи обробляти комплект документів. Для користувачів, що оброблятимуть комплект документів, налаштовуються доступи до комплектів.

• Адміністратор Компанії та модуля Cryptex (АК) – користувач, який відповідає за налаштування Компанії, модуля Cryptex, налаштовує роботу з сертифікатами та ключами шифрування. АК має доступ до розділів «Журнал подій» (перегляд), «Шифрування» в карточці компанії та «Сертифікати» (редагування).

• Адміністратор користувачів (АП) – користувач, відповідальний за створення, редагування облікових записів користувачів, присвоєння ролей користувачам. Для АП доступний розділ «Користувачі».

• Адміністратор ролей (АР) – користувач, що відповідає за створення та редагування ролей, налаштування доступів до комплектів (присвоєння довідників та їх значень). Для АР доступний розділ «Ролі».

• Бізнес-адміністратор (БА) – користувач, відповідальний за налаштування та введення довідників, обробку контрактів, налаштування компанії, налаштування та керування комплектами та типами документів. БА доступні розділи «Мої компанії», «Сценарії документообігу», «Налаштування комплектів документів».

2 Авторизація

Для авторизації на платформі перейдіть за посиланням https://doc.edin.ua/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Створення облікового запису користувача

Для створення облікового запису нового користувача перейдіть до розділу меню «Налаштування доступу» - «Користувачі». В розділі відображається перелік вже існуючих облікових записів користувачів. Список можливо відфільтрувати за статусом або скористатися пошуком за ПІБ чи email.

Для створення облікового запису користувача натисніть «Створити користувача»:

Форма створення / редагування облікового запису користувача містить наступні вкладки:

• Основна інформація – містить базову інформацію з налаштувань користувача, дозволяє задати рівень складності пароля, дає можливість скинути пароль для користувача

• Білий список – використовується для налаштування білого списку доступних ІР-адрес, з яких буде можливо заходити на платформу

• Ролі – вкладка для призначення ролей користувачам

• Шифрування – вкладка для встановлення параметрів розшифрування документів

• Доступ до комплектів – містить перелік контрактів і типів комплектів, до яких має доступ користувач.

3.1 Основна інформація

Для створення облікового запису користувача заповніть обов’язкові поля (виділені червоним і позначені «зірочкою») форми «Основна інформація». Значення, внесене в поле Email, буде використовуватися системою як логін. Процедура зміни Email описана в «Інструкції з авторизації».

Поле ПІБ призначене для внесення прізвища, імені та по-батькові користувача, мінімальна кількість знаків для внесення – п’ять.

Поле «Парольна політика» містить випадаючий список рівнів парольної політики, які налаштовуються в меню «Безпека» - «Безпека акаунту» – «Парольна політика».

За відсутності інших налаштувань до користувача, для якого не встановлений рівень парольної політики, застосовуються наступні правила:

• Обов’язкове використання капчі;

• Час блокування користувача – 5 хвилин

• Кількість попередніх паролів (кількість раніше використаних паролів,збережених у системі для блокування їх повторного використання) – 1

• Мінімальна довжина пароля - 6 знаків

• Обов’язкова наявність цифр у паролі.

Зверніть увагу!

Значення поля Email (логін користувача) повинно бути унікальним. У разі введення даних вже зареєстрованого користувача система повідомить про помилку.

3.2 Білий список IP-адрес

Якщо не задано інакше, доступ дозволено з будь-якої IP-адреси:

Для внесення обмежень за IP-адресою користувача натисніть «Редагувати», перейдіть до вкладки Білий список і натисніть «Додати обмеження»:

Для додання IP-адреси до переліку необхідно ввести цифрове значення у відповідне поле та натиснути «Зберегти». Для зручності реалізована можливість вказати лише початкові цифри IP-адреси, замінивши останні цифри «зірочками» — * :

Після додання усіх необхідних IP-адрес натисніть кнопку «Зберегти». Система повідомить про успішне збереження даних. Обмеження за кількістю доступних IP-адрес у білому списку відсутнє. Для видалення IP-адреси з переліку натисніть «Видалити»:

3.3 Призначення ролі

Оскільки роль визначає перелік розділів, доступних користувачеві, призначення ролі є необхідною передумовою початку роботи нового користувача. Обмеження не стосується користувачів, які є власниками акаунта.

Для призначення ролі користувачеві натисніть «Редагувати», перейдіть до вкладки «Ролі» і натисніть «Додати»:

Наступним кроком виберіть роль для користувача з випадаючого списку і натисніть «Додати». У списку будуть відображені всі ролі, створені в розділі «Налаштування доступу» - «Ролі»:

Одному користувачеві можливо призначити декілька ролей.

Для видалення ролі зі списку призначених користувачеві натисніть позначку «Видалити» навпроти ролі.

3.4 Шифрування

Для визначення порядку розшифрування документів для користувача перейдіть до вкладки «Шифрування» і оберіть потрібний варіант:

При виборі «Розшифрувати документи за допомогою Cryptex» необхідно вказати IP-адресу серверу шифрування і порт сервера (комп’ютера), де встановлений модуль.

Для збереження внесених данних натисніть «Зберегти».

3.5 Доступ до комплектів

Доступ до комплектів використовується для визначення зв’язку користувача та сценаріїв документообігу і типів комплектів, доступних користувачеві для роботи. Список доступів до комплектів налаштовується у розділі «Налаштування доступу» - «Доступ до комплектів». Для додання доступу до комплектів до облікового запису користувача перейдіть до вкладки «Доступ до комплектів», де у вигляді списку будуть відображені всі доступи, призначені даному користувачеві. Для додання доступів натисніть «Додати»:

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

3.6 Налаштування облікового запису користувача при інтеграції

За відсутності інших налаштувань капча застосовується для всіх користувачів при доступі на WEB-платформу. Для користувачів із інтеграційним підключенням для обробки комплектів капча не застосовується.

Для вимкнення капчі перейдіть до розділу «Особистий кабінет» – «Акаунт» – «Парольна політика» і створіть або відредагуйте парольну політику без застосування капчі. Для цього зніміть відмітку у відповідному чекері:

Детальніше про порядок налаштування парольної політики в пункті 4.3 даної інструкції.

В цілях безпеки для користувачів із вимкненою капчею рекомендовано налаштовувати білий список.

3.7 Блокування користувача

З метою обмеження доступу користувачів на плафторму реалізована можливість їх блокування. Для цього натисніть «Редагувати» у формі налаштувань облікового запису користувача. У формі, що відкриється, натисніть перемикач «Заблокувати»:

Для розблокування поверніться до форми налаштувань користувача («Налаштування доступу» – «Користувачі» - «Редагувати») та натисніть перемикач «Розблокувати»:

4 Налаштування акаунта

Для спрощення процедури створення облікових записів користувачів реалізована можливість встановлення налаштувань білого списку, шифрування та парольної політики на рівні акаунта у розділі «Безпека» - «Безпека акаунту».

4.1 Налаштування парольної політики

Для налаштування парольної політики перейдіть до розділу меню «Безпека» - «Безпека акаунту», вкладка «Парольна політика». На вкладці відображений перелік всіх створених рівнів парольної політики із можливістю редагування та видалення.

Для створення нового рівня натисніть «Створити»:

У формі створення рівня парольної політики заповніть наступні поля:

• Назва — назва рівня парольної політики (обов’язкове для заповнення поле)

• Довжина пароля — мінімальна кількість символів 4, максимальна - 50 (обов’язкове для заповнення поле)

• Складність пароля — зумовлює необхідність використання у паролі наступних символів: великих літер, малих літер, спец. символів; наявність цифр обов’язкова (відмітка проставлена автоматично)

• Кількість попередніх паролів — вказується кількість раніше використаних паролів, збережених у системі для блокування їх повторного використання; поле не обов’язкове для заповнення

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

• Час блокування — мінімальне значення 3 (хвилини) , максимальне 1440 (= 24 години).

На формі також є можливість увімкнути / вимкнути капчу, встановивши відмітку у відповідному чекері:

Після заповнення форми налаштувань натисніть «Зберегти».

4.2 Налаштування білого списку на рівні акаунта

Для налаштування обмежень за IP-адресами перейдіть до розділу «Особистий кабінет» – «Акаунт», вкладка «Білий список IP адрес».

Якщо не задано інакше, доступ дозволено з будь-якої IP-адреси:

Для додання обмеження необхідно натиснути Додати обмеження, ввести IP-адресу, з якої користувачеві буде дозволений доступ до платформи, та натиснути «Додати»:

При створенні облікового запису нового користувача вказані у даному розділі IP-адреси будуть автоматично завантажені до налаштувань користувача у меню «Налаштування доступу» - «Користувачі».

4.3 Налаштування шифрування на рівні акаунта

Для визначення порядку розшифрування документів на рівні акаунта перейдіть до розділу «Особистий кабінет» – «Акаунт» – «Шифрування»:

Серед доступних методів розшифрування Web або Cryptex оберіть потрібний варіант і натисніть «Зберегти». При створенні облікового запису нового користувача вказані у даному розділі налаштування будуть автоматично завантажені на вкладку «Шифрування» у формі налаштувань користувача меню «Налаштування доступу» - «Користувачі».

5 Створення ролі

Для створення ролі перейдіть до розділу «Налаштування доступу» – «Ролі». У розділі списком відображатимуться всі ролі, створені у межах компаній облікового запису. Натисніть «Створити»:

У формі, що відкриється, заповніть поля «Назва ролі», «Код ролі», «Компанія». Всі поля є обов’язковими для заповнення. Значення для поля «Компанія» необхідно вибрати з системного переліку. Значення, введене в поле «Код ролі», повинно бути унікальним у межах компанії.

Після внесення даних натисніть «Створити». Система повідомить про успішне створення ролі і відкриє форму налаштувань.

На вкладці «Користувачі» оберіть користувачів, котрим буде призначена роль. Для цього натисніть «Додати користувача» і оберіть із переліку :

Одну роль можливо призначити декільком користувачам (кількість користувачів необмежена). Для визначення прав доступу для ролі перейдіть до вкладки «Розділи»:

Розділ передбачає наступні варіанти доступу:

• Немає доступу – розділ не відображається для користувача

• Перегляд – розділ доступний для перегляду без можливості редагування

• Редагування і перегляд – повний доступ до всіх опцій розділу.

До початку налаштувань всі розділи є закритими для ролі (автоматично проставлена відмітка «немає доступу»). Для надання доступу встановіть відмітку напроти певного розділу та натисніть «Зберегти».

Розділи в ролі відповідають наступним розділам платформи:

• Комплекти – «Зовнішні комплекти документів»

• Компанії - «Налаштування компанії» - «Мої компанії»

• Сценарії документообігу - «Контрагенти» - «Сценарії документообігу»

• Типи комплектів - «Налаштування компанії» - «Налаштування комплектів документів»

• Користувачі - - «Налаштування доступу» - «Користувачі»

• Безпека - «Безпека» - «Безпека акаунту»

• Акаунт – «Особистий кабінет» - «Акаунт»

• Журнал подій - «Особистий кабінет» - «Журнал подій»

• Доступ до комплектів - «Налаштування доступу» - «Доступ до комплектів»

• Налаштування сценаріїв документообігу - «Контрагенти» - «Сценарії документообігу»

• Рахунки - «Особистий кабінет» - «Рахунки та акти»

• Групи для узгодження - «Налаштування доступу» - «Групи для узгодження»

• Узгодження - «Налаштування доступу» - «Маршрути узгодження»

• Мої завдання - «Мої завдання»

• Контрагенти - «Контрагенти» - «Запрошення контрагентів»

• Внутрішній документообіг

• Аналітика - «Аналітичні звіти»

• Білінг - «Особистий кабінет» - «Білінг»

• Ролі - «Налаштування доступу» - «Ролі»

• Список тегів - «Налаштування компанії» - «Керування тегами»

• Сертифікати безпеки - «Безпека» - «Сертифікати безпеки»

5.1 Рекомендації щодо налаштування спеціальних ролей

5.1.1 Бізнес-адміністратор

Для налаштування ролі бізнес-адміністратора надайте доступ до редагування наступних розділів:

5.1.2 Адміністратор

Налаштування ролі адміністратора передбачає доступ до наступних розділів:

5.1.3 Адміністратор користувачів

Налаштування ролі адміністратора доступу користувачів передбачає доступ до наступних розділів:

5.1.4 Користувач

Налаштування ролі користувача передбачає доступ до наступних розділів:

5.2 Автоматичне створення ролей

Для зручності ролі бізнес-адміністратора, адміністратора системи та користувача створюються автоматично при доданні нової компанії («Налаштування компанії» – «Мої компанії»- «Створити»). Роль адміністратора системи об’єднує в собі ролі адміністратора доступу та адміністратора.

Зверніть увагу!

У разі створення компанії користувачем, який не є власником акаунта, система автоматично надасть йому роль бізнес–адміністратора.

Відредагувати автоматично надану роль можливо у меню «Налаштування доступу» – «Ролі» або «Налаштування доступу» – «Користувачі» – «Редагувати» – «Роль».

5.3 Блокування – розблокування ролі

Для блокування / розблокування ролі переведіть перемикач у відповідне положення:

6 Керування розсилкою повідомлень

Для керування розсилкою повідомлень перейдіть до розділу меню «Налаштування компанії» - «Мої компанії» і виберіть зі списку потрібну компанію, натиснувши на її назву. У формі редагування, що відкриється, перейдіть до вкладки «Повідомлення»:

Вкладка містить наступні поля:

• Ел. адреса для нових сценаріїв документообігу - поле для введення електронних адрес, на які надходитимуть повідомлення щодо отримання нових контрактів

• Ел. адреса для змінених сценаріїв документообігу – поле для введення електронних адрес, на які надходитимуть повідомлення щодо зміни статусу контракту (прийняття або відхилення на стороні отримувача контракту)

• Ел. адреса для нових комплектів – поле для введення електронних адрес, на які надходитимуть повідомлення про отримання нових комплектів

• Ел. адреса для змінених комплектів – поле для введення електронних адрес, на які надходитимуть повідомлення при зміну статусу комплекта отримувачем (надання статусу«прийнятий», «відхилений», «відмова», «уточнення»).

• Ел.адреса для нових завдань на узгодження

• Ел.адреса для нових повідомлень чату

Для кожного поля доступні варіанти:

• Відключити – розсилка не надходитиме

• За користувачем – розсилка надходитиме на Email користувача з відповідними правами доступу. Повідомлення про надходження нових вхідних контрактів або зміну статусу вихідних надходитимуть лише тим користувачам, що мають доступ на перегляд та редагування розділу «Контракти», а також доступ до компанії відповідно до ролі. Повідомлення про надходження нових комплектів або зміну статусу комплекта отримувачем будуть надходити лише тим користувачам, що мають доступ на перегляд та редагування розділу «Зовнішні комплекти документів», а також доступ до комплекта відповідно до ролі та доступу до комплектів. Всі повідомлення також будуть надходити власнику акаунта.

• Вказані адреси – розсилка надходитиме на вказані адреси:

Після заповнення полів та вибору варіанту розсилки натисніть «Зберегти».

Інструкція користувача з обміну комплектами

---

Зміст:

• Інструкція користувача з обміну комплектами

  • 1 Терміни та визначення

  • 2 Авторизація

  • 3 Передумови обміну комплектами

  • 4 Створення та відправка комплекта

  • 5 Редагування комплекта та відстеження статусу

  • 6 Обробка вхідних комплектів документів

  • 7 Мої завдання

  • 8 Внутрішній документообіг компанії

  • 9 Візуалізація ЕЦП

  • 10 Багатоступеневе узгодження за допомогою ієрархічних довідників

  • 11 Копіювання комплекту с документами, позначеними для редагування

---

Дана інструкція описує порядок дій користувача на платформі DOCflow з підготовки до обміну комплектами, створення та відправлення комплекта документів.

---

1 Терміни та визначення

• Компанія – юридична чи фізична особа, яка використовує систему для виконання своїх процесів. До одного акаунта можливо прив’язати декілька компаній. Документи, довідники, типи комплектів, контракти, маршрути, налаштування узгодження створюються в межах компанії і закріплюються за нею.

• Тип документа – спеціальний системний довідник, що містить дані за типами документів, якими виконуватиметься обмін між сторонами.

• Тип комплекта – налаштування та параметри комплекта документів для обміну.

• Контракт – форма налаштування зв’язку між контрагентами, у відповідності до якої відбувається обмін комплектами документів.

• Маршрут – операція визначення працівників отримувача, які будуть отримувати та обробляти комплекти документів. Маршрут будується на основі переліку доступних користувачеві контрактів і типів комплекта.

• Електронний цифровий підпис (ЕЦП/КЕП) — електронний цифровий підпис уповноважених осіб та окремий електронний цифровий підпис, що виконує функцію печатки (у разі наявності), з посиленим сертифікатом ключа, наданим акредитованими центрами сертифікації ключів (далі – АЦСК).

2 Авторизація

Для авторизації на платформі перейдіть за посиланням https://doc.edin.ua/auth та введіть свої логін та email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Передумови обміну комплектами

Налаштування, які є передумовами обміну комплектами, детально викладені в «Інструкції бізнес-адміністратора», «Інструкції з налаштування ЕЦП/КЕП», «Інструкції з налаштування шифрування». Деталі процедури створення та налаштування облікових записів користувачів та їх ролей описані в «Інструкції адміністратора користувачів».

Для пришвидшення та полегшення налаштування аккаунту на платформі, скористайтеся підказками Майстра налаштувань, що з’явиться при першому відвідуванні платформи після авторизації.

За допомогою майстра ви зможете здійснити первісні налаштування для обробки та обміну документів та комплектів документів:

1. Створення вашої компанії (знадобиться ЕЦП/КЕП або токен з ключем)

2. Створення типів документів (Мої компанії => Документи), якими плануєте обмінюватися із своїми контрагентами

3. Створення комплектів, правил обробки документів в комплекті та сценарії доступу

4. Запрошення контрагентів

Слідуйте підсказкам (по кнопці Далі) та підготуйте усі умови для зручного та швидкого обміну комплектами документів.

Якщо не хочете знову бачити майстер налаштувань при повторному вході, відмітьте позначку Не запускати Майстер налаштування автоматично. Щоб викликати Майстер повторно, натисніть на позначку «шестерні» біля перемикача мови платформи.

4 Створення та відправка комплекта

Для створення комплекта перейдіть до розділу меню «комплекти» і натисніть «Створити комплект»:

У формі створення комплекта виберіть компанію, яка відправлятиме комплект документів, із випадаючого списку:

Після вибору компанії стане доступним поле для вибору сценарію документообігу. Поле містить перелік активних (діючих) сценаріїв за обраною компанією, що відображаються випадаючим списком.

Після вибору сценарію система відобразить перелік доступних комплектів:

Для вибору типу комплекта натисніть кнопку Створити. Після цього автоматично відкриється форма для заповнення обраного типу комплекта.

Зверніть увагу!

Якщо у формі контракту не налаштований перелік типів комплектів, система повідомить про їх відсутність.

У такому випадку слід виконати налаштування переліку вихідних типів комплектів відповідно до пункту 5.1.2 даної інструкції (для вихідних контрактів) або узгодити відповідні налаштування на стороні контрагента (для вхідних контрактів).

4.1 Заповнення комплекта

При створенні чи редагуванні комплекта відкриється форма обробки комплекта, що містить наступні вкладки:

• Документи – основний розділ для додавання та обробки документів, також можливо додати теги, створені раніше

• Основна інформація – містить загальну інформацію про комплект (дані про Відправника та Отримувача, дані про контракт, дані про комплект, статус комплекта)

• Чат – розділ містить інформацію щодо змін і коментарів до документів та комплекта

• Додаткові атрибути – використовується для керування користувацькими полями, що пов’язані з комплектом

• Довідники – використовується для керування довідниками, що пов’язані з комплектом

Комплект створюється передзаповнений інформацією, що додана до цього комплекту у Налаштування компанії -> Налаштування комплектів документів.

4.1.1 Введення довідників

Вкладка «Довідники» містить перелік довідників, які потребують заповнення відповідно до налаштувань типу комплекта. Для заповнення довідника натисніть Редагувати.

Далі виберіть значення з випадаючого списку та натисніть Зберегти:

Додаткові атрибути додаються та налаштовуються у Налаштування компанії -> Налаштування комплектів документів.

4.1.2 Введення документів

Вкладка «Документи» містить перелік обов’язкових та не обов’язкових документів для даного комплекта. Обов’язкові для конкретного комплекта документи позначаються відміткою . Документи, що потребують шифрування, позначаються відміткою .

Для завантаження документа натисніть «Додати»:

Після цього з’явиться можливість завантажити файли документів. Для завантаження файлу або файлів натисніть кнопку «Обрати файл» та виберіть необхідні файли з власного ПК.

Якщо для даного типу документа встановлено обмеження, система повідомить про помилку (обмеження кількості документів встановлюється у налаштуваннях типу комплекта), наприклад про перевищення розміру файлу:

Якщо для документа встановлено ознаку шифрування, перед початком завантаження файлу необхідно вибрати ЕЦП/КЕП, який буде використано для шифрування. При цьому сертифікати для шифрування повинні бути завантажені як на стороні відправника, так і отримувача.

Після завантаження файлу натисніть кнопку Зберегти:

Зверніть увагу!

Для документів, які відповідно до налаштувань типу комплекта повинні бути завантажені на стороні контрагента (довкладення), відсутня кнопка «Додати».

При додаванні документа з привязаним довідником, необхідно заповнити усі значення довідника до фінального дочірнього значення. Ви можете також редагувати довідники, які привязані до типу докумена у комплекті.

Для цього необхідно перейти в «Чернетки», вибрати комплект що потребує редагування, та внести зміни. Довідники доступні до редагування тільки на стороні відправника комплекта.

Документ у якому потрібно редагувати довідник, показує підсказку «Потрібно додати значення». Натисніть кнопку «Редагувати значення», для того щоб вибрати усі небхідні значення довідника, потім натисніть «Зберегти».

4.1.4 Додання раніше підписаного документа

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

Якщо для документа встановлено ознаку шифрування, перед завантаженням файлів підписів документ необхідно розшифрувати. Для цього на формі виберіть ключ для розшифрування:

Після цього натисніть «Завантажити». При завантаженні система перевіряє валідність підпису. Файли підписів, що пройшли перевірку, можливо зберегти. У разі помилки верифікації підпису з’явиться відповідне повідомлення. Завантажені підписи додаються до загальної кількості підписів на документі.

4.1.5 Підписання документа(ів)

Для підписання одиничного документа натисніть на кнопку підпису Підписати в необхідному рядку:

Якщо для документа встановлено ознаку шифрування, перед підписанням його необхідно розшифрувати. Для цього виберіть ЕЦП/КЕП для розшифрування. Успішно розшифрований документ можливо буде підписати. У разі виникнення помилки розшифрування з’явиться відповідне повідомлення, і подальше підписання буде неможливим.

Ознайомтеся з інструкцією з з налаштування ЕЦП/КЕП для підписання! .

У разі використання MobileID користувачеві буде надіслано sms-запит на номер телефону, зв’язаний із ЕЦП/КЕП. Для підтвердження підписання введіть код підтвердження.

Для масового підписання виберіть у списку потрібні документи та натисніть кнопку «Підписання виділених». При цьому відкриється форма підписання з переліком вибраних файлів. Якщо серед вибраних документів є такі, що потребують шифрування, їх потрібно розшифрувати.

Зверніть увагу!

Підписати документ тим самим підписом декілька разів неможливо.

4.1.6 Видалення документа

Для видалення документа натисніть відповідну кнопку Видалити файл. Підтвердження дії призведе до видалення контенту та підписів, що були накладені чи завантажені окремо:

4.1.7 Перегляд детальної інформації

Для отримання детальної інформації за документом після завантаження файлу, або для переходу до редагування даних документа натисніть на кнопку «Додаткова інформація по документу»:

У формі, що відкриється, потрібно натиснути кнопку «Редагувати»:

Після чого відкриється форма для редагування:

На формі, що відкриється, будуть відображені наступні дані: назва типу документа, ім’я файлу, № та дата документа, коментар, дата/час відправки, кількість підписів, а також детальна інформація щодо накладених підписів з позначкою часу, додаткові користувацькі поля, посилання для скачування документу, тощо.

Для редагування даних документа натисніть «Редагувати» і внесіть необхідні зміни. Для збереження внесених даних натисніть «Зберегти документ».

До відправки документу, можливо додати персоналізовані теги (стаоренні раніше). Для цього виберіть тег зі списку, натисніть кнопку Додати. тег відразу відобразиться біля поля з тегами. Теги спрощують пошук комплекту у подальшому.

4.2 Відправлення комплекта

Для відправки комплекта натисніть кнопку «Відправити» на формі комплекта:

У разі, якщо в комплекті не заповнені обов’язкові довідники чи користувацькі поля, обов’язкові документи не містять файлів або не дотримано вимоги щодо мінімальної кількісті ЕЦП/КЕП, кнопка «Відправити» буде заблокована. Для отримання повідомлення-підказки наведіть курсор на неактивну кнопку.

У разі, якщо до складу комплекта входять документи, що потребують узгодження, замість кнопки «Відправити» відображатиметься кнопка «Надіслати на узгодження»:

Відправити контрагенту комплект із документами, для яких процес узгодження не завершено, неможливо. Для запуску процедури узгодження натисніть кнопку «Надіслати на узгодження». Документу буде надано статус «На узгодженні».

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

У блоці «Журнал узгодження» міститься інформація щодо статусів узгодження, дати та часу виконання завдання (погодити, підписати або переглянути документ), коментар у разі відхилення документа в процесі узгодження:

Тільки після надання документу фінального статусу узгодження активується кнопка «Відправити».

Для масової відправки або видалення комплектів із папки «Чернетки» виділіть необхідні комплекти і натисніть кнопку «Надіслати» / «Видалити»:

Незаповнені комплекти не підлягають відправці і позначаються іконкою Комплект не повний. При масовій відправці такі комплекти не будуть відправлені.

5 Редагування комплекта та відстеження статусу

Для роботи з комплектами перейдіть до розділу «Зовнішні комплекти документів» на навігаційній панелі. Розділ містить наступні папки:

• Вхідні – для отриманих комплектів документів

• Вихідні – для відправлених комплектів

• Чернетки – для зберігання комплектів на стадії обробки

• Архів – для відображення отриманих та відправлених комплектів, які були оброблені і переведені в архів

• Створення ярлику та – для зберігання відфільтрованих комплектів.

Для кожної папки відображається свій список комплектів.

Необроблені та нерозглянуті на стороні контрагента комплекти відображаються зі статусом «Прийнятий» («Надісланий») та виділяються жирним шрифтом. Комплекти відображаються за датою / часом зміни у порядку зменшення (спочатку новіші).

Для редагування комплекта натисніть на рядок із потрібним комплектом, після чого відкриється форма редагування.

5.1 Контроль статусу комплекта

Статус комплекта відображається у списку комплектів у вигляді іконок з відповідним описом, а також на формі редагування комплекта у вкладці «Основна інформація»:

Статуси документів відображаються напроти кожного конкретного документа безпосередньо у формі перегляду/редагування комплекта:

Історія зміни статусів зберігається у розділі «Чат» форми обробки:

5.2 Фільтр (пошук комплекта)

Дізнайтеся більше про використання фільтрів та пошук за тегами у «Інструкції користування пошуком та фільтрами».

Для пошуку потрібного комплекта натисніть «Фільтр»:

Пошук виконується за наступними атрибутами:

• Номер (для пошуку вкажіть три або більше символів номера комплекта)

• Статус (поле містить системний перелік статусів у відповідності до обраного розділу)

• Дата (вказується в діапазоні від _ до)

• Відправник (ЄДРПОУ, назва)

• Тип комплекта відправника (для фільтрування за типом комплекта необхідно обрати відправника у відповідному полі фільтра)

• Отримувач (ЄДРПОУ, назва)

• Тип комплекта отримувача (для фільтрування за типом комплекта необхідно обрати отримувача у відповідному полі фільтра)

• Тег (вибрати назву тегу)

• Довідник

• Додаткові атрибути (користувацькі поля)

Для одночасного видалення внесених у налаштування фільтра значень натисніть «Скинути».

5.3 Уточнення до комплекта з боку відправника

До комплекта в статусі «Відправлено» чи «Уточнення» можливо довкласти (додати, завантажити) файли на стороні відправника.

Комплекти в статусі «Уточнення» відображаються в папці «Уточнення». Також для таких комплектів у журналі відображені коментарі, зроблені власником контракту (отримувачем).

Для додання файлу зайдіть в комплект, натисніть кнопку «Редагувати» та додайте файл. Підпишіть додані файли (якщо вони потребують підпису) та відправте комплект з новими файлами.

6 Обробка вхідних комплектів документів

Для обробки комплектів, що надійшли від контрагентів, перейдіть до розділу «Зовнішні комплекти документів» на навігаційній панелі меню, папка «Вхідні», та натисніть на рядок із потрібним комплектом - або скористайтеся фільтром на виберіть комплекти у потрібному статусі.

6.1 Керування довідниками

Для перегляду чи редагування довідника, прикріпленого до комплекта, перейдіть на вкладку «Довідники». На вкладці відображені довідники комплекта з заповненими значеннями, що вказав відправник при формуванні комплекта:

Для редагування довідника на стороні отримувача натисніть «Редагувати». При цьому будуть відображені лише ті довідники, які дозволено редагувати користувачеві. Після введення значень виконується їх автоматичне збереження.

6.2 Фільтр та пошук документа у комплекті На формі перегляду/редагування комплекту, у вкладці Документи можливий пошук конкретного длкументу за багатьма параметрами.

Для пошуку документа за статусом, виберіть зі списку статус - активні лише можливі для пошуку статуси:

Для пошуку документа за назвою, у формі обробки введіть три або більше символів у відповідне поле на панелі пошуку:

Також доступні параметри Важливість документів та Готовність комплекту.

Для фільтрування документів за ознаками «обов’язковий» / «необов’язковий» виберіть відповідне значення на панелі пошуку:

Для фільтрування типів документів за ознаками «з документами» / «документи відсутні» виберіть відповідне значення на панелі пошуку:

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

6.3 Обробка документів у комплекті

Для обробки надісланих контрагентами документів перейдіть до вкладки «Документи» у формі обробки комплекта. На вкладці буде відображений список типів документів з завантаженими файлами, панель для пошуку та фільтрації списку, інформація щодо кількості вкладених файлів.

Під обробкою документа слід розуміти надання статусу «Прийнято» чи «Відхилено». Для цього натисніть на відповідну кнопку навпроти кожного документа:

При відхиленні документа необхідно вказати причину відхилення у відповідному вікні:

Встановлення статусу записується в журнал дії за комплектом у вкладці Чат.

Обов’язкові для конкретного комплекта документи позначаються відміткою біля назви (зірочка). Зашифровані документи позначаються відміткою (щит). У списку документів відображається назва файлу та кількість накладених підписів.

Для отримання детальної інформації за документом та накладеними на нього підписами натисніть на іконку «Додаткова інформація про документ».

6.4 Підписання документа отримувачем

Документ можна підписувати як зовнішнім так і внутрішнім Електронним цифровим підписом. Внутрішній ЕЦП додається в тіло документу, зовнішній - створюється в окремому файлі.

Для підписання документа внутрішнім підписом натисніть на іконку підпису :

Якщо для документа встановлено ознаку шифрування, перед підписанням його необхідно розшифрувати. Для цього виберіть ЕЦП/КЕП для розшифрування. Успішно розшифрований документ можливо буде підписати. У разі виникнення помилки розшифрування з’явиться відповідне повідомлення, і подальше підписання буде неможливим.

Після розшифрування виберіть потрібні ЕЦП/КЕП з переліку зчитаних, якими буде виконане підписання документа, і натисніть «Підписати». Кількість накладених ЕЦП/КЕП буде відображена в списку документів.

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

Для накладення зовнішнього підпису натисніть відповідну іконку:

Зверніть увагу!

Підписаний отримувачем документ автоматично набуває статусу «Прийнятий».

6.5 Скачування та перегляд документа та архіву

Для перегляду (ознайомлення) з документом натисніть на його назву або на іконку «Зберегти» (1) навпроти документу, а для скачування всіх документів у комплекті натисніть «Завантажити все» (2):

В залежності від налаштувань методу розшифрування будуть завантажені відповідні дані у .zip архіві або окремим файлом. При скачувані архіву, ви можете вказати документи у якому статусі ви хочете скачати, або вибрати усі. Після вибору статусу натисніть «Завантажити»:

З’явиться вікно формування архіву, та коли підготовка файлів закінчиться - архів завантажиться автоматично:

Зверніть увагу!

Параметри скачування (каталог для зберігання, відображення після скачування тощо) залежать від налаштувань браузера.

Документи у форматі PDF не обов’язково скачувати для перегляду - лише для таких документів можливий перегляд прямо у вікні браузера. Для цього натисніть на піктограмму (око). Документ відкриється у новому вікні браузеру.

6.5.1 Незашифрований документ або розшифрування на WEB

Якщо для типу документа, який скачується, вказано «Нешифрований», або в налаштуваннях шифрування для користувача, який скачує, вказано «Розшифрування на WEB», то при натисканні на ім’я файлу буде скачаний оригінальний файл, а при натисканні на кнопку «Скачати архів» — оригінальний файл та архів підписів. В архіві підписів містяться файли ЕЦП/КЕП, що були накладені, та файл із візуалізацією ЕЦП/КЕП у форматі PDF.

Якщо для типу документа встановлено ознаку шифрування, перед скачуванням файлу необхідно вибрати ЕЦП/КЕП з переліку зчитаних, за допомогою якого буде виконуватись розшифрування контенту.

У разі помилки розшифрування з’явиться відповідне повідомлення і скачування файлу не відбудеться.

6.5.2 Cryptex

Якщо в налаштуваннях розшифрування користувача вказано «Розшифрування Cryptex», то при натисканні на назву файлу чи на кнопку «Скачати архів» буде скачаний архів документів, який містить оригінальний файл, файли підписів, якими підписано документ, файл з візуалізацією ЕЦП/КЕП та друкований макет з «водяними знаками» (тільки якщо оригінальний файл у форматі PDF).

6.6 Довкладення документа в комплект

Примітка

Довкладення може додати лише отримувач комплекта. Автор документа може замінити неузгоджений документ новим виправленим в тому ж пакеті, щоб не витрачати час на створення нового пакета.

Під довкладенням мається на увазі можливість додати (завантажити) документ на стороні отримувача комплекта. Довкладення можливе лише для документа з ознакою «Довкладення отримувача» (встановлюється в налаштуваннях типу комплекта, детальніше про порядок налаштування типів комплектів в «Інструкції бізнес-адміністратора»).

Для завантаження документа перейдіть у форму обробки комплекта, вкладка «Документи», і натисніть «Додати»:

Після цього з’явиться можливість завантажити файли документів. Для завантаження файлу натисніть на кнопку «Обрати файл»:

Якщо для документа встановлено ознаку шифрування, перед початком завантаження файлу необхідно вибрати ЕЦП/КЕП, який буде використано для шифрування. При цьому сертифікати для шифрування повинні бути завантажені як на стороні відправника, так і на стороні отримувача:

Завантажені файли будуть відображені у списку зі статусом «Новий»:

Для передачі довкладення на розгляд відправникові комплекта натисніть кнопку «Надіслати довкладення».

Довкладенню буде наданий статус «Надісланий», комплект набуде статусу «Додано документ», і відповідно буде перенесений до папки «Вхідні». У свою чергу, відправник комплекта отримає можливість перегляду та обробки довкладення.

6.7 Обробка комплекта

Під обробкою комплекту слід розуміти надання комплекту відповідного статусу. Статус комплекту можливо встановити лише за умови, що всі документи в комплекті оброблені. Для встановлення потрібного статусу натисніть відповідну кнопку: «Прийняти» або «Відхилити»:

При встановленні статусу «Відмова», «Відхилено» або «Обробленно» необхідно вказати причину відхилення у відповідному вікні Комментар.

Комплекти у статусі «Оброблено», «Відмова», «Відхилено» відображатимуться в папці «Архів».

6.7.1 Керування додатковими атрибутами

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

Для редагування поля на стороні обробника (отримувача) натисніть «Редагувати». При цьому будуть відображені лише ті поля, які може редагувати користувач:

Після внесення змін натисніть «Зберегти».

6.8 Чат

Для перегляду інформації про зміну статусів документів чи комплекта та коментарів по даних змінах (причини відхилення документа / комплекта) перейдіть до розділу «Чат»:

Записи в журналі відображаються в зворотному хронологічному порядку.

7 Мої завдання

Для документів, що входять у комплект, може бути налаштований процес узгодження (детальніше в «Інструкції бізнес-адміністратора», п. 13). У такому випадку користувачеві, який входить до групи виконавців, необхідно виконати потрібну дію за документом.

Для перегляду завдань для виконання перейдіть до розділу «Мої завдання» навігаційної панелі сервісу, де у вигляді таблиці будуть відображені всі завдання користувача:

Таблиця складається з наступних колонок:

• Компанія одержувач – назва та код ЄДРПОУ компанії, у межах якої виконується узгодження

• Компанія відправник – назва та код ЄДРПОУ компанії, у межах якої виконується узгодження

• Напрямок – напрямок руху документа, вхідний чи вихідний

• Тип завдання - узгодження, підписання, повідомлення

• Дата створення завдання – дата і час створення завдання

• Термін виконання – кінцева дата і час виконання

• Тип документа – тип документа, що підлягає узгодженню

• Завантажити / Переглянути документ – містить посилання на скачування чи форму перегляду документу, що підлягає узгодженню

• Статус завдання - статус виконяння завдання: Виконано, Відхилено, Прострочено;

Статус завдання – містить наступні значення: «до виконання» - надається новому завданню; «виконано» - надається завданню, за яким виконана потрібна дія; «відхилено» - фінальний статус, при наданні якого документ вибуває з процесу узгодження, а завдання автоматично анулюється; статуси відображаються за допомогою іконок, при наведенні курсору на які спливає підказка.

Під виконанням завдання мається на увазі надання документу відповідного статусу за допомогою кнопок: узгодження - «Погодити» або «Відхилити», підписання - «Підписати» та «Завантажити підпис», повідомлення - «Переглянути». Кнопки відображаються в залежності від типу завдання, зазначеного в налаштуваннях. Для типу завдання підписання необхідно підписати документ, вибравши з переліку зчитаних потрібний ЕЦП/КЕП.

Для перегляду форми задачі натисніть на назву компанії (перша колонка в таблиці):

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

При переході за посиланням відкривається форма перегляду комплекта, що містить документ:

Дії узгодження за документом відображаються у «Журналі узгодження» на формі перегляду додаткової інформації про документ (розділ «Комплекти», форма редагування, вкладка «Документи» - Додаткова інформація по документу).

8 Внутрішній документообіг компанії

Внутрішній документообіг необхідний для узгодження внутрішніх документів у межах однієї компанії - наприклад, коли потрібно узгодити зміну тарифу чи розмір знижки для контрагента, або коли заява на відпустку потребує узгодження в різних відділах. Для створення внутрішніх документів перейдіть до розділу «Внутрішній документообіг».

Розділ Внутрішній документообіг складається з розділів «Мої Чернетки» та «Мої Відправлені документи».

В меню Внутрішній документообіг можливо створити документ для відправки на узгодження за допомогою кнопки «Створити документ», або вибрати й відмітити вже створений документ із списку у вкладці Мої Чернетки.

Таблична частина розділу «Мої Чернетки» складається з стовбців з інформацією по документу й відображають наступну інформацію:

• «Відправник» -назва і код ЕДРПОУ/ІНН компанії

• «Тип документу» - структурований або неструктурований

• «Завантажити/Переглянути» - скачування або перегляд документу чи архіву з документом та підписом

• «Додаткова Інформація» - інформація про документ та підписи

Таблична частина розділу «Мої Відправлені документи» відображає ті ж стовпці що в Чернетках, але додатково ще:

• «Дата відправлення» - дата та час відправки

• «Статус документу» - Потребує узгодження; Погоджений; Не погоджений

8.1 Відправка документів на внутрішнє узгодження в рамках компанії

За допомогою кнопки «Створити документ» можливо створити новий структурований або неструктурований документ з наступними елементами:

• Поле «Компанія» зі списком компаній, доступних відповідно до ролі;

• Поле «Доступні внутрішні документи компанії» з списком активних типів документів з ознакою «Внутрішній документ» і зв’язкою з налаштуванням узгодження, за компанією обраною в полі «Компанія»;

• Поле «Коментар» (зберігається в стовбці «Дод. Інформація по документу»)

• Кнопка «Завантажити» (тільки якщо обраний неструктурований тип документа);

При створенні документа на узгодження обовязково потрібно вибрати компанію із списку, вибрати тип документу із доступних і завантажити сам документ (якщо вибрано неструктурований документ). У списку будуть відображені всі типи документів, закріплені за обраною компанією.

Тільки після заповнення усіх полів на формі з’явиться кнопка Створити документ.

Якщо обраний структурований тип документа, після збереження з’явиться форма для заповнення полей структурованого документу.

Створений документ відобразиться у вкладці «Мої Чернетки».

Зверніть увагу!

Якщо у списку немає необхідного типу документу, зверніться до бізнес-адміністратора вибраної компанії та попросіть створити тип у «Мої компанії -> редагування компанії -> Внутрішні документи компанії». Якщо при створенні явилася помилка «Не налаштоване правило узгодження документа» - потрібно налаштувати документ у розділі «Налаштування доступу -> Маршрут погодження».

Документ у розділі можна відмітити й Підписати (за необхідності), Надіслати, або Видалити за допомогою відповідних кнопок. Також можливо скачати/переглянути документ, або переглянути додаткову інформацію про документ та підписи сторін.

Відправлений документ відобразиться у вкладці «Мої відправлені документи» з актуальним статусом.

Відправлений документ з’явиться у розділі «Мої завдання» у людини яка вказана у Узгоджені типу документу, з напрямком Внутрішній документ.

Для кожного типу документа процес узгодження налаштовується окремо. Для налаштування правил і послідовності процесу узгодження перейдіть до розділу «Налаштування доступу» - «Маршрути погодження». В розділі списком будуть відображені вже створені процеси узгодження по всіх компаніях, доступних користувачеві за маршрутом і роллю.

9 Візуалізація ЕЦП

У підписаних документах без шифрування та у форматі PDF відображається візуалізація ЕЦП у листі підписання при скачуванні архіва.

Обовязкова умова - увімкнути ознаку «Відображати штамп ЕЦП» для документу, детальніше - у пункті Відображення штампу ЕЦП у листі підписання.

Внизу сторінки листа підпису буде відображено штамп «Документ підписаний…» та вказано id документа.

У листі підписання з архіву,у тому числі відображається основна інформація по документу, а також про підписантів, та загальна інформація про електронний документ з Електроннім цифровим підписом.

Також, у структурованому документі, в формі перегляду редагування структурованого документа (внизу форми) відображається інформація про підпис, а саме поле «Власник», поле «ЄДРПОУ» та поле «Посада».

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

• в комплекті

• в розділі «Внутрішній документообіг»

• в задачі на узгодження

10 Багатоступеневе узгодження за допомогою ієрархічних довідників

Використання ієрархічних довідників полегшує узгодження документів в комплекті. Ієрархічні (або древовидні) довідники дозволяють застосовувати до одного типу документа різні маршрути узгодження. Різні типи документів мають різних узгоджувачів - наприклад, бухгалтера, менеджера напрямку, директора. Один раз налаштувавши маршрути, документи завжди будуть надходити до правильного Узгоджувача.

Налаштування на стороні одержувача комплекта

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

1. Створити ієрархічний довідник. Меню «Налаштування компанії» → «Мої компанії» → відкрити форму редагування компанії (кліком по назві) → вкладка «Довідники» → кнопка «Додати». Додайте необхідні значення.

2. Зв’язати довідник з типом документа. Перейти у вкладку «Документи» → натиснути на іконку «Зв’язок з довідником» (у виді ланцюжка) і вибрати потрібний довідник зі списку.

3. Додати документ в налаштування узгодження, вказавши фінальні значення довідника. Меню «Налаштування доступу» → «Маршруті погодження» → вкладка «Тип документа». Виберіть тип документа й значення. Детальніше про налаштування узгодження в інструкції «Маршрути погодження».

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

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

1. У комплекті по кожному файлу документа заповнити значення довідників до «фінальних» і відправити комплект.

11 Копіювання комплекту с документами, позначеними для редагування

У Налаштування компанії - Налаштування комплектів документів, при додаванні звязку комплекта з типами документів можливо налаштувати правила роботи з документом.

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

Якщо обрано структурований документ та без відмітки «Довкладення отримувача», можливо встановити відмітку «Документ дозволений для редагування партнером».

Даний функціонал дозволяє вашому партнеру редагувати отриманий документ. Дозволяючи вам, тим самим, відправити структурованний документ партнеру для довнесення інформації.

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

Усі документи з відміткою «Документ дозволений для редагування партнером» буде позначено у комплекті спеціальною іконкою зі спливаючою підказкою, а також додано примітку у блоці Додаткова інформація.

Отримувач вхідного комплекта з такими документами може створити копію комплекту документів за допомогою відповідної кнопки Створити у відповідь копію. Новий створений комплект буде збережено у Чернетках.

У новому комплекті у вкладці «Документи» відображаються тільки документи з ознакою «Дозволений для редагування партнером» в статусі «Новий» - отримувач може редагувати структуровані документи, тобто заповнити їх інформацією.

До скопійованих типів документів застосовуються усі налаштування правил роботи з документом з комплекта-основи. Наприклад необхідна кількість підписів ініціатора і клієнта, допустима кількість файлів та термін підписання. Партнер не зможе редагувати налаштування. Номер комплекта-основи зберігається у вкладці «Основна інформація» при опрацюванні комплекту.

Зверніть увагу!

У скопійованих документах зберігається налаштування Терміну підписання документа отримувачем. Після закінчення терміну, партнер не зможе підписати документ, але зможе скопіювати, та надіслати у відповідь з ідентичним терміном підписання.

У вкладках «Довідники» й «Користувацькі поля» зберігаються налаштування комплекту-основи. Журнал комплекту-основи не зберігається. Неможливо прикріпити довкладення.

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інструкція з налаштування шифрування

---

Зміст:

• Інструкція з налаштування шифрування

  • 1 Авторизація в системі

  • 2 Завантаження сертифіката

---

Дана інструкція описує порядок налаштування сертифікатів для шифрування.

1 Авторизація в системі

Для авторизації на платформі перейдіть за посиланням http://doc.edin.ua/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

2 Завантаження сертифіката

Для завантаження сертифіката перейдіть до розділу меню «Безпека» – «Сертифікати бепеки» та натисніть «Завантажити сертифікат»:

Система повідомить про успішне завантаження, після чого сертифікат з’явиться у переліку завантажених сертифікатів. За сертифікатом відображатиметься серійний номер, код ЄДРПОУ організації, назва та дата закінчення дії. Завантаження сертифікатів після закінчення строку їх дії блокується системою.

Для перегляду детальнішої інформації за сертифікатом натисніть на його серійний номер:

Для повернення з форми деталізації до переліку сертифікатів натисніть на кнопку «Назад»:

2.1 Налаштування зв’язку з сертифікатом

Для налаштування зв’язку сертифіката з конкретною компанією виберіть на навігаційній панелі меню «Налаштування компанії» – «Мої компанії», відкрийте форму обробки компанії, натиснувши на її назву, та перейдіть до розділу «Сертифікати». Наступним кроком натисніть «Додати зв’язок» та «Прив’язати», обравши сертифікат з переліку доступних, що відображені системою:

Опція завантажити сертифікат присутня також безпосередньо у формі налаштування зв’язку. Для завантаження сертифіката натисніть «Завантажити сертифікат» або «Завантажити новий».

2.2 Видалення сертифіката

Для видалення сертифіката натисніть на кнопку «Кошик» напроти обраного сертифіката:

Для одночасного видалення декількох сертифікатів відмітьте обрані для видалення сертифікати та натисніть кнопку «Видалити виділені».

Опція видалення доступна також безпосередньо у формі детальної інформації за сертифікатом:

Інформація шодо підписання шифрованих документів та додавання шифрованих документів описана в інструкції Підписання шифрованих документів .

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інструкція з налаштування структурованого документа

---

Зміст:

• Інструкція з налаштування структурованого документа

  • 1 Авторизація в системі

  • 2 Налаштування структурованого документа

  • 3 Налаштування зв’язку структурованого документа з типом комплекта

  • 4 Заповнення структурованого документа

  • 5 Блокування типу документа

---

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

---

1 Авторизація в системі

Для авторизації на платформі перейдіть за посиланням https://doc.edin.ua/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

2 Налаштування структурованого документа

У межах документообігу EDIN-DOCflow, поряд із неструктурованими (звичайними) документами, реалізована можливість передачі структурованих (XML) документів у комплекті. Визначення типу документа як структурованого відбувається на етапі налаштування типів документів у межах компанії.

Для налаштування структурованого документа перейдіть в меню «Налаштування компанії» – «Мої компанії» та оберіть потрібну компанію зі списку, натиснувши на її назву. У формі редагування, що відкриється, перейдіть до вкладки «Документи». Вкладка містить вже закріплені за компанією типи документів. Для додання нового документа з ознакою «Структурований» натисніть на кнопку «Додати»:

У формі додання типу документа заповніть обов’язкові поля:

• Назва – поле призначене для введення літер, цифр або спеціальних символів, мінімальна кількість знаків – три

• Код - поле призначене для введення літер, цифр або спеціальних символів, мінімальна кількість знаків – один. Значення, введене в поле «Код», має бути унікальним у межах компанії. У разі введення значення, що вже використовується, система відобразить відповідне повідомлення.

Наступним кроком встановіть відмітку напроти типу документа, а саме «Структурований», і натисніть «Зберегти»:

Документ буде збережено та відображено в переліку типів документів з позначкою «Структурований» :

Натисніть на позначку «Структурований» та додайте структуру документа натиснувши на кнопку «Додати».

Відкриється поле для додавання опису структури. Також можливо скористатися заготовленими шаблонами Рахунку або Акту - просто виберіть зі списку документ та структура додастся автоматично.

Для редагування назви або коду типу документа натисніть на його назву у загальному переліку, внесіть потрібні зміни та натисніть «Зберегти».

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

Для опису і зберігання структури документа використовується текстовий формат JSON. Параметри, що прописуються у налаштуваннях структури, визначають порядок відображення на web-формі елементів структури документа і правила їх заповнення.

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

Основні параметри, що використовуються при описі структурованого документа:

• id — ідентифікатор елемента, назва елемента в документі XML

• title — назва елемента на web-формі при заповненні документа

• readonly (true / false) — визначає можливість редагування відповідного елемента структури

• attribute (true / false) — при встановленому параметрі відповідний елемент є атрибутом в XML-файлі, при невстановленому — тегом

• optional (true / false) — визначає обов’язковість заповнення поля

• type — спеціальна секція для визначення типу елемента

• data — спеціальна секція для визначення заповнення елемента певними значеннями, посиланнями на об’єкти плафторми, тощо

• fields — спеціальна секція для опису масиву полів для типів елементів object і array

• function — function - задана функція виконання вибірки з довідника або математичних операцій по вже введеним інших полях документа (функції updateDictLink і arithmeticOperate)

Зверніть увагу!

Імена елементів у структурі XML повинні дотримуватись наступних правил написання імен:

• Імена можуть містити літери, цифри та інші символи, але,

• Імена не можуть починатися з цифри або символу пунктуації

• Імена не можуть починатися з поєднання «xml» (або XML, або Xml і т.п.)

• Імена не можуть містити пробіли

Кожен тип елемента описується у вигляді окремої, особливої структури зі своїм переліком параметрів. На поточний момент реалізовані наступні типи:

• рядок (string) - дозволяє зберігати текстові значення

• число (number) - дозволяє зберігати числові значення зі знаком і розділювач дробової частини, кількість цифр після коми

• дата (date) - дозволяє зберігати дату без часу

• час (time) - дозволяє зберігати час

• перелік (enum) - дозволяє задати список значень з можливістю вибору одного значення

• об’єкт (object) - дозволяє вказати елемент, який є вузлом, структурою зі своїми полями

• масив (array) - дозволяє вказати елемент, який є таблицею або масивом значень зі своїми полями

Таблиця 1 - Типи даних (типи елементів) із параметрами, що застосовуються при описі структурованого документа:

Тег	Значення	Опис	Параметр	Приклад
string	рядок	Для внесення і збереження текстових значень	minLength — мінімальна кількість символів не меньше 1; maxLength — максимальна кількість символів не більше 9999; regexp — регулярний вираз case (реєстр) — визначає, в якому реєстрі використовувати рядок (upper, lower, camel)	«string»: { «minLength»: 1, «maxLength»: 10, «regexp»: «….», «case»: «upper│lower│camel» },
number	число	Для внесення і збереження числових значень	type (тип) — позитивне / негативне; decimal (дріб) — вказується кількість цифр після коми (для дробів)	«number»: { «type»: «positive│negative», «decimal»: 3 },
date	дата	Для внесення і збереження дати, без позначки часу	format — вказується формат дати, где Y - рік, M - місяць, D - день	«type»: { «date»: { «format»: «DD.MM.YYYY» }
time	час	Для внесення і збереження часу	format — вказується формат часу, де H - година, M - хвилина, S - секунда; при цьому H використовується для 24-годинного формату, h - для 12-годинного	«type»: { «time»: { «format»: «HH:MM:SS» }
enum	перелік	Для внесення і збереження списку значень із можливістю вибору одного значення	value (значення) — значення, яке буде додане в тег; name (назва) — назва значення	«enum»: [ { «value»: «Значение которое будет добавлено в документ», «name»: «Название значения» } ]
object	об’єкт	Для позначення елемента, який є структурою зі своїми полями		«type»: { «object»: {} },
array	масив	Для позначення елемента, який є таблицею або масивом значень зі своїми полями	minLength — мінімальна кількість рядків не менше 1; maxLength — максимальна кількість рядків не более 9999;	«array»: { «minLength»: 1, «maxLength»: 10 },

Секція data описує правила і можливості щодо заповнення елемента.

Зверніть увагу!

Тег «ref» заповнюється посиланням на комплект лише при формуванні зовнішнього документа у розділі «Документи», наприклад: «ref»: «pack.senderCompany.companyId». При формуванні внутрішнього документа у розділі «Внутрішні документи компанії» потрібно використовувати посилання на документ, наприклад: «ref»: «doc.senderCompany».

Таблиця 2 - Структура секції data:

Тег	Опис	Приклад
index	В даному параметрі вказується індекс (ID) рядка для масив узначень, нумерація починається з 0. Якщо вказати -1 то для всіх рядків буде застосовуватися; Якщо вказати значення більше -1 то тільки в зазначеному рядку.	«index»: 0
template	В параметрі задається шаблон даних для відповідного елемента документа. Якщо даний параметр заповнено, елемент документа недоступний для редагування користувачем. В шаблоні поряд із текстом реалізовані наступні можливості: посилання на системну функцію (1) посилання на поле з документа чи з комплекта посилання на прикріплений до комплекта довідник посилання на описаний вище елемент документа використання функцій-модифікаторів Посилання позначається символами ##. Формат опису посилань - див. для параметра ref Для введення модифікатора в опис посилання використовується символ «│» (вертикальний слеш), після якого йде опис функції- модифікатора з атрибутами. Якщо даний параметр заповнений, елемент документа не редагується користувачем і завжди буде з типом «рядок» незалежно від того, що зазначено в секції type. Для того щоб автоматично проставлявся порядковий номер документа в табличній частині, потрібно, в структурі в поле template вказати «# rowIndex #». Також необхідно використовувати «index»: -1 для нумерації у всьому документі. Початкове значення = 1. Кожне наступне значення на 1 більше попереднього. (2)	1.»template»: «Простий текст з використанням функції отримання поточної дати з форматуванням #sys.currentDate│convertDate:“yyyy-mm-dd“# «{«index»: -1, «template»: «#rowIndex#»}»
ref	В параметрі вказується посилання, за яким встановлюється значення для елемента документа. На відміну від шаблона, в даному параметрі можливо дати посилання лише на 1 об’єкт. При цьому використовуються наступні префікси: sys - при посиланні на системну функцію pack - при посиланні на поле з комплекта (лише для зовнішніх документів що формуються у розділі «Документи») xml - при посиланні на тег документа dict - и посиланні на довідник із зазначенням ID довідника (dict.14) user - при посиланні на дані користувача із зазначенням поля з даних користувача (user.fio) doc - при посиланні на поле з документа (для внутрішніх документів що формуються у розділі «Внутрішні документи компанії») extra - при посиланні на користувацьке поле із зазначенням ID поля (extra.12) Реалізовані системні функції: currentDate - отримання поточної дати і часу replaceSpace - заміна пробілів у текстовому значенні	«ref»: «sys.currentDate» «ref»: «pack.senderCompany.companyId» «ref»: «dict.1»
default	Параметр для введення довільного тексту в якості значення, без посилань та функцій	«default»: «Простий текст»
Function	задана функція виконання вибірки даних з довідника або для математичних операцій по вже введеним іншим полях документа (updateDictLink і arithmeticOperate) Початок і кінець оголошення функції обрамляється символом $. Функції можливо записувати послідовно, наприклад, $функція1$$функція2$. Також у функціях при вказівці шляхів задається індекс [@index] елемента масиву, в якому викликається ф-ція: [2] - фіксоване значення індексу (індексація починається з «0») [-1] - операція буде виконана над усіма елементами масиву.	«function»: «$ updateDictLink („Акт.Послуги[@index].Код“ «function»: «$ arithmeticOperate („Акт.Послуги[@index].Сума“, „Акт.Послуги[@index].Кількість“, „*“, „Акт.Послуги[@index].Ціна“)$»

Функції:

1. updateDictLink - здійснює вибірку з довідника за шаблоном: $updateDictLink('Акт.Послуги[2].Код', 'code')$, де

• Акт.Послуги[2].Код - маршрут до поля, яке потрібно заповнити code зі довідника;

• code - поле значення довідника, з якого потрібно взяти значення.

Якщо тип даних (array) і функція вказана в полі data - то вона буде працювати тільки для зазначеного елемента масиву, наприклад:

"data": [
     {
       "index": 1,
       "ref": "dict.10",
      **"function": "$updateDictLink('Акт.Послуги[1].Код', 'code')$"**
     }
 ]

Пояснення до прикладу: при зміні в першому елементі масиву «index»: 1 поля «id»: «Назва», буде виконана функція $ UpdateDictLink („Акт.Послугі [1] .Код“, „code“) $ «яка запише в поле Акт.Послуги [1].Код значення code із довідника.

Якщо функція вказана в самому вузлі field, то вона буде працювати для кожного елемента масиву, також якщо маршрут вказати наступним чином „Акт.Послуги [@index] .Код“, то він буде посилатися на той же елемент масиву, в якому функція була викликана, наприклад:

 "fields": [
{
  "id": "Назва",
  "title": "Найменування робіт, послуг",
  "optional": false,
  "readonly": false,
  "attribute": true,
  "data": [
    {
      "index": -1,
      "ref": "dict.10"
    }
  ],
 **"function": "$updateDictLink('Акт.Послуги[@index].Код', 'code')$"**,
  "type": {
    "enum": []
  }
}]

2. arithmeticOperate - виконує математичні операції по вже введених інших полях. Шаблон: $arithmeticOperate(resultPath: string, sourcePath1: string, operationType: string, sourcePath2: string)$, де

• resultPath - шлях до елементу структурованого документа в який потрібно записати результат;

• sourcePath1 - шлях до елементу структурованого документа в якому міститься перший аргумент для арифметичної операції;

• operationType - вид операції, можливі значення «+», «-«, «/», «*»;

• sourcePath2 - шлях до елементу структурованого документа в якому міститься другий аргумент для арифметичної операції (sourcePath2 може бути відсутнім);

Зверніть увагу!

Важливо! У разі, якщо схема документа створена з використанням типу даних enum, для відображення значень довідника в структурованому документі необхідно вказати «type»: {«enum»: []}}.

Для завантаження (внесення) опису структури документа натисніть на іконку «Структурований»:

У формі, що відкриється, натисніть на кнопку «Додати»:

Наступним кроком введіть опис структури документа у форматі JSON, оберіть кодування xml для документа і натисніть «Зберегти»:

Система повідомить про успішне збереження відповідним повідомленням. Під час збереження опису структури відбувається перевірка валідності внесених даних на відповідність формату JSON та перевірка на дублі.

Перевірка елементів структурованого документа при збереженні:

У разі внесення не коректних даних кнопка «Зберегти» не активується. При внесенні дублюючого опису користувачеві буде відображене відповідне повідомлення. Перевірка на дублі виконується у межах компанії.

Збереження опису структури відбувається по версіях створення. Номер версії присвоюється автоматично. Система також фіксує дату та час модифікації кожної версії.

Під версією мається на увазі збереження певної модифікації опису структури. Система передбачає можливість роботи з різними модифікаціями одного типу документа за рахунок активації тієї чи іншої версії структури даних. Не активована схема зберігається у статусі «Чернетка».

Схема у статусі «Чернетка» доступна для редагування. Для переходу у режим редагування натисніть на номер версії або на кнопку «Редагувати». Для активації певної версії структури натисніть «Активувати» у формі редагування опису даних.

Для зручності у формі додання версій реалізований пошук за номером і датою. Для старту пошуку введіть початкові символи у пошукове поле:

Зверніть увагу!

У статусі «Активний» і «Чернетка» може бути лише одна версія структури.

3 Налаштування зв’язку структурованого документа з типом комплекта

Налаштування виконується на загальних підставах. Детальний опис процедури в пункті 8 «Інструкції бізнес-адміністратора».

4 Заповнення структурованого документа

Форма заповнення структури відкривається при доданні документа з ознакою «структурований» до комплекта. Для цього перейдіть в меню «Зовнішні комплекти документів», у вкладці Чернетки виберіть комплект та в ньому перейдіть до вкладки «Документи», і натисніть «Додати»:

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

Елементи структури документа відображаються послідовно, у порядку, заданому в налаштуваннях структури. При цьому типи елемента (секції) відображаються у вигляді окремих структур, складові компоненти яких розташовуються горизонтально по три в ряд. Назва структури (типу елемента) виділяється жирним шрифтом:

Заповніть поля документа і натисніть кнопку «Зберегти». Для повторного перегляду збереженого структурованого документа в комплекті натисніть на іконку напроти документа:

5 Блокування типу документа

Для блокування типу документа оберіть потрібний тип з переліку закріплених за компанією, меню «Налаштування компанії» – «Мої компанії» – «Документи», та переведіть перемикач у положення «Заблокувати»:

Тип документа буде переведений у статус «Заблокований». Даний статус блокує використання типу документа у будь-яких операціях з моменту призначення статусу.

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

Інтеграція 1C

Інструкція користувача модуля DocFlow

Зміст:

• Інструкція користувача модуля DocFlow

  • Вступ

  • Налаштування

    • Підключення

    • Схеми обміну (довідник комплектів)

  • Робота з модулем

    • Відправка комплектів документів

      • Служба Технічної Підтримки

---

Скорочення:

ОС - облікова система

ЮЗД - юридично значущий документ/документообіг

ЕЦП - електронно-цифровий підпис/печатка

---

Вступ

Розроблений компанією EDIN інтеграційний модуль EDIN.DocFlow (в подальшому просто модуль) дозволяє працювати з обліковими системами 1С: Підприємство 8.Х на звичайних формах (надалі ОС) на базі операційної системи Windows. Модуль за замовчуванням дозволяє відправляти структуровані/ неструктуровані документи та переглядати комплекти документів, самі документи з платформи DocFlow, слідкувати за статусом документообігу.

Для роботи з модулем користувачеві потрібно мати логін (email) і пароль для доступу до платформи EDIN.DocFlow.

Налаштування

Для корректної роботи інтеграційного модуля EDIN.DocFlow необхідно внести зміни в конфігуратор 1С: долучити 2 довідника (DocFlow_Settings - довідник налаштувань та DocFlow_Sets - довідник комплектів документів) та 1 регістр відомостей (DocFlow_DocInfo), що надаються співробітниками компанії EDIN.

Для запуску модуля необхідно в обліковій системі 1С відкрити файл запуску модуля (передається користувачеві співробітниками EDIN):

Також облікова система 1С дозволяє налаштувати запуск модуля, як встроєним функціоналом (через «Файл»->»Зовнішні друковані форми і обробки»).

Підключення

При першому запуску модуля для початку роботи потрібно провести налаштування модуля (про це також повідомить повідомлення-підказка):

Для підключення модуля EDIN.DocFlow до платформи документообігу в вкладці «Налаштування» потрібно ввести адресу платформи (https://doc.edin.ua), свій логін та пароль. Після того, як дані користувачів були введені можливо здійснити перевірку (кнопка «Перевірити підключення» (1)) введених даних. Модуль повідомить про корректність введених даних. Після того, як всі дані введені потрібно «Зберегти налаштування» (2). Для користування електронним юридично значущим документообігом (ЮЗД) потрібно додатково вказати на місцерозташування зовнішнього файлу підпису та ввести особистий пароль (3).

Примітка

Пароль зберігається в «Операції»->»Довідник»->»DocFlow_параметри» в неявному (зашифрованому) вигляді.

Схеми обміну (довідник комплектів)

Окрім основних налаштувань модуля під особливості документообігу в Вашій організації необхідно також провести налаштування «Схеми обміну» (довідник комплектів):

Підказка

Налаштування можуть бути проведені спеціалістом Вашої організації чи співробітником EDIN.

У вікні «Налаштувань схеми обміну» вказуються:

• Код схеми (надається співробітником EDIN)

• Назва схеми обміну (довільно)

• Код комплекта (надається співробітником EDIN)

• Тип документа 1С (через кнопку «…» обирається головний тип документа)

В налаштуваннях схем обміну розміщені вкладки «Контрагенти» і «Типи документів».

«Контрагенти» - вкладка, в якій додаються та налаштовуютья контрагенти електронного документообігу

• Контрагент - контрагенти 1С (довідник)

• ID сценарію документообігу - вказується ідентифікатор сценарію документообігу з платформи EDIN.DocFlow (надається співробітником EDIN)

Увага

Якщо в схему обміну додано більше одного типа документу, то для внесення змін в логіку документообігу потрібне втручання програміста 1С.

«Типи документів» - вкладка, в якій додаються і налаштовуються правила обробки документів схеми документообігу

1. Назва типу - довільна назва типу документа

2. ID типу - вказується ідентифікатор типу документа з платформи EDIN.DocFlow (надається співробітником EDIN)

3. Тип документа 1С - обирається зі списку (за замовчуванням відповідає головному «Типу документа 1С»)

4. Форма друку для вивантаження - зовнішні друковані форми вказуються лише для неструктурованого типу документу (задаються програмістом 1С - можуть бути зареєстровані і виведені разом із внутрішніми формами 1С)

5. Підписувати - за активованої відмітки (проставлена галочка) модуль буде автоматично здійснювати спробу підписання документу при його вивантаженні

6. Струтурований - активована відмітка (проставлена галочка) свідчить про те, що обраний документ є структурованим. Активує налаштування «Типова структура».

7. Типова структура: * АктБезНДС (тільки для послуг) * Акт_с_НДС (тільки для послуг) * СчетБезНДС * Счет_с_НДС

Робота з модулем

Всі дії з документами проводяться у вкладці «Вихідні». Для початку роботи з документами потрібно обрати період (1) та якщо документи не відобразились натиснути «Відобразити документи 1С» (2) - в журналі комплектів документів відобразяться всі документи всіх контрагентів (вказані в налаштуваннях схеми) за обраний період:

Якщо при відображенні документів в комплекта документів вже вказано «ID_Пакета», то це свідчить про те, що даний комплект вже був вивантажений і для перевірки його статусу потрібно «Завантажити інфо з DocFlow» (1) (з платформи підвантажиться «Номер комплекта», «Статус DocFlow» та інформація по документах, що входять в цей комплект):

Примітка

«Завантажити інфо з DocFlow» не потребує вибору конкретного комплекта документів, а завантажує інформацію по всім комплектам, що відображаються в журналі.

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

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

Статуси комплектів документів:

1. Чернетка

2. Відправлено

3. Прийнято

4. Відхилено

5. Не погоджено

Статуси документів:

1. Чернетка

2. Відправлено

3. Прийнято

4. Уточнення

5. Відхилено

6. Оброблено

7. Відміна

8. Доповнення

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

• «Зберегти файли» - можливо обрати документи (навіть із різних комплектів) і після натискання кнопки завантажує файл до локального сховища користувача.

• «Підписати обрані» - дозволяє підписати за допомогою ЕЦП всі обрані документи (навіть із різних комплектів) незважаючи на налаштування Схеми обміну (довідник комплектів).

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

Для відправки комплекта документів потрібно:

1. «Відобразити документи 1С»;

2. Обрати бажані комплекти документів для вивантаження/відправки;

3. Вивантажити документи в DocFlow;

4. Завантажити інфо з DocFlow - таким чином можливо пересвідчитись, що документи пройшли всі перевірки: вони виділяються жирним та мають статус «Готові до відправлення»;

5. Обрати (пункт 2) за необхідності комплекти документів, що можуть бути відправлені та натиснути «Відправити комплекти».

Примітка

Документи підписуються автоматично, якщо в налаштуваннях Схеми обміну (довідник комплектів) проставлена відмітка «Підписувати». Однак, якщо відмітки не було, а документи вже помилково відправлені непідписаними, то можливо проставити відмітку «Підписувати» і натиснути кнопку «Підписати вивантажені» - всі вивантажені документи в даній «Схемі обміну» будуть підписані.

Також в додатковий функціонал входить можливість «Зберегти архів пакета», що дозволяє завантажити вибрані пакети в якості архіву:

• в випадку, якщо це неструктурований документ архів містить: оригінал документу (pdf) та при наявності підписи (p7s) + документ з інформацією про підписи (pdf);

• в випадку, якщо це структурований документ архів містить: оригінал документу (xml) та при наявності підписи (p7s) + документ з інформацією про підписи (pdf).

Служба Технічної Підтримки

• edin.ua

• +38 (044) 359-01-12

• support@edin.ua

API DOCFLOW

Авторизація

Для роботи з API користувачу для авторизації потрібні логін (email) та пароль. Авторизація API відбувається за допомогою передачі цих ключових параметрів в двох HTTPS POST запитах (в два етапи).

Увага

Авторизація відбувається в два кроки:

1. Користувачу необхідно відправити адресу своєї електронної адреси (метод {url сервера}/bdoc/auth_uuid). В відповідь на запит приходить токен.

2. Користувачу необхідно відправити пароль і отриманий токен з пункта 1, використовуючи метод {url сервера}/bdoc/auth.

Після авторизації відбувається передача унікального cookie токена «SID». HTTP-заголовок відповіді сервера в вигляді «Set-Cookie» використовується для подальшої відправки файлів «Cookie». В кожному наступному запиті (виклику методу) повинен бути присутнім HTTP-заголовок (Header) «Cookie», який для коректного виконання запитів повинен містити токен «SID» зі значенням, отриманим при авторизації.

В сучасних популярних браузерах і Rest клієнтах відбувається автоматичне збереження і передача токена на сервер під час сесії, однак при використанні деяких інтеграційних рішень, самописних REST-клієнтів цей обов’язковий параметр може не передаватись - його необхідно примусово передавати в заголовку (Header) «Cookie». Після авторизації час життя сесії при бездіяльності користувача становить 10 хвилин.

Авторизація (крок 1)

Метод запиту	HTTPS POST
Content-Type	multipart/form-data (елементи запиту передаются в інтерфейсі form-data)
URL запиту	https://doc.edin.ua/bdoc/auth_uuid
Параметри, що передаються в URL (разом з адресою методу)	-//-

При авторизації і тілі запиту обов’язково передається наступний параметр:

email=[електронна пошта користувача]

При успішній авторизації отримуємо у відповідь «токен авторизації», необхідний для подальшої роботи:

{
  "isCaptcha": false,
  "token": "1ebe6825-0d1f-4577-a8d7-472650ce86b0"
}

isCaptcha - ознака відображення капчі для користувача

token - токен авторизації

---

Авторизація (крок 2)

Метод запиту	HTTPS POST
Content-Type	multipart/form-data (елементи запиту передаются в інтерфейсі form-data)
URL запиту	https://doc.edin.ua/bdoc/auth
Параметри, що передаються в URL (разом з адресою методу)	-//-

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

token=[токен авторизації]
password=[пароль користувача]

При успішній авторизації отримуємо у відповідь на запит: код відповіді сервера 200 (ok)

Створення компанії з КЕП/ЕЦП

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

Увага

Створення компанії з КЕП/ЕЦП відбувається в два кроки:

1. Користувачу необхідно отримати унікальний UUID (метод {url сервера}/bdoc/sign_auth_uuid). Далі отриманий UUID необхідно підписати ЕЦП - зовнішнє підписання, в результаті якого користувач отримує .bin-файл.

2. Користувачу необхідно відправити отриманий .bin-файл (пункт 1), використовуючи метод {url сервера}/bdoc/company_from_sign.

Отримання UUID (крок 1)

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/sign_auth_uuid
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

В результаті успішного запиту отримуємо у відповідь «UUID» у вигляді рядка. UUID необхідно підписати ЕЦП, в результаті підписання якого користувач отримує .bin-файл.

---

Створення компанії (крок 2)

Метод запиту	HTTPS POST
Content-Type	application/binary/json (тіло запиту передається в бінарному вигляді, тіло відповіді в json форматі)
URL запиту	https://doc.edin.ua/bdoc/company_from_sign
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Параметри HTTPS запиту/відповіді

REQUEST

В тілі запиту передається .bin-файл (підписаний UUID).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Company)

Таблиця 1 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Приклади

В тілі запиту передається .bin-файл (підписаний UUID).

---

Приклад тіла відповіді (json):

{
  "companyId": 1329,
  "accountId": 8,
  "type": 1,
  "name": "Название",
  "inn": "144444444444",
  "code": "12345",
  "isApproved": 0,
  "isSignedOffer": 1,
  "isActive": 1,
  "ownershipType": "Форма собственности",
  "atCode": "КОАТУУ",
  "certNum": "Номер свидетельства",
  "uuid": "8af7a3e0-297a-4463-a353-b229137aaba8",
  "bankAcc": {},
  "legalAddress": {
    "localityType": 0
  },
  "actualAddress": {
    "localityType": 0
  },
  "fizName": {},
  "certificates": [],
  "dictionaries": [],
  "notifySettings": [
    {
      "notifyType": 1,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 2,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 3,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 4,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 5,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 6,
      "notifyStatus": 2,
      "emails": []
    }
  ]
}

Оновлення компанії з КЕП/ЕЦП

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

Увага

Оновлення компанії з КЕП/ЕЦП відбувається в два кроки:

1. Користувачу необхідно отримати унікальний UUID (метод {url сервера}/bdoc/sign_auth_uuid). Далі отриманий UUID необхідно підписати ЕЦП - зовнішнє підписання, в результаті якого користувач отримує .bin-файл.

2. Користувачу необхідно відправити отриманий .bin-файл (пункт 1), використовуючи метод {url сервера}/bdoc/company/approve.

Отримання UUID (крок 1)

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/sign_auth_uuid
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

В результаті успішного запиту отримуємо у відповідь «UUID» у вигляді рядка. UUID необхідно підписати ЕЦП, в результаті підписання якого користувач отримує .bin-файл.

---

Оновлення компанії (крок 2)

Метод запиту	HTTPS POST
Content-Type	application/binary/json (тіло запиту передається в бінарному вигляді, тіло відповіді в json форматі)
URL запиту	https://doc.edin.ua/bdoc/company/approve
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії

Параметри HTTPS запиту/відповіді

REQUEST

В тілі запиту передається .bin-файл (підписаний UUID).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Company)

Таблиця 1 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Приклади

В тілі запиту передається .bin-файл (підписаний UUID).

---

Приклад тіла відповіді (json):

{
  "companyId": 1329,
  "accountId": 8,
  "type": 1,
  "name": "Название",
  "inn": "144444444444",
  "code": "12345",
  "isApproved": 0,
  "isSignedOffer": 1,
  "isActive": 1,
  "ownershipType": "Форма собственности",
  "atCode": "КОАТУУ",
  "certNum": "Номер свидетельства",
  "uuid": "8af7a3e0-297a-4463-a353-b229137aaba8",
  "bankAcc": {},
  "legalAddress": {
    "localityType": 0
  },
  "actualAddress": {
    "localityType": 0
  },
  "fizName": {},
  "certificates": [],
  "dictionaries": [],
  "notifySettings": [
    {
      "notifyType": 1,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 2,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 3,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 4,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 5,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 6,
      "notifyStatus": 2,
      "emails": []
    }
  ]
}

Створення/редагування компанії

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/company
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	type, name, code

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Company)

Таблиця 1 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Company)

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

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

{
  "type": 1,
  "name": "Название",
  "code": "12345"
}

---

Приклад тіла відповіді (json):

{
  "companyId": 1329,
  "accountId": 8,
  "type": 1,
  "name": "Название",
  "inn": "144444444444",
  "code": "12345",
  "isApproved": 0,
  "isSignedOffer": 1,
  "isActive": 1,
  "ownershipType": "Форма собственности",
  "atCode": "КОАТУУ",
  "certNum": "Номер свидетельства",
  "uuid": "8af7a3e0-297a-4463-a353-b229137aaba8",
  "bankAcc": {},
  "legalAddress": {
    "localityType": 0
  },
  "actualAddress": {
    "localityType": 0
  },
  "fizName": {},
  "certificates": [],
  "dictionaries": [],
  "notifySettings": [
    {
      "notifyType": 1,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 2,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 3,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 4,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 5,
      "notifyStatus": 2,
      "emails": []
    },
    {
      "notifyType": 6,
      "notifyStatus": 2,
      "emails": []
    }
  ]
}

Зміна статусу документу

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

Метод запиту	HTTPS POST
Content-Type	multipart/form-data (тіло запиту в form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/status
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В тілі запиту в form-data передаються параметри.

Таблиця 1 - Опис json-параметрів запиту метода API

Параметр	Mandatory/Optional	Формат	Опис
package_id	M	long	ID пакета
document_id	M	long	ID документа
status	M	long	ID статусу (3 - прийнято; 4 - відхилено)

RESPONSE

У відповідь передаються дані комплекту (об’єкт Package) в json форматі

Таблиця 6 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company_	об’єкт; інформація про компанію

---

Приклади

В тілі запиту в form-data передається файл з бінарними данними сертифікату.

---

Приклад тіла відповіді в json форматі

{
    "packageId": 7535,
    "senderCompanyId": 1319,
    "recipientCompanyId": 4,
    "senderCompany": {},
    "recipientCompany": {},
    "contract": {},
    "packageTypeId": 2353,
    "packageTypeChainId": 330,
    "dateCreated": 1576479459,
    "dateChanged": 1576760119,
    "status": 3,
    "archive": 0,
    "packageNumber": "1576252943",
    "documents": [
        {
            "documentId": 8903,
            "packageId": 7535,
            "senderCompanyId": 1319,
            "documentType": {},
            "number": "1576479454",
            "date": 1576479454,
            "dateSent": 1576479459,
            "clientSignsCount": 0,
            "ownerSignsCount": 0,
            "status": 3,
            "versionStructure": 0,
            "extraFields": [],
            "bodies": [],
            "isReadFromApi": 0,
            "documentUuid": "1896ca78-761a-4804-9fc8-6ef2855f4b1a",
            "agreementProcId": 0,
            "agreementStatus": 0
        }
    ],
    "package2Dictionaries": [],
    "extraFields": [],
    "contractDictionaries": [],
    "packageTags": [],
    "packageType": {},
    "isRead": 1,
    "isReadFromApi": 0,
    "isReadyForSend": 0,
    "packageDirection": 1,
    "signDateTerm": 0,
    "packageUuid": "f30c55dd-47cf-4a82-a07c-0be2c95b8716",
    "isWithAgreement": 0
}

Отримання списку всіх документів своєї компанії та компанії контрагента

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

Метод використовується для отримання списку документів при налаштуванні процесу узгодження.

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/extra/document_types?document_company_id=55&agreement_company_id=44
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_company_id - ID компанії власника документа agreement_company_id - ID компании власника процесу узгодження

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

В тілі відповіді передається список документів з ID процесу узгодження для компанії-власника процесу узгодження (тої, що визначається параметром agreement_company_id)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

В тілі відповіді передається список документів з ID процесу узгодження для компанії-власника процесу узгодження (тої, що визначається параметром agreement_company_id)

Створення/редагування структурованого документа

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/structure
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт DocumentStore)

Таблиця 1 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company_	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт DocumentStore)

Таблиця 2 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company_	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

---

Приклади

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

{
  "packageId": 1982,
  "documentType": {
    "documentId": 1086
  },
  "number": "99999",
  "date": 1526947200,
  "structure": [
    {
      "id": "Тег1",
      "structure": [
        [
          {
            "id": "Тег2",
            "structure": null,
            "value": "Имя файла"
          },
          {
            "id": "Тег3",
            "structure": [
              [
                {
                  "id": "Тег4",
                  "structure": null,
                  "value": "20820657",
                  "index": 0
                }
              ]
            ],
            "value": 11111
          }
        ]
      ],
      "value": 1222
    }
  ]
}

---

Приклад тіла відповіді (json):

{
  "documentId": 1662,
  "packageId": 1982,
  "senderCompanyId": 2,
  "documentType": {
    "documentId": 1086,
    "companyId": 2,
    "name": "Для тест ",
    "type": 2,
    "code": "sdoc1",
    "isActive": 1,
    "structures": [
      {
        "id": 1086,
        "structure": [
          {}
        ],
        "version": 1,
        "status": 1,
        "dateUpdate": 1540280767
      }
    ]
  },
  "number": "99999",
  "date": 1526947200,
  "dateSent": 0,
  "clientSignsCount": 0,
  "ownerSignsCount": 0,
  "status": 1,
  "comment": "aaaa",
  "versionStructure": 1,
  "bodies": [
    {
      "bodyId": 1662,
      "documentId": 1662,
      "fileName": "99999_1526947200_1662.xml",
      "signBodies": []
    }
  ],
  "structure": [
    {
      "id": "Тег1",
      "value": "1222",
      "index": 0,
      "structure": []
    }
  ],
  "isReadFromApi": 0
}

Отримання списку всіх документів на рівні компанії

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/document_types?company_id=989&type=0&limit=10&offset=0
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії use_type - тип документообігу (1 - external use (зовнішній), 2 - internal use (внутрішній)) Опціональні url-параметри (фільтр) type - тип документу (1 - Файл (неструктурований); 2 - Структура; 3 - Динамічна структура; 4 - Таблиця) limit - ліміт вибірки (за замовчуванням=20) offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0) is_active - статус документу; 1 - активний, 0 - заблокований

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт Document).

Таблиця 1 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company_	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
    {
        "documentId": 2467,
        "companyId": 989,
        "name": "имя",
        "type": 1,
        "code": "4324234223425",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
    },
...
    {
        "documentId": 2385,
        "companyId": 989,
        "name": "выаыаы",
        "type": 1,
        "code": "43242342",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
    },
    {
        "documentId": 2383,
        "companyId": 989,
        "name": "Для коли",
        "type": 1,
        "code": "32321321",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
    }
]

Відтворення візуалізації штампу ЕЦП на .pdf документах

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/document_type/provider_access
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу access - доступ (завжди=1); 1 - так, 0 - ні

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Отримання списку типів документів у вигляді .xlsx файлу

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

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Вивантаження списку типів документів з .xlsx файлу

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/document_types
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу Опціональні url-параметри: use_type - тип документообігу („1 - external use (зовнішній), 2 - internal use (внутрішній)“)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

Опис json-параметрів відповіді методу API (масив об’єктів Document).

Таблиця 1 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company_	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

---

Приклади

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

---

Приклад тіла відповіді в json форматі

[
  {
    "agreementProcId": 0,
    "companyId": 4,
    "documentId": 2583,
    "extraFields": [],
    "isActive": 1,
    "isProviderAccess": 1,
    "name": "Для шифрования",
    "type": 1,
    "useType": 1
  },
  {
    "agreementProcId": 68,
    "code": "423",
    "companyId": 4,
    "documentId": 1008,
    "extraFields": [],
    "isActive": 1,
    "isProviderAccess": 0,
    "name": "О еще один",
    "type": 1,
    "useType": 1
  },
  {
    "agreementProcId": 0,
    "code": "56",
    "companyId": 4,
    "documentId": 980,
    "extraFields": [],
    "isActive": 1,
    "isProviderAccess": 0,
    "name": "для шифрования",
    "type": 1,
    "useType": 1
  }
]

Активувати / Заблокувати документ

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

Важливо

Метод дозволяє заблокувати чи активувати значення довідника в залежності від значення параметра is_active=0 / is_active=1

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	Заблокувати документ https://doc.edin.ua/bdoc/document_type?document_id=2393&is_active=0 Активувати документ https://doc.edin.ua/bdoc/document_type?document_id=2393&is_active=1
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документа is_active - статус документа; 1 - активний, 0 - заблокований

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Додавання структури в структурований документ

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/document_type/structure
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	encoding, id, structure (будь-яка кількість регламентованих полей)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST / RESPONSE

Опис json-параметрів запиту та відповіді метода API (об’єкт DocumentStructure)

Таблиця 1 - Опис параметрів об’єкта DocumentStructure

Параметр	Формат	Опис
	Об’єкт DocumentStructure
id	long	id структурованого документу
structure	List<DocStructField>	структура документу
version	long	версія структури
status	int	статус документа; «0 - чернетка; 1 - активний; 2 - архівний»
dateUpdate	long	дата оновлення
encodingPattern	Pattern_	шаблон кодування (utf-8|windows-1251)
encoding	String	кодування (за замовчуванням «utf-8»)

Таблиця 2 - Опис параметрів об’єкта DocStructField

Параметр	Формат	Опис
	Об’єкт DocStructField
id	String	ідентифікатор елемента, тобто як елемент буде називатися безпосередньо в документі (в XML)
title	String	назва елемента на WEB-формі при заповненні документа
optional	Boolean	визначає необов’язковість заповнення поля
readonly	Boolean	визначає можливість редагування відповідного елемента структури (при встановленому параметрі обов’язкове заповнення параметра default)
attribute	Boolean	при встановленому параметрі відповідний елемент є атрибутом в xml-файлі, при невстановленому - тегом
function	String	задана функція виконання вибірки з довідника або математичних операцій по вже введеним іншим полях документа (updateDictLink і arithmeticOperate)
data	List<DocStructData>	масив об’єктів; правила і можливості щодо заповнення елемента
type	DocStructType	об’єкт; тип структури документа
fields	List<DocStructField>	масив об’єктів; поля для типів елементів «object» і «array»
errors	List<String>	масив; помилки

Таблиця 3 - Опис параметрів об’єкта DocStructData

Параметр	Формат	Опис
	Об’єкт DocStructData
index	int	в даному параметрі вказується індекс (id) рядка для масиву значень, нумерація починається з 0
Default	String	параметр для вказівки довільного тексту в якості значення за замовчуванням, використовується простий текст без посилань і функцій
template	String	в параметрі задається шаблон даних для відповідного елемента документа. У шаблоні поряд з текстом реалізовані можливості: - вказати посилання на системну функцію; - вказати посилання на поле з комплекта або документа; - вказати посилання на довідник, який прив’язаний до комплекту; - вказати посилання на вищестоящий (описаний раніше) елемент документа; - використовувати функції-модифікатори (наприклад, формат дати); Для визначення посилань необхідно укласти посилання в ##. Формат опису посилань - див. параметр ref. Для використання модифікатора в описі посилання використовується | (Вертикальний слеш). За ним йде опис функції-модифікатора з атрибутами. Якщо даний параметр заповнений, елемент документа не редагується користувачем і завжди буде з типом «рядок» незалежно від того, що зазначено в секції type.
ref	String	в параметрі вказується посилання, по якому буде встановлено значення за замовчуванням для елемента документа. На відміну від шаблону, в даному параметрі можна вказати тільки посилання на 1 об’єкт. При вказівці посилання використовуються наступні префікси: - sys - при посиланні на системну функцію - pack - при посиланні на поле з комплекта - xml - при посиланні на тег документа - dict - при посиланні на призначений для користувача довідник із зазначенням ID довідника (dict.14) - user - при посиланні на дані користувача із зазначенням поля з даних користувача (user.fio) - doc - при посиланні на поле з документа - extra - при посиланні на призначене для користувача поле із зазначенням ID поля (extra.12) З системних функцій реалізовано:  - currentDate - отримання поточної дати і часу  - replaceSpace - заміна прогалин в текстовому значенні Додаткова інформація, яка використовується при описі структури документа, може бути отримана з наступних методів (Рауса):  - / bdoc / store / package в повернутому JSON передається: інформація про компанію (Індекс, Область, Район, Населений пункт, Тип населеного пункту, Вулиця, Будинок, Корпус, Квартира (по юр. І фіз. Адресою); банківські реквізити (Назва банку, Розрахунковий рахунок, МФО БИК, кор. рахунок банку, GUID); UUID комплекта (package_uuid)  - / bdoc / store / package / document в повернутому JSON передається UUID документа (document_uuid)
Function	String	задана функція виконання вибірки з довідника або математичних операцій по вже введеним інших полях документа (updateDictLink і arithmeticOperate) Початок і кінець оголошення функції обрамляється символом $. Функції можливо записувати послідовно, наприклад, $ функція1 $$ функція2 $. Також у функціях при вказівці шляхів задається індекс [@index] елемента масиву, в якому викликається ф-ція: [2] - фіксоване значення індексу (індексація починається з «0») [-1] - операція буде виконана над усіма елементами масиву. Функції: updateDictLink - виробляє вибірку з довідника за шаблоном: $updateDictLink(„Акт.Послуги[2].Код“, „code“)$, де Акт.Послуги[2].Код - маршрут до поля, котре потрібно заповнити code зі довідника; code - поле значення довідника, з якого потрібно взяти значення. Якщо тип даних (array) і функція вказана в полі data - то вона буде працювати тільки для зазначеного елемента масиву, наприклад: «function»: «$updateDictLink(„Акт.Послуги[1].Код“, „code“)$» «Пояснення прикладу: при зміні в першому елементі масиву «index»: 1 поля «id»: «Назва» буде виконана функція «$updateDictLink(„Акт.Послуги[1].Код“, „code“)$» яка запише в поле Акт.Послуги[1].Код значення code із довідника. Якщо функція вказана в самому вузлі field то вона буде працювати для кожного елемента масиву якщо маршрут вказати наступним чином: „Акт.Послуги[@index].Код“- то він буде посилатися на той же елемент масиву в якому функція була викликана; наприклад:»function»: «$updateDictLink(„Акт.Послуги[@index].Код“, „code“)$» ArithmeticOperate - виконує математичні операції за вже заповненими іншими полями. Шаблон: $arithmeticOperate(resultPath: string, sourcePath1: string, operationType: string, sourcePath2: string)$, де resultPath - шлях до елементу структурованого документа в який потрібно записати результат; sourcePath1 - шлях до елементу структурованого документа в якому міститься перший аргумент для арифметичної операції; operationType - вид операції, можливі значення «+», «-«, «/», «*»; sourcePath2 - шлях до елементу структурованого документа в якому міститься другий аргумент для арифметичної операції (sourcePath2 може бути відсутнім);

Таблиця 4 - Опис параметрів об’єкта DocStructType

Параметр	Формат	Опис
	Об’єкт DocStructType
object	Object	об’єкт; елемент, який є вузлом, структурою зі своїми полями
array	DocFieldTypeArray	об’єкт; елемент, який є таблицею або масивом значень зі своїми полями
number	DocFieldTypeNumeric	об’єкт; числові значення зі знаком і символ розділювача числа в дробовій формі
string	DocFieldTypeString	об’єкт; текстові значення
date	DocFieldTypeDate	об’єкт; дата без часу
time	DocFieldTypeTime	об’єкт; час
aEnum	List<DocFieldTypeEnum>	масив об’єктів; список
	Об’єкт DocFieldTypeString
length	Integer	кількість символів
minLength	Integer	мінімальна кількість символів (мінімум 1)
maxLength	Integer	максимальна кількість символів (максимум 9999)
regexp	String	регулярний вираз
case	String	регістр - вказується, в якому регістрі використовувати рядок (upper, lower, camel)
	Об’єкт DocFieldTypeArray
minLength	int	мінімальна кількість рядків (мінімум 1)
maxLength	int	максимальна кількість рядків (максимум 9999)
	Об’єкт DocFieldTypeNumeric
type	String	тип числа
positive	boolean	додатне число
negative	boolean	від’ємне число
decimal	int	кількість цифр після коми
	Об’єкт DocFieldTypeDate
format	String	формат дати, де Y - рік, M - місяць, D - день
	Об’єкт DocFieldTypeTime
format	String	формат часу, де H - година, M - хвилина, S - секунда; при цьому H використовується для 24-годинного формату, h - для 12-годинного формату
	Об’єкт DocFieldTypeEnum
value	String	значення; значення, яке буде додано в тег
name	String	назва; відображувана назва значення

---

Приклади

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

{
  "encoding": "utf-8",
  "id": 2393,
  "status": 1,
  "structure": [
    {
      "id": "Акт",
      "title": "АКТ приймання-передачі наданих послуг",
      "optional": true,
      "readonly": false,
      "attribute": false,
      "type": {
        "object": {}
      },
      "fields": [
        {
          "id": "Назва",
          "title": "Найменування робіт, послуг",
          "optional": false,
          "readonly": false,
          "attribute": true,
          "data": [
            {
              "index": 3
            }
          ],
          "type": {
            "enum": []
          }
        },
        {
          "id": "Послуги",
          "title": "Виконавцем були виконані наступні роботи (надані такі послуги):",
          "optional": false,
          "readonly": false,
          "attribute": true,
          "type": {
            "array": {
              "minLength": 1,
              "maxLength": 10
            }
          },
          "fields": [
            {
              "id": "Назва",
              "title": "Найменування робіт, послуг",
              "optional": false,
              "readonly": false,
              "attribute": true,
              "function": "$updateDictLink('Акт.Послуги[@index].Код', 'code')$",
              "data": [
                {
                  "index": -1
                }
              ],
              "type": {
                "enum": []
              }
            },
            {
              "id": "Код",
              "title": "Код",
              "optional": true,
              "readonly": true,
              "attribute": true,
              "type": {
                "string": {
                  "length": 50,
                  "minLength": 1,
                  "maxLength": 50
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

---

Приклад тіла відповіді (json):

{
  "id": 2393,
  "structure": [
    {
      "id": "Акт",
      "title": "АКТ приймання-передачі наданих послуг",
      "optional": true,
      "readonly": false,
      "attribute": false,
      "type": {
        "object": {}
      },
      "fields": [
        {
          "id": "Назва",
          "title": "Найменування робіт, послуг",
          "optional": false,
          "readonly": false,
          "attribute": true,
          "data": [
            {
              "index": 3
            }
          ],
          "type": {
            "enum": []
          }
        },
        {
          "id": "Послуги",
          "title": "Виконавцем були виконані наступні роботи (надані такі послуги):",
          "optional": false,
          "readonly": false,
          "attribute": true,
          "type": {
            "array": {
              "minLength": 1,
              "maxLength": 10
            }
          },
          "fields": [
            {
              "id": "Назва",
              "title": "Найменування робіт, послуг",
              "optional": false,
              "readonly": false,
              "attribute": true,
              "function": "$updateDictLink('Акт.Послуги[@index].Код', 'code')$",
              "data": [
                {
                  "index": -1
                }
              ],
              "type": {
                "enum": []
              }
            },
            {
              "id": "Код",
              "title": "Код",
              "optional": true,
              "readonly": true,
              "attribute": true,
              "type": {
                "string": {
                  "length": 50,
                  "minLength": 1,
                  "maxLength": 50
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "version": 2,
  "status": 1,
  "dateUpdate": 1557935263,
  "encoding": "utf-8"
}

Створення / оновлення структурованого документа з XML

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

Важливо

Якщо поле documentId - не вказувати - буде створено новий документ, якщо вказати - відредагується вказаний; інші поля в documentStore (окрім вказаних) можна не передавати - вони враховуватися не будуть.

Метод запиту	HTTPS POST
Content-Type	multipart/form-data (тіло запиту в form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/xml
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В тілі запиту в form-data передається файл xml та параметри JSON объекта documentStore в полі document_store.

Таблиця 1 - Опис json-параметрів запиту метода API (дані комплекту - об’єкт DocumentStore )

Параметр	Mandatory/Optional	Формат	Опис
package_id	M	long	ID пакета
document_id	M	long	ID документа
senderCompanyId	M	long	ID організації відправника
documentType	M	Document_	об’єкт; опис типу документу
number	M	String	номер документу
date	M	long	дата документу

RESPONSE

Опис json-параметрів відповіді метода API (дані комплекту - об’єкт DocumentStore)

Таблиця 2 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company_	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

---

Приклади

В тілі запиту в form-data передається файл з данними документу та json об’єкта documentStore.

Приклад тіла запиту в json форматі

  {
"documentId": 10253,
"packageId": 8269,
"senderCompanyId": 4,
"documentType": {
 "documentId": 3381
},
"number": "1583158378",
"date": 1583158378
  }

---

Приклад тіла відповіді (json):

{
  "documentId": 1662,
  "packageId": 1982,
  "senderCompanyId": 2,
  "documentType": {
    "documentId": 10253,
    "companyId": 2,
    "name": "Для тест ",
    "type": 2,
    "code": "sdoc1",
    "isActive": 1,
    "structures": [
      {
        "id": 10253,
        "structure": [
          {}
        ],
        "version": 1,
        "status": 1,
        "dateUpdate": 1540280767
      }
    ]
  },
  "number": "99999",
  "date": 1526947200,
  "dateSent": 0,
  "clientSignsCount": 0,
  "ownerSignsCount": 0,
  "status": 1,
  "comment": "aaaa",
  "versionStructure": 1,
  "bodies": [
    {
      "bodyId": 10253,
      "documentId": 10253,
      "fileName": "99999_1526947200_1662.xml",
      "signBodies": []
    }
  ],
  "structure": [
    {
      "id": "Тег1",
      "value": "1222",
      "index": 0,
      "structure": []
    }
  ],
  "isReadFromApi": 0
}

Отримання інформації по внутрішньому документу

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-document/info
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт DocumentStore).

Таблиця 1 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody>	масив об’єктів; тіла документів
structure	List<DocStructValue>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Таблиця 4 - Опис параметрів об’єкта DocumentBody

Параметр	Формат	Опис
	Об’єкт DocumentBody
bodyId	long	id тіла документа
documentId	long	id документа
fileName	String	найменування файлу
body	byte[]	тіло документа
signBodies	List<SignBody_>	масив об’єктів; тіла підписів на документі

Таблиця 5 - Опис параметрів об’єкта ExtraField

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

Таблиця 6 - Опис параметрів об’єкта DocStructValue

Параметр	Формат	Опис
	Об’єкт DocStructValue
id	String	ID тега відповідно до опису структури
value	String	значення тега
index	int	номер рядка для масивів, починається з «0»
structure	List<List<DocStructValue>>	масив масивів об’єктів; опис структури зі значеннями
errors	List<String>	масив об’єктів; помилки

Таблиця 7 - Опис параметрів об’єкта AgreementLogs

Параметр	Формат	Опис
	Об’єкт AgreementLogs
agreementLogId	long	ID логу узгодження
taskId	long	ID завдання
actionType	int	тип дії
dateCreated	long	дата створення завдання
comment	String	комментарий
user	User_	об’єкт; дані користувача

Таблиця 8 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "agreementLogs": [
    {
      "actionType": 4,
      "agreementLogId": 1279,
      "comment": "авы",
      "dateCreated": 1562230627,
      "taskId": 5035,
      "user": {
        "accountId": 0,
        "companies": [],
        "email": "sashabelovv@meta.ua",
        "fio": "Ляшенко евгений",
        "isOwner": 0,
        "lastLoginDate": 0,
        "passPolicyId": 0,
        "passSecureType": 0,
        "roles": [],
        "routes": [],
        "status": 0,
        "tel": "34324322",
        "uiTypes": [],
        "userAccess": {},
        "userId": 0
      }
    }
  ],
  "agreementProcId": 0,
  "agreementStatus": 0,
  "bodies": [
    {
      "bodyId": 6257,
      "documentId": 6383,
      "fileName": "1562240257_1562240257_6383.xml",
      "signBodies": [
        {
          "bodyId": 6257,
          "companyId": 4,
          "info": {
            "certSerial": "33B6CB7BF721B9CE040000000CAB250045995A00",
            "isTimeStamp": true,
            "issuerCN": "Акредитований центр сертифікації ключів ІДД ДФС",
            "subjCN": "Мирний Олександр Максимович (Тест)",
            "subjCode": "1010101017",
            "subjFullName": "Мирний Олександр Максимович (Тест)",
            "subjInn": "1010101017",
            "subjOrg": "Мирний Олександр Максимович (Тест)",
            "subject": "CN=Мирний Олександр Максимович (Тест);SN=Мирний;GivenName=Олександр Максимович (Тест);Serial=2468620;C=UA;L=Київ",
            "timeStamp": 1562312853
          },
          "signId": 1967
        },
        {
          "bodyId": 6257,
          "companyId": 4,
          "info": {
            "certSerial": "33B6CB7BF721B9CE040000000CAB250045995A00",
            "isTimeStamp": true,
            "issuerCN": "Акредитований центр сертифікації ключів ІДД ДФС",
            "subjCN": "Мирний Олександр Максимович (Тест)",
            "subjCode": "1010101017",
            "subjFullName": "Мирний Олександр Максимович (Тест)",
            "subjInn": "1010101017",
            "subjOrg": "Мирний Олександр Максимович (Тест)",
            "subject": "CN=Мирний Олександр Максимович (Тест);SN=Мирний;GivenName=Олександр Максимович (Тест);Serial=2468620;C=UA;L=Київ",
            "timeStamp": 1562312873
          },
          "signId": 1969
        }
      ]
    }
  ],
  "clientSignsCount": 0,
  "comment": "121212",
  "date": 1562054351,
  "dateSent": 1562229582,
  "documentId": 6270,
  "documentType": {
    "agreementProcId": 0,
    "code": "0cfa1f6f52884f6c8a4d1f1e51b7b07d",
    "companyId": 4,
    "documentId": 2677,
    "extraFields": [],
    "isActive": 1,
    "isProviderAccess": 0,
    "name": "Внутренний2",
    "type": 2,
    "useType": 2
  },
  "documentUuid": "dd5f6a59-2cf2-4bf3-b70e-26cf5e11266e",
  "extraFields": [],
  "isReadFromApi": 0,
  "number": "1562054351",
  "ownerSignsCount": 0,
  "packageId": 0,
  "senderCompanyId": 4,
  "status": 5,
  "versionStructure": 2
}

Отримання структури внутрішнього документу

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-document/structure
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт DocumentStore).

Таблиця 1 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody>	масив об’єктів; тіла документів
structure	List<DocStructValue>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Таблиця 4 - Опис параметрів об’єкта DocumentBody

Параметр	Формат	Опис
	Об’єкт DocumentBody
bodyId	long	id тіла документа
documentId	long	id документа
fileName	String	найменування файлу
body	byte[]	тіло документа
signBodies	List<SignBody_>	масив об’єктів; тіла підписів на документі

Таблиця 5 - Опис параметрів об’єкта ExtraField

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

Таблиця 6 - Опис параметрів об’єкта DocStructValue

Параметр	Формат	Опис
	Об’єкт DocStructValue
id	String	ID тега відповідно до опису структури
value	String	значення тега
index	int	номер рядка для масивів, починається з «0»
structure	List<List<DocStructValue>>	масив масивів об’єктів; опис структури зі значеннями
errors	List<String>	масив об’єктів; помилки

Таблиця 7 - Опис параметрів об’єкта AgreementLogs

Параметр	Формат	Опис
	Об’єкт AgreementLogs
agreementLogId	long	ID логу узгодження
taskId	long	ID завдання
actionType	int	тип дії
dateCreated	long	дата створення завдання
comment	String	комментарий
user	User_	об’єкт; дані користувача

Таблиця 8 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "agreementProcId": 0,
  "agreementStatus": 0,
  "bodies": [],
  "clientSignsCount": 0,
  "date": 1562240257,
  "dateSent": 0,
  "documentId": 6383,
  "documentType": {
    "agreementProcId": 0,
    "code": "82bca6976b564c149f5ee15688e5742a",
    "companyId": 4,
    "documentId": 2681,
    "extraFields": [],
    "isActive": 1,
    "isProviderAccess": 0,
    "name": "Новенький",
    "structures": [
      {
        "dateUpdate": 1562159706,
        "encoding": "utf-8",
        "id": 2681,
        "status": 1,
        "structure": [
          {
            "attribute": false,
            "fields": [
              {
                "attribute": true,
                "data": [
                  {
                    "index": 0,
                    "template": " "
                  }
                ],
                "id": "Empty1",
                "optional": true,
                "readonly": false,
                "title": " ",
                "type": {
                  "string": {
                    "maxLength": 10,
                    "minLength": 1
                  }
                }
              },
              {
                "attribute": true,
                "data": [
                  {
                    "index": 0,
                    "template": " "
                  }
                ],
                "id": "Empty1",
                "optional": true,
                "readonly": false,
                "title": " ",
                "type": {
                  "string": {
                    "maxLength": 10,
                    "minLength": 1
                  }
                }
              },
              {
                "attribute": true,
                "data": [
                  {
                    "default": "Генеральному директору ТОВ 'АТС' Клюсі О.М.",
                    "index": 0
                  }
                ],
                "id": "Кому",
                "optional": true,
                "readonly": true,
                "title": "Кому:",
                "type": {
                  "string": {
                    "maxLength": 10,
                    "minLength": 1
                  }
                }
              },
              {
                "attribute": true,
                "data": [
                  {
                    "index": 0,
                    "template": "Прошу надати мені відпустку без збереження заробітної плати "
                  }
                ],
                "id": "ОснТекст",
                "optional": true,
                "readonly": false,
                "title": "  ",
                "type": {
                  "string": {
                    "maxLength": 100,
                    "minLength": 1
                  }
                },
                "viewType": "text-area"
              },
              {
                "attribute": true,
                "data": [
                  {
                    "index": 0,
                    "template": "Юзер:user:#user.fio#"
                  }
                ],
                "id": "User",
                "optional": true,
                "readonly": false,
                "title": "Юзер",
                "type": {
                  "string": {
                    "maxLength": 500,
                    "minLength": 1
                  }
                }
              }
            ],
            "id": "Заява",
            "optional": true,
            "readonly": false,
            "title": "Заява на відпустку без збереження заробітної плати",
            "type": {
              "object": {}
            }
          }
        ],
        "version": 10
      }
    ],
    "type": 2,
    "useType": 2
  },
  "documentUuid": "abfa6629-4feb-48ae-943b-9e643e1f2700",
  "extraFields": [],
  "isReadFromApi": 0,
  "number": "1562240257",
  "ownerSignsCount": 2,
  "packageId": 0,
  "senderCompanyId": 4,
  "status": 1,
  "structure": [
    {
      "id": "Заява",
      "index": 0,
      "structure": [
        [
          {
            "id": "Empty1",
            "index": 0,
            "value": " "
          },
          {
            "id": "ОснТекст",
            "index": 0,
            "value": "Прошу надати мені відпустку без збереження заробітної плати "
          },
          {
            "id": "Підрозділ",
            "index": 0,
            "value": "пвапавпв"
          },
          {
            "id": "Вособsaі",
            "index": 0,
            "value": "вы"
          },
          {
            "id": "User",
            "index": 0,
            "value": "Юзер:user:Ляшенко евгений"
          }
        ]
      ]
    }
  ],
  "versionStructure": 10
}

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

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-documents
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: folder - вибір каталога користувача (1- draft (чернетки), 2-sent (відправлені документи))

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт DocumentStore).

Таблиця 1 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Таблиця 4 - Опис параметрів об’єкта DocumentBody

Параметр	Формат	Опис
	Об’єкт DocumentBody
bodyId	long	id тіла документа
documentId	long	id документа
fileName	String	найменування файлу
body	byte[]	тіло документа
signBodies	List<SignBody_>	масив об’єктів; тіла підписів на документі

Таблиця 5 - Опис параметрів об’єкта AgreementLogs

Параметр	Формат	Опис
	Об’єкт AgreementLogs
agreementLogId	long	ID логу узгодження
taskId	long	ID завдання
actionType	int	тип дії
dateCreated	long	дата створення завдання
comment	String	комментарий
user	User_	об’єкт; дані користувача

Таблиця 6 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "agreementProcId": 142,
    "agreementStatus": 1,
    "bodies": [],
    "clientSignsCount": 0,
    "date": 1562584937,
    "dateSent": 0,
    "documentId": 6428,
    "documentType": {
      "agreementProcId": 0,
      "companyId": 0,
      "documentId": 2676,
      "extraFields": [],
      "isActive": 0,
      "isProviderAccess": 0,
      "name": "внутренний",
      "type": 1,
      "useType": 0
    },
    "documentUuid": "328ca968-45fd-4b4f-8742-9249b049d4f6",
    "extraFields": [],
    "isReadFromApi": 0,
    "number": "1562584937",
    "ownerSignsCount": 0,
    "packageId": 0,
    "senderCompany": {
      "accountId": 8,
      "certificates": [],
      "code": "34554355",
      "companyId": 4,
      "dictionaries": [],
      "inn": "123456789043",
      "isActive": 0,
      "isApproved": 0,
      "isSignedOffer": 0,
      "legalName": "ПрАТ \"Літак\"",
      "name": "Царь Царей",
      "notifySettings": [],
      "ownershipTypeId": 0,
      "type": 0
    },
    "senderCompanyId": 4,
    "status": 1,
    "versionStructure": 0
  },
  {
    "agreementProcId": 142,
    "agreementStatus": 1,
    "bodies": [],
    "clientSignsCount": 0,
    "date": 1561646310,
    "dateSent": 0,
    "documentId": 6235,
    "documentType": {
      "agreementProcId": 0,
      "companyId": 0,
      "documentId": 2676,
      "extraFields": [],
      "isActive": 0,
      "isProviderAccess": 0,
      "name": "внутренний",
      "type": 1,
      "useType": 0
    },
    "documentUuid": "49ee9089-e5f9-49a9-8807-3323ab925f2c",
    "extraFields": [],
    "isReadFromApi": 0,
    "number": "1561646310",
    "ownerSignsCount": 0,
    "packageId": 0,
    "senderCompany": {
      "accountId": 8,
      "certificates": [],
      "code": "34554355",
      "companyId": 4,
      "dictionaries": [],
      "inn": "123456789043",
      "isActive": 0,
      "isApproved": 0,
      "isSignedOffer": 0,
      "legalName": "ПрАТ \"Літак\"",
      "name": "Царь Царей",
      "notifySettings": [],
      "ownershipTypeId": 0,
      "type": 0
    },
    "senderCompanyId": 4,
    "status": 1,
    "versionStructure": 0
  }
]

Створення внутрішнього структурованого або НЕструктурованого документу

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

Метод запиту	HTTPS POST
Content-Type	application/form-data (тіло запиту/відповіді в форматі form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-document
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API:

Параметр	Тип	Формат	Опис
document_type_id	M		id типу документу
«файл-документа»	M		тільки для НЕструктурованого документу! - документ/зміст документу
document_structure_content	M		тільки для структурованого документу! - документ/зміст документу
companyId	M		id компанії, по якій створюється документ

RESPONSE

У відповідь передається код сервера 200 (ok).

---

Приклади

Приклад тіла запиту в форматі form-data:

WebKitFormBoundarylHOrB8PBaKDORWrl
Content-Disposition: form-data; name="company_id"

4

WebKitFormBoundarylHOrB8PBaKDORWrl
Content-Disposition: form-data; name="document_type_id"

2681

WebKitFormBoundarylHOrB8PBaKDORWrl
Content-Disposition: form-data; name="document_structure_content"

[{"id":"Заява","structure":","errors":null,"sid":3},{"id":"Empty1","structure":null,"value":" ","errors":null,"sid":4},{"id":"Empty1","structure":null,"value":" ","errors":null,"sid":5},{"id":"Empty1","structure":null,"value":" ","errors":null,"sid":6},{"id":"Заголовок","structure":null,"value":"ЗАЯВА","errors":null,"sid":7},{"id":"Empty1","structure":null,"value":" ","errors":null,"sid":8},{"id":"ОснТекст","structure":null,"value":"Прошу надати мені відпустку без збереження заробітної плати ","errors":null,"sid":9},{"id":"Підрозділ","structure":null,"value":"впаапвпв","errors":null,"sid":10},{"id":"Вособsaі","structure":null,"value":"1212","errors":null,"sid":11},{"id":"User","structure":null,"value":"Юзер:user:Ляшенко евгений","errors":null,"sid":12},"value":null,"errors":null,"sid":0}]

WebKitFormBoundarylHOrB8PBaKDORWrl

---

У відповідь передається код сервера 200 (ok).

Отримання типу комплекта документів по сценарію документообігу

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

Важливо

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/extra/contract/package_type?contract_id=111&package_id=58
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу package_id - ID комплекту документів

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт PackageType).

Таблиця 1 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company_	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "packageId": 1459,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 1,
    "version": 3,
    "dateChanged": 1557488853,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  {
    "packageId": 1457,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 2,
    "version": 2,
    "dateChanged": 1557488632,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  {
    "packageId": 1455,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 2,
    "version": 1,
    "dateChanged": 1557488538,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  }
]

Створення комплекта документів

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	contractId, packageId наприклад: {«contract»:{«contractId»:55},»packageType»:{«packageId»:59}}

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST / RESPONSE

Опис json-параметрів запиту та відповіді метода API (об’єкт Package)

Таблиця 1 - Опис параметрів об’єкта Package

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company	об’єкт; дані власника компанії
clientCompany	Company	об’єкт; дані контрагента
senderCompany	Company	об’єкт; дані компанії-відправника
recipientCompany	Company	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 6 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 7 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue_>	масив об’єктів; значення довідника

---

Приклади

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

{
  "packageId": 264,
  "contract": {
    "contractId": 55,
    "number": "777",
    "date": 0,
    "ownerCompany": {
      "companyId": 43,
      "accountId": 24,
      "type": 1,
      "name": "Державне підприємство НИВА",
      "edrpou": "20820657",
      "phone": "0661525636",
      "info": "",
      "legalAddress": "Украина, Киев, ул. Волкова 53 ",
      "actualAddress": "Украина, Киев, бул. Шевченка 52-а ",
      "pdv": "31321320323",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 1,
      "certificates": [],
      "dictionaries": []
    },
    "clientCompany": {
      "companyId": 46,
      "accountId": 32,
      "type": 1,
      "name": "Марченко О.В.",
      "edrpou": "СН777555",
      "legalAddress": "",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 1,
      "certificates": [],
      "dictionaries": []
    },
    "description": "для проверки маршрутов",
    "expiredDate": 0,
    "status": 2,
    "paymentStatus": 0,
    "isSpecialConditions": 0,
    "isAllClientSenderPackages": 0,
    "isAllOwnerSenderPackages": 0,
    "dictionaries": [],
    "ownerPackages": [],
    "clientPackages": []
  },
  "packageTypeId": 59,
  "dateCreated": 1527754374,
  "dateChanged": 1527754374,
  "status": 1,
  "archive": 0,
  "packageNumber": "1527754374",
  "documents": [],
  "package2Dictionaries": [],
  "extraFields": [],
  "contractDictionaries": [],
  "packageType": {
    "packageId": 59,
    "companyId": 43,
    "name": "Риски тест (есть) ",
    "type": 1,
    "code": "12",
    "status": 1,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  "isRead": 0,
  "isReadFromApi": 0,
  "isReadyForSend": 0,
  "packageDirection": 0
}

---

Приклад тіла відповіді (json):

{
  "packageId": 264,
  "contract": {
    "contractId": 55,
    "number": "777",
    "date": 0,
    "ownerCompany": {
      "companyId": 43,
      "accountId": 24,
      "type": 1,
      "name": "Державне підприємство НИВА",
      "edrpou": "20820657",
      "phone": "0661525636",
      "info": "",
      "legalAddress": "Украина, Киев, ул. Волкова 53 ",
      "actualAddress": "Украина, Киев, бул. Шевченка 52-а ",
      "pdv": "31321320323",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 1,
      "certificates": [],
      "dictionaries": []
    },
    "clientCompany": {
      "companyId": 46,
      "accountId": 32,
      "type": 1,
      "name": "Марченко О.В.",
      "edrpou": "СН777555",
      "legalAddress": "",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 1,
      "certificates": [],
      "dictionaries": []
    },
    "description": "для проверки маршрутов",
    "expiredDate": 0,
    "status": 2,
    "paymentStatus": 0,
    "isSpecialConditions": 0,
    "isAllClientSenderPackages": 0,
    "isAllOwnerSenderPackages": 0,
    "dictionaries": [],
    "ownerPackages": [],
    "clientPackages": []
  },
  "packageTypeId": 59,
  "dateCreated": 1527754374,
  "dateChanged": 1527754374,
  "status": 1,
  "archive": 0,
  "packageNumber": "1527754374",
  "documents": [],
  "package2Dictionaries": [],
  "extraFields": [],
  "contractDictionaries": [],
  "packageType": {
    "packageId": 59,
    "companyId": 43,
    "name": "Риски тест (есть) ",
    "type": 1,
    "code": "12",
    "status": 1,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  "isRead": 0,
  "isReadFromApi": 0,
  "isReadyForSend": 0,
  "packageDirection": 0
}

Додавання документа в комплект документів (в пакет)

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

Важливо

Логіка виконання методу може мінятися: якщо «Header» відсутній, у відповідь на успішний запит прийдуть дані по всьому комплекту документів (пакету) - об’єкт Package; якщо ж в «Header» запиту вибрати (передати) один з response-object-type, то:

• uuid - GUID документа; у відповідь на успішний запит прийде тільки GUID документа (documentUuid);

• document - дані документів; у відповідь на успішний запит прийде тільки об’єкт з даними документа (DocumentStore)

Метод запиту	HTTPS PUT
Content-Type	application/form-data/json (тіло HTTPS запиту в form-data /тіло відповіді в json форматі)
URL запиту	https://doc.edin.ua/bdoc/store/package/document
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта document_type_id - ID типу комплекту документів, в котрий додається документ Опціональні url-параметри: document_date - дата документу форматі UNIX TimeStamp document_number - номер документу comment - коментар

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі у тіло запиту в form-data передається файл (тільки один file розміром менше 5 Mb) документа, який необхідно додати.

RESPONSE

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

Таблиця 1 - Опис параметрів об’єкта Package

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company	об’єкт; дані власника компанії
clientCompany	Company	об’єкт; дані контрагента
senderCompany	Company	об’єкт; дані компанії-відправника
recipientCompany	Company	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 6 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 7 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue_>	масив об’єктів; значення довідника

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
    "packageId": 1966,
    "senderCompanyId": 2,
    "recipientCompanyId": 8,
    "senderCompany": {
        "companyId": 2,
        "accountId": 4,
        "name": "Державне підприємство НИВА",
        "code": "20820657",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
    },
    "recipientCompany": {
        "companyId": 8,
        "accountId": 6,
        "name": "Анткевич Г.В.",
        "code": "2131767363",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
    },
    "contract": {
        "contractId": 10,
        "number": "2000",
        "contractName": "Владелец \"ДП НИВА\" - Клиент \"Анткевич\"",
        "date": 1530403200,
        "ownerCompany": {
            "companyId": 2,
            "accountId": 4,
            "name": "Державне підприємство НИВА",
            "code": "20820657",
            "isApproved": 0,
            "isSignedOffer": 0,
            "isActive": 1,
        },
        "clientCompany": {
            "companyId": 8,
            "accountId": 6,
            "name": "Анткевич Г.В.",
            "code": "2131767363",
            "isApproved": 0,
            "isSignedOffer": 0,
            "isActive": 1,
        },
        "description": "Владелец \"ДП НИВА\" - Клиент \"Анткевич\"",
        "expiredDate": 1598659200,
        "status": 2,
    },
    "packageTypeId": 8,
    "dateCreated": 1540286988,
    "dateChanged": 1540287270,
    "status": 1,
    "archive": 0,
    "packageNumber": "1540286988",
    "documents": [
        {
            "documentId": 20,
            "packageId": 13,
            "documentType": {
                "documentId": 5,
                "companyId": 1,
                "name": "Інвойс",
                "code": "11006",
                "isActive": 1,
            },
            "number": "1515757306",
            "date": 1515715200,
            "signsCount": 1,
            "status": 2,
            "bodies": [
                {
                    "bodyId": 20,
                    "documentId": 20,
                    "fileName": "Воросы по БД (ответы).docx",
                    "signBodies": [
                        {
                            "signId": 36,
                            "bodyId": 20,
                            "info": {
                                "ownerInfo": "O=Тестова організація \"Тест Б\";OU=ТестовийБ;…
                                "issuer": "O=ТОВ \"КС\";OU=ЦСК;CN=АЦСК ТОВ \"КС\";Serial=UA
                                "issuerCN": "АЦСК ТОВ \"КС\"",
                                "subjAddress": "22222, м. Київ, вул. Тестова, 2, оф.2",
                                "subjDRFOCode": "",
                                "subjEDRPOUCode": "22332233",
                                "subjEMail": "stamp@m.ail",
                                "subjFullName": "Іванов Іван Петрович",
                                "subjLocality": "Київ",
                                "subjOrg": "Тестова організація \"Тест Б\"",
                                "subjOrgUnit": "ТестовийБ",
                                "subjPhone": "(222) 222222",
                                "subjTitle": "печатка тестовий директор"
                            }
                        }
                    ]
                }
            ]
            "isReadFromApi": 0,
            "documentUuid": "c48233b5-2e08-4a46-92f6-04bbb8e9ca8e"
        },
    ],
    "package2Dictionaries": [
        {
            "packageId": 1,
            "dictionaryId": 3,
            "dictionary": {
                "dictionaryId": 3,
                "companyId": 1,
                "name": "Відділення",
                "code": "DEPARTMENT",
                "isActive": 1,
                "values": [
                    {
                        "valueId": 27,
                        "dictionaryId": 3,
                        "name": "Херсон. Базове.",
                        "code": "1621",
                        "isActive": 1
                    }
                ]
            }
        }
    ],
    "extraFields": [
        {
            "packageId": 37,
            "fillType": 3,
            "required": 1,
            "extraField": {
                "fieldId": 31,
                "companyId": 27,
                "name": "NumDogovor",
                "description": "№ договора поставки",
                "dataType": 1,
                "status": 1,
                "value": "21312фыва1ё"
            }
    "contractDictionaries": [
        {
            "contractId": 1,
            "dictionaryId": 1,
            "dictionary": {
                "dictionaryId": 1,
                "companyId": 1,
                "name": "Сегмент клієнта",
                "code": "SEGMENT",
                "isActive": 1,
                "values": [
                    {
                        "valueId": 1,
                        "dictionaryId": 1,
                        "name": "Мідмаркет",
                        "code": "01",
                        "isActive": 1
                    }
                ]
            }
        }
    ],
    "isRead": 0,
    "isReadFromApi": 0,
    "isReadyForSend": 1,
    "packageDirection": 2,
    "packageUuid": "693ffb23-6b13-4d49-999d-7368e7069c2a"
}

Додавання (прив’язка) типу комплекта документів до документу

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

Важливо

Для активації комплекта документів достатньо додати документ - це є обов’язковою умовою, без документа користувач отримує повідомлення про помилку з проханням додати документ.

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package_document
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	packageId, documentId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Document2Package)

Таблиця 1 - Опис параметрів об’єкта Document2Package

Параметр	Формат	Опис
	Об’єкт Document2Package
packageId	long	id комплекта
documentId	long	id документа
needSign	int	необхідність підписання; «0 - Ні; 1 - Так»
signsCount	int	кількість підписів
ownerSignsCount	int	кількість підписів власника
needEncrypt	int	необхідність шифрування; «0 - Ні; 1 - Так»
required	int	обов’язковий документ: 0 - Ні; 1 - Так
isRecipientAttach	int	ознака, що вказує, що документ є «довкладенням» з боку одержувача; «0 - Ні; 1 - Так»
maxFilesCount	int	максимальна кількість вкладених файлів
document	Document	об’єкт; дані документа

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageType)

Таблиця 2 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

Таблиця 3 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 4 - Опис параметрів об’єкта Document2Package

Параметр	Формат	Опис
	Об’єкт Document2Package
packageId	long	id комплекта
documentId	long	id документа
needSign	int	необхідність підписання; «0 - Ні; 1 - Так»
signsCount	int	кількість підписів
ownerSignsCount	int	кількість підписів власника
needEncrypt	int	необхідність шифрування; «0 - Ні; 1 - Так»
required	int	обов’язковий документ: 0 - Ні; 1 - Так
isRecipientAttach	int	ознака, що вказує, що документ є «довкладенням» з боку одержувача; «0 - Ні; 1 - Так»
maxFilesCount	int	максимальна кількість вкладених файлів
document	Document	об’єкт; дані документа

Таблиця 5 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

---

Приклади

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

{
  "packageId": 1485,
  "documentId": 2391,
  "needSign": 0,
  "signsCount": 0,
  "ownerSignsCount": 0,
  "maxFilesCount": 3,
  "needEncrypt": 0,
  "required": 0,
  "isRecipientAttach": 0
}

---

Приклад тіла відповіді (json):

{
  "packageId": 1485,
  "companyId": 989,
  "name": "авыаыв123",
  "type": 1,
  "code": "323222",
  "packageChainId": 244,
  "status": 3,
  "version": 1,
  "dateChanged": 1557905884,
  "autoHandle": 0,
  "document2packages": [
    {
      "packageId": 1485,
      "documentId": 2391,
      "needSign": 0,
      "signsCount": 0,
      "ownerSignsCount": 0,
      "needEncrypt": 0,
      "required": 0,
      "isRecipientAttach": 0,
      "maxFilesCount": 3,
      "document": {
        "documentId": 2391,
        "companyId": 989,
        "name": "dsfdsfs",
        "type": 2,
        "code": "2322",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
      }
    }
  ],
  "package2dictionaries": [],
  "extraFields": [],
  "company": {
    "companyId": 0,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}

Отримання списку типів комплектів документів

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/extra/package_types
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії Опціональні url-параметри status - ID статусу комплекта документів («1 - Активний; 2 - Заблокований; 3 - Чернетка») search_pattern - пошук по признаку типу комплекта документів (фільтр)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

Примітка

В результаті запиту 100 значень вибірки групуються по package_chain_id (ID типу комплекта документів)

RESPONSE

Опис json-параметрів відповіді методу API (масив об’єктів PackageType).

Таблиця 1 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company_	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

додати приклад

Створення/редагування типу комплекта документів (структурованого чи НЕструктурованого)

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній documentId, то документ з зазначеним Id підлягає редагуванню. Відсутність параметра documentId веде до створення нового документу.

Увага

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

type=1 - НЕструктурований документ

type=2 - структурований документ

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/document_type
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	documentId (для редагування документу), isActive, companyId, name, code, type

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Document)

Таблиця 1 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company_	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Document)

Таблиця 2 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company_	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

---

Приклади

Приклад тіла запиту (json) для Створення НЕструктурованого документу:

{
  "isActive": 1,
  "companyId": 989,
  "name": "выаыdssdаы",
  "code": "4324234223425",
  "type": 1
}

---

Приклад тіла запиту (json) для Редагування НЕструктурованого документу:

{
  "documentId": 2467,
  "isActive": 1,
  "companyId": 989,
  "name": "имя",
  "code": "4324234223425",
  "type": 1
}

Приклад тіла запиту (json) для Створення структурованого документу:

{
  "isActive": 1,
  "companyId": 989,
  "name": "выаыdssdаы",
  "code": "4324234223425",
  "type": 2
}

---

Приклад тіла запиту (json) для Редагування структурованого документу:

{
  "documentId": 2467,
  "isActive": 1,
  "companyId": 989,
  "name": "имя",
  "code": "4324234223425",
  "type": 2
}

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
  "documentId": 2467,
  "companyId": 989,
  "name": "выаыdssdаы",
  "type": 1,
  "code": "4324234223425",
  "agreementProcId": 0,
  "isActive": 1,
  "extraFields": []
}

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

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/packages_by_chain?package_chain_id=242
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_chain_id - ID комплекту документів

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт PackageType).

Таблиця 1 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company_	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "packageId": 1459,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 1,
    "version": 3,
    "dateChanged": 1557488853,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  {
    "packageId": 1457,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 2,
    "version": 2,
    "dateChanged": 1557488632,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  },
  {
    "packageId": 1455,
    "companyId": 989,
    "name": "авыаыв",
    "type": 1,
    "code": "323222",
    "packageChainId": 242,
    "status": 2,
    "version": 1,
    "dateChanged": 1557488538,
    "autoHandle": 0,
    "document2packages": [],
    "package2dictionaries": [],
    "extraFields": []
  }
]

Активувати тип комплекту документів (змінити статус комплекту документів)

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package_type/status?package_id=1455&status=1
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекту документів status - статус комплекту документів (1 - Активний; 2 - Заблокоаний; 3 - Чернетка)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Створення/редагування типу комплекта документів

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній packageId, то тип комлекту документів з зазначеним Id підлягає редагуванню. Відсутність параметра packageId веде до створення нового типу комлекту документів.

Увага

За замовчуванням комплект документів створюється зі статусом «Чорновик» і для подальшої корректної роботи його необхідно активувати !!!

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	packageId (для редагування типу комплекта документів), name, code, type, companyId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт PackageType)

Таблиця 1 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageType)

Таблиця 2 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

Таблиця 3 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

Приклад тіла запиту (json) для Створення типу комплекта документів:

{
  "name": "опаопа",
  "code": "323222",
  "type": 1,
  "autoHandle": 0,
  "companyId": "989"
}

---

Приклад тіла запиту (json) для Редагування типу комплекта документів:

{
  "packageId": 1485,
  "name": "авыаыв123",
  "code": "323222",
  "type": 1,
  "autoHandle": 0,
  "companyId": "989"
}

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
  "packageId": 1485,
  "companyId": 989,
  "name": "авыаыв",
  "type": 1,
  "code": "323222",
  "packageChainId": 244,
  "status": 3,
  "version": 1,
  "dateChanged": 1557905884,
  "autoHandle": 0,
  "document2packages": [],
  "package2dictionaries": [],
  "extraFields": [],
  "company": {
    "companyId": 0,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}

Відправка коментаря до комплекта документів

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/comment?package_id=5261
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта документів, до якого необхідно відправити документ

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

Опис json-параметрів відповіді метода API (масив об’єктів PackageComments)

Таблиця 1 - Опис параметрів об’єкта PackageComments

Параметр	Формат	Опис
	Об’єкт PackageComments
commentId	long	id коментаря
packageId	long	id комплекту
user	User	об’єкт; дані користувача
action	int	дія; тип операції
comment	Comment	об’єкт; коментар
date	long	дата коментаря

Таблиця 2 - Опис параметрів об’єкта Comment

Параметр	Формат	Опис
	Об’єкт Comment
before	Changes	об’єкт; зміни (коментар до)
after	Changes	об’єкт; зміни (коментар після)
userComment	String	коментар користувача
documentId	Long	ID документа

Таблиця 3 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

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

---

Приклад тіла відповіді в json форматі

[
      [
        {
          "commentId": 1960,
          "packageId": 5261,
          "user": {
            "userId": 0,
            "accountId": 0,
            "email": "sashabelovv@meta.ua",
            "isOwner": 0,
            "fio": "Ляшенко евгений",
            "tel": "34324322",
            "companies": [],
            "status": 0,
            "roles": [],
            "routes": [],
            "passSecureType": 0,
            "passPolicyId": 0,
            "lastLoginDate": 0,
            "uiTypes": [],
            "userAccess": {}
          },
          "action": 3,
          "comment": {
            "before": {
              "status": 6
            },
            "after": {
              "status": 6
            },
            "userComment": "121212"
          },
          "date": 1561036190
        },
        {
          "commentId": 1959,
          "packageId": 5261,
          "user": {
            "userId": 0,
            "accountId": 0,
            "email": "lyashenko270619933@meta.ua",
            "isOwner": 0,
            "fio": "Личный раб",
            "tel": "423423",
            "companies": [],
            "status": 0,
            "roles": [],
            "routes": [],
            "passSecureType": 0,
            "passPolicyId": 0,
            "lastLoginDate": 0,
            "uiTypes": [],
            "userAccess": {}
          },
          "action": 1,
          "comment": {
            "before": {
              "status": 3
            },
            "after": {
              "status": 6
            }
          },
          "date": 1560517761
        }
      ]
    ]

Отримання списку комплекта документів

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/packages
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри: limit - ліміт вибірки (за умовчуванням 30; максимальне значення вибірки 50) offset - зміщення відносно верхньої межі вибірки (за умовчуванням 0)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (частина об’єкта PackageFilter)

Таблиця 1 - Опис параметрів об’єкта PackageFilterPart

Таблиця 2 - Опис параметрів об’єкта ExtraField

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

Таблиця 3 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

RESPONSE

Опис json-параметрів відповіді метода API (масив об’єктів Package)

Таблиця 4 - Опис параметрів об’єкта Package

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company_	об’єкт; дані власника компанії
clientCompany	Company_	об’єкт; дані контрагента
senderCompany	Company_	об’єкт; дані компанії-відправника
recipientCompany	Company_	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract_	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore_>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries_>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField_>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary_>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

---

Приклади

Пиклад тіла запиту в json форматі

{
  "folder": 1,
  "packageStatuses": [
    2,
    3,
    4,
    6,
    5,
    7,
    8
  ],
  "filterId": 0,
  "filterName": null
}

---

Приклад тіла відповіді в json форматі

[
  {
    "packageId": 6913,
    "senderCompanyId": 6,
    "recipientCompanyId": 4,
    "senderCompany": {
      "companyId": 6,
      "accountId": 10,
      "type": 0,
      "name": "ФІЗИЧНА ОСОБА",
      "legalName": "Ромашка",
      "inn": "0987654321",
      "code": "12345678",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "22345200-abe8-4f60-90c8-0d43c5f6c0f6",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "recipientCompany": {
      "companyId": 4,
      "accountId": 8,
      "type": 0,
      "name": "Царь Царей",
      "legalName": "ПрАТ \"Літак\"",
      "inn": "123456789043",
      "code": "34554355",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "contract": {
      "contractId": 6,
      "number": "1",
      "contractName": "Сотрудник",
      "date": 1531872000,
      "description": "ав",
      "expiredDate": 1563408000,
      "sentDate": 0,
      "status": 2,
      "paymentStatus": 1,
      "isSpecialConditions": 0,
      "isAllClientSenderPackages": 0,
      "isAllOwnerSenderPackages": 0,
      "dictionaries": [],
      "ownerPackages": [],
      "clientPackages": []
    },
    "packageTypeId": 2139,
    "packageTypeChainId": 285,
    "dateCreated": 1573051584,
    "dateChanged": 1573052586,
    "status": 2,
    "archive": 0,
    "packageNumber": "1573051558",
    "documents": [],
    "package2Dictionaries": [],
    "extraFields": [],
    "contractDictionaries": [],
    "packageType": {
      "packageId": 2139,
      "companyId": 4,
      "name": "Создал что бы удалить",
      "type": 1,
      "code": "80be4146ea4b4ca9a808ce6e8ae98a98",
      "packageChainId": 285,
      "status": 1,
      "version": 0,
      "dateChanged": 1573051420,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    },
    "isRead": 1,
    "isReadFromApi": 0,
    "isReadyForSend": 0,
    "packageDirection": 1,
    "signDateTerm": 0,
    "packageUuid": "4eb586a0-50e3-4455-97bf-c049c656af22",
    "isWithAgreement": 0
  },
  {
    "packageId": 6263,
    "senderCompanyId": 6,
    "recipientCompanyId": 4,
    "senderCompany": {
      "companyId": 6,
      "accountId": 10,
      "type": 0,
      "name": "ФІЗИЧНА ОСОБА",
      "legalName": "Ромашка",
      "inn": "0987654321",
      "code": "12345678",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "22345200-abe8-4f60-90c8-0d43c5f6c0f6",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "recipientCompany": {
      "companyId": 4,
      "accountId": 8,
      "type": 0,
      "name": "Царь Царей",
      "legalName": "ПрАТ \"Літак\"",
      "inn": "123456789043",
      "code": "34554355",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "contract": {
      "contractId": 6,
      "number": "1",
      "contractName": "Сотрудник",
      "date": 1531872000,
      "description": "ав",
      "expiredDate": 1563408000,
      "sentDate": 0,
      "status": 2,
      "paymentStatus": 1,
      "isSpecialConditions": 0,
      "isAllClientSenderPackages": 0,
      "isAllOwnerSenderPackages": 0,
      "dictionaries": [],
      "ownerPackages": [],
      "clientPackages": []
    },
    "packageTypeId": 1945,
    "packageTypeChainId": 285,
    "dateCreated": 1568620619,
    "dateChanged": 1568620619,
    "status": 2,
    "archive": 0,
    "packageNumber": "1568620497",
    "documents": [],
    "package2Dictionaries": [],
    "extraFields": [],
    "contractDictionaries": [],
    "packageType": {
      "packageId": 1945,
      "companyId": 4,
      "name": "Создал что бы удалить",
      "type": 1,
      "code": "80be4146ea4b4ca9a808ce6e8ae98a98",
      "packageChainId": 285,
      "status": 2,
      "version": 0,
      "dateChanged": 1568620428,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    },
    "isRead": 1,
    "isReadFromApi": 0,
    "isReadyForSend": 0,
    "packageDirection": 1,
    "signDateTerm": 0,
    "packageUuid": "b5800b95-e181-474c-adb3-50f8593f322c",
    "isWithAgreement": 1
  }
]

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

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/send
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта документів

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані комплекту документів (об’єкт Package) в json форматі

Таблиця 1 - Опис параметрів об’єкта Package

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company	об’єкт; дані власника компанії
clientCompany	Company	об’єкт; дані контрагента
senderCompany	Company	об’єкт; дані компанії-відправника
recipientCompany	Company	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 6 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 7 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue_>	масив об’єктів; значення довідника

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
        "packageId": 1966,
        "senderCompanyId": 2,
        "recipientCompanyId": 8,
        "senderCompany": {
            "companyId": 2,
            "accountId": 4,
            "name": "Державне підприємство НИВА",
            "code": "20820657",
            "isApproved": 1,
            "isSignedOffer": 1,
            "isActive": 1,
        },
        "recipientCompany": {
            "companyId": 8,
            "accountId": 6,
            "name": "Анткевич Г.В.",
            "code": "2131767363",
            "isApproved": 1,
            "isSignedOffer": 1,
            "isActive": 1,
        },
        "contract": {
            "contractId": 10,
            "number": "2000",
            "contractName": "Владелец \"ДП НИВА\" - Клиент \"Анткевич\"",
            "date": 1530403200,
            "ownerCompany": {
                "companyId": 2,
                "accountId": 4,
                "name": "Державне підприємство НИВА",
                "code": "20820657",
                "isApproved": 0,
                "isSignedOffer": 0,
                "isActive": 1,
            },
            "clientCompany": {
                "companyId": 8,
                "accountId": 6,
                "name": "Анткевич Г.В.",
                "code": "2131767363",
                "isApproved": 0,
                "isSignedOffer": 0,
                "isActive": 1,
            },
            "description": "Владелец \"ДП НИВА\" - Клиент \"Анткевич\"",
            "expiredDate": 1598659200,
            "status": 2,
        },
        "packageTypeId": 8,
        "dateCreated": 1540286988,
        "dateChanged": 1540287270,
        "status": 1,
        "archive": 0,
        "packageNumber": "1540286988",
        "documents": [
            {
                "documentId": 20,
                "packageId": 13,
                "documentType": {
                    "documentId": 5,
                    "companyId": 1,
                    "name": "Інвойс",
                    "code": "11006",
                    "isActive": 1,
                },
                "number": "1515757306",
                "date": 1515715200,
                "signsCount": 1,
                "status": 2,
                "bodies": [
                    {
                        "bodyId": 20,
                        "documentId": 20,
                        "fileName": "Воросы по БД (ответы).docx",
                        "signBodies": [
                            {
                                "signId": 36,
                                "bodyId": 20,
                                "info": {
                                    "ownerInfo": "O=Тестова організація \"Тест Б\";OU=ТестовийБ;…
                                    "issuer": "O=ТОВ \"КС\";OU=ЦСК;CN=АЦСК ТОВ \"КС\";Serial=UA
                                    "issuerCN": "АЦСК ТОВ \"КС\"",
                                    "subjAddress": "22222, м. Київ, вул. Тестова, 2, оф.2",
                                    "subjDRFOCode": "",
                                    "subjEDRPOUCode": "22332233",
                                    "subjEMail": "stamp@m.ail",
                                    "subjFullName": "Іванов Іван Петрович",
                                    "subjLocality": "Київ",
                                    "subjOrg": "Тестова організація \"Тест Б\"",
                                    "subjOrgUnit": "ТестовийБ",
                                    "subjPhone": "(222) 222222",
                                    "subjTitle": "печатка тестовий директор"
                                }
                            }
                        ]
                    }
                ]
                "isReadFromApi": 0,
                "documentUuid": "c48233b5-2e08-4a46-92f6-04bbb8e9ca8e"
            },
        ],
        "package2Dictionaries": [
            {
                "packageId": 1,
                "dictionaryId": 3,
                "dictionary": {
                    "dictionaryId": 3,
                    "companyId": 1,
                    "name": "Відділення",
                    "code": "DEPARTMENT",
                    "isActive": 1,
                    "values": [
                        {
                            "valueId": 27,
                            "dictionaryId": 3,
                            "name": "Херсон. Базове.",
                            "code": "1621",
                            "isActive": 1
                        }
                    ]
                }
            }
        ],
        "extraFields": [
            {
                "packageId": 37,
                "fillType": 3,
                "required": 1,
                "extraField": {
                    "fieldId": 31,
                    "companyId": 27,
                    "name": "NumDogovor",
                    "description": "№ договора поставки",
                    "dataType": 1,
                    "status": 1,
                    "value": "21312фыва1ё"
                }
        "contractDictionaries": [
            {
                "contractId": 1,
                "dictionaryId": 1,
                "dictionary": {
                    "dictionaryId": 1,
                    "companyId": 1,
                    "name": "Сегмент клієнта",
                    "code": "SEGMENT",
                    "isActive": 1,
                    "values": [
                        {
                            "valueId": 1,
                            "dictionaryId": 1,
                            "name": "Мідмаркет",
                            "code": "01",
                            "isActive": 1
                        }
                    ]
                }
            }
        ],
        "isRead": 0,
        "isReadFromApi": 0,
        "isReadyForSend": 1,
        "packageDirection": 2,
        "packageUuid": "693ffb23-6b13-4d49-999d-7368e7069c2a"
    }

Зміна статусу комплекту

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

Метод запиту	HTTPS POST
Content-Type	application/json/form-data (тіло запиту в form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/status
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В тілі запиту в form-data передаються параметри.

Таблиця 1 - Опис json-параметрів запиту метода API

Параметр	Mandatory/Optional	Формат	Опис
package_id	M	int	ID пакета
status	M	int	ID статусу (3 - Прийнято; 4 - Запит на уточнення; 5 - Відхилено; 6 - Опрацьовано; 7 - Відмова)

RESPONSE

У відповідь передаються дані комплекту (об’єкт Package) в json форматі

Таблиця 6 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company_	об’єкт; інформація про компанію

---

Приклади

В тілі запиту в form-data передаються дані комплекту.

---

Приклад тіла відповіді в json форматі

{
    "packageId": 7535,
    "senderCompanyId": 1319,
    "recipientCompanyId": 4,
    "senderCompany": {},
    "recipientCompany": {},
    "contract": {},
    "packageTypeId": 2353,
    "packageTypeChainId": 330,
    "dateCreated": 1576479459,
    "dateChanged": 1576760119,
    "status": 3,
    "archive": 0,
    "packageNumber": "1576252943",
    "documents": [],
    "package2Dictionaries": [],
    "extraFields": [],
    "contractDictionaries": [],
    "packageTags": [
        {
            "tagId": 227,
            "name": "с ексели",
            "code": "7e5708a30a1348d8acea9b86041c9824"
        }
    ],
    "packageType": {
        "packageId": 2353,
        "companyId": 1319,
        "name": "Договора аренды на КОМОД",
        "type": 1,
        "code": "dcb8e60a6ffa4a5cafd2b4cdd405527d",
        "packageChainId": 330,
        "status": 2,
        "version": 2,
        "dateChanged": 1574850008,
        "autoHandle": 0,
        "document2packages": [],
        "package2dictionaries": [],
        "extraFields": []
    },
    "isRead": 1,
    "isReadFromApi": 0,
    "isReadyForSend": 0,
    "packageDirection": 1,
    "signDateTerm": 0,
    "packageUuid": "f30c55dd-47cf-4a82-a07c-0be2c95b8716",
    "isWithAgreement": 0
}

Відправка сценарію документообігу

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract/send
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

[
  2181
]

---

У відповідь передається код сервера 200 (ok)

Зміна статусу сценарію документообіга

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract?contract_id=2169&status=2
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообіга status - новий статус сценарію документообіга ( 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Отримання сценарію документообігу

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт Contract).

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "contractId": 2129,
  "contractName": "новый контракт123245465 ",
  "date": 0,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 823,
    "accountId": 245,
    "type": 1,
    "name": "tyhtht",
    "code": "77778542",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 6,
    "uuid": "45953ef9-128d-4e4d-b02d-406a0777fb24",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 0,
  "sentDate": 0,
  "status": 0,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [],
  "ownerPackages": [],
  "clientPackages": []
}

Видалення сценарію документообігу

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract/delete
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

[
  2181
]

---

У відповідь передається код сервера 200 (ok)

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

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

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract_packages
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу package_chain_id - ID типу комплекта документів sender_type - тип відправника: 1 - клієнт, 2 - власник

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані комплекту документів (об’єкт Contract) в json формате

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType>	масив об’єктів; дані комплектів документів одержувача

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта SpecialConditions

Параметр	Формат	Опис
	Об’єкт SpecialConditions
specialConditionId	long	ідентифікатор спеціальних умов обслуговування
companyId	long	id компанії (Компанія-власник сценарію документообігу)
fileName	String	назва файлу
body	byte[]	тіло файлу
ecomSigns	byte[]	підпис E-COM
ecomSignsInfo	byte[]	інформація про сертифікат E-COM
signInfos	List<SignInfo_>	масив об’єктів; інформація про сертифікат користувача

Таблиця 4 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue>	масив об’єктів; значення довідника

Таблиця 5 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 6 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
  "contractId": 2181,
  "number": "423434442",
  "contractName": "Для Коли2",
  "date": 1557446400,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 20,
    "accountId": 14,
    "type": 2,
    "name": "ФІЗИЧНА ОСОБА",
    "code": "3366905914",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 2,
    "uuid": "8d20c4a2-f21b-11e8-9806-005056013e25",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1557446400,
  "sentDate": 1557490133,
  "status": 1,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [
    {
      "dictionaryId": 8,
      "companyId": 4,
      "name": "Регион",
      "code": "6",
      "isActive": 1,
      "values": [
        {
          "valueId": 625,
          "dictionaryId": 8,
          "name": "Проверка 2",
          "code": "4444444444",
          "isActive": 1
        }
      ]
    }
  ],
  "ownerPackages": [],
  "clientPackages": [
    {
      "packageId": 1467,
      "companyId": 4,
      "name": "Тестовый для версий",
      "type": 1,
      "code": "78965",
      "packageChainId": 119,
      "status": 1,
      "version": 0,
      "dateChanged": 1557574242,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    }
  ]
}

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

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

Метод запиту	HTTPS PUT
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract_packages
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу package_chain_id - ID типу комплекта документів sender_type - тип відправника: 1 - клієнт, 2 - власник

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані комплекту документів (об’єкт Contract) в json формате

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType>	масив об’єктів; дані комплектів документів одержувача

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта SpecialConditions

Параметр	Формат	Опис
	Об’єкт SpecialConditions
specialConditionId	long	ідентифікатор спеціальних умов обслуговування
companyId	long	id компанії (Компанія-власник сценарію документообігу)
fileName	String	назва файлу
body	byte[]	тіло файлу
ecomSigns	byte[]	підпис E-COM
ecomSignsInfo	byte[]	інформація про сертифікат E-COM
signInfos	List<SignInfo_>	масив об’єктів; інформація про сертифікат користувача

Таблиця 4 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue>	масив об’єктів; значення довідника

Таблиця 5 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 6 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
  "contractId": 2181,
  "number": "423434442",
  "contractName": "Для Коли2",
  "date": 1557446400,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 20,
    "accountId": 14,
    "type": 2,
    "name": "ФІЗИЧНА ОСОБА",
    "code": "3366905914",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 2,
    "uuid": "8d20c4a2-f21b-11e8-9806-005056013e25",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1557446400,
  "sentDate": 1557490133,
  "status": 1,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [
    {
      "dictionaryId": 8,
      "companyId": 4,
      "name": "Регион",
      "code": "6",
      "isActive": 1,
      "values": [
        {
          "valueId": 625,
          "dictionaryId": 8,
          "name": "Проверка 2",
          "code": "4444444444",
          "isActive": 1
        }
      ]
    }
  ],
  "ownerPackages": [],
  "clientPackages": [
    {
      "packageId": 1467,
      "companyId": 4,
      "name": "Тестовый для версий",
      "type": 1,
      "code": "78965",
      "packageChainId": 119,
      "status": 1,
      "version": 0,
      "dateChanged": 1557574242,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    }
  ]
}

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

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

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract_dictionary
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу dictionary_id - ID довідника dictionary_value_id - ID значення довідника

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані комплекту документів (об’єкт Contract) в json формате

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType>	масив об’єктів; дані комплектів документів одержувача

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта SpecialConditions

Параметр	Формат	Опис
	Об’єкт SpecialConditions
specialConditionId	long	ідентифікатор спеціальних умов обслуговування
companyId	long	id компанії (Компанія-власник сценарію документообігу)
fileName	String	назва файлу
body	byte[]	тіло файлу
ecomSigns	byte[]	підпис E-COM
ecomSignsInfo	byte[]	інформація про сертифікат E-COM
signInfos	List<SignInfo_>	масив об’єктів; інформація про сертифікат користувача

Таблиця 4 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue>	масив об’єктів; значення довідника

Таблиця 5 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 6 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
  "contractId": 2181,
  "number": "423434442",
  "contractName": "Для Коли2",
  "date": 1557446400,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 20,
    "accountId": 14,
    "type": 2,
    "name": "ФІЗИЧНА ОСОБА",
    "code": "3366905914",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 2,
    "uuid": "8d20c4a2-f21b-11e8-9806-005056013e25",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1557446400,
  "sentDate": 1557490133,
  "status": 1,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [
    {
      "dictionaryId": 8,
      "companyId": 4,
      "name": "Регион",
      "code": "6",
      "isActive": 1,
      "values": [
        {
          "valueId": 625,
          "dictionaryId": 8,
          "name": "Проверка 2",
          "code": "4444444444",
          "isActive": 1
        }
      ]
    }
  ],
  "ownerPackages": [],
  "clientPackages": [
    {
      "packageId": 1467,
      "companyId": 4,
      "name": "Тестовый для версий",
      "type": 1,
      "code": "78965",
      "packageChainId": 119,
      "status": 1,
      "version": 0,
      "dateChanged": 1557574242,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    }
  ]
}

Додавання (прив’язка) довідника до сценарію документообігу

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

Метод запиту	HTTPS PUT
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract_dictionary
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу dictionary_id - ID довідника dictionary_value_id - ID значення довідника

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані комплекту документів (об’єкт Contract) в json формате

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType>	масив об’єктів; дані комплектів документів одержувача

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта SpecialConditions

Параметр	Формат	Опис
	Об’єкт SpecialConditions
specialConditionId	long	ідентифікатор спеціальних умов обслуговування
companyId	long	id компанії (Компанія-власник сценарію документообігу)
fileName	String	назва файлу
body	byte[]	тіло файлу
ecomSigns	byte[]	підпис E-COM
ecomSignsInfo	byte[]	інформація про сертифікат E-COM
signInfos	List<SignInfo_>	масив об’єктів; інформація про сертифікат користувача

Таблиця 4 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue>	масив об’єктів; значення довідника

Таблиця 5 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 6 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package_>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
  "contractId": 2181,
  "number": "423434442",
  "contractName": "Для Коли2",
  "date": 1557446400,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 20,
    "accountId": 14,
    "type": 2,
    "name": "ФІЗИЧНА ОСОБА",
    "code": "3366905914",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 2,
    "uuid": "8d20c4a2-f21b-11e8-9806-005056013e25",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1557446400,
  "sentDate": 1557490133,
  "status": 1,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [
    {
      "dictionaryId": 8,
      "companyId": 4,
      "name": "Регион",
      "code": "6",
      "isActive": 1,
      "values": [
        {
          "valueId": 625,
          "dictionaryId": 8,
          "name": "Проверка 2",
          "code": "4444444444",
          "isActive": 1
        }
      ]
    }
  ],
  "ownerPackages": [],
  "clientPackages": [
    {
      "packageId": 1467,
      "companyId": 4,
      "name": "Тестовый для версий",
      "type": 1,
      "code": "78965",
      "packageChainId": 119,
      "status": 1,
      "version": 0,
      "dateChanged": 1557574242,
      "autoHandle": 0,
      "document2packages": [],
      "package2dictionaries": [],
      "extraFields": []
    }
  ]
}

Створення/редагування сценарію документообігу

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

Важливо

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	contractId (для редагування сценарію документообігу), clientCompany, companyId, contractName, ownerCompany, number

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Contract)

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

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

Параметр	Mandatory/Optional	Формат	Опис
companyId	M	long	id компанії
accountId	O	long	id аккаунту

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Contract)

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

Приклад тіла запиту (json) для Створення сценарію документообігу:

{
  "clientCompany": {
    "companyId": 823
  },
  "ownerCompany": {
    "companyId": 4
  },
  "contractName": "новый контракт ",
  "date": 1554336000,
  "description": "фсвымапроло",
  "expiredDate": 1554940800,
  "number": "1234354656"
}

---

Приклад тіла запиту (json) для Редагування сценарію документообігу:

{
  "contractId": 2129,
  "clientCompany": {
    "companyId": 823
  },
  "ownerCompany": {
    "companyId": 4
  },
  "contractName": "новый контракт ",
  "date": 1554336000,
  "description": "фсвымапроло",
  "expiredDate": 1554940800,
  "number": "1234354656"
}

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
  "contractId": 2129,
  "contractName": "новый контракт123245465 ",
  "date": 0,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 823,
    "accountId": 245,
    "type": 1,
    "name": "tyhtht",
    "code": "77778542",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 6,
    "uuid": "45953ef9-128d-4e4d-b02d-406a0777fb24",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 0,
  "sentDate": 0,
  "status": 0,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [],
  "ownerPackages": [],
  "clientPackages": []
}

Отримання списку контрагентів

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/partners
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри (фільтр) search_pattern - код ЕДРПОУ або назва компанії limit - ліміт вибірки (за замовчанням=20) offset - зміщення відносно верхньої межі вибірки (за замовчанням=0) is_registered - відмітка про те, що контрагент зареєстрований на платформі DOCflow; 1 - так, 0 - ні

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Partner)

Таблиця 3 - Опис параметрів об’єкта Partner

Параметр	Формат	Опис
	Об’єкт Partner
partnerId	long	id контрагента-партнера
accountId	long	id аккаунта
code	String	код ЕДРПОУ
name	String	назва компанїї
contactPerson	String	ПІБ контактної особи
contactEmail	String	Email контактної особи
contactPhone	String	контактный телефон
comment	String	коментар
invitationDate	long	дата / час запрошення
status	int	статус запрошення
contractStatus	int	статус сценарію документообігу (відмітка про те, що контрагент зареєстрований на платформі DOCflow); 1 - так, 0 - немає
companyId	long	id компанії

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді (json):

[
  {
    "partnerId": 762,
    "accountId": 8,
    "code": "3260408077",
    "name": "Arsen",
    "contactPerson": "Arsen contact-person",
    "contactEmail": "007Arsen@gmail.com",
    "contactPhone": "123244",
    "comment": "fdf",
    "invitationDate": 1566223863,
    "status": 2,
    "contractStatus": 0,
    "companyId": 0
  },
  {
    "partnerId": 766,
    "accountId": 8,
    "code": "12345678",
    "name": "Физычна особа",
    "contactEmail": "sahabekfdsov@meta.ua",
    "invitationDate": 1566222958,
    "status": 2,
    "contractStatus": 1,
    "companyId": 6
  },
]

Додавання / редагування контрагента

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/partner
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	code, name, contactEmail

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Partner)

Таблиця 1 - Опис параметрів об’єкта Partner

Параметр	Формат	Опис
	Об’єкт Partner
partnerId	long	id контрагента-партнера
accountId	long	id аккаунта
code	String	код ЕДРПОУ
name	String	назва компанїї
contactPerson	String	ПІБ контактної особи
contactEmail	String	Email контактної особи
contactPhone	String	контактный телефон
comment	String	коментар
invitationDate	long	дата / час запрошення
status	int	статус запрошення
contractStatus	int	статус сценарію документообігу (відмітка про те, що контрагент зареєстрований на платформі DOCflow); 1 - так, 0 - немає
companyId	long	id компанії

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Partner)

Таблиця 3 - Опис параметрів об’єкта Partner

Параметр	Формат	Опис
	Об’єкт Partner
partnerId	long	id контрагента-партнера
accountId	long	id аккаунта
code	String	код ЕДРПОУ
name	String	назва компанїї
contactPerson	String	ПІБ контактної особи
contactEmail	String	Email контактної особи
contactPhone	String	контактный телефон
comment	String	коментар
invitationDate	long	дата / час запрошення
status	int	статус запрошення
contractStatus	int	статус сценарію документообігу (відмітка про те, що контрагент зареєстрований на платформі DOCflow); 1 - так, 0 - немає
companyId	long	id компанії

---

Приклади

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

{
  "code": "3260408077",
  "name": "Arsen",
  "contactPerson": "Arsen contact-person",
  "contactEmail": "007Arsen@gmail.com",
  "contactPhone": "123244",
  "comment": "запит",
}

---

Приклад тіла відповіді (json):

{
  "partnerId": 762,
  "accountId": 8,
  "code": "3260408077",
  "name": "Arsen",
  "contactPerson": "Arsen contact-person",
  "contactEmail": "007Arsen@gmail.com",
  "contactPhone": "123244",
  "comment": "запит",
  "invitationDate": 1566223863,
  "status": 2,
  "contractStatus": 0,
  "companyId": 0
}

Додавання списку контрагентаів з Excel файлу

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/partners
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі в тілі запиту передається .xls/.xlsx файл у вигляді масиву байт. Файл повинен відповідати шаблону:

Завантажити шаблон

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

В цьому методі в тілі запиту передається .xls/.xlsx файл у вигляді масиву байт. Файл повинен відповідати шаблону:

Завантажити шаблон

---

У відповідь передається код сервера 200 (ok)

Зміна статусу контрагента (статус: відправлено запрошення)

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/partner/status
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	partnerId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

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

[
  561651651,
  849494984,
  9849848
]

---

У відповідь передається код сервера 200 (ok)

Відправка запрошення контрагенту

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

Метод запиту	HTTPS POST
Content-Type	application/form-data (тіло запиту/відповіді в форматі form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/partner/invitation
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (form-data)	partner_id - id контрагента contract_template_id - id шаблону сценарію документообігу АБО owner_company_id - id компанії від якої відправляється запрошення

Примітка

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

JSON-параметри в тілі HTTPS запиту/відповіді

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту (form-data):

WebKitFormBoundarylHOrB8PBaKDORWrl
Content-Disposition: form-data; name="partner_id"

5684

WebKitFormBoundarylHOrB8PBaKDORWrl
Content-Disposition: form-data; name="contract_template_id"

5551

WebKitFormBoundarylHOrB8PBaKDORWrl

---

У відповідь передається код сервера 200 (ok).

Підписання документа за допомогою MobileID

Увага

Підписання з допомогою MobileID відбувається в два кроки:

1. Користувачу необхідно відправити запит що містить документ на підпис. В відповідь на запит приходить ID транзакції.

2. Користувачу необхідно відправити ID з пункта 1, й отримати тіло підпису , використовуючи метод {url сервера}/bdoc/mobile_sign.

Крок 1. Отримання ID транзакції

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

Метод запиту	HTTPS POST
Content-Type	application/form-data (бінарні данні в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/mobile_sign
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі тіло запиту передається в form-data.

Параметр	Формат	Опис
msisdn		номер телефону, до якого прив’язаний сертифікат
message	long	повідомлення, яке відображається на телефоні
positionId	long	ID ключа сертифіката (не потрібно для Київстар)
document_body	long	тіло документ на підпис

RESPONSE

Опис json-параметрів відповіді метода API

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр	Формат	Опис
trans_id	long	ID транзакції

---

Приклади

Приклад тіла запиту в form-data

{
  "msisdn": 380667901456
  "message":
  "positionId": 6075
  "document_body": {}

}

---

Приклад тіла відповіді в json форматі

{
  "trans_id": 16
}

Крок 2. Отримання тіла підпису

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

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Отримання списку сертифікатів MobileID

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/mobile_certs?msisdn=380667901456
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: msisdn - номер телефону

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані сертификатів, що прив’язані до вказаного номера телефону (об’єкт MobileCert).

Таблиця 1 - Опис параметрів об’єкта MobileCert

Параметр	Формат	Опис
	Об’єкт MobileCert
organization	String	організація
positionId	String	id посади
services	String[]	масив; коди послуг
title	String	посада
msisdn	String	номер телефону

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "organization": "",
    "title": "Anonymous",
    "positionId": 3419,
    "services": [
      "AUTH_ANONYMOUS",
      "POSITIONS_PERMIT_ANONYMOUS",
      "REG_ANONYMOUS"
    ]
  },
  {
    "organization": "ТОВ АТС",
    "title": "генеральний директор",
    "positionId": 3420,
    "services": [
      "AUTH_DSTU_DEPUTY",
      "ENCRYPT_DSTU_DEPUTY",
      "DECRYPT_DSTU_DEPUTY",
      "REG_DSTU_DEPUTY",
      "SIGN_DSTU_DEPUTY"
    ]
  }
]

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

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/body?package_id=58&document_id=53&body_id=53
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекту документів document_id - ID документа body_id - ID тіла документа

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Отримання тіла підпису

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/sign?package_id=58&document_id=53&body_id=53&sign_id=84
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекту документів document_id - ID документа body_id - ID тіла документа sign_id - ID підпису

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Отримання документу (в вигляді архіву)

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/arch
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу body_id - ID тіла документу package_id - ID комплекта документів

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається архів, який містить указаний в запиті оригінальний документ, а також підпис і лист підписання (за наявності підпису).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У цьому методі у відповідь передається архів, який містить указаний в запиті документ.

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

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Таблиця 1 - Опис параметрів об’єкта Package

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company	об’єкт; дані власника компанії
clientCompany	Company	об’єкт; дані контрагента
senderCompany	Company	об’єкт; дані компанії-відправника
recipientCompany	Company	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 6 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 7 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue_>	масив об’єктів; значення довідника

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "accountId": 8,
  "activityBase": "Царь царей",
  "addInfo": "kjkjаыавы",
  "adminAccount": {
    "address_fact": "Фактический адрес",
    "address_legal": "Юридический адрес",
    "agreement_date": "2018-09-10 00:00:00",
    "agreement_number": "15.08.2018",
    "bank_account": "4634653654665",
    "bank_mfo": "56456",
    "bank_name": "6436",
    "category_id": "0",
    "director_name": "443643646ggg",
    "director_position": "5688888іваіваіва",
    "edrpou": "00000000",
    "email": "alieva@edi.su",
    "id": 1232,
    "inn": "11111111111100",
    "name": "Тесте",
    "nds_cert_num": "-",
    "operation": "111111100000000",
    "own_type": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
    "phone": "32623626526",
    "status": "test"
  },
  "adminAccountId": 1232,
  "company": {
    "accountId": 8,
    "atCode": "12363",
    "certNum": "456",
    "certificates": [],
    "code": "34554355",
    "companyId": 4,
    "dictionaries": [],
    "info": "ewdw",
    "inn": "123456789043",
    "isActive": 1,
    "isApproved": 1,
    "isSignedOffer": 1,
    "legalName": "ПрАТ \"Літак\"",
    "name": "Царь Царей",
    "notifySettings": [],
    "ownershipTypeId": 6,
    "phone": "4234234324",
    "prsNum": "43242352",
    "type": 1,
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1"
  },
  "companyId": 4,
  "decryptType": 1,
  "dirPosition": "Оплачено",
  "email": "dfsjfjdsji@meta.ua",
  "fullName": "Ляшенко Евгений",
  "isIndivOffer": 1,
  "phone": "2",
  "status": 1,
  "tariffId": 0,
  "whiteList": []
}

Додавання підпису до документу по GUID документу

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

Метод запиту	HTTPS PUT
Content-Type	application/form-data/json (тіло HTTPS запиту в form-data/тіло відповіді в json форматі)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/upload_sign_by_uuid
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_uuid - GUID документа

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі в form-data запиту передається файл тіла підпису до документа (один або кілька файлів).

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok)

Додавання підпису до документу

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

Метод запиту	HTTPS PUT
Content-Type	application/form-data/json (тіло HTTPS запиту в form-data /тіло відповіді в json форматі)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/sign
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу body_id - ID тіла документу package_id - ID комплекта документов (пакета)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі в form-data запиту передається передається файл тіла підпису до документа (один або кілька файлів).

RESPONSE

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

Таблиця 1 - Опис параметрів об’єкта Package

Параметр	Формат	Опис
	Об’єкт Package
packageId	long	ID комплекту
senderCompanyId	long	ID компанії-відправника
recipientCompanyId	long	ID компанії-одержувача
ownerCompanyId	long	ID власника компанії
clientCompanyId	long	ID контрагента
ownerCompany	Company	об’єкт; дані власника компанії
clientCompany	Company	об’єкт; дані контрагента
senderCompany	Company	об’єкт; дані компанії-відправника
recipientCompany	Company	об’єкт; дані компанії-одержувача
contractId	long	ID сценарію документообігу
contract	Contract	об’єкт; дані сценарію документообігу
packageTypeId	long	ID типу комплекту
packageTypeChainId	long	ID ланцюжка типу комплекту (використовується для пошуку пов’язаних версій комплекта)
dateCreated	long	дата створення
dateChanged	long	дата зміни
status	int	статус комплекту
archive	int	ознака архівації
packageNumber	String	номер комплекту
documents	List<DocumentStore>	масив об’єктів; документи комплекту
package2Dictionaries	List<Package2Dictionaries>	масив об’єктів; довідники комплекту
extraFields	List<Package2ExtraField>	масив об’єктів; користувацькі поля, прив’язані до комплекту
contractDictionaries	List<Dictionary>	масив об’єктів; список довідників, скопійованих з сценарію документообігу в момент створення комплекта
packageTags	List<Tag_>	масив об’єктів; список тегів, що прив’язані до комплекту
packageType	PackageType	об’єкт; настройки комплекту документів (комплекту)
isRead	int	ознака прочитання на WEB
isReadFromApi	int	ознака прочитання (завантаження) по API
isReadyForSend	int	індикатор «Готовий до відправлення»
packageDirection	int	напрямок комплекту; 1 - inbox, 2 - outbox, 3 - draft
signDateTerm	long	термін для підписання
packageUuid	UUID	унікальний ідентифікатор комплекта
packageBase	PackageBase_	об’єкт; дані комплекта підстави
packageId	long	ID комплекту
packageBasedId	long	ID комплекта підстави
packageBasedNumber	String	номер комплекта підстави

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document_	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField_>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody_>	масив об’єктів; тіла документів
structure	List<DocStructValue_>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs_>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue_	об’єкт; значення довідника

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 6 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 7 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue_>	масив об’єктів; значення довідника

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
    "packageId": 1966,
    "senderCompanyId": 2,
    "recipientCompanyId": 8,
    "senderCompany": {
    },
    "recipientCompany": {
    },
    "contract": {
        "contractId": 10,
        "number": "2000",
        "contractName": "Владелец \"ДП НИВА\" - Клиент \"Антсукевич\"",
        "date": 1530403200,
        "ownerCompany": {
        },
        "clientCompany": {
        },
    "packageTypeId": 8,
    "dateCreated": 1540286988,
    "dateChanged": 1540287270,
    "status": 1,
    "archive": 0,
    "packageNumber": "1540286988",
    "documents": [
    ],
    "package2Dictionaries": [
    ],
    "extraFields": [
    ],
    "contractDictionaries": [
    ],
    "isRead": 0,
    "isReadFromApi": 0,
    "isReadyForSend": 1,
    "packageDirection": 2,
    "packageUuid": "693ffb23-6b13-4d49-999d-7368e7069c2a"
}

Зміна налаштувань підписання в аккаунті

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc_admin/account/sign_settings
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Примітка

1 довідник можна прив’язати до декількох документів. До 1 документу можна прив’язати тільки 1 довідник.

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів відповіді метода API (об’єкт AccountInfo)

Таблиця 2 - Опис параметрів об’єкта AccountInfo

Параметр	Формат	Опис
	Об’єкт AccountInfo
accountID	long	ID аккаунта
edrpouVerify	Integer	перевірка ЕДРПОУ; 0 - ні, 1 - так
digitalSignUnique	Integer	перевірка унікальності електронного підпису; 0 - ні, 1 - так
whiteList	List<String>	масив; список білих ip адрес
decryptType	int	тип розшифровки; 1 - WEB; 2 - Cryptex
cryptexServer	String	адреса cryptex-сервера на стороні клієнта

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

Приклад тіла запиту в json форматі:

{
  "accountID": 8,
  "digitalSignUnique": 1,
  "edrpouVerify": 0
}

---

У відповідь передається код сервера 200 (ok)

Отримати внутрішній документ в вигляді архіву

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-documents/arch
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається файл-архів (масив байтів).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається файл-архів (масив байтів).

Збереження підпису внутрішнього документу

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

Метод запиту	HTTPS PUT
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-document/sign
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

Таблиця 1 - Опис параметрів об’єкта SignBody

Таблиця 2 - Опис параметрів об’єкта SignInfo

Параметр	Формат	Опис
	Об’єкт SignInfo
subjCN	String	ім’я власника сертифіката
subjCode	String	код сертификата
subjInn	String	ІПН власника сертифіката
subjFullName	String	повне ім’я власника сертифіката
subjTitle	String	посада власника сертифіката
subject	String	загальна інформація про власника сертифіката
certSerial	String	серійний номер сертифіката
issuerCN	String	ім’я видавця
subjOrg	String	організація власника сертифіката
isTimeStamp	boolean	відмітка «дата в форматі timeStamp»
timeStamp	long	дата сертификата

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

Пиклад тіла запиту в json форматі

приклад відсутній

---

У відповідь передається код сервера 200 (ok)

Отримання тіла внутрішнього документу

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/internal-documents/body
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь на запит передається файл в *.xml (структурований документ) чи іншому форматі, в якому був відправлений НЕструктурований документ.

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь на запит передається *.xml файл.

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

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/arch
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта документів Необов’язкові url-параметри: doc_mark_id - мітка документу, 1 - Опрацьовано, все вірно; 2 - Опрацьовано, є помилки;

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається архів, який містить указаний в запиті комплект документів.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У цьому методі у відповідь передається архів, який містить указаний в запиті комплект документів.

Отримання листа підписання (в вигляді архіву)

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/document/sign-list
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу body_id - ID тіла документу package_id - ID комплекта документів

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Отримання архіву

1.Відправка запиту на формування архіву

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

Зверніть увагу!

Повторна відправка даного запиту з таким же packageId - поверне той же PackageArchRequest, новий запит не буде створюватися поки архів не буде скачено!

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package-arch/request
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта документів Необов’язкові url-параметри: doc_status - якщо потрібен архів документів певного статусу doc_mark_id - мітка документу, 1 - Опрацьовано, все вірно; 2 - Опрацьовано, є помилки;

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається об’єкт PackageArchRequest.

Таблиця 1 - Опис параметрів об’єкта PackageArchRequest

Параметр	Формат	Опис
	Об’єкт PackageArchRequest
requestUuid	uuid	uuid запиту
userId	long	ID користувача
packageId	long	ID комплекту
companyId	long	ID компанії-відправника запиту
docStatuses	List	масив статусів документів які потраплять в архів
isArchReady	int	0 - архів ще не створений; 1 - архів уже створено;
zipArchName	long	ім’я архіву (поле заповнене тільки якщо isArchReady == 1)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У цьому методі у відповідь передається об’єкт PackageArchRequest.

{
 "requestUuid": "c7f1354b-93a0-48a7-9b84-5ee50d8f3c6e",
 "userId": 10,
 "packageId": 8129,
 "companyId": 4,
 "docStatuses": [
   1,
   2,
   3,
   4,
   5
 ],
 "isArchReady": 1,
 "zipArchName": "8129_1579690544_2539_3189823647_34554355_2020-02-18-17-28-16.zip"
}

2.Отримання посилання на скачування архіву

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package-arch/link
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: request_uuid - uuid отриманий у PackageArchRequest

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається:

• якщо архів уже сформований - то у відповіді прийде посилання на скачування архіву;

• 814,»trans_in_progress» - якщо архів ще не сформований і треба почекати

• 762, «uuid not found» - якщо за вказаним uuid запис не знайдено

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У цьому методі у відповідь передається посилання на скачування.

Отримання списку користувачів

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/users?status=0&limit=30
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри (фільтр) search_pattern - пошук по ПІБ та email limit - ліміт вибірки (за замовчуванням=20) offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0) status - статус користувача (0-всі; 1-активний; 2-заблокований)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

count: 100500

Опис json-параметрів відповіді метода API (масив об’єктів User)

Таблиця 3 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді (json):

[
  {
    "userId": 473,
    "accountId": 8,
    "email": "test@test33232",
    "isOwner": 0,
    "isCaptcha": 1,
    "fio": "test test ",
    "companies": [],
    "status": 1,
    "roles": [],
    "routes": [],
    "passSecureType": 2,
    "passPolicyId": 282,
    "lastLoginIp": "0.0.0.0",
    "lastLoginDate": 0,
    "uiTypes": [],
    "userAccess": {}
  },
  {
    "userId": 479,
    "accountId": 8,
    "email": "fds@dfsfs.ua",
    "isOwner": 0,
    "isCaptcha": 1,
    "fio": "43343",
    "companies": [],
    "status": 1,
    "roles": [],
    "routes": [],
    "passSecureType": 2,
    "passPolicyId": 282,
    "lastLoginIp": "0.0.0.0",
    "lastLoginDate": 0,
    "uiTypes": [],
    "userAccess": {}
  },
  {
    "userId": 475,
    "accountId": 8,
    "email": "dfsmaelgern@gfldnbskjngb",
    "isOwner": 0,
    "isCaptcha": 1,
    "fio": "xfzvb dfgb ",
    "companies": [],
    "status": 2,
    "roles": [],
    "routes": [],
    "passSecureType": 2,
    "passPolicyId": 282,
    "lastLoginIp": "0.0.0.0",
    "lastLoginDate": 0,
    "uiTypes": [],
    "userAccess": {}
  }
]

Отримання списку ролей

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/roles?status=1&company_id=1307&limit=30
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри (фільтр) search_pattern - пошук по назві ролі limit - ліміт вибірки (за замовчуванням=20) offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0) company_id - id компанії status - статус ролі (0-всі; 1-активні; 2-заблоковані)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

count: 100500

Опис json-параметрів відповіді метода API (об’єкт Role)

Таблиця 3 - Опис параметрів об’єкта Role

Параметр	Формат	Опис
	Об’єкт Role
roleId	long	id ролі
company	Company_	об’єкт; інформація про компанію
companyId	long	id компаниії
name	String	назва ролі
code	String	код ролі
status	int	статус; «1 - активний; 2 - заблокований»
autoBind	int	ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да
users	List<User_>	масив об’єктів; користувачі
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких розділів і ролей
packageAccessType	int	тип доступу

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді (json):

[
  {
    "roleId": 3425,
    "company": {
      "companyId": 1307,
      "accountId": 8,
      "type": 1,
      "name": "Для ролей ",
      "code": "43343",
      "isApproved": 0,
      "isSignedOffer": 1,
      "isActive": 1,
      "ownershipType": "vccv",
      "uuid": "7ef5b288-537f-4efd-b175-5993ed2438e3",
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "companyId": 1307,
    "name": "Сахар",
    "code": "c64a655f76a5404d8d1391e9517abbb0",
    "status": 1,
    "autoBind": 0,
    "users": [],
    "uiTypes": [],
    "packageAccessType": 0
  }
]

Отримання даних користувача по ID

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/user?user_id=683
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: user_id - ID користувача

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт User)

Таблиця 1 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "userId": 683,
  "accountId": 423,
  "email": "willnotgotomumbai@gmail.com",
  "isOwner": 1,
  "isCaptcha": 1,
  "fio": "Гаврилюк Татьяна",
  "companies": [],
  "status": 1,
  "roles": [],
  "routes": [],
  "passSecureType": 2,
  "passPolicyId": 497,
  "userInfo": {
    "position": "Бизнес аналитик ",
    "department": "Департамент внедрения инновационных решений ",
    "whiteList": [],
    "decryptType": 1,
    "language": 3,
    "notShowWizard": 1
  },
  "lastLoginIp": "172.16.6.142",
  "lastLoginDate": 1576237547,
  "uiTypes": [],
  "userAccess": {}
}

Блокування / активація користувача

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/user?user_id=697&status=1
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: user_id - ID користувача status - статус (активація = 1, блокування = 2)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Створення ролі

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/role
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	companyId, name, code

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Role)

Таблиця 1 - Опис параметрів об’єкта Role

Параметр	Формат	Опис
	Об’єкт Role
roleId	long	id ролі
company	Company	об’єкт; інформація про компанію
companyId	long	id компаниії
name	String	назва ролі
code	String	код ролі
status	int	статус; «1 - активний; 2 - заблокований»
autoBind	int	ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да
users	List<User_>	масив об’єктів; користувачі
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких розділів і ролей
packageAccessType	int	тип доступу

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

Параметр	Mandatory/Optional	Формат	Опис
companyId	M	long	id компанії

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Role)

Таблиця 3 - Опис параметрів об’єкта Role

Параметр	Формат	Опис
	Об’єкт Role
roleId	long	id ролі
company	Company	об’єкт; інформація про компанію
companyId	long	id компаниії
name	String	назва ролі
code	String	код ролі
status	int	статус; «1 - активний; 2 - заблокований»
autoBind	int	ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да
users	List<User_>	масив об’єктів; користувачі
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких розділів і ролей
packageAccessType	int	тип доступу

Таблиця 4 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

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

{
  "company": {
    "companyId": 1307
  },
  "name": "Чупакабра",
  "code": "38d8f5b0f6224565b45726228e1a55b4"
}

---

Приклад тіла відповіді (json):

{
  "roleId": 3427,
  "company": {
    "companyId": 1307,
    "accountId": 8,
    "type": 1,
    "name": "Для ролей ",
    "code": "43343",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "vccv",
    "uuid": "7ef5b288-537f-4efd-b175-5993ed2438e3",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "companyId": 1307,
  "name": "Чупакабра",
  "code": "38d8f5b0f6224565b45726228e1a55b4",
  "status": 1,
  "autoBind": 0,
  "users": [],
  "uiTypes": [],
  "packageAccessType": 0
}

Редагування профілю користувача

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/user-profile
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	notShowWizard, language

Важливо

У цьому методі при запиті змінюються лише 2 обов’язкові параметри - notShowWizard, language, інші параметри, навіть якщо передати інші значення, ніяк не змінюються!

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API

Параметр	Mandatory/Optional	Формат	Опис
whiteList	О	List<String>	масив; список «білих» ІР-адрес
decryptType	О	int	тип розшифровки документів; «1 - WEB; 2 - Cryptex»
language	M	int	мова, «1 - російська; 2 - англійська; 3 - українська»
notShowWizard	M	tinyint	відмітка «Не показувати при повторному вході» в Майстрі налаштувань; 1-є відмітка (Не показувати); 0 - немає (показувати)

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

Приклад тіла запиту в json форматі

{
  "whiteList": [],
  "decryptType": 1,
  "language": 1,
  "notShowWizard": 0
}

---

У відповідь передається код сервера 200 (ok)

Створення / редагування користувача

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній userId, то користувач з зазначеним Id підлягає редагуванню. Відсутність параметра userId веде до створення нового користувача.

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/user
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	fio, email (повинен бути валідний з доменною частиною), passPolicyId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST / RESPONSE

Опис json-параметрів запиту та відповіді метода API (об’єкт User)

Таблиця 1 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

Таблиця 2 - Опис параметрів об’єкта UserInfo

Параметр	Формат	Опис
	Об’єкт UserInfo
position	String	посада
department	String	відділ
comment	String	коментар
whiteList	List<String>	масив; список «білих» IP адрес
decryptType	int	тип розшифровки; «1 - WEB; 2 - Cryptex»
cryptexServer	String	адреса cryptex-сервера на стороні клієнта
language	int	мова, «1 - російська; 2 - англійська; 3 - українська»
notShowWizard	tinyint	відмітка «Не показувати майстер налаштувань при повторному вході», 0 - показувати(нема відмітки), 1- Не показувати(є відмітка)

---

Приклади

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

{
  "isOwner": 0,
  "user_id": 467,
  "status": 1,
  "userInfo": {
    "whiteList": [],
    "decryptType": 1,
    "language": 1,
    "department": null,
    "position": null,
    "comment": null
  },
  "fio": "fdsfs",
  "email": "dfsfsdf@meta.ua",
  "tel": null,
  "passPolicyId": 282
}

---

Приклад тіла відповіді (json):

{
  "userId": 469,
  "accountId": 8,
  "email": "dfsffdsfsdsdf@meta.ua",
  "isOwner": 0,
  "isCaptcha": 1,
  "fio": "fdsffdss",
  "companies": [],
  "status": 1,
  "roles": [],
  "routes": [],
  "passSecureType": 2,
  "passPolicyId": 282,
  "userInfo": {
    "whiteList": [],
    "decryptType": 1,
    "language": 1
  },
  "lastLoginIp": "0.0.0.0",
  "lastLoginDate": 0,
  "uiTypes": [],
  "userAccess": {}
}

Редагування (додавання / видалення) зв’язків користувачів з роллю(-ями)

Увага

Додавання / видалення зв’язків виконується шляхом перезатирання - залишаються тільки ті зв’язки (передаються списком), котрі були передані в останньому запиті!

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

Метод запиту	HTTPS PATCH
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/user/roles
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: user_id - ідентифікатор користувача

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передаються ідентифікатори ролей (roleId), котрі необхідно «прив’язати» до користувача. Дані передаються в вигляді масиву об’єктів.

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт Role).

Таблиця 1 - Опис параметрів об’єкта Role

Параметр	Формат	Опис
	Об’єкт Role
roleId	long	id ролі
company	Company_	об’єкт; інформація про компанію
companyId	long	id компаниії
name	String	назва ролі
code	String	код ролі
status	int	статус; «1 - активний; 2 - заблокований»
autoBind	int	ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да
users	List<User_>	масив об’єктів; користувачі
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких розділів і ролей
packageAccessType	int	тип доступу

---

Приклади

Приклад тіла запиту в json форматі:

[
  {
    "roleId": 128
  }
]

---

Приклад тіла відповіді в json форматі:

[
  {
    "roleId": 128,
    "companyId": 4,
    "name": "Новая",
    "code": "23",
    "status": 1,
    "autoBind": 0,
    "users": [],
    "uiTypes": [],
    "packageAccessType": 0
  }
]

Створення/редагування групи користувачів узгодження

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній groupId, то група з зазначеним Id підлягає редагуванню. Відсутність параметра groupId веде до створення нової групи.

Увага

Додавання / видалення користувачів виконується шляхом перезатирання - залишаються тільки ті користувачі (передаються списком), userId котрих були передані в останньому запиті!

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_group
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API для створення групи:

Параметр	Mandatory/Optional	Формат	Опис
companyId	M	long	id компанії
groupName	M	String	назва групи узгодження
comment	O	String	коментар

Таблиця 2 - Опис json-параметрів запиту методу API для додавання користувачів в групу:

Параметр	Mandatory/Optional	Формат	Опис
groupId	M	long	id групи узгодження
users	M	ArrayList<User>	масив об’єктів; дані користувачів

Об’єкт User	Mandatory/Optional	Формат	Опис
userId	M	long	id користувача

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт AgreementGroup)

Таблиця 3 - Опис параметрів об’єкта AgreementGroup

Параметр	Формат	Опис
	Об’єкт AgreementGroup
users	ArrayList<User>	масив об’єктів; дані користувачів
groupID	long	ID групи узгодження
companyID	long	ID компанії
company	Company	об’єкт; дані компанії
groupName	String	назва групи узгодження
comment	String	коментар

Таблиця 4 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 5 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

Приклад тіла запиту в json форматі для створення групи:

{
  "groupName": "Юридический отдел",
  "companyId": 989,
  "comment": null
}

Приклад тіла запиту в json форматі для додавання користувачів в групу:

{
  "users": [
    {
      "userId": 683,
      "accountId": 0,
      "email": "will752757omumbai@gmail.com",
      "isOwner": 0,
      "fio": "Гаврилюк Татьяна",
      "companies": [],
      "status": 0,
      "roles": [],
      "routes": [],
      "passSecureType": 0,
      "passPolicyId": 0,
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    },
    {
      "userId": 693,
      "accountId": 0,
      "email": "566666798989797z55z@gmail.com",
      "isOwner": 0,
      "fio": "Петров Иван ",
      "companies": [],
      "status": 0,
      "roles": [],
      "routes": [],
      "passSecureType": 0,
      "passPolicyId": 0,
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    }
  ],
  "groupId": 187,
  "companyId": 989,
  "company": {
    "companyId": 1313,
    "accountId": 0,
    "type": 0,
    "name": "ФОП Гаврилюк Татьяна",
    "code": "3189823647",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "groupName": "Юридический отдел",
  "comment": ""
}

---

Приклад тіла відповіді в json форматі для створення групи:

{
  "users": [],
  "groupId": 187,
  "companyId": 989,
  "company": {
    "companyId": 989,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "groupName": "Юридический отдел"
}

Приклад тіла відповіді в json форматі для додавання користувачів в групу:

{
  "users": [
    {
      "userId": 683,
      "accountId": 423,
      "email": "wifgh644humbai@gmail.com",
      "isOwner": 1,
      "isCaptcha": 1,
      "fio": "Гаврилюк Татьяна",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 497,
      "lastLoginIp": "127.0.0.1",
      "lastLoginDate": 1576159661,
      "uiTypes": [],
      "userAccess": {}
    },
    {
      "userId": 693,
      "accountId": 423,
      "email": "5666643568989797zz@gmail.com",
      "isOwner": 0,
      "isCaptcha": 1,
      "fio": "Петров Иван ",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 497,
      "lastLoginIp": "172.16.6.142",
      "lastLoginDate": 1576154372,
      "uiTypes": [],
      "userAccess": {}
    }
  ],
  "groupId": 187,
  "companyId": 1313,
  "company": {
    "companyId": 1313,
    "accountId": 0,
    "type": 0,
    "name": "ФОП Гаврилюк Татьяна",
    "code": "3189823647",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "groupName": "Юридический отдел"
}

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

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_group?agreement_group_id=301
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: agreement_group_id - ID групи узгодження (groupId)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт AgreementGroup).

Таблиця 1 - Опис параметрів об’єкта AgreementGroup

Параметр	Формат	Опис
	Об’єкт AgreementGroup
users	ArrayList<User_>	масив об’єктів; дані користувачів
groupID	long	ID групи узгодження
companyID	long	ID компанії
company	Company_	об’єкт; дані компанії
groupName	String	назва групи узгодження
comment	String	коментар

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "users": [
    {
      "userId": 683,
      "accountId": 423,
      "email": "willnotgotomumbai@gmail.com",
      "isOwner": 1,
      "isCaptcha": 1,
      "fio": "Гаврилюк Татьяна",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 497,
      "lastLoginIp": "127.0.0.1",
      "lastLoginDate": 1576156409,
      "uiTypes": [],
      "userAccess": {}
    }
  ],
  "groupId": 301,
  "companyId": 1313,
  "company": {
    "companyId": 1313,
    "accountId": 0,
    "type": 0,
    "name": "ФОП Гаврилюк Татьяна",
    "code": "3189823647",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "groupName": "Юридический отдел "
}

Отримання списка групп користувачів для узгодження

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_groups?search_pattern=%D1%84%D0%B8%D0%BD&company_id=1313&limit=30
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри:(пошук та фільтри): company_id - ID компанії (вибірка за компанією) search_pattern - пошук за назвою групи limit - ліміт вибірки (за замовчанням=30)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт AgreementGroup).

Таблиця 1 - Опис параметрів об’єкта AgreementGroup

Параметр	Формат	Опис
	Об’єкт AgreementGroup
users	ArrayList<User_>	масив об’єктів; дані користувачів
groupID	long	ID групи узгодження
companyID	long	ID компанії
company	Company_	об’єкт; дані компанії
groupName	String	назва групи узгодження
comment	String	коментар

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "users": [],
    "groupId": 301,
    "companyId": 1313,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Татьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "groupName": "Юридический отдел "
  },
  {
    "users": [],
    "groupId": 293,
    "companyId": 1313,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Татьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "groupName": "Бухгалтерия"
  }
]

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

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_procs?search_pattern=%D1%81%D0%BE%D0%B3%D0%BB%D0%B0&company_id=1319&status=1&limit=30
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри:(пошук та фільтри): company_id - ID компанії (вибірка за компанією) search_pattern - пошук за назвою процесу limit - ліміт вибірки (за замовчанням=30) status - статус (1=активний; 2=заблокований)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт AgreementProc)

Таблиця 1 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc_>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

[
  {
    "agrementSteps": [],
    "agreementProc2Docs": [],
    "agreementProcId": 195,
    "companyId": 1313,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Татьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "name": "Согласование актов сверки ",
    "status": 1
  },
  {
    "agrementSteps": [],
    "agreementProc2Docs": [],
    "agreementProcId": 189,
    "companyId": 1313,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Татьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "name": "Внутреннее согласование заявлений на отпуск ",
    "status": 1
  },
  {
    "agrementSteps": [],
    "agreementProc2Docs": [],
    "agreementProcId": 187,
    "companyId": 1319,
    "company": {
      "companyId": 0,
      "accountId": 0,
      "type": 0,
      "name": "ТОВ Альбатрос ",
      "code": "01235896",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    },
    "name": "Cогласования актов вып работ ",
    "status": 1
  },
]

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

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

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Отримання інформації по документу в задачі на узгодження

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/task/doc-info
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: task_id - ID задачі

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді методу API (об’єкт DocumentStore).

Таблиця 1 - Опис параметрів об’єкта DocumentStore

Параметр	Формат	Опис
	Об’єкт DocumentStore
documentId	long	id документа
packageId	long	id комплекта
senderCompanyId	long	id організації відправника
senderCompany	Company	об’єкт; дані компанії відправника
documentType	Document	об’єкт; опис типу документу
documentTypeId	Long	id типу документу
number	String	номер документу
date	long	дата документу
dateSent	long	дата відправки
clientSignsCount	int	кількість підписів клієнта
ownerSignsCount	int	кількість підписів власника
status	int	статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений
comment	String	коментар
versionStructure	long	версія структури структурованого документу
extraFields	List<ExtraField>	масив об’єктів; прив’язка додаткових полів до документа
bodies	List<DocumentBody>	масив об’єктів; тіла документів
structure	List<DocStructValue>	масив об’єктів; опис структури зі значеннями
agreementLogs	List<AgreementLogs>	масив об’єктів; історія / логи узгоджень
isReadFromApi	int	ознака прочитання по API
documentUuid	UUID	унікальний ідентифікатор документа
agreementProcId	long	ID процесу узгодження
agreementStatus	int	статус узгодження
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Таблиця 4 - Опис параметрів об’єкта ExtraField

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

Таблиця 5 - Опис параметрів об’єкта DocumentBody

Параметр	Формат	Опис
	Об’єкт DocumentBody
bodyId	long	id тіла документа
documentId	long	id документа
fileName	String	найменування файлу
body	byte[]	тіло документа
signBodies	List<SignBody_>	масив об’єктів; тіла підписів на документі

Таблиця 6 - Опис параметрів об’єкта DocStructValue

Параметр	Формат	Опис
	Об’єкт DocStructValue
id	String	ID тега відповідно до опису структури
value	String	значення тега
index	int	номер рядка для масивів, починається з «0»
structure	List<List<DocStructValue>>	масив масивів об’єктів; опис структури зі значеннями
errors	List<String>	масив об’єктів; помилки

Таблиця 7 - Опис параметрів об’єкта AgreementLogs

Параметр	Формат	Опис
	Об’єкт AgreementLogs
agreementLogId	long	ID логу узгодження
taskId	long	ID завдання
actionType	int	тип дії
dateCreated	long	дата створення завдання
comment	String	комментарий
user	User_	об’єкт; дані користувача

Таблиця 8 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "agreementLogs": [],
  "agreementProcId": 0,
  "agreementStatus": 0,
  "bodies": [
    {
      "bodyId": 5087,
      "documentId": 5117,
      "fileName": "16.png",
      "signBodies": [
        {
          "bodyId": 5087,
          "companyId": 4,
          "info": {
            "certSerial": "33B6CB7BF721B9CE040000000CAB250045995A00",
            "isTimeStamp": true,
            "issuerCN": "Акредитований центр сертифікації ключів ІДД ДФС",
            "subjCN": "Мирний Олександр Максимович (Тест)",
            "subjCode": "1010101017",
            "subjFullName": "Мирний Олександр Максимович (Тест)",
            "subjInn": "1010101017",
            "subjOrg": "Мирний Олександр Максимович (Тест)",
            "subject": "CN=Мирний Олександр Максимович (Тест);SN=Мирний;GivenName=Олександр Максимович (Тест);Serial=2468620;C=UA;L=Київ",
            "timeStamp": 1555492497
          },
          "signId": 1591
        }
      ]
    }
  ],
  "clientSignsCount": 0,
  "date": 1555492339,
  "dateSent": 0,
  "documentId": 5117,
  "documentType": {
    "agreementProcId": 0,
    "code": "423",
    "companyId": 4,
    "documentId": 1008,
    "extraFields": [],
    "isActive": 1,
    "isProviderAccess": 0,
    "name": "О еще один",
    "type": 1,
    "useType": 1
  },
  "documentUuid": "068f1000-844f-41e3-9546-bf41b595873d",
  "extraFields": [],
  "isReadFromApi": 0,
  "number": "1555492339",
  "ownerSignsCount": 1,
  "packageId": 4615,
  "senderCompanyId": 4,
  "status": 1,
  "versionStructure": 0
}

Видалити тип документа з узгодження

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

Важливо

Додати тип документа до узгодження * без прив’язаного довідника - в url параметр dict_val_id = 0

• з прив’язаним до нього довідником - в url параметр dict_val_id = «наприклад323»

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_proc/document?company_id=989&document_id=2393&dict_val_id=323&agreement_proc_id=123
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії document_id - ID документа dict_val_id - ID значення довідника agreement_proc_id - ID процесу узгодження

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані аккаунта (об’єкт AgreementProc).

Таблиця 1 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc_>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "agrementSteps": [],
  "agreementProc2Docs": [],
  "agreementProcId": 123,
  "companyId": 989,
  "company": {
    "companyId": 989,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "name": "ывавы",
  "status": 2
}

Видалення групи користувачів

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

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_group?agreement_group_id=185
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: agreement_group_id - ID групи користувачів

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Видалення кроку узгодження

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

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_step?agreement_proc_id=119&agreement_step_id=489
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: agreement_proc_id - ID процесу узгодження agreement_step_id - ID кроку узгодження

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані аккаунта (об’єкт AgreementProc).

Таблиця 1 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта AgreementProc2Doc

Параметр	Формат	Опис
	Об’єкт AgreementProc2Doc
document	Document	об’єкт; дані документа
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 4 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "agrementSteps": [],
  "agreementProc2Docs": [
    {
      "document": {
        "documentId": 2289,
        "companyId": 4,
        "company": {
          "companyId": 0,
          "accountId": 0,
          "type": 0,
          "name": "Царь Царей",
          "code": "34554355",
          "isApproved": 0,
          "isSignedOffer": 0,
          "isActive": 0,
          "ownershipTypeId": 0,
          "certificates": [],
          "dictionaries": [],
          "notifySettings": []
        },
        "name": "Старые закончились",
        "type": 1,
        "code": "432432",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
      }
    }
  ],
  "agreementProcId": 119,
  "companyId": 4,
  "company": {
    "companyId": 4,
    "accountId": 0,
    "type": 0,
    "name": "Царь Царей",
    "code": "34554355",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "name": "Бухгалтер",
  "status": 1
}

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

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

Важливо

Додати тип документа до узгодження * без прив’язаного довідника - в url параметр dict_val_id**=0 * **з прив’язаним до нього довідником - в url параметр **dict_val_id**=»наприклад323»

Метод запиту	HTTPS PUT
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_proc/document?company_id=989&document_id=2393&dict_val_id=323&agreement_proc_id=123
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії document_id - ID документа dict_val_id - ID значення довідника agreement_proc_id - ID процесу узгодження

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані аккаунта (об’єкт AgreementProc).

Таблиця 1 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта AgreementProc2Doc

Параметр	Формат	Опис
	Об’єкт AgreementProc2Doc
document	Document	об’єкт; дані документа
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 4 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
    "agrementSteps": [],
    "agreementProc2Docs": [
        {
            "document": {
                "documentId": 2393,
                "companyId": 989,
                "company": {
                    "companyId": 0,
                    "accountId": 0,
                    "type": 0,
                    "name": "dwdsss",
                    "code": "433",
                    "isApproved": 0,
                    "isSignedOffer": 0,
                    "isActive": 0,
                    "ownershipTypeId": 0,
                    "certificates": [],
                    "dictionaries": [],
                    "notifySettings": []
                },
                "name": "sdffs",
                "type": 2,
                "code": "43242",
                "agreementProcId": 0,
                "isActive": 1,
                "extraFields": []
            }
        }
    ],
    "agreementProcId": 123,
    "companyId": 989,
    "company": {
        "companyId": 989,
        "accountId": 0,
        "type": 0,
        "name": "dwdsss",
        "code": "433",
        "isApproved": 0,
        "isSignedOffer": 0,
        "isActive": 0,
        "ownershipTypeId": 0,
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
    },
    "name": "ывавы",
    "status": 2
}

Створення/редагування процесу узгодження

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

Важливо

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_proc
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	agreementProcId (для редагування), name, companyId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт AgreementProc)

Таблиця 1 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc_>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт AgreementProc)

Таблиця 2 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc_>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

Таблиця 3 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

Приклад тіла запиту (json) для Створення процесу узгождення:

{
  "name": "ывавы",
  "companyId": 989,
  "comment": null
}

---

Приклад тіла запиту (json) для Редагування процесу узгождення:

{
  "name": "sabaka",
  "agreementProcId": 125,
  "companyId": 989,
  "comment": null
}

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
    "agrementSteps": [],
    "agreementProc2Docs": [],
    "agreementProcId": 125,
    "companyId": 989,
    "company": {
        "companyId": 989,
        "accountId": 0,
        "type": 0,
        "name": "dwdsss",
        "code": "433",
        "isApproved": 0,
        "isSignedOffer": 0,
        "isActive": 0,
        "ownershipTypeId": 0,
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
    },
    "name": "ывавы",
    "status": 1
}

Отримання журналу комплекту

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту в form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/comments?package_id=2137
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекту

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані з подіями комплекту (об’єкт PackageComments) в json форматі

Таблиця 1 - Опис параметрів об’єкта PackageComments

Параметр	Формат	Опис
	Об’єкт PackageComments
commentId	long	id коментаря
packageId	long	id комплекту
user	User	об’єкт; дані користувача
action	int	дія; тип операції
comment	Comment	об’єкт; коментар
date	long	дата коментаря

Таблиця 2 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "commentId": 825,
    "packageId": 2003,
    "user": {
      "userId": 4,
      "accountId": 0,
      "email": "willnotgotomumbai@gmail.com",
      "isOwner": 0,
      "fio": "Арно Апполинария Петровна",
      "companies": [],
      "status": 0,
      "roles": [],
      "routes": [],
      "passSecureType": 0,
      "passPolicyId": 0,
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    },
    "action": 1,
    "comment": {
      "before": {
        "status": 2
      },
      "after": {
        "status": 3
      }
    },
    "date": 1567756601
  }

Створення/редагування кроку узгодження

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

Важливо

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/agreement_step
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	agreementStepId (для редагування сценарію документообігу), agreementExecType, agreementTaskType, agreementStepId, agreementProcId, agreementGroups

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт AgreementStep)

Таблиця 1 - Опис параметрів об’єкта AgreementStep

Параметр	Формат	Опис
	Об’єкт AgreementStep
agreementGroups	List<AgreementGroup>	масив об’єктів; групи узгодження
agreementStepId	long	ID налаштувань кроків узгодження
agreementProcId	long	ID процесу узгодження
agreementTaskType	int	тип завдання; «1 - узгодження; 2 - підписання; 3 - повідомлення»
agreementExecType	int	тип виконання; «1 — до виконання всіма користувачами групи; 2 - одним користувачем з групи»
agreementExecPeriod	int	строк виконання в днях
agreementStepPriority	int	пріоритет; чим більше число тим вищий пріоритет
groupNames	String	найменування груп виконавців узгодження
userIds	List<Long_>	масив; ID користувачів

Таблиця 2 - Опис параметрів об’єкта AgreementGroup

Параметр	Формат	Опис
	Об’єкт AgreementGroup
users	ArrayList<User_>	масив об’єктів; дані користувачів
groupID	long	ID групи узгодження
companyID	long	ID компанії
company	Company	об’єкт; дані компанії
groupName	String	назва групи узгодження
comment	String	коментар

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт AgreementProc)

Таблиця 3 - Опис параметрів об’єкта AgreementProc

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

Таблиця 4 - Опис параметрів об’єкта AgreementStep

Параметр	Формат	Опис
	Об’єкт AgreementStep
agreementGroups	List<AgreementGroup>	масив об’єктів; групи узгодження
agreementStepId	long	ID налаштувань кроків узгодження
agreementProcId	long	ID процесу узгодження
agreementTaskType	int	тип завдання; «1 - узгодження; 2 - підписання; 3 - повідомлення»
agreementExecType	int	тип виконання; «1 — до виконання всіма користувачами групи; 2 - одним користувачем з групи»
agreementExecPeriod	int	строк виконання в днях
agreementStepPriority	int	пріоритет; чим більше число тим вищий пріоритет
groupNames	String	найменування груп виконавців узгодження
userIds	List<Long_>	масив; ID користувачів

Таблиця 5 - Опис параметрів об’єкта AgreementProc2Doc

Параметр	Формат	Опис
	Об’єкт AgreementProc2Doc
document	Document	об’єкт; дані документа
dictionaryValue	DictionaryValue	об’єкт; значення довідника

Таблиця 6 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary_	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Таблиця 7 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

Приклад тіла запиту (json) для Створення кроку узгождення:

{
      "agreementProcId": 119,
      "stepNumber": 0,
      "agreementTaskType": "1",
      "agreementExecType": "1",
      "agreementExecPeriod": null,
      "agreementStepPriority": null,
      "agreementGroups": [
        {
          "groupId": 136,
          "groupName": "Группа - 2 "
        }
      ]
    }

---

Приклад тіла запиту (json) для Редагування кроку узгождення:

{
  "agreementProcId": 119,
  "stepNumber": 0,
  "agreementStepId": 477,
  "agreementTaskType": "1",
  "agreementExecType": "1",
  "agreementExecPeriod": null,
  "agreementStepPriority": null,
  "agreementGroups": [
    {
      "groupId": 136,
      "groupName": "Группа - 2 "
    }
  ]
}

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
      "agrementSteps": [
        {
          "agreementGroups": [
            {
              "users": [],
              "groupId": 136,
              "companyId": 4,
              "groupName": "Группа - 2 "
            }
          ],
          "agreementStepId": 477,
          "agreementProcId": 119,
          "agreementTaskType": 1,
          "agreementExecType": 1,
          "agreementExecPeriod": 0,
          "agreementStepPriority": 0
        },
        {
          "agreementGroups": [
            {
              "users": [],
              "groupId": 136,
              "companyId": 4,
              "groupName": "Группа - 2 "
            }
          ],
          "agreementStepId": 479,
          "agreementProcId": 119,
          "agreementTaskType": 1,
          "agreementExecType": 1,
          "agreementExecPeriod": 0,
          "agreementStepPriority": 0
        },
        {
          "agreementGroups": [
            {
              "users": [],
              "groupId": 136,
              "companyId": 4,
              "groupName": "Группа - 2 "
            }
          ],
          "agreementStepId": 481,
          "agreementProcId": 119,
          "agreementTaskType": 1,
          "agreementExecType": 1,
          "agreementExecPeriod": 0,
          "agreementStepPriority": 0
        }
      ],
      "agreementProc2Docs": [
        {
          "document": {
            "documentId": 2289,
            "companyId": 4,
            "company": {
              "companyId": 0,
              "accountId": 0,
              "type": 0,
              "name": "Царь Царей",
              "code": "34554355",
              "isApproved": 0,
              "isSignedOffer": 0,
              "isActive": 0,
              "ownershipTypeId": 0,
              "certificates": [],
              "dictionaries": [],
              "notifySettings": []
            },
            "name": "Старые закончились",
            "type": 1,
            "code": "432432",
            "agreementProcId": 0,
            "isActive": 1,
            "extraFields": []
          }
        }
      ],
      "agreementProcId": 119,
      "companyId": 4,
      "company": {
        "companyId": 4,
        "accountId": 0,
        "type": 0,
        "name": "Царь Царей",
        "code": "34554355",
        "isApproved": 0,
        "isSignedOffer": 0,
        "isActive": 0,
        "ownershipTypeId": 0,
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      },
      "name": "Бухгалтер",
      "status": 1
    }

Додавання (прив’язка) обраного сценарію документообігу до маршруту

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

Метод запиту	HTTPS PUT
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/route/contracts?route_id=251
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: route_id - ID маршруту

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В json-тілі запиту передається масив id сценаріїв документообігу.

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

[
  5087,
  2109,
  2110
]

---

У відповідь передається код сервера 200 (ok)

Додавання (прив’язка) типу комплекта документів до маршруту

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

Метод запиту	HTTPS PUT
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package_route/package_type?company_id=989&route_id=251
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії route_id - ID маршруту

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

[
  5087,
  2109,
  2110
]

---

У відповідь передається код сервера 200 (ok)

Видалення прив’язки обраного сценарію документообігу до маршруту

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

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/route/contracts?route_id=251
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: route_id - ID маршруту

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В json-тілі запиту передається масив id сценаріїв документообігу.

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

[
  5087,
  2109,
  2110
]

---

У відповідь передається код сервера 200 (ok)

Видалення прив’язки типу комплекта документів до маршруту

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

Метод запиту	HTTPS DELETE
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package_route/package_type?route_id=251
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: route_id - ID маршруту

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

[
  5087,
  2109,
  2110
]

---

У відповідь передається код сервера 200 (ok)

Редагування прив’язки між маршрутом та користувачем

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

Метод запиту	HTTPS PATCH
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/route/users
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	routeId, isOwner, userId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту методу API

Параметр	Mandatory/Optional	Формат	Опис
routeId	M	long	id маршруту
users	M	ArrayList<User>	масив об’єктів; дані користувачів

Об’єкт User	Mandatory/Optional	Формат	Опис
userId	M	long	id користувача
isOwner	M	long	ознака власника аккаунту; 0 - ні, 1 - так

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageRoute)

Таблиця 2 - Опис параметрів об’єкта PackageRoute

Параметр	Формат	Опис
	Об’єкт PackageRoute
routeId	long	id маршруту
companyId	long	id компанії
name	String	найменування маршруту
code	String	код маршруту
status	int	статус маршруту; 1 - активний; 2 - заблокований
company	Company_	об’єкт; дані компанії
users	List<User>	масив об’єктів; користувачі
contracts	List<Contract_>	масив об’єктів; сценарії документообігу
packageTypes	List<PackageType_>	масив об’єктів; налаштування комплектів документів
isAllContracts	boolean	відмітка про всі сценарії документообігу; 0 - ні; 1 - так
isAllPackageTypes	boolean	відмітка про всі типи комплектів документів; 0 - ні; 1 - так
direction	int	напрямок маршруту; 1 - від клієнта до власника; 2 - від власника до клієнта

Таблиця 3 - Опис параметрів об’єкта User

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

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

приклад відсутній

---

Приклад тіла відповіді (json):

{
  "routeId": 251,
  "companyId": 4,
  "name": "vvvv",
  "code": "3ea391f8309246d4b8a6447f406abebf",
  "status": 2,
  "users": [
    {
      "userId": 473,
      "accountId": 8,
      "email": "test@test33232",
      "isOwner": 0,
      "isCaptcha": 1,
      "fio": "test test ",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 282,
      "lastLoginIp": "0.0.0.0",
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    },
    {
      "userId": 487,
      "accountId": 8,
      "email": "fdsfdsfds@dfsfs.ua",
      "isOwner": 0,
      "isCaptcha": 1,
      "fio": "fdsfds",
      "companies": [],
      "status": 1,
      "roles": [],
      "routes": [],
      "passSecureType": 2,
      "passPolicyId": 282,
      "lastLoginIp": "0.0.0.0",
      "lastLoginDate": 0,
      "uiTypes": [],
      "userAccess": {}
    }
  ],
  "contracts": [],
  "packageTypes": [],
  "isAllContracts": false,
  "isAllPackageTypes": false,
  "direction": 1
}

Видалення тега зі сценарію документообігу

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

Метод запиту	HTTPS DELETE
Content-Type	application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract_tag?contract_id=2445&tag_id=409
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу tag_id - ID тегу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Таблиця 2 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company_	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company_	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "contractId": 2445,
  "number": "1",
  "contractName": "Акт выполненных работ ",
  "date": 1574380800,
  "ownerCompany": {
    "companyId": 1317,
    "accountId": 427,
    "type": 2,
    "name": "ФОП Иванов Иван",
    "code": "3258963012",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "ФОП",
    "uuid": "4e8ad4c1-b6b7-477d-a439-8544f6ad9c2b",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 1313,
    "accountId": 423,
    "type": 2,
    "name": "ФОП Гаврилюк Татьяна",
    "code": "3189823647",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "ТОВ",
    "uuid": "7f38f6c6-4f1e-4361-9837-cdfa64fa3e0f",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1606003200,
  "sentDate": 1574416366,
  "status": 2,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 1,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [],
  "tags": [],
  "ownerPackages": [],
  "clientPackages": []
}

Видалення тега з комплекту документів

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

Метод запиту	HTTPS DELETE
Content-Type	application/json; (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/tag?package_id=7511&tag_id=409
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекту tag_id - ID тегу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok)

Видалення тегу

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

Метод запиту	HTTPS DELETE
Content-Type	text/plain; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/tag?tag_id=447
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: tagId - ID тегу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі у тіло запиту відсутнє (дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok)

Отримання списку тегів

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

Метод запиту	HTTPS GET
Content-Type	text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/tags
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Таблиця 1 - Опис параметрів об’єкта Tag

Параметр	Формат	Опис
	Об’єкт Tag
tagId	long	ID тега
name	String	назва тега
code	long	унікальний код ідентифікатор
accountId	long	ID аккаунту

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "tagId": 307,
    "name": "Лавина",
    "code": "a04c42406020405292783984ae730a5"
  },
  {
    "tagId": 301,
    "name": "Гулливер",
    "code": "a67043a8e44e43feb1ea9cc01a2544c2"
  },
  {
    "tagId": 295,
    "name": "Ашан",
    "code": "8c753e72e90c41499b1d281839c89cbc"
  },
  {
    "tagId": 293,
    "name": "Ривермол 1",
    "code": "43274dec45704dbe9340831896a557fd"
  },
  {
    "tagId": 291,
    "name": "Перекресток",
    "code": "6c41d0b49d9d4287a7e78b689ad98c27"
  },
  {
    "tagId": 285,
    "name": "Пирамида",
    "code": "145"
  },
  {
    "tagId": 283,
    "name": "Комод",
    "code": "254eb706b67042c8931fa988dbc4f516"
  }
]

Створення / редагування тегів

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

Метод запиту	HTTPS POST
Content-Type	text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/tag
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Важливо

Редагування тегу відбувається аналогічним запитом за допомогою перезапису даних, обов’язково при цьому вказувати tagId!

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API

Параметр	Mandatory/Optional	Формат	Опис
name	M	String	назва тегу
code	О	long	унікальний код, якщо не передано створиться автоматично

RESPONSE

У відповідь передаються дані тегу (об’єкт Tag).

Таблиця 2 - Опис параметрів об’єкта Tag

Параметр	Формат	Опис
	Об’єкт Tag
tagId	long	ID тега
name	String	назва тега
code	long	унікальний код ідентифікатор
accountId	long	ID аккаунту

Приклади

Приклад тіла запиту в json форматі

{
  "code": "6418c44baec34df7bc17a66a1989fa1a",
  "name": "Альбатрос"
}

---

Приклад тіла відповіді в json форматі

{
  "tagId": 409,
  "name": "Альбатрос",
  "code": "6418c44baec34df7bc17a66a1989fa1a"
}

Експорт тегів з .xlsx файлу на платформу

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

Метод запиту	HTTPS POST
Content-Type	text/plain; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/tag/xls
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

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

Файл повинен відповідати шаблону:

Завантажити шаблон

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok)

Додавання (прив’язка) тега до сценарію документообігу

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

Метод запиту	HTTPS PUT
Content-Type	application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract_tag?contract_id=2445&tag_id=409
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу tag_id - ID тегу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Таблиця 2 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company_	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company_	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "contractId": 2445,
  "number": "1",
  "contractName": "Акт выполненных работ ",
  "date": 1574380800,
  "ownerCompany": {
    "companyId": 1317,
    "accountId": 427,
    "type": 2,
    "name": "ФОП Иванов Иван",
    "code": "3258963012",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "ФОП",
    "uuid": "4e8ad4c1-b6b7-477d-a439-8544f6ad9c2b",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 1313,
    "accountId": 423,
    "type": 2,
    "name": "ФОП Гаврилюк Татьяна",
    "code": "3189823647",
    "isApproved": 0,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipType": "ТОВ",
    "uuid": "7f38f6c6-4f1e-4361-9837-cdfa64fa3e0f",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 1606003200,
  "sentDate": 1574416366,
  "status": 2,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 1,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [],
  "tags": [
    {
      "tagId": 409,
      "name": "Альбатрос",
      "code": "6418c44baec34df7bc17a66a1989fa1a"
    }
  ],
  "ownerPackages": [],
  "clientPackages": []
}

Додавання тега до комплекту документів

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

Метод запиту	HTTPS PUT
Content-Type	text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/store/package/tag?package_id=7511&tag_id=409
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекту tag_id - ID тегу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Таблиця 2 - Опис параметрів об’єкта Tag

Параметр	Формат	Опис
	Об’єкт Tag
tagId	long	ID тега
name	String	назва тега
code	long	унікальний код ідентифікатор
accountId	long	ID аккаунту

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "tagId": 293,
    "name": "Ривермол 1",
    "code": "43274dec45704dbe9340831896a557fd"
  },
  {
    "tagId": 409,
    "name": "Альбатрос",
    "code": "6418c44baec34df7bc17a66a1989fa1a"
  }
]

Отримання списку всіх ярликів фільтрів

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній filterId, то запис з зазначеним filterId підлягає редагуванню.

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/filters
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageFilter)

Таблиця 2 - Опис параметрів об’єкта PackageFilter

Параметр	Формат	Опис
	Об’єкт PackageFilter
filterId	long	ID фильтру
filterName	long	назва ярлика-фільтру
packageId	long	ID комплекта (пакета)
ownerCompaniesIds	List<ownerCompaniesIds>	масив об’єктів; список ID компаній власника
clientCompaniesIds	List<clientCompaniesIds>	масив об’єктів; список ID компаній контрагента
senderCompaniesIds	List<senderCompaniesIds>	масив об’єктів; список ID компаній відправника
recipientCompaniesIds	**List<recipientCompaniesIds>*	масив об’єктів; список ID компаній одержувача
dateFrom	long	дата початку вибірки при пошуку комплекту (unix timestamp)
dateTo	long	дата закынчення вибірки при пошуку комплекту (unix timestamp)
packageNumber	String	номер комплекту
packageTypesIds	List<packageTypesIds>	масив; за типами комплектів документів
packageChainIds	List<packageChainIds>	масив; за версією типу комплекту документів
contractIds	List<contractIds>	масив ID сценаріїв документообігу
packageStatuses	List<packageStatuses>	масив; по статусах комплектів документів де «1» - чернетка; «2» - відправлений; «3» — прийнятий; «4» - запит на уточнення; «5» - відхилений; «6» - оброблений; «7» - відмова; «8» — додано документ;
packageTagIds	List<packageTagIds>	масив  ID тегів
folder	int	папка; 1 — inbox; 2 — outbox; 3 — draft;
isReadFromApi	int	ознака прочитання (завантаження) по API
isRead	int	ознака прочитання на WEB
periodType	int	період; 1 — currentMonth; 2 — previousMonth; 3 — currentDate; 4 fixedPeriod;
dateShift	int	N днів в формі «Поточна дата мінус N-днів» (якщо periodType = 3)
fileName	String	пошук по імені файлу документа
packageDictionaryValue	DictionaryValue_	об’єкт; довідник скопійований з сценарію документообігу в момент створення комплекту
extraField	ExtraField_	об’єкт; користувацькi поля прив’язані до комплекту

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді (json):

[
  {
    "filterId": 305,
    "filterName": "альбус",
    "ownerCompaniesIds": [],
    "clientCompaniesIds": [],
    "senderCompaniesIds": [],
    "recipientCompaniesIds": [
      1319
    ],
    "dateFrom": 1575151200,
    "dateTo": 1576533600,
    "packageTypesIds": [],
    "packageChainIds": [
      330
    ],
    "contractIds": [],
    "packageStatuses": [
      2,
      3,
      4,
      6,
      5,
      7,
      8
    ],
    "packageTagIds": [
      409
    ],
    "folder": 1,
    "periodType": 1,
    "dateShift": 0,
    "packageDictionaryValue": {
      "valueId": 1431,
      "dictionaryId": 715,
      "name": "Направление 5",
      "code": "1b35ec2b56d24ae29951010bd2a4f279",
      "isActive": 1,
      "childs": []
    },
    "extraField": {
      "fieldId": 265,
      "companyId": 0,
      "name": "Сумма ",
      "dataType": 0,
      "status": 0,
      "value": "5"
    }
  },
  {
    "filterId": 303,
    "filterName": "альба",
    "ownerCompaniesIds": [],
    "clientCompaniesIds": [],
    "senderCompaniesIds": [],
    "recipientCompaniesIds": [],
    "dateFrom": 1574719200,
    "dateTo": 1576533600,
    "packageTypesIds": [],
    "packageChainIds": [],
    "contractIds": [],
    "packageStatuses": [
      2,
      3,
      4,
      6,
      5,
      7,
      8
    ],
    "packageTagIds": [],
    "folder": 1,
    "periodType": 3,
    "dateShift": 20
  },
  {
    "filterId": 301,
    "filterName": "альбатрос",
    "ownerCompaniesIds": [],
    "clientCompaniesIds": [],
    "senderCompaniesIds": [],
    "recipientCompaniesIds": [],
    "dateFrom": 1575158400,
    "dateTo": 1576540800,
    "packageTypesIds": [],
    "packageChainIds": [],
    "contractIds": [],
    "packageStatuses": [
      2,
      3,
      4,
      6,
      5,
      7,
      8
    ],
    "packageTagIds": [
      295
    ],
    "folder": 1,
    "periodType": 4,
    "dateShift": 0
  }
]

Створення / редагування ярлика фільтра

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній filterId, то запис з зазначеним filterId підлягає редагуванню.

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/filter
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	filterName; periodType; dateFrom; dateTo;

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт PackageFilter_)

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageFilter)

Таблиця 2 - Опис параметрів об’єкта PackageFilter

Параметр	Формат	Опис
	Об’єкт PackageFilter
filterId	long	ID фильтру
filterName	long	назва ярлика-фільтру
packageId	long	ID комплекта (пакета)
ownerCompaniesIds	List<ownerCompaniesIds>	масив об’єктів; список ID компаній власника
clientCompaniesIds	List<clientCompaniesIds>	масив об’єктів; список ID компаній контрагента
senderCompaniesIds	List<senderCompaniesIds>	масив об’єктів; список ID компаній відправника
recipientCompaniesIds	**List<recipientCompaniesIds>*	масив об’єктів; список ID компаній одержувача
dateFrom	long	дата початку вибірки при пошуку комплекту (unix timestamp)
dateTo	long	дата закынчення вибірки при пошуку комплекту (unix timestamp)
packageNumber	String	номер комплекту
packageTypesIds	List<packageTypesIds>	масив; за типами комплектів документів
packageChainIds	List<packageChainIds>	масив; за версією типу комплекту документів
contractIds	List<contractIds>	масив ID сценаріїв документообігу
packageStatuses	List<packageStatuses>	масив; по статусах комплектів документів де «1» - чернетка; «2» - відправлений; «3» — прийнятий; «4» - запит на уточнення; «5» - відхилений; «6» - оброблений; «7» - відмова; «8» — додано документ;
packageTagIds	List<packageTagIds>	масив  ID тегів
folder	int	папка; 1 — inbox; 2 — outbox; 3 — draft;
isReadFromApi	int	ознака прочитання (завантаження) по API
isRead	int	ознака прочитання на WEB
periodType	int	період; 1 — currentMonth; 2 — previousMonth; 3 — currentDate; 4 fixedPeriod;
dateShift	int	N днів в формі «Поточна дата мінус N-днів» (якщо periodType = 3)
fileName	String	пошук по імені файлу документа
packageDictionaryValue	DictionaryValue_	об’єкт; довідник скопійований з сценарію документообігу в момент створення комплекту
extraField	ExtraField_	об’єкт; користувацькi поля прив’язані до комплекту

---

Приклади

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

{
  "folder": 1,
  "packageStatuses": [
    2,
    3,
    4,
    6,
    5,
    7,
    8
  ],
  "dateFrom": 0,
  "dateTo": 0,
  "senderCompaniesIds": [],
  "recipientCompaniesIds": [],
  "packageChainIds": [],
  "periodType": 1,
  "filterName": "альбус",
  "packageTagIds": []
}

---

Приклад тіла відповіді (json):

{
  "filterId": 129,
  "filterName": "альбус",
  "ownerCompaniesIds": [],
  "clientCompaniesIds": [],
  "senderCompaniesIds": [],
  "recipientCompaniesIds": [],
  "dateFrom": 0,
  "dateTo": 0,
  "packageTypesIds": [],
  "packageChainIds": [],
  "contractIds": [],
  "packageStatuses": [
    2,
    3,
    4,
    6,
    5,
    7,
    8
  ],
  "packageTagIds": [],
  "folder": 1,
  "periodType": 1,
  "dateShift": 0
}

Отримання списку довідників компанії

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/dictionaries?company_id=1313
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Dictionary)

Таблиця 1 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "dictionaryId": 715,
    "companyId": 1313,
    "name": "Направления ",
    "code": "e18fac537c49470a8d0a20f4a030edfa",
    "isActive": 1,
    "values": []
  },
  {
    "dictionaryId": 719,
    "companyId": 1313,
    "name": "Без значений ",
    "code": "68a9aa7931c94170975fda51c94bf204",
    "isActive": 1,
    "values": []
  }
]

Отримання довідника компанії

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/dictionary?dictionary_id=719
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: dictionary_id - ID довідника

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Dictionary)

Таблиця 1 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт User
userId	long	ID користувача
accountId	long	ID аккаунта
email	String	email та логін користувача
password	String	пароль користувача
isOwner	int	ознака власника аккаунта; 0 - ні, 1 - так
isCaptcha	Integer	ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)
fio	String	ПІБ користувача
tel	String	телефон
companies	List<Company_>	масив об’єктів; компанії
account	Account_	об’єкт; дані облікового запису
status	int	статус користувача («1» - активний; «2» - заблокований)
roles	List<Role_>	масив об’єктів; ролі
routes	List<PackageRoute_>	масив об’єктів; маршрути
passSecureType	int	рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)
passPolicyId	long	id пральний політики, застосованої до користувача
userInfo	UserInfo_	об’єкт; інформація про користувача
lastLoginIp	String	IP-адреса останнього входу
lastLoginDate	long	дата останнього входу
uiTypes	List<UIType2Role_>	масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "dictionaryId": 719,
  "companyId": 1313,
  "name": "Без значений ",
  "code": "68a9aa7931c94170975fda51c94bf204",
  "isActive": 1,
  "values": []
}

Отримання данних довідника у вигляді .xlsx файлу

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/dictionary/xlsx?dictionary_id=719
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: dictionary_id - ID довідника

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Завантаження значень довідника в .xlsx файл

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/dictionary_values/xls?dictionary_id=117
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: dictionary_id - ID довідника

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

RESPONSE

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

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Створення/редагування довідника

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній dictionaryId, то довідник з зазначеним Id підлягає редагуванню. Відсутність параметра dictionaryId веде до створення нового довідника.

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/dictionary
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API:

Параметр	Тип	Формат	Опис
dictionaryId	O…M	long	id довідника (передається для редагування (перезатирання) даних раніше створеного довідника)
isActive	M	int	статус довідника; 1 -активний, 0 - заблокований
name	M	String	назва довідника
code	M	String	код довідника
companyId	M	long	id компанії

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Dictionary)

Таблиця 2 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue_>	масив об’єктів; значення довідника

---

Приклади

Приклад тіла запиту в json форматі:

{
  "dictionaryId": 0,
  "isActive": 1,
  "name": "віфвфывыівфі",
  "code": "423423",
  "companyId": "989"
}

---

Приклад тіла відповіді в json форматі:

{
  "dictionaryId": 459,
  "companyId": 989,
  "name": "Как бе справочник",
  "code": "423423",
  "isActive": 1,
  "values": []
}

Додавання (прив’язка) довідника до типу документа

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/document_types/dictionary?document_id=2385&dictionary_id=443
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу dictionary_id - ID довідника

Примітка

1 довідник можна прив’язати до декількох документів. До 1 документу можна прив’язати тільки 1 довідник.

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok)

Активувати / Заблокувати значення довідника

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

Важливо

Метод дозволяє заблокувати чи активувати значення довідника в залежності від значення параметра is_active=0 / is_active=1

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	Заблокувати значення довідника https://doc.edin.ua/bdoc/dictionary_value?dictionary_id=445&value_id=755&is_active=0 Активувати значення довідника https://doc.edin.ua/bdoc/dictionary_value?dictionary_id=445&value_id=755&is_active=1
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: dictionary_id - ID довідника is_active - статус довідника; 1 - активний, 0 - заблокований value_id - ID значення довідника

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Активувати / Заблокувати довідник

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

Важливо

Метод дозволяє заблокувати чи активувати довідник в залежності від значення параметра is_active=0 / is_active=1

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	Заблокувати довідник https://doc.edin.ua/bdoc/dictionary?dictionary_id=443&is_active=0 Активувати довідник https://doc.edin.ua/bdoc/dictionary?dictionary_id=443&is_active=1
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: dictionary_id - ID довідника is_active - статус довідника; 1 - активний, 0 - заблокований

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь передається код сервера 200 (ok).

Додавання значень довідника

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

Підказка

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/dictionary_value
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API:

Параметр	Тип	Формат	Опис
dictionaryId	O…M	long	id довідника (передається для редагування (перезатирання) даних раніше створеного довідника)
isActive	M	int	статус довідника; 1 -активний, 0 - заблокований
name	M	String	назва довідника
code	M	String	код довідника
parentCode	M	String	параметр визначає кейс використання методу: parentCode=null - створення «материнського» значення parentCode=»12345» - прив’язка «дочірнього» значения до «материнського 12345»

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт DictionaryValue)

Таблиця 2 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

---

Приклади

Приклад тіла запиту в json форматі:

{
  "name": "СуперВещь",
  "code": "4212522",
  "parentCode": "423423",
  "dictionaryId": 445,
  "isActive": 1
}

---

Приклад тіла відповіді в json форматі:

{
  "valueId": 769,
  "dictionaryId": 445,
  "name": "СуперВещь",
  "code": "4212522",
  "parentCode": "423423",
  "isActive": 1
}

Додавання (прив’язка) типу комплекта документів до довідника

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package_dictionary
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	packageId, dictionaryId

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Package2Dictionaries)

Таблиця 1 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageType)

Таблиця 2 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries_>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

Таблиця 3 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 4 - Опис параметрів об’єкта Document2Package

Параметр	Формат	Опис
	Об’єкт Document2Package
packageId	long	id комплекта
documentId	long	id документа
needSign	int	необхідність підписання; «0 - Ні; 1 - Так»
signsCount	int	кількість підписів
ownerSignsCount	int	кількість підписів власника
needEncrypt	int	необхідність шифрування; «0 - Ні; 1 - Так»
required	int	обов’язковий документ: 0 - Ні; 1 - Так
isRecipientAttach	int	ознака, що вказує, що документ є «довкладенням» з боку одержувача; «0 - Ні; 1 - Так»
maxFilesCount	int	максимальна кількість вкладених файлів
document	Document	об’єкт; дані документа

Таблиця 5 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 3 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue>	масив об’єктів; значення довідника

Таблиця 4 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 5 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

---

Приклади

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

{
  "packageId": 1485,
  "dictionaryId": 443,
  "fillType": 3,
  "required": 0
}

---

Приклад тіла відповіді (json):

{
  "packageId": 1485,
  "companyId": 989,
  "name": "авыаыв123",
  "type": 1,
  "code": "323222",
  "packageChainId": 244,
  "status": 3,
  "version": 1,
  "dateChanged": 1557905884,
  "autoHandle": 0,
  "document2packages": [
    {
      "packageId": 1485,
      "documentId": 2391,
      "needSign": 0,
      "signsCount": 0,
      "ownerSignsCount": 0,
      "needEncrypt": 0,
      "required": 0,
      "isRecipientAttach": 0,
      "maxFilesCount": 3,
      "document": {
        "documentId": 2391,
        "companyId": 989,
        "name": "dsfdsfs",
        "type": 2,
        "code": "2322",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
      }
    }
  ],
  "package2dictionaries": [
    {
      "packageId": 1485,
      "dictionaryId": 443,
      "fillType": 3,
      "required": 0,
      "dictionary": {
        "dictionaryId": 443,
        "companyId": 989,
        "name": "выфвф",
        "code": "32423",
        "isActive": 1,
        "values": [
          {
            "valueId": 759,
            "dictionaryId": 443,
            "name": "куцкуц",
            "code": "кцу",
            "isActive": 1
          }
        ]
      }
    }
  ],
  "extraFields": [],
  "company": {
    "companyId": 0,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}

Додавання (прив’язка) додаткового атрибуту до типу комплекта документів

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

Метод запиту	HTTPS OPTIONS
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/package/extra_field
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	packageId, required, fieldId, fillType

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Package2ExtraField)

Таблиця 1 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 2 - Опис параметрів об’єкта ExtraField

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт PackageType)

Таблиця 3 - Опис параметрів об’єкта PackageType

Параметр	Формат	Опис
	Об’єкт PackageType
packageId	long	id комплекта
companyId	long	id компанії
name	String	назва типу комплекта
type	int	тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content»
code	String	код комплекта
packageChainId	long	незмінний ID комплекта на різних стадіях редагування
status	int	статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик»
version	long	версія комплекту (кількість редакцій)
dateChanged	long	дата останньої зміни комплекта
autoHandle	int	ознака автооброботки комплекта; 0 - ні, 1 - так
document2packages	List<Document2Package>	масив об’єктів; зв’язок документа і комплекта
package2dictionaries	List<Package2Dictionaries>	масив об’єктів; зв’язок комплекта і довідника
extraFields	List<Package2ExtraField_>	масив об’єктів; прив’язка додаткових полів до комплекту
company	Company	об’єкт; інформація про компанію

Таблиця 4 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 5 - Опис параметрів об’єкта Document2Package

Параметр	Формат	Опис
	Об’єкт Document2Package
packageId	long	id комплекта
documentId	long	id документа
needSign	int	необхідність підписання; «0 - Ні; 1 - Так»
signsCount	int	кількість підписів
ownerSignsCount	int	кількість підписів власника
needEncrypt	int	необхідність шифрування; «0 - Ні; 1 - Так»
required	int	обов’язковий документ: 0 - Ні; 1 - Так
isRecipientAttach	int	ознака, що вказує, що документ є «довкладенням» з боку одержувача; «0 - Ні; 1 - Так»
maxFilesCount	int	максимальна кількість вкладених файлів
document	Document	об’єкт; дані документа

Таблиця 6 - Опис параметрів об’єкта Package2Dictionaries

Параметр	Формат	Опис
	Об’єкт Package2Dictionaries
packageId	long	id комплекту
dictionaryId	long	id довідника
fillType	int	тип заповнення поля; «1 - заповнює ініціатор комплекта; 2 - одержувач; 3 - обидва»
required	int	ознака обов’язковості; «0 - Ні; 1 - Так»
dictionary	Dictionary	об’єкт; дані довідника

Таблиця 7 - Опис параметрів об’єкта Dictionary

Параметр	Формат	Опис
	Об’єкт Dictionary
dictionaryId	long	id довідника
companyId	long	id компании
name	String	назва довідника
code	String	код довідника
isActive	int	статус довідника; 1 - активний, 0 — заблокований
values	List<DictionaryValue>	масив об’єктів; значення довідника

Таблиця 8 - Опис параметрів об’єкта DictionaryValue

Параметр	Формат	Опис
	Об’єкт DictionaryValue
valueId	long	id значення довідника
dictionaryId	long	id довідника
name	String	назва значення довідника
code	String	код значення довідника
parentCode	String	код «батьківського» значення довідника
isActive	int	статус значення довідника; 1 - активний, 0 - заблокований

Таблиця 9 - Опис параметрів об’єкта Document

Параметр	Формат	Опис
	Об’єкт Document
documentId	long	id документа
companyId	long	id компанії
company	Company	об’єкт; інформація про компанію
name	String	назва документа
type	int	тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця»
code	String	код документа
agreementProcId	long	id процесу узгодження
isActive	int	статус; «1 - Активний; 0 - Заблокований»
extraFields	List<ExtraField_>	масив об’єктів; додаткові поля документа
dictionary	Dictionary	об’єкт; дані довідника
structures	List<DocumentStructure_>	масив об’єктів; дані структурованого документа

Таблиця 10 - Опис параметрів об’єкта Package2ExtraField

Параметр	Формат	Опис
	Об’єкт Package2ExtraField
packageId	long	id комплекта
fillType	int	тип заповнення; 1 - заповнює клієнт; 2 - заповнює власник; 3 - заповнюють обидва
required	int	ознака обов’язковості; 0 - немає, 1 - так
extraField	ExtraField_	об’єкт; дані додаткового поля

Таблиця 11 - Опис параметрів об’єкта ExtraField

Параметр	Формат	Опис
	Об’єкт ExtraField
fieldId	long	id поля
companyId	long	id компанії
name	String	назва поля
description	String	опис поля
dataType	int	формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра
status	int	статус; 1 - Активно, 0 - Неактивно (Заблокировано)
value	String	значення поля

---

Приклади

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

{
  "required": 0,
  "extraField": {
    "fieldId": 231
  },
  "packageId": 1485,
  "fillType": "3"
}

---

Приклад тіла відповіді (json):

{
  "packageId": 1485,
  "companyId": 989,
  "name": "авыаыв123",
  "type": 1,
  "code": "323222",
  "packageChainId": 244,
  "status": 3,
  "version": 1,
  "dateChanged": 1557905884,
  "autoHandle": 0,
  "document2packages": [
    {
      "packageId": 1485,
      "documentId": 2391,
      "needSign": 0,
      "signsCount": 0,
      "ownerSignsCount": 0,
      "needEncrypt": 0,
      "required": 0,
      "isRecipientAttach": 0,
      "maxFilesCount": 3,
      "document": {
        "documentId": 2391,
        "companyId": 989,
        "name": "dsfdsfs",
        "type": 2,
        "code": "2322",
        "agreementProcId": 0,
        "isActive": 1,
        "extraFields": []
      }
    }
  ],
  "package2dictionaries": [
    {
      "packageId": 1485,
      "dictionaryId": 443,
      "fillType": 3,
      "required": 0,
      "dictionary": {
        "dictionaryId": 443,
        "companyId": 989,
        "name": "выфвф",
        "code": "32423",
        "isActive": 1,
        "values": [
          {
            "valueId": 759,
            "dictionaryId": 443,
            "name": "куцкуц",
            "code": "кцу",
            "isActive": 1
          }
        ]
      }
    }
  ],
  "extraFields": [
    {
      "packageId": 1485,
      "fillType": 3,
      "required": 0,
      "extraField": {
        "fieldId": 231,
        "companyId": 989,
        "name": "выфывфы",
        "description": "ыв",
        "dataType": 1,
        "status": 1
      }
    }
  ],
  "company": {
    "companyId": 0,
    "accountId": 0,
    "type": 0,
    "name": "dwdsss",
    "code": "433",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "ownershipTypeId": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}

Створення запиту на формування аналітичного звіту

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

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/report
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	reportType (визначає тип звіту), reportName, companyId, reportStartDate, reportEndDate

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API:

Таблиця 1 - Опис параметрів запиту

Параметр	Mandatory/Optional	Формат	Опис
reportType	M	int	тип звіту; 1 - по зовнішньому документообігу, 2 - по завданням
reportName	M	String	назва звіту
companyId	M	long	ID компанії
reportFilter	O	об’єкт	в залежності від reportType, містить або «partnerCompanyId», або «taskUser» та «taskUserId»
reportStartDate	M	long	дата початку часового періоду звіту (Unix timestamp)
reportEndDate	M	long	дата закінчення часового періоду звіту (Unix timestamp)

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Report)

Таблиця 2 - Опис параметрів об’єкта Report

Параметр	Формат	Опис
	Об’єкт Report
reportName	String	назва звіту
reportId	long	ID звіту
companyId	long	ID компанії
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
dateCreated	long	дата і час запиту на створення звіту (у форматі Unix timestamp)
dateCompleted	long	дата і час створення звіту (у форматі Unix timestamp)
reportType	int	тип звіту; 1 - по зовнішньому документообігу, 2 - по задачам
userId	long	ID користувача
userEmail	String	Email користувача
reportStatus	int	статус звіту; 1 - IN_PROGRESS, 2 - FINISHED
company	Company_	об’єкт; інформація про компанію
reportFilter	ReportDocumentFilter або ReportTaskFilter	змінна, в залежності про типу звіту містить об’єкт ReportDocumentFilter або об’єкт ReportTaskFilter
reportFileLink	String	посилання на файл

Таблиця 3 - Опис параметрів об’єкта ReportDocumentFilter

Параметр	Формат	Опис
	Об’єкт ReportDocumentFilter
companyId	long	ID компанії
company	Company_	об’єкт; інформація про компанію
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
partnerCompanyId	long	ID компанії-партнера
partnerCompany	Company_	об’єкт; об’єкт; інформація про компанію-партнера

Таблиця 4 - Опис параметрів об’єкта ReportTaskFilter

Параметр	Формат	Опис
	Об’єкт ReportTaskFilter
companyId	long	ID компанії
company	Company_	об’єкт; інформація про компанію, за якою вибираються завдання
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
taskUserId	long	ID користувача, за яким вибираються завдання
taskUser	User_	об’єкт; інформація про користувача
taskStatus	int	тип завдання (1 - узгодження; 2 - підписання; 3 - повідомлення)
taskType	int	Статус завдання - 2-in_progress, 3-finished, 4-canceled, 5-expired (До виконання, Виконано, Відхилено, Прострочена )

---

Приклади

Приклад тіла запиту (json) для Створення звіту по зовнішньому документообігу:

{
 "reportType": 1,
 "reportFilter": {
  "partnerCompanyId": 4
 },
 "reportName": "тижневий звіт",
 "companyId": 1313,
 "reportStartDate": 1572566800,
 "reportEndDate": 1575244600
}

---

Приклад тіла відповіді (json):

{
  "reportName": "тижневий звіт",
  "reportId": 339,
  "companyId": 1319,
  "reportStartDate": 1575244800,
  "reportEndDate": 1575849600,
  "dateCreated": 1575910632,
  "dateCompleted": 0,
  "reportType": 1,
  "userId": 683,
  "userEmail": "wilfdlnfujkbai@gmail.com",
  "reportStatus": 1,
  "company": {
    "companyId": 1319,
    "accountId": 0,
    "type": 0,
    "name": "ТОВ Альбатрос ",
    "code": "01235896",
    "isApproved": 0,
    "isSignedOffer": 0,
    "isActive": 0,
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  }
}

---

Отримання файлу аналітичного звіту

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/report_file
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: report_id - ID звіту

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь повертається файл звіту в форматі Excel (* .xls)

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У відповідь повертається файл звіту в форматі Excel (* .xls)

Отримання списку запитів на формування аналітичного звіту

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/reports
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

В Response Header відправляється count - кількість запитів, а в тілі json передається об’єкт Report та Company

Опис json-параметрів відповіді метода API

Таблиця 1 - Опис параметрів об’єкта Report

Параметр	Формат	Опис
	Об’єкт Report
reportName	String	назва звіту
reportId	long	ID звіту
companyId	long	ID компанії
reportStartDate	long	дата початку часового періоду звіту (у форматі Unix timestamp)
reportEndDate	long	дата закінчення часового періоду звіту (у форматі Unix timestamp)
dateCreated	long	дата і час запиту на створення звіту (у форматі Unix timestamp)
dateCompleted	long	дата і час створення звіту (у форматі Unix timestamp)
reportType	int	тип звіту; 1 - по зовнішньому документообігу, 2 - по задачам
userId	long	ID користувача
userEmail	String	Email користувача
reportStatus	int	статус звіту; 1 - IN_PROGRESS, 2 - FINISHED
company	Company	об’єкт; інформація про компанію
reportFilter	ReportDocumentFilter_ або ReportTaskFilter_	змінна, в залежності про типу звіту містить об’єкт ReportDocumentFilter або об’єкт ReportTaskFilter
reportFileLink	String	посилання на файл

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді (масив з json):

[
  {
    "reportName": "Звіт за грудень",
    "reportId": 343,
    "companyId": 1319,
    "reportStartDate": 1573430400,
    "reportEndDate": 1576022400,
    "dateCreated": 1575976573,
    "dateCompleted": 0,
    "reportType": 1,
    "userId": 683,
    "userEmail": "wilfdlnfujkbai@gmail.com",
    "reportStatus": 1,
    "company": {
      "companyId": 1319,
      "accountId": 0,
      "type": 0,
      "name": "ТОВ Альбатрос ",
      "code": "01235896",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    }
  },
  {
    "reportName": "Звіт за грудень",
    "reportId": 341,
    "companyId": 1319,
    "reportStartDate": 1575158400,
    "reportEndDate": 1577836800,
    "dateCreated": 1575976225,
    "dateCompleted": 1575976366,
    "reportType": 1,
    "userId": 683,
    "userEmail": "wilfdlnfujkbai@gmail.com",
    "reportStatus": 2,
    "company": {
      "companyId": 1319,
      "accountId": 0,
      "type": 0,
      "name": "ТОВ Альбатрос ",
      "code": "01235896",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    }
  },
  {
    "reportName": "Аналитика за ноябрь ",
    "reportId": 329,
    "companyId": 1313,
    "reportStartDate": 1572566400,
    "reportEndDate": 1575158400,
    "dateCreated": 1574429132,
    "dateCompleted": 1574429153,
    "reportType": 1,
    "userId": 693,
    "userEmail": "566666798989797zz@gmail.com",
    "reportStatus": 2,
    "company": {
      "companyId": 1313,
      "accountId": 0,
      "type": 0,
      "name": "ФОП Гаврилюк Марьяна",
      "code": "3189823647",
      "isApproved": 0,
      "isSignedOffer": 0,
      "isActive": 0,
      "certificates": [],
      "dictionaries": [],
      "notifySettings": []
    }
  }
]

---

Отримання данних сертифікату компанії

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/bdoc/certificate?certificate_id=18
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: certificate_id - ID сертифікату

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Certificate)

Таблиця 1 - Опис параметрів об’єкта Certificate

Параметр	Формат	Опис
	Об’єкт Certificate
certId	long	ID сертифіката
info	EndUserCertificateInfoEx_	об’єкт; дані про сертифікат
expireDate	long	дата закінчення дії сертифіката
serial	String	серійний номер сертифіката
body	byte[]	тіло відкритого сертифіката
fullName	String	ПІБ власника сертифіката
EDRPOUCode	String	Код ЄДРПОУ
cer2accId	long	ID зв’язку аккаунта з сертифікатами
keyUsage	String	призначення сертифіката

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "certId": 18,
  "info": {
    "issuer": "O=ТОВ \"АРТ-МАСТЕР\";OU=АЦСК;CN=АЦСК \"MASTERKEY\" ТОВ   \"АРТ-МАСТЕР\";Serial=UA-30404750-09;C=UA;L=Київ",
    "issuerCN": "АЦСК \"MASTERKEY\" ТОВ \"АРТ-МАСТЕР\"",
    "serial": "4E6929B96F6EA0750405400005AEE080022731200",
    "subject": "O=ПП \"Тест\";Title=Директор;CN=Іванів Іван Іванович;SN=Іванів;GivenName=Іван   Іванович;Serial=585306;C=UA;L=м. Київ",
    "subjCN": "Іванів Іван Іванович",
    "subjOrg": "ПП \"Тест\"",
    "subjTitle": "Директор",
    "subjLocality": "м. Київ",
    "subjFullName": "Іванів Іван Іванович",
    "subjAddress": "03035, м.Київ, ВУЛИЦЯ СУРИКОВА, будинок 3 ЛІТ.А",
    "subjEDRPOUCode": "77777777",
    "subjDRFOCode": "7777777777",
    "certBeginTime": "Sep 28, 2018, 12:00:00 AM",
    "certEndTime": "Sep 27, 2019, 11:59:59 PM",
    "privKeyTimesAvail": true,
    "privKeyBeginTime": "Sep 28, 2018, 12:00:00 AM",
    "privKeyEndTime": "Sep 27, 2019, 11:59:59 PM",
    "publicKeyBits": 432,
    "keyUsage": "Протоколи розподілу ключів",
    "extKeyUsages": "1.2.804.2.1.1.1.11.30404750.46, 1.2.804.2.1.1.1.11.30404750.59",
    "policies": "Правила посиленої сертифікації",
    "crlDistribPoint1": "http://masterkey.ua/download/crls/CA-4E6929B9-Full.crl",
    "crlDistribPoint2": "http://masterkey.ua/download/crls/CA-4E6929B9-Delta.crl",
    "powerCert": true,
    "subjTypeAvail": true,
    "subjCA": false,
    "chainLength": 0,
    "publicKeyType": 1,
    "keyUsageType": 16,
    "OCSPAccessInfo": "http://masterkey.ua/services/ocsp/",
    "TSPAccessInfo": "http://masterkey.ua/services/tsp/",
    "limitValueAvailable": false,
    "limitValue": 0,
    "subjType": 4,
    "subjSubType": 0,
    "subjCountry": "UA"
  },
  "expireDate": 1569617999,
  "serial": "4E6929B96F6EA075040000005AEE080022731200",
  "fullName": "ПП \"Тест\"",
  "EDRPOUCode": "77777777",
  "cer2accId": 0
}

Отримання списку сертифікатів компанії

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/certificates
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Certificate)

Таблиця 1 - Опис параметрів об’єкта Certificate

Параметр	Формат	Опис
	Об’єкт Certificate
certId	long	ID сертифіката
info	EndUserCertificateInfoEx_	об’єкт; дані про сертифікат
expireDate	long	дата закінчення дії сертифіката
serial	String	серійний номер сертифіката
body	byte[]	тіло відкритого сертифіката
fullName	String	ПІБ власника сертифіката
EDRPOUCode	String	Код ЄДРПОУ
cer2accId	long	ID зв’язку аккаунта з сертифікатами
keyUsage	String	призначення сертифіката

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

[
  {
    "certId": 18,
    "expireDate": 1569617999,
    "serial": "4E6929B96F6EA075040000005AEE080022731200",
    "fullName": "ПП \"Тест\"",
    "EDRPOUCode": "77777777",
    "cer2accId": 0
  }
]

Закінчення сессії користувача

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/logout
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

RESPONSE

При використанні методу json-тіло відповіді відсутнє, в результаті сесія активного користувача завершена

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

При використанні методу json-тіло відповіді відсутнє, в результаті сесія активного користувача завершена

Отримання файлу договору-оферти

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

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

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

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

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

Завантаження сертифікату безпеки

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

Метод запиту	HTTPS PUT
Content-Type	multipart/form-data (тіло запиту в form-data в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/certificate
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В тілі запиту в form-data передається файл з бінарними данними сертифікату.

RESPONSE

У відповідь передається код сервера 200 (ok)

---

Приклади

В тілі запиту в form-data передається файл з бінарними данними сертифікату.

---

У відповідь передається код сервера 200 (ok)

Отримання даних аккаунту

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/account
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані аккаунта (об’єкт Account).

Таблиця 1 - Опис параметрів об’єкта Account

Параметр	Формат	Опис
	Об’єкт Account
accountId	long	ID аккаунта
companyId	long	ID компанії
company	Company	об’єкт; дані про компанію
isIndivOffer	int	відмітка про наявність індивідуального договору; 0 - нет, 1 - есть
adminAccountId	long	ID аккаунта в Адмінці
status	int	статус; 0 - заблокований; 1 - активний
accountInfo	AccountInfo_	об’єкт; додаткова інформація про аккаунт
adminAccount	AdminAccount	об’єкт; данні по аккаунту в Адмінці

Таблиця 2 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 3 - Опис параметрів об’єкта AdminAccount

Параметр	Формат	Опис
	Об’єкт AdminAccount
id	long	ID аккаунта
product_id	String	id продукта, береться з довідника тарифних продуктів
name	String	назва компанії
own_type	String	форма відповідності
inn	String	ІНН
edrpou	String	код ЕДРПОУ / КПП / БІН
agreement_number	String	номер договору
agreement_date	String	дата договору
status	String	статус договору - „work“, „stop“, „prestop“, „unbill“, „test“, „wait“, „cancel“, „manbill“, „rataile“, „onhold“, „confirmation“, „check“, „tendex“, „block“, „debt_bloc (діючий договір; призупинений договір; ПРИСТОП; не виставляти рахунки; тест; заявка є, чекаєм договір; розірваний; рахунок виставлений вручну; роздр. мережа та інше; чекає підтвердження; на перевірці; TENDEX; неактивний клієнт; дебітор)
email_billing	String	email для рахунків
email_owner	String	email власника компанії
email_responsible	String	email відповідального МРК
email	String	email
phone	String	телефон
nds_cert_num	String	№ свідотства платника НДС
address_legal	String	юридична адреса
address_fact	String	фактична адреса
bank_name	String	банк
bank_account	String	розрахунковий рахунок
bank_mfo	String	МФО банку
director_name	String	ПІП директора
director_position	String	посада директора
operation	String	підстава діяльності
category_id	String	ID категорії аккаунта (для уточнення в випадку дублів)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

{
  "accountId": 8,
  "activityBase": "Царь царей",
  "addInfo": "kjkjаыавы",
  "adminAccount": {
    "address_fact": "Фактический адрес",
    "address_legal": "Юридический адрес",
    "agreement_date": "2018-09-10 00:00:00",
    "agreement_number": "15.08.2018",
    "bank_account": "4634653654665",
    "bank_mfo": "56456",
    "bank_name": "6436",
    "category_id": "0",
    "director_name": "443643646ggg",
    "director_position": "5688888іваіваіва",
    "edrpou": "00000000",
    "email": "alieva@edi.su",
    "id": 1232,
    "inn": "11111111111100",
    "name": "Тесте",
    "nds_cert_num": "-",
    "operation": "111111100000000",
    "own_type": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ",
    "phone": "32623626526",
    "status": "test"
  },
  "adminAccountId": 1232,
  "company": {
    "accountId": 8,
    "atCode": "12363",
    "certNum": "456",
    "certificates": [],
    "code": "34554355",
    "companyId": 4,
    "dictionaries": [],
    "info": "ewdw",
    "inn": "123456789043",
    "isActive": 1,
    "isApproved": 1,
    "isSignedOffer": 1,
    "legalName": "ПрАТ \"Літак\"",
    "name": "Царь Царей",
    "notifySettings": [],
    "ownershipTypeId": 6,
    "phone": "4234234324",
    "prsNum": "43242352",
    "type": 1,
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1"
  },
  "companyId": 4,
  "decryptType": 1,
  "dirPosition": "Оплачено",
  "email": "dfsjfjdsji@meta.ua",
  "fullName": "Ляшенко Евгений",
  "isIndivOffer": 1,
  "phone": "2",
  "status": 1,
  "tariffId": 0,
  "whiteList": []
}

Отримання списку транзакцій

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/transactions
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: trans_status - статус транзакції; можливі значення: «1» - вхідна; «2»- вихідна; «3»- тарифікуєма date_from - дата початку періоду отримання транзакцій; дата в форматі timeStamp date_to - дата закінчення періоду отримання транзакцій; дата в форматі timeStamp Опціональні url-параметри: trans_type - тип транзакції; можливі значення: «1» - відправка документу; «2» - довкладення отримувача company_id - ID компанії, по якій необхідно отримати інформацію limit - ліміт вибірки (за умовчуванням 30; максимальне значення вибірки 50) offset - зміщення відносно верхньої межі вибірки (за умовчуванням 0)

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається об’єкт BillingData зі списком транзакцій.

Таблиця 1 - Опис параметрів об’єкта BillingData

Параметр	Формат	Опис
.._BillingData:	Об’єкт BillingData
chargeableTransCount	long	тарифіковані транзакції
remainsTransCount	int	залишок оплачених транзакцій (базові + регулярні)
baseTransCount	int	кількість оплачених транзакцій за поточний період по базовому тарифному пакету
regularTransCount	int	кількість оплачених транзакцій за поточний період по регулярному тарифному пакету
transCount	long	кількість використаних транзакцій
transactions	List<Transaction_>	список транзакцій

Таблиця 2 - Опис параметрів об’єкта Transaction

Параметр	Формат	Опис
.._Transaction:	Об’єкт Transaction
transId	long	ідентифікатор транзакції
senderId	long	ідентифікатор відправника
recipientId	long	ідентифікатор отримувача
payerId	long	ідентифікатор платника
packageId	long	ідентифікатор комплекту (пакета)
documentId	long	ідентифікатор документу
transDate	long	дата транзакції (в форматі UNIX-timestamp)
transType	int	тип транзакції (1 - відправлений документ; 2 - довкладення отримувача)
transDirection	int	статус транзакції (trans_status); можливі значення: «1» - вхідні; «2» - вихідні; «3» — тарифіковані
isChargeAble	boolean	відмітка Тарифіковані транзакції
senderCompany	Company_	дані компанії відправника
recipientCompany	Company_	дані компанії отримувача
payerCompany	Company_	дані компанії платника (може бути як відправник так і отримувач)

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі

  {
  "chargeableTransCount": 2,
  "transCount": 2,
  "transactions": [
    {
      "transId": 18,
      "packageId": 2114,
      "documentId": 2114,
      "transDate": 1541429099,
      "transType": 1,
      "senderCompany": {
        "companyId": 6,
        "accountId": 10,
        "type": 2,
        "name": "ФІЗИЧНА ОСОБА",
        "inn": "0987654321",
        "code": "3366905914",
        "phone": "432532",
        "info": "выфвфы565",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
        "ownershipTypeId": 0,
        "atCode": "2432423",
        "certNum": "21321321312",
        "uuid": "22345200-abe8-4f60-90c8-0d43c5f6c0f6",
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      },
      "recipientCompany": {
        "companyId": 4,
        "accountId": 8,
        "type": 1,
        "name": "ПрАТ \"Літак\"",
        "inn": "123456789012",
        "code": "34554355",
        "phone": "4234234324",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
        "ownershipTypeId": 4,
        "addCode": "121212",
        "atCode": "12363",
        "prsNum": "43242352",
        "certNum": "456",
        "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      },
      "payerCompany": {
        "companyId": 4,
        "accountId": 8,
        "type": 1,
        "name": "ПрАТ \"Літак\"",
        "inn": "123456789012",
        "code": "34554355",
        "phone": "4234234324",
        "isApproved": 1,
        "isSignedOffer": 1,
        "isActive": 1,
        "ownershipTypeId": 4,
        "addCode": "121212",
        "atCode": "12363",
        "prsNum": "43242352",
        "certNum": "456",
        "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
      }
    }
  ]
}

Отримання PDF рахунку / акту від ТОВ «АТС» за користування сервісом

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

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/payment/invoice - PDF рахунку https://doc.edin.ua/bdoc/payment/act - PDF акту
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: payment_id - ID розрахункового документу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається посилання на скачування печатного макету в форматі pdf відповідного документа.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

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

/bdoc/payment/invoice?payment_id=1272

---

У цьому методі у відповідь передається посилання на скачування печатного макету в форматі pdf відповідного документа

Отримання лог-файлу

1.Відправка запиту на формування лог-файлу

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

Зверніть увагу!

Скачати можливо лог-файл лише за проміжок часу, що не перевищує 1 рік, тобто date_to - date_from < або = 365 днів!

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/log_file_request
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: date_from - ID комплекта документів date_to - якщо потрібен архів документів певного статусу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається request_uuid.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У цьому методі у відповідь передається requestUuid.

{
 "requestUuid": "c7f1354b-93a0-48a7-9b84-5ee50d8f3c6e",
}

2.Отримання посилання на скачування лог-файлу

Метод запиту	HTTPS GET
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/log_file_link
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: request_uuid - uuid отриманий у запиті на формування лог-файлу

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається посилання на скачування лог-файлу;

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

У цьому методі у відповідь передається посилання на скачування.