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

Зміст:

Платформа EDIN

Робота з платформою EDIN

Дана інструкція описує загальні принципи роботи на web-платформі.

Важливо

Увага! Перед початком роботи на web-платформі Вам на пошту надійде лист з даними для доступу.

_images/Instrukcija_po_rabote_s_platformoj_EDIN_01.png

Генерація пароля

Для доступу на портал, необхідно створити пароль, для генерації пароля, відкрийте лист і перейдіть за посиланням для створення пароля з пункту 3:

_images/Instrukcija_po_rabote_s_platformoj_EDIN_02.png

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_03.png

Після збереження пароля, система перенаправить Вас на головну сторінку для входу. Для доступу на web-платформу введіть логін з листа (пункт 2) і придуманий пароль.

_images/Instrukcija_po_rabote_s_platformoj_EDIN_04.png

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

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

Основні папки

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_05.png

Фільтри

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_06.png

Якщо у Вас кілька GLN, переключитися можливо натиснувши на 13-ти значний номер / назва компанії в правому верхньому куті екрану і ввести перші символи номера / назви компанії. Щоб при наступному вході на платформу відображався певний GLN, його потрібно відзначити «зірочкою».

_images/Instrukcija_po_rabote_s_platformoj_EDIN_07.png

Спочатку всі документи, що надійшли на платформу, виділені жирним шрифтом і є в статусі ** «Не прочитані» **. Після перегляду (відкриття) документ стає прочитаним. Повернути його в колишній статус неможливо.

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_08.png

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

  1. Створити ярлик

  2. Перенести в ** «Оброблені» ** (повернути документ назад можливо, зазначивши галочкою)

  3. Надрукувати

  4. Зберегти в форматі Excel

  5. Підписати (в разі, якщо це юридично значимий документ)

  6. Відзначити як прочитаний

  7. Роздрукувати в форматі .PDF

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_09.png

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

  1. Надрукувати документ

  2. Зберегти в форматі Excel

  3. Зберегти в форматі XML

  4. Сформувати відповідні документи

  5. Підписати (в разі, якщо це юридично значимий документ)

  6. Відкрити повний вид документа

  7. Перенести документ в папку «Оброблені»

_images/Instrukcija_po_rabote_s_platformoj_EDIN_10.png

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

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

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_11.png

Завершує список, папка «Документи АТС». Яка містить в собі первинну документацію та податкові накладні від ТОВ «АТС». Документ «Акт наданих послуг», вимагає підписання ЕЦП з вашого боку. Процедура підписання вказана у відповідній інструкції.

Ярлики

Крім основних папок на Web-платформі, є можливість створити «Ярлик» для певних типів документів і мереж. Для цього необхідно натиснути на кнопку «Створити ярлик».

_images/Instrukcija_po_rabote_s_platformoj_EDIN_12.png

Дана функція дозволяє створити окремий ярлик, під певні типи документів, стану документів (прочитані та непрочитані), вибрати розділ «Вхідні», «Відправлені», «Важливі», «Чернетки» або «Оброблені». Так само можна додати GLN номер, певну роздрібну мережу або місце доставки.

_images/Instrukcija_po_rabote_s_platformoj_EDIN_13.png

Після внесення необхідних даних, під стандартними папками на web-платформі з’явиться створений Ярлик з документами за вказаними параметрами.

_images/Instrukcija_po_rabote_s_platformoj_EDIN_14.png

Пошук

Розширений «Пошук»*

_images/Instrukcija_po_rabote_s_platformoj_EDIN_17.png

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

Звичайний «Пошук», і «Розширений пошук»*

_images/Instrukcija_po_rabote_s_platformoj_EDIN_15.png

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

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

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

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

Кнопка налаштувань знаходиться в правому верхньому кутку:

_images/Instrukcija_po_rabote_s_platformoj_EDIN_18.png

В налаштуваннях знаходяться наступні вкладки:

_images/Instrukcija_po_rabote_s_platformoj_EDIN_19.png

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_20.png

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_21.png

Функціонал у вкладці «Біллінг», знаходиться на стадії розробки.

У вкладці «Рахунки» знаходяться документи, виставлені від контрагента. Їх можна надрукувати натиснувши на іконку в колонці «Дії».

_images/Instrukcija_po_rabote_s_platformoj_EDIN_22.png

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_23.png

У вкладці «Реквізити» відображаються реквізити вашої компанії. Після заповнення полів потрібно натиснути кнопку «Надіслати».

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_24.png

Функціонал у вкладці «Мої покупці», знаходиться в на стадії розробки.

Меню

На верхній панелі Web-платформи міститься наступне меню:

_images/Instrukcija_po_rabote_s_platformoj_EDIN_25.png

Розділ «Каталоги» містить в собі:

  • Товарний довідник

  • Каталог транспортних засобів

  • Довідник водіїв

  • Довідник тегів

_images/Instrukcija_po_rabote_s_platformoj_EDIN_26.png

Товарний довідник - необхідний для внесення цін і номенклатури для коректної роботи з відповідними документами по деяких торговельних мереж.

Каталог транспортних засобів - містить в собі довідник автомобілів. Спрощує роботу з деякими сервісами електронного документообігу.

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

Довідник тегів - містить в собі довідник тегів.

Розділ «План поставок» являє собою календар:

_images/Instrukcija_po_rabote_s_platformoj_EDIN_27.png

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_28.png

Функціонал у вкладці «Контрагенти» знаходиться на стадії розробки.

_images/Instrukcija_po_rabote_s_platformoj_EDIN_29.png

Сервіси

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

_images/Instrukcija_po_rabote_s_platformoj_EDIN_30.png

  • EDIN-Certificate

  • Завдання

  • EDIN-Price

  • Статистичні звіти за документами

EDIN-Certificate - Сервіс обміну електронними сертифікатами, дозволяє прикріплювати і обмінюватися сертифікатами якості, експертними висновками, деклараціями виробника та ін.

Завдання - Сервіс, дозволяє масово вивантажувати документи в .PDF форматі;

EDIN-Price - Сервіс узгодження цін в електронному вигляді;

Статистичні звіти за документами - Сервіс знаходиться на стадії розробки.

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

Зміна Логіна і Пароля на EDIN

1. Вхід на платформу EDIN

Для входу на web платформу EDIN необхідно перейти за посиланням: https://edo.edi-n.com

На початковій сторінці необхідно ввести Логін та Пароль доступу та натиснути кнопку “Вхід”.

_images/vosstanovlenie_parolja_na_platforme_EDIN_01.png

2. Відновлення Паролю (в разі втрати пароля)

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

  1. На сторінці входу необхідно натиснути кнопку “Нагадати пароль” .

_images/vosstanovlenie_parolja_na_platforme_EDIN_02.png

  1. Далі з’явиться сторінка відновлення паролю, де потрібно вказати “Логін” для якого потрібно виконати відновлення та натиснути “Відправити”.

_images/vosstanovlenie_parolja_na_platforme_EDIN_03.png

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

Для генерации нового пароля перейдитепо ссылке: https://edo.edi-n.com/access?event……..

_images/vosstanovlenie_parolja_na_platforme_EDIN_04.png

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

3. Встановлення нового пароля (якщо пароль відомий)

Розглянемо ситуацію, коли пароль доступу до входу на платформу EDIN вам відомий, але вам необхідно його змінити.

  1. Вам необхідно увійти на платформу EDIN. В правому верхньому куті перейти до налаштувань.

_images/vosstanovlenie_parolja_na_platforme_EDIN_05.png

  1. Перейти на сторінку «Мої налаштування». В полі змінення паролю внести необхідні данні та натиснути «Зберегти зміни».

_images/vosstanovlenie_parolja_na_platforme_EDIN_06.png

4. Редагування Логіна і Пароля (для нового користувача)

  1. Вам необхідно увійти на платформу EDIN. В правому верхньому куті перейти до налаштувань.

_images/vosstanovlenie_parolja_na_platforme_EDIN_07.png

  1. Перейти на сторінку «Користувачі». Вибрати Логін для якого необхідно внести зміни.

_images/vosstanovlenie_parolja_na_platforme_EDIN_08.png

На сторінці редагування можливо змінити:

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

  2. Змінити Логін Користувача.

  3. Додати або змінити існуючу ел.пошту.

_images/vosstanovlenie_parolja_na_platforme_EDIN_09.png

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

Заповнення Товарного Довідника

Вступ

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

Заповнити Товарний Довідник на Web-платформі можна декількома способами:

Вручну на платформі, Через шаблон .CSV, Через шаблон .XLS. Нижче будуть наведені приклади усіх способів.

Заповнення Товарного Довідника вручну

Для переходу до заповнення Товарного довідника, необхідно перейти в розділ «Меню» -> «Довідники» -> «Товарний Довідник»

_images/zapolnenie_tovarnogo_spravochnika_01.png

Для того щоб додати товарної позиції, натисніть на кнопку «+».

_images/zapolnenie_tovarnogo_spravochnika_02.png

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

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

_images/zapolnenie_tovarnogo_spravochnika_03.png

  1. Найменування* - вкажіть найменування товарної позиції.

  2. Штрих-код* - вкажіть штрихкод позиції.

  3. Ціна* - вкажіть ціну без ПДВ.

  4. Од.вим.* - зі списку виберіть одиницю.

  5. ПДВ* - Вкажіть ставку ПДВ.

  6. ТМ - вкажіть, до яких торговельних мереж буде відноситись даний товар. За замовчуванням стоїть значення «Всі».

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

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

_images/zapolnenie_tovarnogo_spravochnika_04.png

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

Позиції з позначкою ТМ будуть відображатися в довіднику з найменуванням мережі в квадратних дужках після найменування.

_images/zapolnenie_tovarnogo_spravochnika_05.png

Завантаження Товарного Довідника через шаблон

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

_images/zapolnenie_tovarnogo_spravochnika_06.png

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

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

Важливо

Зверніть увагу! Коди «Одиниць вимірювань» і Коди «Ставок ПДВ» потрібно заповнити згідно таблиці, яка розташована в центральній частині екрану

_images/zapolnenie_tovarnogo_spravochnika_07.png
Заповнення ТД за допомогою шаблону .csv

Важливо

Якщо Ваша програма не підтримує формат .csv (або файл відображається некоректно), ви можете встановити безкоштовний пакет офісних програм LibreOffice перейшовши за посиланням: http://free-software.com.ua/office/libreoffice/

_images/zapolnenie_tovarnogo_spravochnika_08.png

Для того щоб завантажити шаблон, натисніть на кнопку ** «Шаблон ТД.CSV» **. Після чого почнеться скачування файлу.

Відкрийте порожній файл Excel, після чого натисканням на кнопку «Файл» -> «Відкрити» відкрийте завантажений шаблон.

_images/zapolnenie_tovarnogo_spravochnika_09.png

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

_images/zapolnenie_tovarnogo_spravochnika_10.png

Для коректного відкриття документа вкажіть в полі Кодування - «Кирилиця (Windows-1251)», в полі Параметри роздільник - «Кома / Крапка з комою» і в полі Інші параметри - «Розпізнавати будь-які числа», і натисніть клавішу ОК.

Відкрийте завантажений файл Excel і заповніть обов’язкові колонки, виділені кольором, згідно з інструкцією на сайті:

_images/zapolnenie_tovarnogo_spravochnika_11.png

Після заповнення таблиці, збережіть файл на робочий стіл.

Завантаження шаблону Товарного Довідника

Для завантаження шаблону необхідно повернутися в Товарний Довідник і натиснути на кнопку «Завантажити Шаблон» (при необхідності, відзначте роздрібну мережу, для якої ви хочете завантажити довідник).

_images/zapolnenie_tovarnogo_spravochnika_12.png

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

Позиції з позначкою ТМ будуть відображатися в довіднику з найменуванням мережі в квадратних дужках після найменування.

_images/zapolnenie_tovarnogo_spravochnika_13.png
Заповнення ТД за допомогою шаблону .xls

Для того щоб завантажити шаблон, натисніть на кнопку «Шаблон ТД XLS», після чого почнеться скачування файлу.

_images/zapolnenie_tovarnogo_spravochnika_14.png

Відкрийте завантажений файл Excel і заповніть обов’язкові колонки, виділені кольором, згідно з інструкцією на сайті:

_images/zapolnenie_tovarnogo_spravochnika_15.png

Після заповнення шаблону, збережіть файл на робочий стіл.

Для завантаження шаблону необхідно повернутися в Товарний Довідник і натиснути на кнопку «Завантажити Шаблон» (при необхідності, відзначте роздрібну мережу, для якої ви хочете завантажити довідник).

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

Позиції з позначкою ТМ будуть відображатися в довіднику з найменуванням мережі в квадратних дужках після найменування.

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

Підписання документів ЕЦП на web-платформі

Підписання документа на web-платформі

Для підписання документів на Web-платформі, необхідно відкрити потрібний юридично значущий документ і натиснути кнопку «Підписати».

_images/01.png

Для первинного налаштування ЕЦП, дочекайтеся завантаження сторінки, а потім натисніть кнопку «Зчитати ключі».

_images/02.png

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

_images/03.png

Види файлів електронно-цифрового підпису

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2, і наступні значення в іменах файлів:

  • Директор «DS»

  • Бухгалтер «BS»

  • Співробітник «SS»

  • Печатка «S»

  • Шифрування «C»

  • Універсальний ключ печатки і шифрування «U»

_images/04.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секрентних ключів мають найменування Key-6.dat.

_images/06.png

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

_images/07.png

При коректному зчитуванні ключів, в блоці «ЕЦП» з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку «Підписати».

_images/08.png

Після підписання натисніть на кнопку «Відправити».

_images/09.png

Робота з веб-платформою EDIN-OBMIN

Инструкція по формуванню і відправленню документа Договір на веб-платформі EDIN-OBMIN

Структура веб-платформи EDIN-OBMIN

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

  1. Зліва побачите каталоги, в яких будуть розміщені відповідні документи:

  • Вхідні – знаходяться всі вхідні документи

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

  • Важливі – знаходяться документи, які ви відмітите, як важливі (поруч з документом натиснути зірку)

  • Чернетки – знаходяться всі збережені документи

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_01.png

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

  1. Над документами розміщена пошукова панель, де можна фільтрувати документи за принципом:

  • Всі, Прочитані, Не прочитані

  • Всі документи або по типу документу

  • По імені документу, попередньо внести дані в пошукове поле і натиснути кнопку “Пошук»

  • Натиснувши копку “Пошук *», можна ввести у випадаючому вікні більше реквізитів для пошуку

  • Натиснувши кнопку скидання иконка-удалить ви видалите всі введені фільтри

  • Натиснувши кнопку “Створити ярлик» ви зможете створити власний каталог для фільтрації документів

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_02.png

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_03.png

  1. В правому верхньому куті відтворюється назва вашого підприємства і GLN номер.

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_04.png

Заповнення карти підприємства

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_05.png

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_06.png

Обов’язковими полями для заповнення є поля відмічені “червоною зіркою», а також «Менеджер» і «Директор»:

  • Код ЄДРПОУ

  • Код ІПН

  • Компані

  • Індекс (юр. адреса)

  • Місто (юр. Адреса)

  • Адреса (юр. Адреса, вулиця, будинок)

  • Часова зона

  • Країну (обирайте з списку)

  • Область (обирайте з списку)

  • ДПІ (обирайте з списку податкову, в яку подаєте звітність)

  • Телефон

  • Менеджер (вказати відп.особу на вашому підприємстві)

  • Форма власності

  • Директор

  • Бухгалтер

  • Підписант

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

Налаштування ЕЦП

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_07.png

Відкриється Провідник, де необхідно буде вказати каталог з секретними ключами і обрати ключі. Якщо ключі отримані в АЦСК ІДД (ДФС), тоді необхідно вибирати ключі (key-6.dat).

Якщо ви використовуєте для підписання ключі АЦСК «Україна», тоді вид ключів такий:

  • Ключ директора: ЄДРПОУ_ІНН підписанта_D1111111.ZS2

  • Ключ бухгалтера: ЄДРПОУ_ІНН підписанта _B1111111.ZS2

  • Ключ печатки: ЄДРПОУ_S1111111.ZS2 (ЄДРПОУ _U1111111.ZS2)

  • Ключ шифрування: ЄДРПОУ_С1111111.ZS2 (ЄДРПОУ _U1111111.ZS2)

Після того, як ключ обраний, зʼявляється вікно, в якому необхідно ввести пароль і натиснути кнопку Зчитати:

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_08.png

Коли ключі считані, у вікні ЕЦП можна буде побачити інформацію щодо ЕЦП:

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_09.png

Створення документа Договір

Для того, щоб створити Договір необхідно натиснути на кнопку Створити і з контекстного меню обрати Коммерційний документ- Договір

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_10.png

Відкриється форма для заповнення. Обовʼязковими полями для заповнення є ті, що відмічені “червоною зіркою»:

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_11.png

Після заповнення обов’язкових полів ви можете внести основну інформацію по Договору в поле Текст документа. Також ви можете внести Термін дії документа і вказати Період підписання документа. Якщо в документ внесена уся необхідна інформація, то після цього натискаємо кнопку Зберегти.

Відправка документа Договір

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_12.png

Підписання документа Договір

Для того, щоб підписати документ ЕЦП, необхідно натиснути кнопку Підписати.

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_13.png

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_14.png

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

  • Директор - 1

  • Печатка - 2

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_15.png

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_16.png

Отримання документа Договір і підписання його з боку одержувача

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_17.png

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

Потім, щоб підписати його, потрібно натиснути кнопку Підписати:

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_18.png

і у полі ЕЦП, що відкриється, повторно натиснути зелену кнопку Підписати:

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_19.png

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_20.png

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

  • Директор - 1

  • Печатка - 2

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_21.png

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_22.png

Друк документа

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

_images/pics_Robota_z_web-platformoju_EDIN-OBMIN_23.png

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

Вступ

Інструкція описує етапи підписання комерційних документів окремо та массово на платформі OBMIN.

Вхід на платформу

Для входу на платформу необхідно перейти за посиланням https://obmin.edi-n.com/. На сторінці, введіть логін і пароль для доступу в систему.

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_01.png

«Налаштування ЕЦП»

Налаштування ЕЦП

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

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_02.png

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

Якщо ключі отримані в АЦСК ІДД (ДФС), тоді необхідно вибирати ключі (key-6.dat). Якщо ви використовуєте для підписання ключі АЦСК «Україна», тоді види ключів наступні:

  • Ключ директора: ЄДРПОУ_ІНН підписанта_D1111111.ZS2

  • Ключ бухгалтера: ЄДРПОУ_ІНН підписанта _B1111111.ZS2

  • Ключ печатки: ЄДРПОУ_S1111111.ZS2 (ЄДРПОУ _U1111111.ZS2)

  • Ключ шифрування: ЄДРПОУ_С1111111.ZS2 (ЄДРПОУ _U1111111.ZS2)

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

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_03.png _images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_04.png

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

На платформі OBMIN є можливість підписувати комерційні документи окремо та масово.

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

Для вибору необхідного документа є можливість скористатися фільтрами, які відображаються над документами:

  • Перший фільтр відображає всі, прочитані і непрочитані документи;

  • Другий фільтр дозволяє вибрати конкретний тип документа;

Після того як Ви оберете потрібний Вам документ, натисніть на нього для відкриття. Для того, щоб підписати документ ЕЦП, необхідно натиснути кнопку Підписати.

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_05.png

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

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_06.png

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

  • Директор - 1

  • Печатка - 2

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_07.png

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

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_08.png
Масове підписання документів

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

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

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_09.png

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

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_10.png

У разі якщо ЕЦП не налаштовано, поверніться до Пункту «Налаштування ЕЦП» даної інструкції.

_images/Pidpis_komercijnih_dokumentiv_na_platformi_OBMIN_11.png

Довідник торгових мереж

Довідник торгових мереж України

Інструкція з пошуку документів на веб-платформі

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

  1. перший фільтр (всі, прочитані, не прочитані) не відповідає тому статусу, в якому зараз документ;

  2. неправильно введений номер документа при пошуку;

  3. не вірно вибраний GLN-номер компанії на який мав надійти документ.

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

Використовуємо фільтр

Увага

Починайте пошук документа переконавшись, що вибрано вірний GLN-номер Вашої компанії.

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

  • Напрямок документа: Вхідний, Відправлений

  • Статус документа: Прочитаний, Непрочитаний, Всі

  • Торгова мережа: (Приклад: Новус, Велика Кишеня)

  • Тип документа: (Приклад: Замовлення, Комерційний документ)

  • Номер документа

_images/instruktsiya_z_poshuku_dokumentiv_01.png

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

Пам’єтаємо про архівні документи

_images/instruktsiya_z_poshuku_dokumentiv_02.png

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

  • Архів АТС (період з 01.06.2018)

  • Архів (період до 01.06.2018)

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

  • Тип документа (Приклад: Замовлення)

  • Торгова мережа (Приклад: Новус, Велика Кишеня)

  • Період (місяць)

  • Номер документа

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

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

Формування документів EDIN

Формування та відправка документа «Підтвердження замовлення» (ORDRSP) на платформі

Вступ

Дана інструкція описує порядок формування та відправки документа «Підтвердження замовлення» (ORDRSP).

Підтвердження замовлення

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

_images/formirovanie_ORDRSP_01.png _images/formirovanie_ORDRSP_02.png

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

_images/formirovanie_ORDRSP_03.png

  1. Номер - може співпадати з номером Замовлення

  2. Дата - дата підтвердження, автоматично вказується поточна дата

  3. Дата Замовлення - автоматично переноситься з Замовлення

  4. Підтверджена дата поставки - переноситься из Замовлення (якщо з мережею погоджене перенесення - змініть її)

  5. Дії - вибирається з наступних: Буде доставлено, Зміни кількості, або Відмовлено

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

_images/formirovanie_ORDRSP_04.png

Система автоматично в колонку «Підтверджено» підставляє значення аналогічне замовленому, а в колонку «Дії» статус «Буде доставлено».

Редагування товарних позицій

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

Важливо

Увага! Кількість підтвердженних товарных позиций не може перевищувати кількість зазначену в замовленні!

Якщо якась із позицій відсутня і поставлятися не буде, в колонці «Дії», виберіть пункт «Відмовлено», значення в колонці «Кількість» автоматично буде змінена на 0.

_images/formirovanie_ORDRSP_05.png

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

_images/formirovanie_ORDRSP_06.png

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

Формування документа «Повідомлення про відвантаження» (DESADV) на платформі

Вступ

Дана інструкція описує порядок формування та відправки документа «Повідомлення про відвантаження» (DESADV).

Формування Повідомлення про відвантаження (DESADV)

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

Розглянемо формування «Повідомлення про відвантаження» на підставі «Підтвердження замовлення».

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

_images/formirovanie_DESADV_01.png

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

_images/formirovanie_DESADV_02.png

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

  1. Номер* - номер «Повідомлення про відвантаження» по даному замовленню (номер Замовлення встановлюється автоматично)

  2. Дата - дата повідомлення про відвантаження, автоматично встановлюється поточна дата

  3. Дата доставки - переноситься з Замовлення (якщо з мережею погоджено перенесення - змініть її)

  4. № Замовлення - автоматично переноситься з Замовлення

  5. Дата Замовлення - автоматично переноситься з Замовлення

  6. № накладної - номер видаткової накладної

  7. Дата накладної - дата видаткової накладної

Важливо

Увага! Номер накладної повинен повністю збігатися з номером оригіналу паперової накладної**.

_images/formirovanie_DESADV_03.png

Важливо

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

Ниже на странице созданного документа находится перечень товарных позиций, которые были заказаны, и их количество:

_images/formirovanie_DESADV_04.png

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

Редагування товарних позицій

За потреби є можливість змінити кількість товару, що поставляється, в колонці «Кількість, що поставляється».

Важливо

Увага! Кількість товарных позиций, що поставляється не може перевищувати кількість зазначену в замовленні!

Якщо якась із позицій відсутня і поставлятися не буде, в колонці «Кількість, що поставляється», вкажіть 0.

_images/formirovanie_DESADV_05.png

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

_images/formirovanie_DESADV_06.png

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

Формування та відправка документа «Рахунок фактура» (INVOICE) на web-платформі

Вступ

Дана інструкція описує порядок формування та відправки документа «Рахунок фактура» (INVOICE).

Формування документа «Рахунок фактура»

Створення документа відбувається на підставі «Замовлення».

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

_images/formirovanie_INVOICE_01.png

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

_images/formirovanie_INVOICE_02.png

У вікні з’явиться Форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою * обов’язкові для заповнення.

Заповнення документа «Рахунок фактура»

Важливо

Увага! Номер накладної повинен повністю співпадати з номером оригіналу паперової накладної.

  1. Номер* - номер рахунку по даному замовленню. Автоматично вказано номер замовлення.

  2. Дата - дата рахунку. Автоматично вказана поточна дата.

  3. Валюта - за замовчуванням «гривня»

  4. № замовлення - автоматично переноситься з Замовлення.

  5. № накладної - номер видаткової накладної

_images/formirovanie_INVOICE_03.png

Важливо

Увага! У разі створення декількох видаткових накладних, необхідно на кожне замовлення сформувати рахунок фактуру. При цьому, поле «Номер накладної» в документах повинно відрізнятися.

_images/formirovanie_INVOICE_04.png

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

_images/formirovanie_INVOICE_05.png

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

Редагування товарних позицій

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

Важливо

Увага! Кількість товарных позиций, що поставляється не може перевищувати кількість зазначену в замовленні!

Якщо якась із позицій відсутня і поставлятися не буде, її необхідно відзначити галочкою і видалити.

_images/formirovanie_INVOICE_06.png

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

_images/formirovanie_INVOICE_07.png

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

Формування документа «Додаток до повідомлення про відвантаження» (QUOTES) на платформі

Вступ

Дана інструкція описує порядок формування та відправки документа «Додаток до повідомлення про відвантаження» (QUOTES).

Формування документа «Додаток до повідомлення про відвантаження» (QUOTES)

Формування документа відбувається на підставі «Повідомлення про відвантаження».

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

_images/011.png

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

_images/021.png

У вікні з’явиться Форма c даними, які переносяться з відповідного Повідомлення про відвантаження. Всі поля, позначені червоною зірочкою * обов’язкові для заповнення.

_images/036.png

  1. Номер документа - переноситься з відповідного Повідомлення про відвантаження.

  2. Дата документа - переноситься з відповідного Повідомлення про відвантаження.

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

Додавання серійних номерів до товарних позицій

Внесити дані можливо декількома способами: вручну, або через шаблон .xls. Нижче описані приклади обох способів.

Додавання номерів вручну

Якщо за товарною позицією буде відвантажено кількість в розмірі однієї одиниці товару, то вам необхідно заповнити поле в колонці «Серійний номер».

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

_images/041.png

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

_images/05.png
Додавання номерів через шаблон .xls

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

_images/061.png

Відкрийте порожній файл Excel, після чого натисканням на кнопку «Файл» -> «Відкрити» відкрийте завантажений шаблон.

_images/071.png

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

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

_images/081.png

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

_images/091.png

Для збереження документа натискаємо на кнопку «Зберегти», а потім - «Відправити».

_images/105.png

Формування документа «Інструкція з транспортування» (IFTMIN) на платформі

Вступ

Дана інструкція описує порядок формування та відправки документа «Інструкція з транспортування» (IFTMIN).

Формування документа «Інструкція з транспортування» (IFTMIN)

Створення документа відбувається на підставі «Замовлення».

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

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_01.png

У відкритому документі, натисніть кнопку «Сформувати» і виберіть зі списку документ «Інструкція з транспортування».

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_02.png

У вікні з’явиться Форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою * обов’язкові для заповнення.

Заповнення документа (IFTMIN)

  1. Номер документа повинен бути наступного формату X_Y, де:

  • Х - це порядковий номер машини, на поставку

  • Y - це загальна кількість машин, на поставку

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

Мінімальна к-ть 1, Максимальна - 99. Х повинен бути менше або рівним Y. Наприклад: 2_5

  1. Дата - фактична дата відправки поставки

  2. Номер замовлення - підтягується автоматично із замовлення

  3. Фактична кількість палет - кількість палет, що відвантажується в вантажний транспорт

  4. Максимальна кількість палет - максимальна місткість палет (вантажний транспорт)

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

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_03.png

После внесения всех данных в документе, нажмите кнопку «Сохранить», затем «Отправить».

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_04.png

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

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

Вступ

Дана інструкція описує порядок формування та відправки документа «Універсальний документ» (CONDRA).

Формування Універсального документа

Для того, щоб сформувати «Універсальний документ» (CONDRA) необхідно скористатися функціоналом створення документа.

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

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_01.png

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

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_02.png

  1. Номер — довільний номер, який присвоюється документу.

  2. Дата — дата документа, автоматично вказана поточна дата.

  3. Тип документа — необхідно вибрати зі списку потрібний тип документа.

  4. Файл — вкладення, що відповідає зформованому документу.

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

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

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_03.png

Підписання документа

Для первинного налаштування ЕЦП, дочекайтеся завантаження сторінки, а потім натисніть кнопку “Зчитати ключі”.

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_04.png

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

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_05.png

Види файлів електронно-цифрового підпису

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів:

  • Директор «DS»

  • Бухгалтер «BS»

  • Співробітник «SS»

  • Печатка «S»

  • Шифрування «C»

  • Універсальний ключ печатки і шифрування «U»

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_06.png

Якщо Ви використовуєте ключі від АЦСК “ПриватБанк”, файли підписів секрентних ключів мають розширення .jks:

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_07.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секрентних ключів мають найменування Key-6.dat:

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_08.png

Після вибору секретних ключів, введіть паролі під кожним з них, а потім натисніть кнопку “Зчитати ключі”.

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_09.png

При коректному зчитуванні ключів, в блоці “ЕЦП” з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку “Підписати”.

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_10.png

Після підписання натисніть на кнопку “Відправити”.

_images/Rabota_s_dokumentom_Universalnyj_dokument_CONDRA_11.png

Загальна інструкція по роботі з Комерційним документом COMDOC

Вступ

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

Прийняття комерційного документа

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

_images/rabotа_s_COMDOC_1.png

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

_images/rabotа_s_COMDOC_2.png

Непрочитані документи не підсвічуються, їх необхідно відкрити або відзначити, як прочитані.

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

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

_images/rabotа_s_COMDOC_3.png

Для первинного налаштування ЕЦП, дочекайтеся завантаження сторінки, а потім натисніть кнопку “Зчитати ключі”.

_images/rabotа_s_COMDOC_4.png

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

_images/rabotа_s_COMDOC_5.png

Види файлів електронно-цифрового підпису

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів:

  • Директор «DS»

  • Бухгалтер «BS»

  • Співробітник «SS»

  • Печатка «S»

  • Шифрування «C»

  • Універсальний ключ печатки і шифрування «U»

_images/rabotа_s_COMDOC_6.png

Якщо Ви використовуєте ключі від АЦСК “ПриватБанк”, файли підписів секрентних ключів мають розширення .jks

_images/rabotа_s_COMDOC_7.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секрентних ключів мають найменування Key-6.dat

_images/rabotа_s_COMDOC_8.png

Після вибору секретних ключів, введіть паролі під кожним з них, а потім натисніть кнопку “Зчитати ключі”

_images/rabotа_s_COMDOC_9.png

При коректному зчитуванні ключів, в блоці “ЕЦП” з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку “Підписати”.

_images/rabotа_s_COMDOC_10.png

Після підписання натисніть на кнопку “Відправити”.

_images/rabotа_s_COMDOC_11.png

Формування Комерційного документа «Видаткова накладна» (COMDOC_006)

Вступ

Дана інструкція описує порядок формування, підписання та відправки Комерційного документа «Видаткова накладна».

Важливо

Увага! Для коректного формування документа Видаткова накладна (Comdoc), необхідно заповнити Товарний довідник. Ви можете переглянути Інструкцію щодо заповнення довідника.

Видаткова накладна (Comdoc)

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

Далі, перейдіть в розділ «Налаштування» (у правому верхньому куті):

_images/formirovanie_Rashodnoj_nakladnoj_01.png

Натисніть на закладку «Мої компанії» і виберіть GLN, з якого буде відбуватись відправка документів.

_images/formirovanie_Rashodnoj_nakladnoj_02.png

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

Важливо

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

_images/formirovanie_Rashodnoj_nakladnoj_03.png

Формування документа Видаткова накладна

Створити видаткову накладну можливо трьома способами:

  1. На підставі Замовлення (ORDERS)

  2. На підставі Повідомлення про відвантаження (DESADV)

  3. На підставі Повідомлення про прийом (RECADV)

*Рекомендується формувати документ «Видаткова накладна» (COMDOC) на підставі «Повідомлення про відвантаження» (DESADV).*

Нижче наведено приклад формування Витратною накладної на підставі відправленого документа, Повідомлення про відвантаження (DESADV).

Для формування документа Видаткова накладна, необхідно перейти в розділ “Відправлені”.

_images/formirovanie_Rashodnoj_nakladnoj_04.png

Відкрити документ «Повідомлення про відвантаження» і натиснути кнопку «Сформувати», потім вибрати зі списку документ “Видаткова накладна”

_images/formirovanie_Rashodnoj_nakladnoj_05.png

Заповнення документа Видаткова накладна

У відкритому документі, необхідно заповнити обов’язкові дані, позначені червоною зірочкою * , в кожному з блоків.

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

_images/formirovanie_Rashodnoj_nakladnoj_06.png

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

_images/formirovanie_Rashodnoj_nakladnoj_07.png

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

_images/formirovanie_Rashodnoj_nakladnoj_08.png

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

_images/formirovanie_Rashodnoj_nakladnoj_09.png

Дев’ятий блок містить інформацію про товарні позиції, які поставляються.

_images/formirovanie_Rashodnoj_nakladnoj_10.png

Даний блок містить такі колонки:

  • Найменування – дані заповнюються автоматично з документа підстави

  • Штрихкод - дані заповнюються автоматично з документа підстави

  • Код УКТЗЕД - дані заповнюються автоматично з товарного довідника

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

  • Од. Вим. - дані заповнюються автоматично з товарного довідника

  • Ціна без ПДВ - дані заповнюються автоматично з документа підстави

  • Ціна з ПДВ - дані заповнюються автоматично з документа підстави

  • Артикул покупця - дані заповнюються автоматично з документа підстави

  • Артикул продавця- дані заповнюються автоматично з товарного довідника

Після внесення всіх даних в документ, переконайтеся в їх коректності та натисніть кнопку “Зберегти”.

_images/formirovanie_Rashodnoj_nakladnoj_11.png

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

Після Збереження документа, його необхідно підписати Електронно-Цифровим підписом (ЕЦП).

_images/formirovanie_Rashodnoj_nakladnoj_12.png

Для первинного налаштування ЕЦП, дочекайтесь завантаження сторінки, а потім натисніть кнопку “Зчитати ключ”.

_images/formirovanie_Rashodnoj_nakladnoj_13.png

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

_images/formirovanie_Rashodnoj_nakladnoj_14.png

Види файлів електронно-цифрового підпису

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів:

  • Директор «DS»

  • Бухгалтер «BS»

  • Співробітник «SS»

  • Печатка «S»

  • Шифрування «C»

  • Універсальний ключ печатки і шифрування «U»

_images/formirovanie_Rashodnoj_nakladnoj_15.png

Якщо Ви використовуєте ключі від АЦСК “ПриватБанк”, файли підписів секрентних ключів мають розширення .jks:

_images/formirovanie_Rashodnoj_nakladnoj_16.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секрентних ключів мають найменування Key-6.dat:

_images/formirovanie_Rashodnoj_nakladnoj_17.png

Після вибору секретних ключів, введіть паролі під кожним з них, а потім натисніть кнопку “Зчитати ключі”

_images/formirovanie_Rashodnoj_nakladnoj_18.png

При коректному зчитуванні ключів, в блоці “ЕЦП” з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку “Підписати”.

_images/formirovanie_Rashodnoj_nakladnoj_19.png

Після підписання натисніть на кнопку “Відправити”.

_images/formirovanie_Rashodnoj_nakladnoj_20.png

Статуси відправлених документів

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

_images/formirovanie_Rashodnoj_nakladnoj_21.png

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

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

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

Приклад коректного статусу:

_images/formirovanie_Rashodnoj_nakladnoj_22.png

Приклад некоректного статусу:

_images/formirovanie_Rashodnoj_nakladnoj_23.png

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

Формування Податкової Накладний на підставі Прибуткової накладної (COMDOC_007)

Початкові налаштування

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

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

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

1.3. Зайти на портал: http://edo.edi-n.com і ввести логін і пароль:

_images/formirovanie_NN_01.png

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

_images/formirovanie_NN_02.png

1.5. Перейти в розділ «Налаштування» (в правому верхньому куті):

_images/formirovanie_NN_03.png

1.6. Перейти в закладку «Мої компанії» і вибрати GLN, з якого відбуватиметься відправка накладних:

_images/formirovanie_NN_04.png

Важливо

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

_images/formirovanie_NN_05.png

Необхідно вказати:

  • Код ЄДРПОУ

  • Код ІПН

  • Правильну назву компанії

  • № свідоцтва платника ПДВ

  • Вулицю і будинок (юр. адреса)

  • Індекс (юр. адреса)

  • Місто (юр. Адреса)

  • Країну (вибирайте зі списку Україну)

  • Область (вибирайте зі списку)

  • ДПІ (вибирайте зі списку податкову, в яку подаєте звітність)

  • Менеджер (можна вказати «-»)

  • Бухгалтер (П.І.Б. головного бухгалтера)

  • Директор (П.І.Б. директора)

  • Посада (посада директора: генеральний, виконавчий, директор)

  • Підписант (П.І.Б. та ІПН підписувача)

  • Телефон

  • Форма власності (юр. чи фіз. особа)

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

Формування Податкової накладної

Перед створенням Податкової накладної рекомендується перевірити товарний довідник, тому що інформація по позиціях підтягується саме з нього. Він знаходиться в правому верхньому кутку:

_images/formirovanie_NN_06.png

2.1. Перейдіть в пункт меню «Відправлені»:

_images/formirovanie_NN_07.png

2.2. Виберіть підписаний і вже відправлений «Комерційний документ» Прибуткова накладна, на підставі якого будете формувати і відправляти електронну Податкову накладну.

_images/formirovanie_NN_08.png

2.3. Далі в відритому «Комерційному документі» необхідно натиснути на кнопку Сформувати —> Податкова накладна.

_images/formirovanie_NN_09.png

2.4. Всі необхідні поля для заповнення позначені червоними зірочками *. Також важливо попозиційно вносити код УКТ ЗЕД:

_images/formirovanie_NN_10.png

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

_images/formirovanie_NN_11.png

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

_images/formirovanie_NN_12.png

2.7. Після натискання кнопки «Відправити» ЕПН відправляється на реєстрацію до Єдиного реєстру податкових накладних.

_images/formirovanie_NN_13.png

Отримання квитанції про реєстрацію

3.1. Після відправки податкової накладної необхідно дочекатися отримання Квитанції №1 з ЄРПН. Існує два статуси: «Зареєстровано в ЄРПН і відправлено покупцеві» и «Помилка при реєстрації в ЄРПН».

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

retail/pics_formirovanie_Nalogovoj_Nakladnoj_na_osnovanii_Prihodnoj_nakladnoj/formirovanie_NN_14.png

3.3. Натиснути кнопку «Зчитати» під написом «Квитанція №1».

_images/formirovanie_NN_15.png

3.4. Після розшифровки текст квитанції стане доступний для читання. Її можна вивантажити в форматі .rpl (можливе завантаження в M.E.Doc), .pdf, а також роздрукувати.

_images/formirovanie_NN_16.jpg

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

Для формування документа необхідно натиснути «Створити» і вибрати «Податкова накладна»:

_images/formirovanie_NN_17.png

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

_images/formirovanie_NN_18.png

Щоб вибрати покупця, натисніть на «Вибрати контрагента» - «Пошук контрагента» і введіть в поле GLN (наприклад, «9863577638028») і натисніть «Знайти», а потім «Вибрати»:

_images/formirovanie_NN_19.png

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

_images/formirovanie_NN_20.png

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

_images/formirovanie_NN_21.png

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

_images/formirovanie_NN_22.png

Після внесення інформації натисніть «Зберегти».

_images/formirovanie_NN_23.png

Після додавання всіх товарних позицій використовуйте кнопки «Зберегти», «Підписати», «Надіслати».

Формування Коригувальної ПН на підставі Накладної на повернення

Початкові налаштування

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

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

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

1.3. Зайти на портал: http://edo.edi-n.com і ввести логін і пароль.

_images/formirovanie_Korrektirovochnoj_NN_01.png

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

_images/formirovanie_Korrektirovochnoj_NN_02.png

1.5. Перейти в розділ «Налаштування» (в правому верхньому куті):

_images/formirovanie_Korrektirovochnoj_NN_03.png

1.6. Перейти в закладку «Мої компанії» і вибрати GLN, з якого відбуватиметься відправка накладних:

_images/formirovanie_Korrektirovochnoj_NN_04.png

Необхідно вказати:

  • Код ЄДРПОУ

  • Код ІПН

  • Правильну назву компанії

  • № свідоцтва платника ПДВ

  • Вулицю і будинок (юр. адреса)

  • Індекс (юр. адреса)

  • Місто (юр. Адреса)

  • Країну (вибирайте зі списку Україну)

  • Область (вибирайте зі списку)

  • ДПІ (вибирайте зі списку податкову, в яку подаєте звітність)

  • Менеджер (можна вказати «-»)

  • Бухгалтер (П.І.Б. головного бухгалтера)

  • Директор (П.І.Б. директора)

  • Посада (посада директора: генеральний, виконавчий, директор)

  • Підписант (П.І.Б. та ІПН підписувача)

  • Телефон

  • Форма власності (юр. чи фіз. особа)

_images/formirovanie_Korrektirovochnoj_NN_05.png

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

Формування документа «Коригування до Податкової накладної (DECLAR_J12)»

Даний документ формується на підставі Комерційного документа (СOMDOC) “Накладна на повернення”.

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

_images/formirovanie_Korrektirovochnoj_NN_06.png

Перед відправкою коригування необхідно підписати і відправити Комерційний документ «Накладна на повернення».

Для того, що б сформувати документ “Коригування до Податкової накладної”, необхідно зайти в Комерційний документ “Накладна на повернення”.

Далі необхідно натиснути на кнопку Сформувати —> Коригування податкової накладної.

_images/formirovanie_Korrektirovochnoj_NN_07.png

Заповнення документа «Коригування до Податкової накладної (DECLAR_J12)»

Всі необхідні поля для заповнення позначені червоними зірочками *.

_images/formirovanie_Korrektirovochnoj_NN_08.png

В випадаючому списку Причина коригування* обов’язково необхідно вибрати відповідний параметр.

_images/formirovanie_Korrektirovochnoj_NN_09.png

Розділ А розраховується автоматично за умови наявності відповідної галочки в чекбоксі.

_images/formirovanie_Korrektirovochnoj_NN_10.png

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

_images/formirovanie_Korrektirovochnoj_NN_11.png

Всі інші поля ви заповнюєте самостійно згідно чинного податкового законодавства України.

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

_images/formirovanie_Korrektirovochnoj_NN_12.png

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

_images/formirovanie_Korrektirovochnoj_NN_13.png

Після натискання кнопки «Надіслати» накладна відправляється на реєстрацію до Єдиного реєстру податкових накладних.

_images/formirovanie_Korrektirovochnoj_NN_14.png

Отримання статусу про реєстрацію

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

  1. Зареєстровано в ЄРПН

Свідчить про те, що Коригувальна податкова накладна була успішно зареєстрована в ЄРПН вашим контрагентом.

_images/formirovanie_Korrektirovochnoj_NN_15.png

  1. Помилка при реєстрації в ЄРПН

Свідчить про те, що Коригувальна податкова накладна була відхилена вашим контрагентом.

_images/formirovanie_Korrektirovochnoj_NN_16.png

Також помилку реєстрації (квитанцію) можна переглянути, зайшовши в документ.

_images/formirovanie_Korrektirovochnoj_NN_17.png

  1. Відправлений на перевірку в торговельну мережу

Документ перевіряється на стороні торгової мережі перед відправкою на реєстрацію.

Формування Товарної і Податкової Накладних

Вступ

Дана інструкція описує порядок формування Товарної накладної і Податкової накладної на web-платформі.

Важливо

Увага! Для коректного формування документів ТН и ПН, необхідно заповнити Товарний довідник. Ви можете подивитися Інструкцію щодо заповнення довідника.

Примітка

Увага! Завершеним ланцюжком документообігу з мережею, є відправлена Товарна накладна, з коректним статусом, плюс створена на підставі Товарної накладної і зареєстрована Податкова накладна.

Товарна накладна

Перед початком роботи з Товарною накладною и Податковою накладною необхідно заповнити всі реквізити компанії, ПІБ підписанта, а також дані ДПІ, в яку будуть відправлятися Податкові Накладні.

Заповнення реквізитів компанії

Далі, перейдіть в розділ «Налаштування» (у правому верхньому куті):

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_01.png

Натисніть на закладку «Мої компанії» і виберыть GLN, з якого відбуватиметься відправка документів.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_02.png

У формі заповніть поля обов’язкові для заповнення (відзначені червоною зірочкою * ).

Важливо

Зверніть увагу! Реквізити заповнюються українською мовою і повинні відповідати інформації в реєстраційних документах компанії.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_03.png
Методи створення Товарної накладної

Створити Товарну накладну можливо трьома способами:

  1. Через меню «Створити» вибрати Товарну накладну

  2. На підставі Замовлення (ORDER)

  3. На підставі Повідомлення про прийом (RECADV)

Рекомендується формувати комплект документів **Товарна накладна + Податкова накладна*, на підставі Повідомлення про прийом (RECADV).*

Нижче наведено приклад формування Товарної накладної на підставі Повідомлення про прийом (RECADV).

Для формирования документа комплекта документов, необходимо перейти в раздел “Входящие”.

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

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_04.png

Відкрити документ «Повідомлення про прийом» і натиснути кнопку «Сформувати», потім вибрати зі списку документ «Товарна накладна + Податкова накладна».

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_05.png
Заповнення документа Товарна накладна

Першим сформованим документом буде Товарна накладна. У відкритому документі, необхідно заповнити обов’язкові дані, позначені червоною зірочкою *, в кожному з блоків.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_06.png

При перевірці внесених даних за товарними позиціями необхідно впевнитись, що обов’язково заповнене поле код УКТ ЗЕД. У разі, якщо поле не заповнено або заповнено некоректно, при збереженні документа буде виведено повідомлення, як на зображенні нижче:

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_07.png

Для того, щоб поле з кодом УКТ ЗЕД за товарними позиціями при формуванні документа Товарна Накладна заповнювалось автоматично, необхідно перевірити коректність заповнення даних в Товарному довіднику.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_08.png
Підписання документа Товарна Накладна

Після збереження документа, його необхідно підписати Електронно-Цифровим підписом (ЕЦП).

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_09.png

Для первинного налаштування ЕЦП, дочекайтеся завантаження сторінки, а потім натисніть кнопку «Зчитати ключі».

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_10.png

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

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_11.png
Види файлів електронно-цифрового підпису

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів:

  • Директор «DS»

  • Бухгалтер «BS»

  • Співробітник «SS»

  • Печатка «S»

  • Шифрування «C»

  • Універсальний ключ печатки і шифрування «U»

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_12.png

Якщо Ви використовуєте ключі від АЦСК “ПриватБанк”, файли підписів секрентних ключів мають розширення .jks:

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_13.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секрентних ключів мають найменування Key-6.dat:

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_14.png

Після вибору секретних ключів, введіть паролі під кожним з них, а потім натисніть кнопку “Зчитати ключі”

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_15.png

При коректному зчитуванні ключів, в блоці “ЕЦП” з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку “Підписати”.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_16.png

Після підписання натисніть на кнопку “Відправити”.

Статуси по Товарній накладній

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

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_17.png

  • «Документ переданий партнеру» - товарна накладна коректна.

  • «Документ переданий на ящик партнера» - товарна накладна коректна.

  • «Правильний канал не знайдено. Немає з’єднання з партнером» - в товарній накладній зазначений некоректний GLN одержувача і покупця.

  • «Помилка конвертації на вихідний формат» - є помилка у формі заповнення товарної накладної. Деякі поля були не заповнені або заповнені некоректно.

У разі виникнення подібної помилки прохання звертатися за адресою ел. пошти support@edi-n.com

Приклад коректного статусу:

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_18.png

Приклад некоректного статусу:

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_19.png

Податкова накладна

Після формування і відправки Товарної накладної, форма Податкової накладної відкриється автоматично.

Дані в документі будуть заповнені автоматично на підставі Товарної накладної. У Податковій накладній необхідно заповнити порядковий номер.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_20.png

Після заповнення всіх даних, документ необхідно зберегти, підписати ЕЦП та відправити аналогічно Товарній накладній.

Документ буде доставлений на сервер ЄРПН і перевірений органом Державної Податкової Інспекції.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_21.png
Статус реєстрації Податкової накладної

Після перевірки документа органом Державної Податкової Інспекції, йому буде присвоєно статус.

На коректний документ надійде статус «Зареєстровано в ЄРПН і відправлено покупцеві».

На некоректний документ надійде статус «Помилка при реєстрації в ЄРПН».

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_22.png

Щоб перевірити причину відмови в реєстрації Податкової накладної, необхідно зайти в відправлений документ і розшифрувати Квитанцію №1 відправлену органом ДПІ.

Для цього дочекайтеся завантаження даних в блоці «Квитанція №1» і натисніть кнопку «Зчитати».

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_23.png

Якщо раніше, ключі ЕЦП не були налаштовані, для розшифровки квитанції необхідно налаштувати ключ «Шифрування».

Розшифрований документ можливо зберегти у форматі .PDF, завантажити в форматі .RPL або відобразити на платформі. Текст причини відмови в реєстрації Податкової накладної вказано в блоці «Виявлені помилки».

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_24.png

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

Формування Товарної і Податкової накладної, через функціонал «Створити документ»

У разі, якщо від торгової мережі відсутній документ «Повідомлення про прийом», Товарну накладну необхідно сформувати самостійно через меню «Створити».

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_25.png
Додавання товарних позицій

З випадаючого списку, виберіть документ «Товарна накладна». В сформованому документі всі реквізити необхідно ввести вручну, на підставі паперових документів.

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

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_26.png

У формі, що з’явилася, заповніть всі обов’язкові поля, позначені червоною зірочкою *. Після внесення даних збережіть зміни.

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_27.png

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

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

Ця процедура, аналогічна пункту «Підписання документа Товарна Накладна» даної інструкції.

Формування Податкової накладної

Перейдіть в розділ «Відправлені», знайдіть і відкрийте раніше відправлену «Товарну накладну»..

_images/formirovanie_Tovarnoj_i_Nalogovoj_nakladnoj_28.png

У відкритому документі натисніть кнопку «Сформувати», потім виберіть зі списку документ «Податкова накладна».

Дані в документі будуть заповнені автоматично на підставі «Товарної накладної». У «Податковій накладній» необхідно заповнити порядковий номер.

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

Ця процедура, аналогічна пункту «Підписання документа Товарна Накладна» даної інструкції.

Формування Коригувальних Товарної і Податкової накладних (РКТН и РКПН)

Вступ

Дана інструкція описує порядок формування Коригувальної Товарної накладної (РКТН) і Коригувальної Податкової накладної (РКПН) на web-платформі.

Важливо

Увага! Для коректного формування документів, необхідно заповнити Товарний довідник. Ви можете подивитися Інструкцію щодо заповнення довідника.

Коригувальна товарна накладна

Перед початком роботи з даними документами необхідно заповнити всі реквізити компанії і ПІБ підписанта.

Важливо

Увага! Завершеним ланцюжком документообігу з мережею, є відправлена Коригувальна товарна накладна, з коректним статусом, плюс створена на підставі РКТН і зареєстрована РКПН.

Заповнення реквізитів компанії

Далі, перейдіть в розділ «Налаштування» (у правому верхньому куті):

_images/Korrekt_01.png

Натисніть на закладку «Мої компанії» і виберыть GLN, з якого відбуватиметься відправка документів.

_images/Korrekt_02.png

У формі заповніть поля обов’язкові для заповнення (відзначені червоною зірочкою * ).

Важливо

Зверніть увагу! Реквізити заповнюються українською мовою і повинні відповідати інформації в реєстраційних документах компанії.

_images/Korrekt_03.png

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

Методи створення Коригувальної товарної накладної

Створити РКТН можливо двома способами:

  1. Через меню «Створити» вибравши Коригувальну товарну накладну

  2. На підставі Товарної накладної

Рекомендується формувати Коригувальну товарну накладну на підставі Товарної накладної.

Нижче наведено приклад формування Коригувальної товарної накладної на підставі Товарної накладної.

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

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

_images/Korrekt_04.png

Відкрийте документ «Товарна накладна» і натисніть кнопку «Сформувати», потім виберіть зі списку документ «Коригувальна товарна накладна».

_images/Korrekt_05.png
Заповнення Коригувальної товарної накладної

У відкритому документі, необхідно заповнити обов’язкові дані, позначені червоною зірочкою *, в кожному з блоків.

_images/Korrekt_06.png

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

_images/Korrekt_07.png

Так само, необхідно вибрати необхідний пункт в блоці «Коригувальні дані».

_images/Korrekt_08.png

Є кілька причин коригування:

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

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

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

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

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

_images/Korrekt_09.png

При перевірці внесених даних за товарними позиціями необхідно упевниться, що обов’язково заповнене поле «код УКТ ЗЕД».

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

_images/Korrekt_10.png

Для того, щоб поле з кодом УКТ ЗЕД при додаванні товарної позиції заповнювалось автоматично, необхідно, щоб дані були заповнені в Товарному довіднику.

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

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

Підписання документа Коригувальна Товарна Накладна

Після збереження документа, його необхідно підписати Електронно-Цифровим підписом (ЕЦП).

_images/Korrekt_11.png

Для первинного налаштування ЕЦП, дочекайтесь завантаження сторінки, а потім натисніть кнопку “Зчитати ключі”.

_images/Korrekt_12.png

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

_images/Korrekt_13.png
Види файлів електронно-цифрового підпису

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів:

  • Директор «DS»

  • Бухгалтер «BS»

  • Співробітник «SS»

  • Печатка «S»

  • Шифрування «C»

  • Універсальний ключ печатки і шифрування «U»

_images/Korrekt_14.png

Якщо Ви використовуєте ключі від АЦСК “ПриватБанк”, файли підписів секрентних ключів мають розширення .jks:

_images/Korrekt_15.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секрентних ключів мають найменування Key-6.dat:

_images/Korrekt_16.png

Після вибору секретних ключів, введіть паролі під кожним з них, а потім натисніть кнопку “Зчитати ключі”

_images/Korrekt_17.png

При коректному зчитуванні ключів, в блоці “ЕЦП” з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку “Підписати”.

_images/Korrekt_18.png

Після підписання натисніть на кнопку “Відправити”.

Статуси по Коригувальній товарній накладній

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

Приклад коректного статусу:

_images/Korrekt_19.png

Приклад некоректного статусу:

_images/Korrekt_20.png

  • «Документ переданий партнеру» - товарна накладна коректна.

  • «Документ переданий на ящик партнера» - товарна накладна коректна.

  • «Правильний канал не знайдено. Немає з’єднання з партнером» - в товарній накладній зазначений некоректний GLN одержувача і покупця.

  • «Помилка конвертації на вихідний формат» - є помилка у формі заповнення товарної накладної. Деякі поля були не заповнені або заповнені некоректно.

У разі виникнення подібної помилки прохання звертатися за адресою ел. пошти support@edi-n.com

Коригувальна Податкова накладна

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

Для формування документа РКПН, перейдіть в розділ «Відправлені», відфільтруйте документи за потрібною роздрібною мережею і типом «Коригувальна товарна накладна».

_images/Korrekt_21.png

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

_images/Korrekt_22.png

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

_images/Korrekt_23.png

Внизу документа знаходиться перелік товарних позицій, які переносяться з документа «Коригування до Товарної Накладної».

Всі інші поля ви заповнюєте самостійно згідно чинного податкового законодавства України.

_images/Korrekt_24.png

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

Документ буде доставлений покупцеві для подальшої реєстрації на сервері ЄРПН.

Статуси по Коригувальній податковій накладній

Після перевірки документа органом Державної Податкової Інспекції, йому буде присвоєно статус.

На коректний документ надійде статус «Зареєстровано в ЄРПН і відправлено покупцеві».

На некоректний документ надійде статус «Помилка при реєстрації в ЄРПН».

У разі отримання статусу «Помилка при реєстрації в ЄРПН» прохання звертатися за адресою ел. пошти support@edi-n.com.

Формування РКТН і РКПН, через функціонал «Створити документ»

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

_images/Korrekt_25.png
Додавання товарних позицій

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

У сформованому документі всі реквізити необхідно ввести вручну, на підставі паперових документів.

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

_images/Korrekt_26.png

У формі, що з’явилася, заповніть всі обов’язкові поля, позначені червоною зірочкою *. Після внесення даних збережіть зміни.

_images/Korrekt_27.png

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

Заповнення даних документа відбувається аналогічно пунктам 5 і 6 цієї інструкції.

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

Ця процедура, аналогічна пунктам 8 та 9 даної інструкції.

Формування Коригувальної податкової накладної

Перейдіть в розділ «Відправлені», знайдіть і відкрийте раніше відправлену «Товарну накладну».

_images/Korrekt_28.png

У відкритому документі натисніть кнопку «Сформувати», потім виберіть зі списку документ «Податкова накладна».

Дані в документі будуть заповнені автоматично на підставі «Товарної накладної». У «Податковій накладній» необхідно заповнити порядковий номер.

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

Ця процедура, аналогічна пунктам 6 та 7 даної інструкції.

Подальше формування і відправка документа Коригувальна податкова накладна відбувається аналогічно пунктам 12 і 13 даної інструкції.

Формування документа «Акт виконаних робіт» на платформі OBMIN

Вступ

Дана інструкція описує порядок формування та відправки документа «Акт виконаних робіт» (COMDOC).

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

Заповнити Товарний Довідник на Web-платформі можна кількома способами:

Вручну на платформі, Через шаблон .CSV, Через шаблон .XLS.

Заповнення Товарного довідника вручну

Для переходу до заповнення Товарного довідника, необхідно перейти в розділ «Меню»-> «Двідники»-> «Довідник послуг/товарів»

_images/formirovanie_Akt_01.png

Для того щоб додати товарну позицію або послугу, натисніть на кнопку «+».

_images/formirovanie_Akt_02.png

Після натискання якої у Вас відкриється форма «Зміни даних товарної позиції».

Обов’язкові поля

_images/formirovanie_Akt_03.png

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

  1. Найменування* - вкажіть найменування товарної позиції або послуги.

  2. Штрихкод* - вкажіть штрихкод позиції, якщо штрихкода немає, вкажіть (1000000000000).

  3. Ціна* - вкажіть ціну без ПДВ.

  4. Од.вим* - зі списку виберіть одиницю.

  5. ПДВ* - вкажіть ставку ПДВ.

  6. РМ - вкажіть, до яких торговельних мереж буде відноситись даний товар. За замовчуванням стоїть значення «Всі».

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

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

_images/formirovanie_Akt_04.png

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

Формування Акту виконаних робіт

Щоб сформувати «Акт виконаних робіт» (COMDOC) необхідно скористатися функціоналом створення документа.

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

_images/formirovanie_Akt_05.png

У відкритій формі, всі поля позначені червоною зірочкою * обов’язкові для заповнення.

_images/formirovanie_Akt_06.png

  1. № документа* - довільний номер, який присвоюється документу.

  2. Дата складання* - вказується поточна дата.

_images/formirovanie_Akt_07.png

У Документі-підставі:

  1. Номер документа* - номер договору з Вашим контрагентом.

  2. Тип документа* - вибираєте з випадаючого списку «Договір».

  3. Дата документа* - вказується дата укладення Договору.

retail/pics_formirovanie_dokumenta_Akt_vypolnennyh_rabot_na_platforme_OBMIN/formirovanie_Akt_08.png

Одержувач:

  1. Статус контрагента* - вибираєте з випадаючого списку Вашого контрагента, він є Одержувачем, Покупцем або Замовником, і т. д. в залежності від наданих Вам або Вами послуг.

  2. Організаційна форма* - Юридична або Фізична особа.

  3. Назва контрагента* - вказуєте назву контрагента.

  4. Код контрагента* - ЄДРПОУ

  5. Індивідуальний податковий номер* - ІПН одержувача, якщо одержувач не є платником ПДВ вказуєте 12-ти значний номер (100000000000).

  6. ** GLN *** - 13-ти значний Global Location Number контрагента, підтягується автоматично.

_images/formirovanie_Akt_09.png

Відправник - дані заповнюються автоматично з картки контрагента.

_images/formirovanie_Akt_10.png

Термін дії документа:

  1. Початок терміну дії* - дата початку дії договору з контрагентом.

  2. Закінчення терміну дії* - дата закінчення договору з контрагентом.

_images/formirovanie_Akt_11.png

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

Для коректного заповнення позицій, необхідно заповнити Товарний довідник. Інстркцію щодо заповнення довідника ви можете знайти за посиланням.

_images/formirovanie_Akt_12.png

  1. Найменування з товарного довідника - вводите назву товарної позиції або послуги.

  2. Кількість (прийнята) - кількість товару.

  3. Ціна - ціна товару або послуги.

_images/formirovanie_Akt_13.png

Після заповнення таблиці, натискаєте Зберегти -> Підписати -> Надіслати.

_images/formirovanie_Akt_14.png

Налаштування ЕЦП

Перед початком роботи необхідно налаштувати підпис, яким Ви будете підписувати документи. Щоб перейти до Налаштування ЕЦП, зайдіть в Налаштування, натисніть на «шестерню» у верхньому правому куті. Відкриється Провідник, де необхідно буде вказати каталог з секретними ключами і вибрати ключі.

_images/formirovanie_Akt_15.png

Якщо ключі отримані в АЦСК ІДД (ДФС), тоді необхідно вибирати: ключі key-6.dat

Якщо ви використовуєте для підписання ключі АЦСК «Україна», тоді види ключів наступні:

  • Ключ директора: ЄДРПОУ_ІНН підписанта_D1111111.ZS2

  • Ключ бухгалтера: ЄДРПОУ_ІНН підписанта _B1111111.ZS2

  • Ключ печатки: ЄДРПОУ_S1111111.ZS2 (ЄДРПОУ _U1111111.ZS2)

  • Ключ шифрування: ЄДРПОУ_С1111111.ZS2 (ЄДРПОУ _U1111111.ZS2)

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

_images/formirovanie_Akt_16.png

Коли ключі зчитані, у вікні ЕЦП можна буде побачити інформацію про ЕЦП:

_images/formirovanie_Akt_17.png

Далі відкриється вікно, в якому необхідно відмітити чекером типи ключів, якими буде підписаний документ. Потім встановлюємо послідовність підпису, наприклад:

  • директор - 1

  • печатка - 2

_images/formirovanie_Akt_18.png

І натискаємо кнопку Підписати. Після процесу підписання необхідно натиснути кнопку Надіслати.

_images/formirovanie_Akt_19.png

Формування та відправка документа «Підтвердження замовлення транспортування» (IFTMBC) на платформі

Вступ

Дана інструкція описує порядок формування та відправки документа «Підтвердження замовлення транспортування» (IFTMBС) на WEB платформі.

Фільтри

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

За замовчуванням нові вхідні документи мають статус «Непрочитані», після відкриття документів статус змінюється на «Прочитані».

_images/formirovanie_IFTMBC_01.png

Формування документа «Підтвердження замовлення транспортування» (IFTMBС)

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

_images/formirovanie_IFTMBC_02.png

Відкритий документ містить коротку інформацію, яка містить наступні дані: № документа, GLN і найменування відправника, місце доставки і місце вивантаження.

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

_images/formirovanie_IFTMBC_03.png

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

_images/formirovanie_IFTMBC_04.png

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

_images/formirovanie_IFTMBC_05.png

Для створення документа IFTMBC, у відкритому документі натисніть кнопку «Сформувати» і виберіть зі списку документ «Підтвердження замовлення транспортування».

_images/formirovanie_IFTMBC_06.png

Заповнення документа «Підтвердження замовлення транспортування» (IFTMBС)

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

  • хронологія подій поставки заповнюється в одному документі

  • хронологія подій поставки заповнюється в окремому документі

Нижче описані обидва способи.

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

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

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

Час підтвердження замовлення: час, яким постачальник логістичних послуг підтверджує готовність виконання замовлення. Вказується в форматі hh: mm

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

_images/formirovanie_IFTMBC_07.png

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

_images/formirovanie_IFTMBC_08.png

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

_images/formirovanie_IFTMBC_09.png

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

Додавання подій

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

_images/formirovanie_IFTMBC_10.png

Події поставки в табличній частині містять наступні колонки:

Тип події - необхідно вибрати зі списку.

Транспорт / судно - необхідно вибрати зі списку.

Назва транспорту / судна - заповнюється вручну.

Назва місця / порту - заповнюється вручну.

Дата події - необхідно вказати дату в календарі.

Час події - заповнюється вручну.

Додаткова інформація - заповнюється вручну.

Для вибору події, натисніть на порожній рядок в колонці «Тип події» і виберіть зі списку потрібний пункт.

_images/formirovanie_IFTMBC_11.png

Аналогічним способом слід заповнити колонки «Транспорт / судно» і «Дата події».

_images/formirovanie_IFTMBC_12.png

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

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

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

_images/formirovanie_IFTMBC_13.png

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

_images/formirovanie_IFTMBC_14.png

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

_images/formirovanie_IFTMBC_15.png

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

_images/formirovanie_IFTMBC_16.png

По отриманню всієї необхідної інформації, замовник транспортування відправляє квитанцію про закриття замовлення.

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

Важливо

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

Обмін е-документами з поштово-логістичним оператором Meest-Express

Вступ

Дана інструкція описує порядок роботи з документами, які відправляє компанія Meest-Express:

  • Рахунок

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

  • Специфікація

Документи Вам будуть надходити у вигляді Комерційного документа з відповідним типом.

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

Вхід на платформу

Для входу на платформу необхідно перейти за посиланням https://obmin.edi-n.com/. На сторінці, введіть логін і пароль для доступу в систему.

_images/Obmen_e-dokumentami_s_Meest-Express_01.png

Налаштування ЕЦП

Перед початком роботи необхідно налаштувати підпис, яким Ви будете підписувати документи. Щоб перейти до Налаштування ЕЦП, зайдіть в Налаштування, натиснувши на «шестерню» у верхньому правому куті. Відкриється Провідник, де необхідно буде вказати каталог з секретними ключами і вибрати ключі.

_images/Obmen_e-dokumentami_s_Meest-Express_02.png

Якщо ключі отримані в АЦСК ІДД (ДФС), тоді необхідно вибирати: ключі key-6.dat.

Якщо ви використовуєте для підписання ключі АЦСК «Україна», тоді вид ключів такий:

  • Ключ директора: ЕДРПОУ_ИНН подписанта_D1111111.ZS2

  • Ключ бухгалтера: ЕДРПОУ_ИНН подписанта _B1111111.ZS2

  • Ключ печатки: ЕДРПОУ_S1111111.ZS2 (ЕГРПОУ _U1111111.ZS2)

  • Ключ шифрування: ЕДРПОУ_С1111111.ZS2 (ЕГРПОУ _U1111111.ZS2)

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

Коли ключі зчитані, у вікні ЕЦП можна буде побачити інформацію про ЕЦП:

_images/Obmen_e-dokumentami_s_Meest-Express_03.png _images/Obmen_e-dokumentami_s_Meest-Express_04.png

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

Для того, щоб підписати документ ЕЦП, необхідно натиснути кнопку Підписати.

_images/Obmen_e-dokumentami_s_Meest-Express_05.png

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

_images/Obmen_e-dokumentami_s_Meest-Express_06.png

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

  • директор - 1

  • печатка - 2

_images/Obmen_e-dokumentami_s_Meest-Express_07.png

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

_images/Obmen_e-dokumentami_s_Meest-Express_08.png

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

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

Зверніть увагу! Тип документа відображається в короткому описі документа.

_images/Obmen_e-dokumentami_s_Meest-Express_09.png

Для вибору необхідного документа є можливість скористатися фільтрами, які відображаються над документами:

  • Перший фільтр відображає всі, прочитані і непрочитані документи;

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

_images/Obmen_e-dokumentami_s_Meest-Express_10.png

Всі документи, які відправляє компанія Meest-Express передаються в форматі Комерційного документа (comdoc).

Після вибору цього документа в другому фільтрі, з’являється два додаткових фільтра, що дозволяють сортувати:

  • за типом документа

  • за статусом.

Також можна скористатися рядком пошуку, вказавши правильний номер документа.

_images/Obmen_e-dokumentami_s_Meest-Express_11.png

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

_images/Obmen_e-dokumentami_s_Meest-Express_12.png

У вікні необхідно ввести параметри пошуку і натиснути кнопку Знайти.

_images/Obmen_e-dokumentami_s_Meest-Express_13.png
Рахунок-фактура

Документ передає інформацію про вартість послуг, що надаються компанією Meest-Express. Інформація про підписання документа відображається в блоці «Підписи». У відкритому документі вгорі є кілька кнопок, які дозволять Вам:

  • роздрукувати документ;

  • скачати документ у форматі .xls;

  • скачати документ у форматі .xml;

  • відобразити більш детальну інформацію по документу;

  • завантажити документ з ЕЦП;

_images/Obmen_e-dokumentami_s_Meest-Express_14.png
Специфікація послуг з перевезень

Документ розшифровує рахунки, виставлені в електронному документі «Рахунок-фактура».

_images/Obmen_e-dokumentami_s_Meest-Express_15.png
Акт виконаних робіт

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

_images/Obmen_e-dokumentami_s_Meest-Express_16.png

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

_images/Obmen_e-dokumentami_s_Meest-Express_17.png

У разі якщо ЕЦП не налаштований, поверніться до кроку 2 даної інструкції.

Додаткові сервіси

Портал сертифікатів

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

Для роботи зі звітністю потрібно вибрати Сервіс -> Сертифікати:

_images/Obmen_e-dokumentami_s_Meest-Express_18.png

Основні можливості сервісу - Портал Сертифікатів:

  • Швидкий пошук сертифіката (2 сек.);

  • Зручний обмін між учасниками;

  • Захист від втрати сертифіката (хмарне зберігання);

  • Пряме посилання для швидкого перегляду / скачування;

  • Завантаження і друк сертифіката в середовищі сервісу;

  • Пошук сертифіката за різними ознаками (№, артикул, штрих-код і т.д.)

Додавання і зміни email в налаштуваннях користувача

Для редагування (зміни, видалення або додавання) адреси e-mail необхідно:

  1. У правому верхньому куті на платформі перейти у «Налаштування».

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

Підказка

Також через «,» можливо додати кілька e-mail. Пример: test@mail.ua,test2@mail.ua,test3@mail.ua

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

_images/Obmen_e-dokumentami_s_Meest-Express_19.png

Інструкція по роботі з мережею ОККО на веб-платформі EDI-Network

Вступ

Дана інструкція описує порядок формування документів у відповідь «Підтвердження замовлення» (ORDRSP) і «Повідомлення про відвантаження» (DESADV), налаштування електронно-цифрового підпису та підписання або відмову від підписання Комерційного документа «Прибуткова Накладна» по мережі ОККО. Також описаний порядок роботи з документом «Повідомлення про повернення» (RETANN), підписання або відмову від підписання Комерційного документа «Накладна на повернення» (COMDOC).

Важливо!

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

Важливо!

Зверніть увагу, що всі документи на які ЕЦП постачальники накладали більше ніж 4 кал. дні від дати фізичної доставки товару, тобто дати прибуткової накладної – для оплати початок відліку буде від дати накладання ЕЦП постачальника.

Важливо!

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

_images/1.jpg

1. Формування документа у відповідь «Підтвердження замовлення»(ORDRSP)

Важливо!

Даний документ формується відразу, після отримання замовлення!

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

_images/2.png

Для зручності пошуку виберіть в першому фільтрі - Всі документи, у другому - ОККО-Нафтопродукт, в третьому - тип документа Замовлення.

_images/3.png

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

_images/4.png

У відкритому документі виберіть Сформувати → Підтвердження замовлення.

_images/5.png

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

_images/6.png

  1. Номер - може збігатися з номером замовлення.

  2. Дата - дата підтвердження, автоматично вказується поточна дата.

  3. Дата замовлення автоматично переноситься з замовлення.

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

  5. Дії - вибираються зі списку такі дії: Буде доставлено, Зміна кількості, або Відмовлено.

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

_images/7.png

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

Важливо!

Просимо внести фактичне значення, яке планується до поставки. Якщо ціни, які вказані в замовленні, не відповідають цінам в специфікації, просимо відразу повідомити про це менеджерів, які відправляють замовлення та додатково Білецьку Анну abilecka@gng.com.ua або Бродюк Ірину IBrodiuk@gng.com.ua.

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

_images/8.png

2. Формування документу у відповідь «Повідомлення про відвантаження» (DESADV)

Важливо!

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

Для зручності пошуку виберіть в першому фільтрі – Всі документи, у другому - ОККО-Нафтопродукт, в третьому - тип документа Замовлення.

_images/9.png

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

_images/104.png

У відкритому документі натисніть Сформувати → Повідомлення про відвантаження.

_images/11.png

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

_images/12.png

  1. Номер - номер повідомлення про відвантаження по даному замовленню (Автоматично встановлюється номер замовлення).

  2. Дата - дата повідомлення про відвантаження, автоматично встановлюється поточна дата.

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

  4. No замовлення автоматично переноситься з замовлення.

  5. Дата замовлення автоматично переноситься з замовлення.

  6. No накладної - номер Видаткової Накладної по даному замовленню.

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

  1. Дата накладної - дата Видаткової Накладної.

*Ця дата повинна потім бути відображена постачальником в акті звірки та цією датою повинні бути складені податкова накладна на отриманий Покупцем товар.*

  1. No Транспортної накладної.

  2. Дата Транспортної накладної.

ПРОСИМО УВАЖНО ПЕРЕВІРЯТИ ВВЕДЕНУ ІНФОРМАЦІЮ!

Важливо!

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

Важливо!

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

_images/13.png

Система автоматично підставляє значення в колонку Кількість, яке поставляється - значення аналогічне замовленому. В даному розділі необхідно вказати кількість тов.позицій, яка поставляється, що відповідає тій кількості, що у вас вказано, в певній, конкретній, видатковій накладній, наприклад:

_images/14.png

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

_images/15.png

Важливо!

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

3. Підписання вхідного Коммерційного документу «Прибуткова Накладна»

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

Важливо!

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

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

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

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

- загальної суми накладної, а у випадку розходження – по кожному товару знайти причину невідповідності.

_images/16.png

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

_images/171.png

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

Лінією прокрутки, перевірте правильність даних в табличній частині та полі «Підсумок». Для друку документа натисніть кнопку Друк. Якщо документ необхідно зберегти в форматі Exсel або XML натисніть кнопку Exсel або XML відповідно.

Для підписання документа натисніть кнопку «Підписати».

Для первинного налаштування ЕЦП, дочекайтеся завантаження сторінки, а потім натисніть кнопку «Зчитати ключі».

_images/18.png

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

_images/19.png

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів: Директор - «DS», Бухгалтер - «BS», Співробітник - «SS», Печатка - «S», Шифрування - «C», Універсальний ключ печатки та шифрування - «U».

_images/201.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секретних ключів мають найменування Key-6.dat

_images/21.png

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

_images/22.png

При коректному зчитуванні ключів, в блоці «ЕЦП» з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку «Підписати».

_images/23.png

Після підписання документа, натисніть кнопку «Відправити».

_images/24.png

4. Відмова від підписання Коммерційного документа «Прибуткова Накладна»

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

_images/251.png

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

_images/261.png

В наступному вікні потрібно ввести причину відмови від підписання і натиснути ОК.

_images/271.png

Важливо!

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

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

_images/281.png

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

5. Підписання вхідного Коммерційного документу «Накладна на повернення»

При поверненні товара мережа формує документ Повідомлення про повенення (RETANN) і відправляє його постачальнику. Потім формує Накладну на повернення (COMDOC), підписує її і відправляє постачальнику.

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

_images/291.png

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

_images/30.png

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

Для підписання документа натисніть кнопку «Підписати». Для первинного налаштування ЕЦП, дочекайтеся завантаження сторінки, а потім натисніть кнопку «Зчитати ключі».

_images/31.png

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

_images/32.png

Якщо Ви використовуєте ключі від АЦСК «Україна», файли підписів секретних ключів мають розширення .ZS2 і наступні значення в іменах файлів: Директор - «DS», Бухгалтер - «BS», Співробітник - «SS», Печатка - «S», Шифрування - «C», Універсальний ключ печатки та шифрування - «U».

_images/33.png

Якщо Ви використовуєте ключі від будь-яких інших АЦСК, файли підписів секретних ключів мають найменування Key-6.dat

_images/34.png

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

_images/35.png

При коректному зчитуванні ключів, в блоці «ЕЦП» з’явиться інформація про власників ключів. Після перевірки інформації натисніть кнопку «Підписати».

_images/361.png

Після підписання документа, натисніть кнопку «Відправити».

_images/371.png

6. Відмова від підписання Коммерційного документу «Накладна на повернення»

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

_images/381.png

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

_images/391.png

В наступному вікні потрібно ввести причину відмови від підписання і натиснути ОК.

_images/401.png

Важливо!

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

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

_images/411.png

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

Інструкція по роботі з мережею Фоззі за схемою «Match Invoice» на веб-платформі EDI-Network

Вступ

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

Дана інструкція описує порядок формування документів від постачальника «Підтвердження замовлення» (ORDRSP) і «Повідомлення про відвантаження» (DESADV) у відповідь на Замовлення по мережі Фоззі.

1. Формування вихідного документа «Підтвердження замовлення»(ORDRSP) у відповідь на Замовлення

Важливо!

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

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

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

_images/Rabota_s_Fozzy_001.png

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

_images/Rabota_s_Fozzy_002.png

У відкритому документі виберіть Сформувати → Підтвердження замовлення.

_images/Rabota_s_Fozzy_003.png

У відкритому вікні з’явиться Форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою * є обов’язковими для заповнення. Інформація про Покупця, Постачальника та Місце доставки автоматично заповниться із Замовлення.

_images/Rabota_s_Fozzy_004.png

  1. Номер - може збігатися з номером замовлення.

  2. Дата - дата підтвердження, автоматично вказується поточна дата.

  3. Дата замовлення автоматично переноситься з замовлення.

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

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

_images/Rabota_s_Fozzy_005.png

Інформація по позиціям, автоматично переноситься із Замовлення:

  1. Номер - номер позиції

  2. Найменування - назва позиції іх товарного довідника

  3. Штрихкод - штрихкод товарної позиції, полегшує пошук, переноситься автоматично з замовлення

  4. Замовлено- кількість автоматично переноситься з замовлення.

  5. Мінімальна кількість замовлення автоматично переноситься з замовлення

  6. Підтверджено - фактична підтверджена кількість, що буде доставлена

  7. Дії - вибираються зі списку в залежності від ситуації: Буде доставлено, Зміна кількості, або Відмовлено.

Для відправки документа натискаємо на кнопку Зберегти, внесені зміни вступають в силу, а потім - Відправити.

_images/Rabota_s_Fozzy_006.png

2. Формування вихідного документа «Повідомлення про відвантаження»(DESADV)

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

Перейдіть в розділ Вихідні, у виберіть другому фільтрі - Фоззі, в третьому - тип документа Підтвердження замовлення.

У відкритому документі натисніть Сформувати → Повідомлення про відвантаження.

У вікні з’явиться Форма для заповнення необхідних даних документа, деякі поля заповняться із Замовлення. Всі поля, позначені червоною зірочкою * обов’язкові до заповнення.

_images/Rabota_s_Fozzy_007.png

  1. Номер - номер повідомлення про відвантаження по даному замовленню (Автоматично встановлюється номер замовлення)

  2. Дата - дата повідомлення про відвантаження, автоматично встановлюється поточна дата

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

  4. № накладної - можливо вказати номер Видаткової Накладної по даному замовленню, або свій внутрішній номер

  5. Дата накладної - дата Видаткової Накладної

  6. Порядковий номер Повідомлення про відвантаження - на кожну одиницю транспорту потрібно своє повідомлення з порядковиим номером (якщо № авто=1, то повідомлення=1)

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

  8. № замовлення автоматично переноситься з замовлення

  9. Дата замовлення автоматично переноситься з замовлення

Важливо!

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

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

_images/Rabota_s_Fozzy_008.png

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

  1. Поставляєма кількість - кількість що поставляється в одиниці транспорту

  2. Одиниці виміру - одиниці вимірювання кількості

  3. Ціна - ціна за позицію

  4. Всього без ПДВ - сумма по позиціям

  5. Ставка ПДВ - виберіть % ставки із списку

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

_images/Rabota_s_Fozzy_009.png

Важливо!

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

3. Формування документа «Інструкція з транспортування» (IFTMIN)

Важливо!

У разі створення декількох «Повідомленнь про відвантаження»(DESADV), необхідно на кожне сформувати свою Інструкцію з транспортування» (IFTMIN).

Створення документа відбувається на підставі «Замовлення».

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

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_01.png

У відкритому документі, натисніть кнопку «Сформувати» і виберіть зі списку документ «Інструкція з транспортування».

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_02.png

У вікні з’явиться Форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою * обов’язкові для заповнення.

  1. Номер документа повинен бути наступного формату X_Y, де:

  • Х - це порядковий номер машини, на поставку (порядковий № Повідомлення про відвантаження)

  • Y - це загальна кількість машин, на поставку (загальна кількість Повідомлень про відвантаження)

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

Мінімальна к-ть 1, Максимальна - 99. Х повинен бути менше або рівним Y. Наприклад: 2_5

  1. Дата - фактична дата відправки поставки

  2. Номер замовлення - підтягується автоматично із замовлення

  3. Фактична кількість палет - кількість палет, що відвантажується в вантажний транспорт

  4. Максимальна кількість палет - максимальна місткість палет (вантажний транспорт)

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

_images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_03.png

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

retail/pics_robota_s_Fozzy_EDI-N_2.0/pics_robota_s_Fozzy_06.png _images/formirovanie_dokumenta_Instrukcija_po_transportirovke_IFTMIN_na_platforme_04.png

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

4 Обробка відповіді від мережі Фоззі

Мережа у відповідь на «Повідомлення про відвантаження»(DESADV) може відправити «Повідомлення про прийом» (RECADV) в якості остаточного підтвердження поставки або «Акт невідповідності» (COMDOC 009) в разі виникнення кількісних чи цінових товарних розбіжностей.

4.1 Обробка вхідного документа «Повідомлення про прийом» (RECADV)

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

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

У журналі документів, а також в самому документі, червоним буде виділено попередження Поставка потребує закриття

_images/Rabota_s_Fozzy_103.png

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

_images/Rabota_s_Fozzy_104.png
4.2 Обробка вхідного документа «Акт невідповідності» (COMDOC 009)

У випадку розходження між відправленною і фактично прийнятою кількістю товару чи виникненням цінової розбіжності – мережа надсилає Вам «Акт невідповідності» (COMDOC 009)

_images/Rabota_s_Fozzy_101.png

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

_images/Rabota_s_Fozzy_102.png

Після ознайомлення з документом необхідно повторно відправити «Повідомлення про відвантаження»(DESADV) з правками кількості/ціни згідно розбіжностей вказаних в «Акті невідповідності» (COMDOC 009) мережі Фоззі.

Увага

В «Повідомлення про відвантаження»(DESADV) потрібно вносити правки лише згідно вказаних розбіжностей в «Акті невідповідності» (COMDOC 009). В іншому документ DESADV повинен бути ідентичним до попередньо відправленого (детально в розділі 2).

У відповідь на відправлений відредагований документ «Повідомлення про відвантаження»(DESADV) повинен надійти документ «Повідомлення про прийом» (RECADV), котрий необхідно буде «закрити» (детально в розділі 4.1).

Інструкція з формування «Інструкції про повернення» (RETINS) для мережі АТБ

Вступ

Документ Інструкція про повернення (RETINS) відправляється у відповідь на Повідомлення про повернення (RETANN) і використовуватися для підтвердження або редагування дати та часу прибуття постачальника.

1 Пошук документу

Необхідно у папці «Вхідні»(1) відфільтрувати документи за мережею та типом. Потрібно обрати мережу «АТБ-маркет»(2) та тип документу «Пов. Про повернення»(3) і відкрити необхідне повідомленння(4).

_images/Retins_ATB_instruction_01.png

2 Формування інструкції

Знаходячись у відкритому документі, необхідно натиснути кнопку «Сформувати»(1) і обрати «Відправити підтвердження»(2)

_images/Retins_ATB_instruction_02.png

3 Заповнення полів

Поля Номер, Дата, Дата повернення, № Пов. про повернення, Дата Пов. про повернення, Отримувач, Покупець, Постачальник і Місце доставки заповнюються автоматично із документа-підстави.

Заповнити необхідно поле Час повернення (1), при необхідності скорегуваті данні в полі Дата повернення (2)

_images/Retins_ATB_instruction_03.png

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

Після заповнення необхідної інформації необхідно натиснут кнопку «Зберегти»(1), після натиснути «Відправити»(2)

_images/Retins_ATB_instruction_04.png

Інструкція по роботі з документами на web-платформі для Modern-Expo

1 Вступ

Дана інструкція описує порядок ведення повного документообігу з мережею Modern Expo.

2 Формування Попереднього Замовлення

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

_images/modern_expo_instruction_01.png _images/modern_expo_instruction_02.png

У відкритій формі, все поля позначені червоною зірочкою * обов’язкові для заповнення.

  1. Номер замовлення — указується номер документа.

  2. Дата замовлення - дата замовлення, автоматично вказана поточна дата.

  3. Дата доставки — необхідно вказати бажану дату доставки товару.

  4. № договору — договір-підстава.

  5. Валюта — валюта, в которой будет воспроизведен расчет.

  6. Отримувач — інформація, хто є одержувачем документа.

  7. Покупець — інформація, хто є покупцем товару.

  8. Місце доставки — інформація, куди необхідно доставити товар.

  9. Постачальник — вибрати контрагента, хто є постачальником.

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

_images/modern_expo_instruction_03.png

Після збереження документа, з’являється можливість знизу документа додати товарні позиції.

_images/modern_expo_instruction_04.png

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

_images/modern_expo_instruction_05.png

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

_images/modern_expo_instruction_06.png

Обов’язковими полями в шаблоні є поля, виділені зеленим кольором, як на прикладі нижче.

_images/modern_expo_instruction_07.png

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

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

_images/modern_expo_instruction_08.png

Необхідно створити, підписати і відправити Постачальнику Товарну специфікацію.

3 Товарна специфікація

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

_images/modern_expo_instruction_09.png

У створеному документі «Товарна специфікація» основні дані підтягнуться з документа підстави. Обов’язкові для заповнення поля будуть відмічені червоною зірочкою *.

_images/modern_expo_instruction_10.png

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

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

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

_images/modern_expo_instruction_11.png

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

Після цього на підставі документа «Повідомлення про відвантаження» (desadv) необхідно сформувати документ «Повідомлення про прийом» (recadv).

4 Повідомлення про прийом (recadv)

Для формування «Повідомлення про прийом» (recadv) необхідно відкрити документ-підставу «Повідомлення про відвантаження» (desadv) і натиснути кнопку ** Сформувати ** - «Повідомлення про прийом».

_images/modern_expo_instruction_12.png

Якщо товар був прийнятий не в повному обсязі, Ви формуєте комерційний документ «Акт про виявлені недоліки» (документ формується на підставі Повідомлення про прийом). Для цього треба зайти в відправлений документ, натиснути Сформувати - Акт про виявлені недоліки. Після заповнення його обов’язково необхідно підписати ЕЦП та відправити на підпис Постачальнику. Завершальним етапом в електронний документообіг є формування і відправка Постачальником документа Товарна накладна.

Важливо

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

_images/modern_expo_instruction_13.png

Заповніть обов’язкові поля, відзначені червоною зірочкою *.

_images/modern_expo_instruction_14.png

Після чого завантажте необхідний файл і виконайте відправку документа. Даний документ можна відправити непідписаним або з накладеними ЕЦП.

_images/modern_expo_instruction_15.png

Інструкція по роботі з документами на web-платформі для Постачальника Modern-Expo

1 Вступ

Дана інструкція описує порядок ведення повного документообігу з мережею Modern Expo.

2 Вхід на платформу

Для входу на web-платформу перейдіть за посиланням https://edo.edi-n.com/ введіть Ваш Логін і Пароль, після чого натисніть Вхід.

_images/modern_expo_postavschuk_instruction_01.png

3 Фільтри

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

_images/modern_expo_postavschuk_instruction_02.png

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

_images/modern_expo_postavschuk_instruction_03.png

4 Підтвердження замовлення (Ordrsp)

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

_images/modern_expo_postavschuk_instruction_04.png

У Вас створиться новий документ «Підтвердження замовлення» (Ordrsp). В даний документ у Вас перенесуться основні дані. Вам необхідно буде вказати чи буде у Вас доставка в повному обсязі чи будуть зміни: #. Буде доставлено — дана товарна позиція буде доставлена в повному обсязі #. Зміна кількості — дана товарна позиція буде доставлена не в повному обсязі #. Відмовлено — дана товарна позиція доставлена не буде

_images/modern_expo_postavschuk_instruction_05.png

Важливо

Підтвердження замовлення є «ціновим» документом (ціни по товарах в документі є обов’язковими для заповнення)

Після чого натисніть «Зберегти» і «Надіслати»

_images/modern_expo_postavschuk_instruction_06.png

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

_images/modern_expo_postavschuk_instruction_07.png

5 Отримання «Товарной спецификации»

ТМ Modern-Expo формує і відправляє підписаний ЕЦП комерційний документ «Товарна специфікація». Так як даний документ є юридично значимим перед його відправкою на нього необхідно накласти електронно цифровий підпис.

6 Рахунок на оплату (invoice)

Наступним документом є Рахунок на оплату (invoice). Для його створення зайдіть в вхідний документ Товарна специфікація. Документ знаходиться у вкладці «Вхідні».

_images/modern_expo_postavschuk_instruction_08.png

У відкритому документі натисніть «Сформувати» -«Рахунок-фактура».

_images/modern_expo_postavschuk_instruction_09.png

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

_images/modern_expo_postavschuk_instruction_10.png

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

_images/modern_expo_postavschuk_instruction_11.png

7 Повідомлення про відвантаження (Desadv)

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

_images/modern_expo_postavschuk_instruction_12.png

У відкритому документі натисніть «Сформувати» - «Повідомлення про відвантаження»

_images/modern_expo_postavschuk_instruction_13.png

У створений документ перенесуться основні дані з документа-підстави. Обов’язкові для заповнення поля будуть підсвічені червоною зірочкою *. Після заповнення документа натисніть «Зберегти» і «Надіслати». Після прийому товару контрагент Modern-Expo відправить Вам «Повідомлення про прийом» (Recadv). Документ буде у Вас відображатися у вкладці «Вхідні».

_images/modern_expo_postavschuk_instruction_14.png

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

Важливо

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

_images/modern_expo_postavschuk_instruction_15.png

8 Товарна накладна

Останнім документом, що закриває ланцюжок документів є Товарна накладна. Для створення документа зайдіть в отримане раніше «Повідомлення про прийом».

_images/modern_expo_postavschuk_instruction_16.png

Відкрийте документ і натисніть «Сформувати» - «Товарна накладна»:

_images/modern_expo_postavschuk_instruction_17.png

Документ створюється попередньо заповненим з документа-підстави. Всі обов’язкові для заповнення поля підсвічуються червоною зірочкою *. Якщо якесь обов’язкове поле буде незаповнено, то біля цього поля відобразиться повідомлення. Після заповнення документа натисніть «Зберегти». Так як документ є юридично значимим перед відправкою на нього необхідно накласти Електронно цифровий підпис (ЕЦП). Після підписання документа натисніть кнопку «Відправити».

9 Універсальний документ

Важливо

Увага! При необхідності з документом відправити додаткове вкладення, наприклад обґрунтування ціни, специфікацію товару і т.д. Зайдіть в будь-який відправлений раніше документ, натисніть «Сформувати» - «Універсальний документ».

_images/modern_expo_postavschuk_instruction_18.png

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

_images/modern_expo_postavschuk_instruction_19.png

На документ можна спочатку накласти ЕЦП (для цього натисніть кнопку «Підписати») або відправити не підписаним (для цього просто натисніть кнопку «Відправити»).

_images/modern_expo_postavschuk_instruction_20.png

Інструкція по роботі з документом «Прайс-лист» для PAMPIK (Лелека Трейд) на web-платформі

1 Формуваня документа «Прайс-лист»

Для входу на web платформу EDIN необхідно перейти за посиланням: https://edo.edi-n.com

Для формування документу в основному меню натискаємо на кнопку “Створити” та обираємо документ “Прайс-лист”.

_images/PricatPampikInstruction_01n.png

Відкриється форма документу для мережі «PAMPIK»:

_images/PricatPampikInstruction_02n.png

Поля «Отримувач», «Покупець» автоматично заповнені (GLN номер головного офісу 9864066874774, мережа «PAMPIK») та недоступні для редагування.

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

  • Номер прайс-листа — можна внести власний номер (при встановленій помітці, номер присвоюється автоматично)

  • Дата прайс-листа — поточна дата

  • Валюта — Гривня за замовчуванням

  • Тип документа — Прайс-лист (повний), Доповнення прайс-листа

  • «Дата з» - дата початку дії цін

  • «Дата до» - дата закінчення дії цін

Всі інші поля не є обов’язковими для заповнення.

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

_images/PricatPampikInstruction_03n.png

В правому верхньому куті буде відображене повідомлення:

_images/PricatPampikInstruction_04n.png

2 Додавання товарних позицій

2.1 Додавання товарних позицій за допомогою Шаблону

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

_images/PricatPampikInstruction_05n.png

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

  • Штрихкод

  • Найменування

  • Ціна

  • Ставка ПДВ

  • Ціна з ПДВ

Важливо

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

Підказка

В полі «Ставка ПДВ» необхідно вказати значення «0» або «7», або «20».

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

_images/PricatPampikInstruction_06n.png
2.2 Додавання позицій з товарного довідника

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

_images/PricatPampikInstruction_07n.png

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

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

_images/PricatPampikInstruction_08n.png

Інструкція щодо додавання продукції до товарного довідника — https://wiki.edi-n.com/uk/latest/general/Zapolnenie_Tovarnogo_spravochnika.html.

3 Збереження та відправка документу

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

Інтеграція

АPI

Даний розділ на стадії розробки. Приносимо свої вибачення.

Конфигурация AS2

Mendelson AS2 configuration

Таблица 1 - Mendelson AS2 configuration

AS2 решение

Mendelson AS2

Провайдер AS2

EDI-N

Операционная система

CentOS

AS2 Identifier (AS2_ID)

Production: EDI-N; Test: EDI-N-TEST

Параметры передачи данных

Таблица 2 - Параметры передачи данных

Описание

Значение

Комментарий

Передача данных с EDI-N

URL for AS2 connection

https://as2.edi-n.com/as2/HttpReceiver

URL (Encoding set applied)

IP address

91.194.88.14

Required for firewall

Port

80, 443

Required for firewall

Transport

https, http

http recommended

Basic HTTP authentication

No

Передача данных в EDI-N

IP address

91.194.88.11

Required for firewall

Transport

https, http

https port 443; http port 80 - recommended

AS2 Сертифицирование

Таблица 3 - AS2 Сертифицирование

Описание

Значение

Type of certificate

Сертификат выданый центром сертификации

Certificate validity period

RSA Encryption

Type of public key

2048 bit

Encryption algorithm

3DES

Notification method

Asynchronous

Certification type

Signed detached encrypted

Algorithm used for electronic signature

SHA1, SHA256

Compression of documents

No

Сертификаты используются при передаче данных по https, а также для их шифрования (дополнительного в случае передачи по https).

Полная цепочка сертификатов, необходимая для установки связи: root - intermedia - edin

Root сертификат - DigiCert_Global_Root_CA.crt

Сертификат Intermediate CA - Intermediate_CA.crt

Вложенный сертификат EDI-N (Organization Validation) - OV_edi-n.com.crt

SOAP API

WSDL схема для роботи з FTPEX по SOAP: https://soap.edi-n.com/soap/service.wsdl

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

Сигнатура (параметри які потрібно передати): логін і MD5 пароля (ті дані, які були видані користувачу при підключенні до платформи електронного документообігу) (MD5 генератор http://www.danstools.com/md5-hash-generator/).

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

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

<result>
           <errorCode>0</errorCode>
           <list>status_20150924144604_4679904.xml</list>
           <list>status_20150924144604_7259532.xml</list>
           <list>status_20150924144604_4784911.xml</list>
   ...
   ...
   <list>status_20151005123023_686803070.xml</list>
           <list>order_20151005132435_707890630.xml</list>
 </result>

Можливі помилки:

  • errorCode 1 - помилка при авторизації,

  • errorCode 2 - інша помилка

«Масове» отримання документів (кількох шуканих документів) (getDocuments)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля і конкретні імена файлів (імена файлів повертає getList)

Що повертає: код відповіді сервера (0 - успішна обробка), а також закодований в base64 zip архів із затребуваними файлами.

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

<soap:getDocumentsRequest>
   <!--Optional:-->
   <user>
      <!--Optional:-->
      <login>login</login>
      <!--Optional:-->
      <pass>parol</pass>
   </user>
   <!--Zero or more repetitions:-->
   <fileName>hello.xml</fileName>
  <fileName>musician.xml</fileName>
</soap:getDocumentsRequest>

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

<result>
   <errorCode>0</errorCode>
 <content>UEsDBBQACAgIAD...AAAA</content>
</result>

Можливі помилки:

  • errorCode 1 - помилка отримання документів (значення помилки повертається в <errorMessage/>)

Отримання конкретного файлу (getDoc)

Сигнатура (параметри, які потрібно передати): логін, MD5 пароля і конкретне ім’я файлу (імена файлів повертає getList)

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

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

<result>
          <errorCode>0</errorCode>
          <content>PFN0YXR1cz4KI...4KPC9TdGF0dXM+</content>
</result>

Вміст поля <content> перекладається в XML подання шляхом розшифровки BASE-64 (в результаті виходить тіло XML файлу).

Можливі помилки:

  • errorCode 1 - помилка при отриманні документа.

Передача конкретного файлу (sendDoc)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля, конкретне ім’я файлу і тіло файлу в вигляді BASE-64 рядка.

У відповідь отримуємо код відповіді сервера (0 - успішна передача).

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

<result>
           <errorCode>0</errorCode>
</result>

Можливі помилки:

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

Архівування документа (видалення конкретного файлу з сервера) (archiveDoc)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля і конкретне ім’я файлу (імена файлів повертає getList)

Що повертає: код відповіді сервера (0 - успішна обробка).

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

<result>
           <errorCode>0</errorCode>
</result>

Можливі помилки:

  • errorCode 4 - помилка при архівуванні документа

«Масове» архівування документів (видалення файлів з сервера) (archiveDocuments)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля і конкретне ім’я файлу (імена файлів повертає getList)

Що повертає: код відповіді сервера (0 - успішна обробка).

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

<soap:archiveDocumentsRequest>
   <!--Optional:-->
   <user>
      <!--Optional:-->
      <login>login</login>
      <!--Optional:-->
      <pass>parol</pass>
   </user>
   <!--Zero or more repetitions:-->
       <fileName>hello.xml</fileName>
     <fileName>musician.xml</fileName>
</soap:archiveDocumentsRequest>

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

<result>
           <errorCode>0</errorCode>
</result>

Можливі помилки:

  • errorCode 4 - помилка при архівуванні документа (значення помилки повертається в<errorMessage/>)

FTP/FTPS

Структура сервера:

  • inbox/ - каталог з вхідними документами

  • cinbox/ - каталог з вхідними документами, зі спец. настройками

  • outbox/ - каталог для вихідних документів

  • coutbox/ - каталог для вихідних документів, зі спец. настройками

  • error/ - каталог з помилковими документами, які не оброблені системою

  • reports/ - каталог для вихідних спец. документів ДФС

  • transit/ - службовий каталог

Примітки щодо використання:

Адреса сервера обміну ftp://ftp.edi-n.com

Якщо ви використовуєте формат обміну даними EDIN, то робочими папками будуть /outbox/ і /inbox/, а якщо використовуєте інший, раніше обумовлений формат обміну даними, то робочими папками будуть: /coutbox/ і /cinbox/.

За замовчуванням файли, які ви відправляєте, будуть з’являтися в веб-інтерфейсі системи у вкладці «Чернетки», але не будуть відправлятися в роздрібну мережу. Для настройки автоматичної відправки потрібен письмовий запит від користувача на адресу integration@edi-n.com.

Важливо

Увага, в іменах файлів для завантаження повинні використовуватися тільки цифри, латинські літери і символи «&», «_», «-» чи «.».

Платформа EDIN також підтримує FTPS з’єднання: ftps://ftp.edi-n.com

Використовуючи такий тип з’єднання, порт буде: 990

FTPS (File Transfer Protocol + SSL, або FTP / SSL) - це розширення широко використовуваного протоколу передачі даних FTP, яке додає підтримку для криптографічних протоколів рівнів транспортної безпеки і захищених сокетів.

Интеграция 1C

1C FTP

1C FTP Інструкція розробника
Перший запуск і настройка модуля

1.1. Скопіюйте файл модуля інтеграції Integration_ (версія_модуля).epf і папку з інсталяціями необхідних програм / install / в загальний каталог.

З 1С-Підприємства запускаємо файл зовнішньої обробки Integration_ (версія_модуля).epf (Файл-> Відкрити)

_images/prog_1C_FTP_integration_001.png

Перший запуск і установку модуля рекомендується проводити користувачем з правами адміністратора.

1.2. З головного меню що з’явилося - «Інтеграція EDI» викликати «Налаштування»

_images/prog_1C_FTP_integration_002.png

1.3. В викликаному меню «Інтеграція: Налаштування» перейти в Майстер налаштувань:

_images/prog_1C_FTP_integration_003.png

1.4. У вікні Майстра налаштувань послідовно виконати налаштуваня у вкладках розташованих зліва:

_images/prog_1C_FTP_integration_004.png

1.5. У вкладці «Загальні настройки інтеграції» в випадаючому списку вибрати Вид конфігурації (1) в якій працює Ваша 1С.

_images/prog_1C_FTP_integration_005.png

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

1.6. Представлені нижче налаштування (2) вибираються опціонально, в залежності від індивідуальних особливостей роботи постачальника.

Трохи докладніше про деякі з них:

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

Вантажоодержувач - це елемент довідника контрагентів. У базі може створюватися:

  • один контрагент і кілька точок доставки, які часто і є вантажоодержувачами (в такому випадку поле Вантажоодержувач, в довіднику Точки доставки заповнюється при необхідності);

  • окремий контрагент на кожну точку доставки: вантажоодержувач підміняє контрагента;

Для вказівки вантажоодержувача як контрагента відзначте прапорець Контрагент = Вантажоодержувач. Таким чином, при імпорті замовлення контрагент підміняється на вантажоодержувача (якщо заповнене поле Вантажоодержувач).

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

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

1.7. Перейшовши у вкладку «Налаштування БД» майстра налаштувань, необхідно встановити ODBC драйвер для SQLlite натиснувши на відповідну кнопку.

_images/prog_1C_FTP_integration_007.png

Запуститься інсталятор ODBC драйвера, під час установки якого не міняйте параметри за замовчуванням (нічого додатково не вказуючи).

Важливо

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

Після успішної установки драйвера встановіть рядок підключення.

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

На закладці З’єднання в пункті 1. Джерело даних встановіть перемикач на Використовувати рядок з’єднання і натисніть кнопку Збірка …

_images/prog_1C_FTP_integration_009.png

У вікні вибору джерела даних на закладці Джерело даних комп’ютера виберіть SQLite3 Datasource і натисніть ОК.

_images/prog_1C_FTP_integration_010.png

У вікні налаштувань з’єднання ODBC-драйвера в поле Database Name: прописуємо шлях, де буде знаходитися файл з даними для інтеграції.

_images/prog_1C_FTP_integration_011.png

В поле Database Name: можна вписати неіснуюче ім’я файлу, який буде створений для бази даних SQLite.

Для повернення в вікно властивостей каналу передачі даних натисніть кнопку ОК.

Рядок з’єднання буде заповнено. Для тестування з’єднання з базою даних натисніть кнопку Перевірити з’єднання. Для повернення в вікно властивостей каналу передачі даних натисніть кнопку ОК.

_images/prog_1C_FTP_integration_012.png

На вкладці Налаштування БД рядок підключення і файл із зовнішнього базою даних будуть заповнені. Після цього створіть структуру бази даних, натиснувши на кнопку Створити структуру БД:

_images/prog_1C_FTP_integration_013.png

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

_images/prog_1C_FTP_integration_014.png

1.9. У вкладці Налаштування FTP прописуємо шляхи до локальних каталогів для вхідних, вихідних і архівних документів, натиснувши «Заповнити за замовчуванням» або вказуємо їх вручну.

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

_images/prog_1C_FTP_integration_015.png

Примітка

Якщо планується працювати з великою кількістю документів, то при синхронізації на закачування нових документів може знадобитися більше часу (1С спочатку закачує, а потім обробляє Додані файли). Для прискорення процесу синхронізації можливо використовувати FTP-клієнт, який у фоновому режимі закачує файли і також автоматично відсилає файли, підготовлені до відправки. В цьому випадку FTP клієнт завантажує файли з сервера в локальний каталог, а 1С працює вже з локальними каталогами. Для активації цієї функції встановіть галочку навпроти «Завантажувати файли з використанням локального каталогу».

1.10. Налаштування на вкладці «ІТТ Користувач ЦСК-1» необхідно виконати в разі роботи з юридично значущими документами. Їх опис можна знайти в розділі «Налаштування та робота з юридично значущими документами»

1.11. У вкладці Організації з переліку організацій виберіть необхідну.

_images/prog_1C_FTP_integration_016.png

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

У формі натискаємо «+» і заповнюємо GLN організації, логін і пароль для підключення до FTP.

_images/prog_1C_FTP_integration_017.png

Примітка

GLN (англ. Global Location Number „глобальний номер розташування“) являє собою номер структури EAN / UCC-13 (з 13 цифр, остання - контрольна). GLN не містить в собі ніякої конкретної інформації, він забезпечує тільки унікальне посилання на суб’єкт господарювання або його виробничий або функціональний об’єкт.

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

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

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

_images/prog_1C_FTP_integration_018.png

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

По подвійному кліку на назву, викличте вікно форми елемента Контрагенти.

_images/prog_1C_FTP_integration_019.png

Заповніть GLN контрагента і активуйте типи документів, якими будете обмінюватися з даними контрагентом.

1.12. У довідник Роздрібні мережі вноситься інформація про роздрібні мережі, з якими планується проводити EDI-обмін. Цю інформацію можна отримати автоматично, натиснувши на кнопку Завантажити роздрібні мережі з сервера.

_images/prog_1C_FTP_integration_020.png

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

_images/prog_1C_FTP_integration_021.png

Після проставлення відповідності довідників натиснути на кнопку Завантажити точки доставки з сервера (автоматично заповниться довідник Точки доставки).

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

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

_images/prog_1C_FTP_integration_022.png

1.14. У довідник Номенклатура контрагентів вноситься перелік номенклатури, яка братиме участь в документообігу із зазначеним контрагентом. Для коректної синхронізації товарних довідників в зазначеному регістрі обов’язково (!) повинні бути заповнені поля Контрагент, Номенклатура, Одиниці виміру, Штрихкод номенклатури контрагента. Список номенклатури, штрихкодів і одиниць вимірювання можна отримати безпосередньо у роздрібній мережі, з якої буде проводитися EDI-обмін.

_images/prog_1C_FTP_integration_023.png

Примітка

Для пошуку номенклатури також використовується поле Артикул номенклатури, а якщо встановлено прапорець Вести облік номенклатури в розрізі характеристик (див. Пункт Майстер настройки), то і за характеристиками.

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

_images/prog_1C_FTP_integration_024.png
1C FTP Інструкція користувача
Робота з модулем
1. Вступ

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

2. Завантаження Замовлень

Для отримання і обробки замовлень в головному вікні «EDIN:Інтеграція» натисніть кнопку Замовлення.

_images/user_FTP_integration_01.png

У вікні що з’явилося відображається журнал замовлень.

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

_images/user_FTP_integration_02.png

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

Завантажені замовлення не створюються відразу в 1С, а завантажуються в базу даних модуля інтеграції. Якщо на підставі завантаженого замовлення в 1С були створені документи Замовлення покупця і / або Реалізація товарів і послуг, то посилання на створені документи можна побачити в колонках Замовлення 1С і Видат.накл. 1С.

_images/user_FTP_integration_03.png

Опис процедури створення даних документів в пунктах 2.3.Створення замовлень в 1С, та 2.4.Створення видаткової накладної

2.2 Відправлення Підтвердження замовлень (ORDRSP)

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

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

_images/user_FTP_integration_04.png

Після закінчення редагування встановіть стан замовлення в Готовий до відправлення і натисніть кнопку Записати (для збереження змін) або ОК (для збереження і закриття вікна).

Важливо

Для документів ORDRSP, DESADV що відправляються у відповідь, більше не має необхідності міняти стан перед відправкою на Готовий до відправлення. Стан потрібно міняти лише при перевідправці - з Відправлений на Готовий до відправлення.

_images/user_FTP_integration_05.png

Для відправки підтвердження замовлення відмітьте в списку замовлення, готові до відправки, і натисніть кнопку Експорт ORDRSP.

_images/user_FTP_integration_06.png

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

_images/user_1C_FTP_integration_08.png

Якщо відправка пройшла успішно, то стан замовлення зміниться на Відправлений. Після здійснення дій із замовленнями змінюються стани прапорів: ORDRSP вивантажено, DESADV вивантажено, RECADV завантажений.

_images/user_FTP_integration_07.png
2.3 Створення замовлень в 1С

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

_images/user_FTP_integration_08.png

Або у вікні замовлення натисніть кнопку Створити Замовлення в 1С.

_images/user_FTP_integration_09.png

В результаті відкриється вікно зі створеним замовленням (якщо одночасно створюються кілька замовлень, то вікно не з’явиться).

_images/user_FTP_integration_010.png

У формі списку замовлень заповниться поле Замовлення 1С номером замовлення в 1С.

_images/user_FTP_integration_011.png

Для перегляду замовлення в 1С виберіть замовлення в списку (прапорець можна не встановлювати) і натисніть кнопку Відкрити Замовлення 1С.

Важливо

На підставі завантаженого в базу модуля інтеграції замовлення можливо створити лише одне замовлення в 1С.

2.4 Створення видаткової накладної

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

_images/user_FTP_integration_012.png

В результаті відкриється вікно створеної видаткової накладної (якщо одночасно створюються кілька видаткових накладних, то вікно не з’явиться).

_images/user_FTP_integration_013.png

У формі списку замовлень навпроти замовлення заповниться поле Посилання на Видат. накл. номером документа Реалізація товарів і послуг в 1С.

_images/user_FTP_integration_014.png

Для перегляду документа 1С Реалізація товарів і послуг в журналі замовлень двічі клікніть на поле Видат. накл. 1С, а для перегляду форми видаткових накладних - натисніть кнопку Відкрити Видат. накл. 1С -> Реалізація товарів і послуг №XXXXXXXXX від DD.MM.YYYY hh: mm: ss.

Важливо

На підставі завантаженого в EDI замовлення можливо створити кілька реалізацій в 1С.

2.5 Видаткові накладні

Для роботи з видатковими накладними в головному вікні натисніть кнопку Видаткові накладні.

_images/user_FTP_integration_015.png

У вікні відображається журнал видаткових накладних.

_images/user_FTP_integration_016.png

Важливо! У разі, якщо Видаткова накладна була створена Введенням на підставі із Замовлення 1С (який в свою чергу був створений обробкою на підставі завантаженого замовлення EDI (!)), а не через обробку як описано в пункті 2.4, то необхідно встановити зв’язок із замовленням EDI вручну. Для цього в формі списку Видаткові накладні необхідно встановити галочки на необхідних документах і натиснути кнопку Створити Акти EDI-N:

_images/user_FTP_integration_017.png

Після чого, якщо замовлення по цій Реалізації був завантажений обробкою, в стовпці Стан відобразитися статус по цій Реалізації «НЕ ОБРОБЛЕНИЙ». Це означає, що зв’язок із замовленням встановлена і на таке замовлення можлива відправка Повідомлення про відвантаження.

2.6 Відправлення повідомлень про відвантаження (DESADV)

Важливо

Для документів ORDRSP, DESADV що відправляються у відповідь, більше не має необхідності міняти стан перед відправкою на Готовий до відправлення. Стан потрібно міняти лише при перевідправці - з Відправлений на Готовий до відправлення.

З видаткової накладної можна відправити повідомлення про відвантаження роздрібної мережі, натиснувши кнопку Вивантажити Повідомлення про відвантаження. Також можна відправити одне або кілька повідомлень зі списку видаткових накладних.

_images/user_FTP_integration_018.png

Після відправки Стан зміниться на «ВІДПРАВЛЕНО».

2.7 Отримання повідомлень про прийом (RECADV)

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

_images/user_FTP_integration_019.png

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

2.8 Експорт додатків до Повідомлення про відвантаження QUOTES для мережі Розетка

У формі Видаткові накладні зайти в потрібну реалізацію і в формі реалізації, у блоці Товари, натиснути кнопку QUOTES.

_images/user_FTP_integration_020.png

У формі праворуч натиснути кнопку зелений «+» і ввести серійні номери по позиціях. Кількість серійних номерів по кожній з товарних позицій має дорівнювати кількості одиниць цієї товарної позиції в Реалізації.

_images/user_FTP_integration_021.png

Відправка QUOTES відбувається аналогічно відправці DESADV, тільки після натискання кнопки Вивантажити додаток до Повід. про відвантаження для Розетка:

_images/user_FTP_integration_022.png
2.9 Відправка інструкції з транспортування IFTMIN

У формі списку Видаткові накладні зайти в потрібну Реалізацію і в формі реалізації перейти на вкладку Транспорт і в формі, що відкрилася заповнити відповідну інформацію:

_images/user_FTP_integration_023.png

Відправка IFTMIN відбувається аналогічно відправці DESADV, тільки після натискання кнопки Вивантажити інструкцію по транспортуванню:

_images/user_FTP_integration_024.png
3. Налаштування та робота з юридично значущими документами

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

У загальних настройках інтеграції (Налаштування -> Загальні налаштування інтеграції), необхідно активувати комерційний документ COMDOC і податкову накладну DECLAR встановивши відповідні позначки.

_images/user_1C_FTP_integration_29.png

У Майстрі налаштування (Налаштування -> Майстер настройки) перейти на вкладку «ITT Користувач ЦСК-1».

Майстер налаштування

_images/user_FTP_integration_026.png

На дану вкладку також можна перейти з форми «Налаштування», натиснувши на кнопку «ITT Користувач ЦСК-1»

_images/user_FTP_integration_027(31).png

Необхідно виконати наступні дії:

Встановити крипто-бібліотеку, натиснувши на кнопку «Встановити бібліотеку криптографії Користувач ЦСК-1».

Якщо ви використовуєте ключі ЕЦП, отримані від АЦСК «УСЦ» (МЕДок) або АЦСК «Україна», то даний пункт можна пропустити. Якщо у вас ключі ЕЦП, отримані від інших АЦСК (ІДД, Masterkey та ін.), То необхідно встановити програму «Користувач АЦСК ІДД Міндоходів», натиснувши на кнопку «Встановити «Користувач АЦСК ІДД Міндоходів»» в Майстрі налаштувань.

Після установки запустити програму «Користувач АЦСК ІДД Міндоходів», перейти до пункту меню «Параметри» і вибрати пункт «Перейти в режим on-line».

_images/user_1C_FTP_integration_32.png

Далі встановлюємо шлях до сховища сертифікатів, натиснути на кнопку «Параметри» -> «Встановити». У діалоговому вікні необхідно встановити шлях до каталогу з сертифікатами, натиснувши на кнопку «Змінити».

_images/user_1C_FTP_integration_33.png

Для того, щоб додати в сховище сертифікатів ваші сертифікати ЕЦП для підписання податкових накладних та інших документів, необхідно натиснути на кнопку «Перегляд сертифікатів» на вкладці «ITT Користувач ЦСК-1» Майстра налаштувань.

У діалоговому вікні «Сертифікати» необхідно натиснути на кнопку «Імпортувати» і вказати шлях до сертифікатів, які знаходяться в папці з інсталяціями необхідних програм / install / certificates.

_images/user_1C_FTP_integration_34.png

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

У діалоговому вікні «Сертифікати» можна також перевірити сертифікат або видалити зі сховища.

Далі необхідно вибрати сертифікати для шифрування ДФС (державної фіскальної служби) та сертифікат EDI-N.

_images/user_FTP_integration_031.png

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

_images/user_FTP_integration_032.png

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

_images/user_FTP_integration_033.png

Для всіх контрагентів з якими буде проводитися обмін електронними податковими накладними, необхідно в настройках активувати даний тип документа - ЕПН.

_images/user_FTP_integration_034.png

Для відправки ЕПН необхідно:

  • Завантажити обробкою інтеграції замовлення від роздрібної мережі, переданий по EDI.

  • На підставі замовлення створити в 1С видаткову накладну (документ «Реалізація товарів і послуг»).

  • На підставі Витратною накладної (документ «Реалізація товарів і послуг») відправити роздрібної мережі повідомлення про відвантаження (DESADV).

  • Завантажити від роздрібної мережі документ COMDOC, відправлений у відповідь на DESADV.

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

_images/user_FTP_integration_035(39).png

У вікні «Комерційні документи COMDOC» встановити період, за який необхідно завантажити документи «COMDOC», вибрати організацію в поле «Організація» і натиснути на кнопку «Загрузити COMDOC»

_images/user_FTP_integration_036.png

На підставі завантаженого документа «COMDOC» відкоригувати (при необхідності) видаткову накладну.

Якщо на завантаженому документі COMDOC були підписи роздрібної мережі, то в колонці «Підписано» для даного документа буде встановлена відповідна відмітка.

Такий документ необхідно підтвердити, натиснувши на кнопку «Підтвердити COMDOC».

_images/user_FTP_integration_037.png

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

_images/user_FTP_integration_038.png

Також реалізована можливість відправити відмова від підписання COMDOC.

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

_images/user_FTP_integration_039.png

Необхідно записати зміни і в формі списку Комерційні документи натиснути «Експорт відмов від підписання», попередньо виділивши необхідний документ відміткою.

Для відправки податкової накладної підставі видаткової накладної в 1С необхідно створити документ «Податкова накладна».

В обробці інтеграції перейти на форму «Податкові накладні», натиснувши на кнопку «ЕПН/РКПН».

_images/user_FTP_integration_040.png

На вкладці «Нові» встановити галочки навпроти документів, на підставі яких необхідно відправити ЕПН, і натиснути «Підписати і відправити ЕПН».

_images/user_FTP_integration_041.png

При відправці електронної податкової накладної (ЕПН) обробка запропонує вибрати ключ ЕЦП підписувача та ввести пароль обраної підпису, а також вибрати ключ ЕЦП печатки і ввести пароль обраної підпису.

Після цього підписані і зашифровані документи DECLAR (ЕНН) будуть відправлені на FTP, звідки будуть автоматично відправлені до Єдиного реєстру податкових накладних (ЄРПН) для реєстрації.

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

Для отримання квитанції від ЄРПН про результат реєстрації ЕПН, на вкладці «У обробці» потрібно натиснути на кнопку «Отримати квитанції»

_images/user_FTP_integration_042.png

На вкладках «У обробці» і «Завершені» відображаються події по виділеному документу «Податкова накладна», а також відображається інформація по нанесеним на документ підписами.

_images/user_1C_FTP_integration_47.png

Після успішного завантаження квитанцій від ЄРПН, посилання на відповідні податкові накладні перейдуть у вкладку «Завершені».

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

У разі необхідності відправки розрахунку коригування податкової накладної необхідно створити таке коригування в 1С.

Перейти у вкладку «РКНН (Додаток 2)» в формі списку Податкові накладні.

_images/user_FTP_integration_043.png

Далі діяти аналогічно як при відправці електронної податкової накладної.

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

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

У разі необхідності підписання і відправки ПН безпосередньо в ЄРПН, наприклад по клієнтам, які не працюють за EDI, необхідно скористатися формою надсилання «Звітність ПН»

_images/user_FTP_integration_044(49).png

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

_images/user_FTP_integration_045.png

У загальних настройках інтеграції встановіть відповідну позначку навпроти «Використовуємо звітність ПН».

_images/user_FTP_integration_046.png

Порядок роботи з формою «Звітність ПН» аналогічний роботі в формі «ЕПН / РКНН».

Відправлення Комерційного документа з ЕЦП «Видаткова накладна»

Виконати пункти в Майстрі налаштування по налаштуванню підписання документів з ЕЦП, якщо раніше вони не виконувалися (встановити криптобібліотеки, вказати шляхи для ключів ЕЦП, і т.д.).

У налаштуваннях перейти в форму «Контрагенти»:

_images/user_FTP_integration_047.png

У формі встановити чекер Використовуємо COMDOC вихідний, зберегти зміни:

_images/user_FTP_integration_048.png

У формі списку Комерційні документи «COMDOC» перейти на вкладку «Вихідні», із відображеного за вказаний період списку Видаткових накладних виділити галочками необхідні і натиснути «Надіслати Видаткову накладну». Обробка запропонує вибрати ключ ЕЦП підписувача та ввести пароль підпису, а також вибрати ключ ЕЦП печатки і ввести пароль підписи після чого Комерційний документ «Видаткова накладна» буде відправлений для його підтвердження мережею:

_images/user_FTP_integration_049.png

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

_images/user_FTP_integration_050.png
Завантаження STATUS файлів від мережі

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

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

_images/user_FTP_integration_051.png

Для завантаження статус файлів необхідно вибрати період завантаження і натиснути кнопку Завантажити STATUS файли.

_images/user_FTP_integration_052.png

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

_images/user_FTP_integration_053.png

Статус файли можна також завантажувати і по відправленим Комерційним документам на відповідній формі натиснувши Імпорт STATUS:

_images/user_FTP_integration_054.png
4. Регламентовані звіти і запити в ЄРПН

Важливо

Функціонал Регламентовані звіти і запити в ЄРПН більше не підтримується!

В даному модулі інтеграції реалізована можливість відправки регламентованої звітності з ЕЦП.

Принцип роботи модуля:

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

  • сформувати звіти заново (і вони відобразяться у відповідному журналі «Регламентований звіт» (назва журналу залежить від конфігурації 1С Підприємство)

  • зберегти звіт в формат XML

  • підписати і відправити звіт

  • завантажити квитанції \ реєстр з ЄРПН

Для відправки регламентованої звітності в головному меню обробки виберете «Створити Регл.звіти і Запит ЄРПН»

_images/user_1C_FTP_integration_58.png

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

_images/user_1C_FTP_integration_59.png

При необхідності сформуйте звіт.

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

_images/user_1C_FTP_integration_60.png

При необхідності змініть організацію або період формування, і натисніть кнопку ОК.

_images/user_1C_FTP_integration_61.png

Після цього в формі, що відкрилася натисніть на кнопку вивантажити в формат ДПАУ. Після чого закрийте форму формування запиту.

У вікні «Майстри вивантаження звітів» натисніть «Далі»:

_images/user_1C_FTP_integration_62.png

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

_images/user_1C_FTP_integration_63.png

Звіт буде вивантажено в зазначений каталог.

Для відправки запиту до загального реєстру податкових накладних в головному меню модуля виберете «Запит в ЄРПН / НН і РКНН»

_images/user_1C_FTP_integration_64.png

У вікні позначте необхідні документи проставивши галочки і натисніть «Надіслати звіти»

_images/user_1C_FTP_integration_65.png

Для підписання запиту в ЄРПН обробка запросить ввести пароль для ключа бухгалтера, директора і печатки підприємства (якщо у друку - 2 ключа, потрібно двічі ввести пароль).

_images/user_1C_FTP_integration_66.png

Введіть необхідні паролі, підтверджуючи кожен введення кнопкою ОК.

Завантаження квитанцій

Для завантаження квитанцій натисніть кнопку «Завантажити квитанції / ЕПН + РКНН».

_images/user_1C_FTP_integration_67.png

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

Якщо при натисканні на кнопку «Завантажити квитанції / ЕПН + РКНН» в службовому повідомленні внизу екрану відобразився текст «Відсутні файли для імпорту в каталозі» - це означає, що квитанції ще не були отримані від податкової або всі доступні квитанції вже були завантажені.

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

_images/user_1C_FTP_integration_68.png

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

_images/user_1C_FTP_integration_69.png

Подписание

E-Connector

Комплексы криптографической защиты информации

XML Специфікації

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

У специфікації представлено опис полів XML-документів, які застосовуються в електронному обміні даними на платформі EDI-N.

Під визначенням колонки Тип поля мається на увазі скорочене позначення: – M (mandatory) — обов’язкові для заповнення поля; – O (optional) — необов’язкові (опціональні) для заповнення поля.

Зміст:

Прайс-лист (PRICAT)

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

Назва поля

Тип

Формат

Опис

PRICAT

Початок документа

ACTION

M

« 9 »,« 13 »,« 51 »,« 21 »,« 99 »

Тип документа: 9 - прайс-лист (повний), 13 - запит прайс-листа, 51 - відповідь на прайс-лист, 21 - доповнення існуючого прайс-листа, 99 - відмова на прайс-лист

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

DATEFROM

O

Дата (РРРР-ММ-ДД)

Вступає в силу з дати

DATETO

O

Дата (РРРР-ММ-ДД)

Дата закінчення дії прайс-листа

TIMEFROM

O

Час (год: хв)

Вступає в силу з часу

TIMETO

O

Час (год: хв)

Час закінчення дії прайс-листа

CAMPAIGNNUMBER

O

Рядок (35)

Номер договору на поставку

PRICATINFO

O

Рядок (75)

Вільний текст

ORDERCONTACT

Контактна інформація

VAT

O

Число позитивне

Ставка ПДВ,%

CURRENCY

O

Рядок (3)

Тризначний код валюти (наприклад, UAH, RUB, USD, EUR, MDL, BYR)

STOREACTION

Дія для магазину (для ТМ Караван) - початок блоку

STOREGLN

GLN магазину дії прайс-листа

STOREACTION

Дія для магазину (для ТМ Караван) - закінчення блоку

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції (Унікальний номер, що генерується відправником)

CATALOGUE

Каталог (початок блоку)

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер товарної позиції (Порядковий номер товарної позиції в документі (1, 2, 3, 4 … n))

ACTION

M

« 2 »,« 3 »,« 4 »,« 27 »,« 29 »

Необхідна дія: 2 - додавання нових позицій, 3 - видалення, 4 - зміна, 27 - прийнято, 29 - не прийнято

ITEMAVAILABLE

O (M-для Розетка)

Так / Ні

Доступність товару до замовлення: 0 - немає, 1 - так

PRODUCT

M

Число (8, 10, 14)

Штрих-код продукту

PRODUCTGROUPCODE

O

Число (4)

Код групи товару

IDSUPPLIER

O (M-для Розетка)

Рядок (16)

Артикул в БД постачальника

IDBUYER

О

Рядок (16)

Артикул в БД покупця

MINORDERQUANTITY

O (M-для Розетка)

Число позитивне

Мінімальна кількість у замовленні

MINORDERQUANTITYUNIT

O

Рядок (3)

Одиниці виміру

MAXORDERQUANTITY

O

Число позитивне

Максимальна кількість в замовленні

MAXORDERQUANTITYUNIT

O

Рядок (3)

Одиниці виміру

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

QUANTITYOFCUINTUUNIT

O

Рядок (3)

Одиниці виміру

IDNATIONAL

O

Рядок (35)

Код товару за національним класифікатором (код УКТЗЕД)

IDINTERNATIONAL

O

Рядок (35)

Код товару за міжнародним класифікатором

IDGPC

O

Рядок (35)

Код продукту відповідає Global Product Classification

REPLACEPRODUCT

O

Число (8, 10, 14)

Продукт для заміни

PRODUCTGROUP

O

Рядок (6)

Товарна група

ANALOGPRODUCT

O

Число (8, 10, 14)

Описаний продукт має аналог

BRAND

O

Рядок (75)

Бренд (торгова марка)

SUBBRAND

O

Рядок (75)

суббренд (торгова марка нижчого рівня)

VARIATY

O

Рядок (75)

Варіант (різновид) назви продукту

FUNCTIONNAME

O

Рядок (75)

Функціональна назва

PRODUCTNAME

M

Рядок (75)

Повна назва продукту

NEWPOSITION

O

Число (1, 0)

Новинка

PROMO

О

Число (1, 0)

Акція

DEPTH

O

Число позитивне

Глибина

DEPTHUNIT

O

Рядок (3)

Одиниці виміру

WIDTH

O

Число позитивне

Ширина

WIDTHUNIT

O

Рядок (3)

Одиниці виміру

HEIGHT

O

Число позитивне

Висота

HEIGHTUNIT

O

Рядок (3)

Одиниці виміру

VOLUME

O

Число позитивне

Об’єм

VOLUMEUNIT

O

Рядок (3)

Одиниці виміру

WEIGHT

O

Число позитивне

Вага

WEIGHTUNIT

O

Рядок (3)

Одиниці виміру

TEMPERATUREOFSTORAGE

Температура зберігання (початок блоку)

FROM

O

Число [-100; 100]

Від (Температура зберігання продукту вказується в градусах за Цельсієм)

TO

O

Число [-100; 100]

До (Температура зберігання продукту вказується в градусах за Цельсієм)

TEMPERATUREOFSTORAGE

Температура зберігання (закінчення блоку)

COUNTRYORIGIN

O

Рядок (2)

Країна виробник (код держави за стандартом ISO-3166 (2 букви))

BESTBEFORDATE

O

Дата (РРРР-ММ-ДД)

Придатний до

CERTIFICATEOFCONFORMITY

O

Рядок (35)

Номер сертифіката відповідності

HYGIENICCERTIFICATE

O

Рядок (35)

Номер гігієнічного сертифіката

TAXRATE

M

Число позитивне

Ставка ПДВ,%

POSITIONCURRENCY

O (M-для Розетка)

Рядок

код валюти (UAH, RUB, USD …) по позиції

BALANCE

O

Число десяткове

Поточний залишок (постачальник)

UNITPRICE

M

Число десяткове

Ціна продукту без ПДВ

PRICEWITHVAT

M

Число десяткове

Ціна продукту з ПДВ

UNIT

М

Рядок (3)

Одиниці виміру

RETAILPRICE

O

Число десяткове

Рекомендована роздрібна ціна

ADVICEPRICE

O

Число десяткове

Рекомендована ціна (державою)

MAXORDERPRICE

O

Число десяткове

Максимальна роздрібна ціна

MINORDERPRICE

O

Число десяткове

Мінімальна роздрібна ціна

DISCONT

Знижка (початок блоку)

PERUNIT

O

Число позитивне

За одиницю

PERCENT

O

Число десяткове

Знижка у відсотках

DISCONT

Знижка (закінчення блоку)

PACKAGE

O

Рядок (2, 3)

Тип упаковки

QUANTITYOFBOX

О

Число позитивне

Кількість коробок

QUANTITYOFPALLET

О

Число позитивне

Кількість палет

INFO

O

Рядок (70)

Вільний текст

PARTYAVAILABILITY

O

0 / 1

Наявність партії у товару: 0 - немає, 1 - так

SSCCAVAILABILITY

O

0/1

Ознака серійного номера: 0 - немає, 1 - так

PRODUCTFACTOR

O

Рядок (12)

Об’єднуюча ознака товару

CONDITIONSTATUS

О

Рядок (3)

Статус кондиції

BONUSRATE

O

Число десяткове

Бонусна ставка

FOREIGNTRADECODE

О

Рядок

Код УКТ ЗЕД (для ТМ Дігма)

ENTERPRICE

О

Число

Введення позиції, грн (для ТМ Дігма)

RETROBONUS

О

Число

Ретро-бонус,% (для ТМ Дігма)

DELAYPAYMENT

О

Число

Відстрочка платежу (для ТМ Дігма)

POSITIONCURRENCY

О

Код валюти, допустимі значення:UAH, EUR, USD

ACTUALQUANTITY

О

Число позитивне

Залишок по позиції

POSITION

Товарні позиції (закінчення блоку)

CATALOGUE

Каталог (закінчення блоку)

PRICAT

Закінчення документа

Замовлення (ORDER)

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

Назва поля

Тип

Формат

Опис

ORDER

Початок документа

DOCUMENTNAME

М

Число позитивне

Назва документа (220 -замовлення)

NUMBER

М

Рядок (50)

Номер замовлення

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

ACTION

О

« 4 »,« 5 »,« 27 »,« 29 »

4 - поставка змінена, 5 - заміна документа, 29 - поставка прийнята, 27 - поставка не прийнята

EXCHANGE_SCHEMA_TYPE

O

лише для Фоззі: схема документообігу: 0-звичайна, 1-особлива

VERSION

O

Число позитивне

Версія замовлення

PROMO

O

« 0 »,« 1 »

Акція: 0 - немає, 1 - є

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Дата поставки

DELIVERYTIME

O

Час (год: хв)

Час поставки

SHIPMENTDATE

O

Дата (РРРР-ММ-ДД)

Дата відвантаження

SHIPMENTTIME

O

Час (год: хв)

Час відвантаження

CAMPAIGNNUMBER

O

Рядок (70)

Номер договору на поставку

CAMPAIGNNUMBERDATE

O

Дата (РРРР-ММ-ДД)

Дата договору

CURRENCY

O

Рядок (3)

Код валюти

TRANSPORTQUANTITY

O

Число позитивне

Кількість машин

ORDERREFERENCENUMBER

Рядок (16)

Унікальний номер замовлення для відстеження

LIMES

Деталі транспорту (початок блоку)

LIMESNAME

O

Рядок (70)

Назва рампи

DATEFROM

O

Дата (РРРР-ММ-ДД)

Дата прибуття транспорту

TIMEFROM

O

Час (год: хв)

Час прибуття транспорту

DATETO

O

Дата (РРРР-ММ-ДД)

Дата закінчення відвантаження

TIMETO

O

Час (год: хв)

Час закінчення відвантаження

LIMES

Деталі транспорту (закінчення блоку)

VAT

O

Число позитивне

Ставка ПДВ,%

TRANSPORTATIONTYPES

O

Рядок (35)

Вид транспортування

TRANSPORTATIONMEANS

O

Рядок (70)

Транспортний засіб

TRANSPORTATIONCONDITION

O

Рядок (70)

Умови транспортування

TRANSPORTATIONPAYMENTTYPE

O

Рядок (35)

Тип оплати доставки

TRANSPORTATIONROUTE

O

Рядок (70)

Маршрут доставки

BLANKETORDERNUMBER

O

Рядок (35)

Номер бланкового замовлення

INFOCODED

O

Рядок (35)

Інфокод

DOCTYPE

O

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення, F - фіктивність замовлення, PO - попереднє замовлення, OS - замовлення на послугу / маркетинг

CORRNUMBER

SUPORDER

O

Рядок (35)

Номер замовлення постачальника

KDKNUM

O

Рядок (35)

Номер загального замовлення КДК

ORDRTYPE

O

Рядок (35)

Тип замовлення

INFO

O

Рядок (70)

Вільний текст

EARLIESTDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Дата не раніше

LATESTDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Дата не пізніше

HEAD

Початок основного блоку

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

BUYERCODE

O

Рядок (35)

Код покупця

BRANCHCODE

O

Рядок

Код філіалу (для Нова Лінія та ЕПІЦЕНТР К )

DELIVERYPLACE

M

Число (13)

GLN місця доставки

FINALRECIPIENT

O

Число (13)

GLN кінцевого консигнатора

ORDERPARTNER

O

Число (13)

GLN замовника

INVOICEPARTNER

O

Число (13)

GLN платника

SENDER

M

Число (13)

GLN відправника повідомлення

RECIPIENT

M

Число (13)

GLN одержувача повідомлення

CONSIGNEE

О

Число (13)

GLN вантажоодержувача

RECIPIENTCODE

O

Рядок (35)

Код отримувача

RECIPIENTNAME

O

Рядок (70)

Ім’я одержувача

INFO

O

Рядок (70)

Вільний текст

DISCOUNTVALUE

O

Число позитивне

Розмір знижки

RECIPIENTCONTACTFACE

O

Рядок (70)

Контактна особа

RECIPIENTPHONE

O

Рядок (35)

Телефон одержувача

RECIPIENTCITY

O

Рядок (35)

Місто одержувача

RECIPIENTADRESS

O

Рядок (70)

Адреса одержувача

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер товарної позиції

PRODUCT

M

Число (8, 10, 14)

Штрихкод продукту

PRODUCTIDSUPPLIER

O

Рядок (16)

Артикул в БД

PRODUCTIDBUYER

O

Рядок (16)

Артикул в БД покупця

BUYERPARTNUMBER

О

Рядок (16)

Внутрішній системний номер артикулу в БД покупця

ORDEREDQUANTITY

M

Число позитивне

Замовлена ​​кількість

QUANTITYOFCUINTU

О

Число позитивне

Кількість в упаковці

ORDERUNIT

О

Рядок (3)

Одиниці виміру

QUANTITYOFPACKS

О

Число позитивне

Кількість упаковок

ORDERPRICE

O

Число десяткове

Ціна продукту без ПДВ

PRICEWITHVAT

O

Число десяткове

Ціна продукту з ПДВ

AMOUNT

O

Число десяткове

Сума товару (без ПДВ)

AMOUNTWITHVAT

О

Число десяткове

Сума товару (з ПДВ)

VAT

O

Число десяткове

Ставка ПДВ,%

CLAIMEDDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Оголошена дата доставки

CLAIMEDDELIVERYTIME

O

Час (год: хв)

Оголошений час доставки

DELIVERYPLACE

О

Число (13)

GLN кінцевого місця доставки

INFOCODED

O

Рядок (35)

Інфокод

MINIMUMORDERQUANTITY

O

Число позитивне

Мінімальна замовлена кількість

MAXIMUMORDERQUANTITY

O

Число позитивне

Максимально допустима відвантажувана кількість

PRODUCTIONCODE

О

Рядок (16)

Код алкогольної продукції

POSITIONKGM

М

Всього кілограм по позиції

INFO

O

Рядок (90)

Вільний текст

COMPAIGNNUMBER

O

Рядок (70)

Номер постачальника

EARLIESTDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Поставка не раніше зазначеної дати

LATESTDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Поставка не пізніше зазначеної дати

LATESTDELIVERYTIME

O

Час (год: хв)

Поставка не пізніше зазначеного часу

CONDITIONSTATUS

О

Рядок (3)

Статус кондиції

PACKAGEID

O

Число позитивне

Ідентифікатор упаковки

CATEGORYNAME

O

Рядок (70)

Найменування категорії товару

BRENDNAME

O

Рядок (70)

Найменування бренду

GROUPNAME

Найменування групи товару

NOVELTY

O

Новинка

COUNTPIECESINBOX

O

Число позитивне

Кількість частин в упаковці

COUNTBOXESINLAYER

O

Число позитивне

Кількість упаковок на 1 рівні

COUNTPERPALLET

O

Число позитивне

Кількість на палеті

WEIGHT

O

Число десяткове

Вага

PALLETS

O

Число позитивне

Кількість палет

COUNTRYORIGIN

О

Рядок (2)

Країна виробник

CALIBRE

O

Число позитивне

Діаметр

PRICEWITHDISCOUNT

O

Число десяткове

Ціна з урахуванням знижки

BOXESCOUNT

O

Число позитивне

Кількість упаковок

CHARACTERISTIC

Характеристики (початок блоку)

SERVICEDESCRIPTION

О/M (обов’язковий тільки для Замовлення послуги - ORDER з полем DOCTYPE=OS)

Рядок (500)

Назва послуги

DESCRIPTION

О

Рядок (70)

Опис продукту

CHARACTERISTIC

Характеристики (закінчення блоку)

PACKING

Упаковка (початок блоку)

PACKINGTYPE

O

Рядок (3)

Тип упаковки

PACKINGQUANTITY

O

Число позитивне

Кількість упаковок

PACKINGUNIT

O

Число позитивне

Пакувальник

PACKING

Упаковка (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

ORDER

Закінчення документа

Підтвердження замовлення (ORDRSP)

Підтвердження замовлення (ORDRSP) відправляється у відповідь на прийнятий документ Замовлення (ORDER). Основною особливістю Підтвердження замовлення є уточнення про постачання по кожній товарній позиції: чи буде товар доставлений; чи змінилася кількість/ціна чи буде відмова від поставки товарної позиції?

Назва поля

Тип

Формат

Опис

ORDRSP

Початок документа

NUMBER

M

Рядок (16)

Номер підтвердження замовлення

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

TIME

O

Час (год: хв)

Час створення документа

ORDERNUMBER

M

Рядок (50)

Номер замовлення

ORDERDATE

M

Дата (РРРР-ММ-ДД)

Дата замовлення

DELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Дата доставки

DELIVERYTIME

O

Час (год: хв)

Час поставки

SHIPMENTDATE

O

Дата (РРРР-ММ-ДД)

Дата відвантаження

CURRENCY

O

Рядок (3)

Код валюти

LIMES

Деталі транспорту (початок блоку)

LIMESNAME

O

Рядок (70)

Назва рампи

DATEFROM

O

Дата (РРРР-ММ-ДД)

Дата прибуття транспорту

TIMEFROM

O

Час (год: хв)

Час прибуття транспорту

DATETO

O

Дата (РРРР-ММ-ДД)

Дата закінчення відвантаження

TIMETO

O

Час (год: хв)

Час закінчення відвантаження

LIMES

Деталі транспорту (початок блоку)

VAT

O

Число позитивне

Ставка ПДВ,%

ACTION

О

« 4 »,« 5 »,« 27 »,« 29 »

4 - поставка змінена, 5 - заміна документа, 29 - поставка прийнята, 27 - поставка не прийнята

TOTALPACKAGES

O

Число десяткове

Кількість упаковок

TOTALPACKAGESSPACE

O

Число десяткове

Кількість місць для упаковок

TRANSPORTQUANTITY

O

Число позитивне

Кількість машин

DOCTYPE

О

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

SUPORDER

O

Рядок (35)

Номер замовлення постачальника

KDKNUM

O

Рядок (35)

Номер загального замовлення КДК

ORDRTYPE

O

Рядок (35)

Тип замовлення

INFO

O

Рядок (70)

Вільний текст

REASONINFO

O

Рядок (70)

Додаткова інформація

CAMPAIGNNUMBER

O

Рядок (70)

Номер договору

HEAD

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

BUYERCODE

O

Рядок (35)

Код покупця

SUPPLIER

M

Число (13)

GLN постачальника

DELIVERYPLACE

M

Число (13)

GLN місця доставки

FINALRECIPIENT

O

Число (13)

GLN кінцевого консигнатора

INVOICEPARTNER

O

Число (13)

GLN платника

SENDER

M

Число (13)

GLN відправника повідомлення

RECIPIENT

M

Число (13)

GLN одержувача повідомлення

CONSIGNEE

O

Число (13)

GLN вантажоодержувача

RECIPIENTCODE

O

Рядок (35)

Код отримувача

RECIPIENTNAME

O

Рядок (70)

Ім’я одержувача

RECIPIENTCONTACTFACE

O

Рядок (70)

Контактна особа

RECIPIENTPHONE

O

Рядок (35)

Телефон одержувача

RECIPIENTCITY

O

Рядок (35)

Місто одержувача

RECIPIENTADRESS

O

Рядок (70)

Адреса одержувача

DELIVERYTERMS

Терміни доставки (в днях)

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції (Унікальний номер, що генерується відправником)

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер товарної позиції (Порядковий номер товарної позиції в документі (1, 2, 3, 4 … n))

PRODUCT

M

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDBUYER

O

Рядок (16)

Артикул в БД покупця

PRODUCTIDSUPPLIER

O

Рядок (16)

Артикул в БД постачальника

ORDRSPUNIT

O

Рядок (3)

Одиниці виміру

DESCRIPTION

O

Рядок (70)

Опис продукту

PRICE

O

Число десяткове

Ціна продукту

PRICEWITHVAT

O

Число десяткове

Ціна продукту c ПДВ

DISCOUNT

О

Число позитивне

Знижка

VAT

O

Рядок (3)

Ставка ПДВ,%

AMOUNT

O

Число десяткове

Сума товару без ПДВ

AMOUNTWITHVAT

O

Число десяткове

Сума товару з ПДВ

TAXAMOUNT

М

Число десяткове

ПДВ

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

PRODUCTTYPE

M

« 1 »,« 2 »,« 3 »

1 - товар буде поставлений без змін, 2 - зміна замовленої кількості ,,, 3 - відмовлено в постачанні ,,,

ORDEREDQUANTITY

M

Число позитивне

Замовлена кількість

ACCEPTEDQUANTITY

M

Число позитивне

Наявна кількість

MINIMUMORDERQUANTITY

O

Число позитивне

Мінімальна замовлена кількість

MAXIMUMORDERQUANTITY

О

Число позитивне

Максимально допустима відвантажувана кількість

INFO

O

Рядок (70)

Вільний текст

CONDITIONSTATUS

О

Рядок (3)

Статус кондиції

PACKAGEID

O

Число позитивне

Ідентифікатор упаковки

COUNTRYORIGIN

О

Рядок (2)

Країна виробник

CALIBRE

О

Число позитивне

Калібр упаковки string (30)

PACKING

Упаковка (початок блоку)

PACKINGTYPE

O

Рядок (3)

Тип упаковки

PACKINGQUANTITY

O

Число позитивне

Кількість упаковок

PACKINGUNIT

O

Число позитивне

Пакувальник

PACKING

Упаковка (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

ORDRSP

Закінчення документа

Повідомлення про відвантаження (DESADV)

Повідомлення про відвантаження (DESADV) відправляє постачальник у відповідь на Замовлення (ORDER). При цьому постачальник може змінити кількість замовлених товарних позицій, що поставляються, дату і час поставки, додаткові відомості. Даний документ є аналогом товарно-транспортної накладної (ТТН)

Назва поля

Тип

Формат

Опис

DESADV

Початок документа

NUMBER

М

Рядок (16)

Номер повідомлення про відвантаження

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Дата поставки

DELIVERYTIME

O

Час (год: хв)

Час поставки

ORDERNUMBER

M

Рядок (50)

Номер замовлення

ORDERDATE

М

Дата (РРРР-ММ-ДД)

Дата замовлення

ORDRSPNUMBER

O

Рядок (16)

Номер підтвердження замовлення

ORDRSPDATE

O

Дата (РРРР-ММ-ДД)

Дата підтвердження замовлення

DELIVERYNOTENUMBER

М

Рядок (16)

Номер накладної

DELIVERYNOTEDATE

М

Дата (РРРР-ММ-ДД)

Дата накладної

RECIPTYPE

О

Рядок (1)

Доступні значення: 0 - «Пряма поставка на АТБ» (за замовчуванням), 1 - «Поставка зі складів Логістик Юніон».

SUPPLIERORDENUMBER

O

Рядок (35)

Номер замовлення в обліковій системі постачальника

SUPPLIERORDERDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

INFO

O

Рядок (70)

Вільний текст

CAMPAIGNNUMBER

O

Рядок (70)

Номер договору на поставку

TRANSPORTQUANTITY

O

Число позитивне

Кількість машин

TRANSPORTMARK

O

Рядок (70)

Марка машини

TRANSPORTID

O

Рядок (70)

Номер транспортного засобу

TRANSPORTERNAME

O

Рядок (70)

Ім’я водія

TRANSPORTERTYPE

O

Рядок (70)

Тип транспорту

TRANSPORTTYPE

О

Рядок (2, 3)

Тип транспортування: 20 - залізничний, 30 - дорожній, 40 - повітряний, 60 - спарений, 100 - кур’єрська служба

PACKAGEWIGHT

O

Число десяткове

Вага

TOTALPACKAGES

О(M-для Метро РЦ)

Число десяткове

Кількість коробів

TOTALPALLETS

О(M-для Метро РЦ)

Число десяткове

Кількість палет

HEAD

Початок основного блоку

SUPPLIER

М

Число (13)

GLN постачальника

SUPPLIERNAME

O

Рядок (70)

Ім’я постачальника

BUYER

М

Число (13)

GLN покупця

BUYERCODE

O

Рядок (35)

Код покупця

DELIVERYPLACE

M

Число (13)

GLN місця доставки

FINALRECIPIENT

O

Число (13)

GLN кінцевого консигнатора

SENDER

М

Число (13)

GLN відправника повідомлення

SENDERNAME

O

Рядок (70)

Ім’я відправника

SENDERPHONE

O

Рядок (35)

Телефон відправника

SENDERCITY

O

Рядок (70)

Місто відправника

SENDERADRESS

O

Рядок (70)

Адреса відправника

RECIPIENT

М

Число (13)

GLN одержувача повідомлення

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

PACKINGSEQUENCE

Робота з товарними позиціями (початок блоку)

HIERARCHICALID

М

Число позитивне

Номер ієрархії упаковки

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер товарної позиції

PRODUCT

М

Число (8, 10, 14)

Штрихкод продукту

PRODUCTIDSUPPLIER

О

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

О

Рядок (16)

Артикул в БД покупця

DELIVEREDQUANTITY

М

Число позитивне

кількість, що поставляється

DELIVEREDUNIT

О

Рядок (3)

Одиниці виміру

ORDEREDQUANTITY

О

Число позитивне

Замовлена кількість

ORDERUNIT

O

Рядок (3)

Одиниці виміру

SSCC

O

Число (18)

Серійний код транспортної упаковки

PARTYNAME

O

Рядок (70)

Назва виробника

INVOICEDQUANTITY

O

Число позитивне

Кількість за рахунком

INVOICEUNIT

O

Рядок (3)

Одиниці виміру

AMOUNT

O

Число десяткове

Сума товару без ПДВ

AMOUNTWITHVAT

O

Число десяткове

Сума товару з ПДВ

PORTAL_CERT

О

Рядок (30)

Номер сертифікату

CUSTOMSTARIFFNUMBER

О

Рядок (30)

Номер державної митної декларації (ВМД)

PRICE

O

Число десяткове

Ціна продукту без ПДВ

PRICEWITHVAT

О

Число десяткове

Ціна продукту c ПДВ

DISCOUNT

O

Число позитивне

Знижка

TAXRATE

O

Число (3)

Ставка податку (ПДВ,%)

CONDITIONSTATUS

О

Рядок (3)

Статус кондиції

DESCRIPTION

О

Рядок (70)

Опис продукту

PACKAGEID

O

Число позитивне

Ідентифікатор упаковки

PARTNUMBER

O

Рядок (35)

Номер партії

SERIALNUMBER

О

Рядок

Серійний номер, особливість для мед. постачальників

GOODDATE

О

Рядок

Термін придатності, особливість для мед. постачальників

MINIMUMORDERQUANTITY

O

Число позитивне

Мінімальна замовлена кількість

OCERTS

Дані вкладеного до товарної позиції сертифікату (початок блоку). Може містити кілька сертифікатів [CERT]

CERT

Початок блоку під один конкретний сертифікат

CERT_NUM

M

Рядок (16)

Номер документа (може містити спец. символи)

CERT_TYPE

M

Рядок (3)

Тип сертифіката * SS - сертифікат відповідності * SK - свідоцтво якості * DI - декларація імпортера * SES - свідоцтво СЕВ (Санітарно-епідеміологічний висновок) * DP - декларація виробника * KS - карантинний сертифікат * AFK - акт фітосанітарного контролю * FS - фітосанітарний сертифікат * SFE - свідоцтво фітосанітарної експертизи * PLI - протокол лабораторних випробувань * EZ - експертний висновок * ST - сертифікат типу

BATCH

O

Рядок (100)

Номер партії, на яку видано сертифікат

START_DATE

M

Дата (YYYY-MM-DD)

Дата початку дії сертифіката

END_DATE

O

Дата (YYYY-MM-DD)

Дата закінчення дії сертифіката

URL

M

Рядок (70)

Пряме хеш-посилання на скан-копію. В XML передається з амперсандом - & amp;

URL

O

Рядок (70)

друге і наступні хеш-посилання на скан-копії з ЕЦП. В XML передається з амперсандом - & amp;

CERT

Кінець блоку під один конкретний сертифікат

OCERTS

Дані вкладеного до товарної позиції сертифікату (закінчення блоку). Може містити кілька сертифікатів [CERT]

POSITION

Товарні позиції (закінчення блоку)

PACKINGSEQUENCE

Робота з товарними позиціями (закінчення блоку)

HEAD

Закінчення основного блоку

DESADV

Закінчення документа

Повідомлення про прийом (RECADV)

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

Назва поля

Тип

Формат

Опис

RECADV

Початок документа

NUMBER

М

Рядок (16)

Номер повідомлення про прийом

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

ACTION

Дія

EXCHANGE_SCHEMA_TYPE

O

лише для Фоззі: схема документообігу: 0-звичайна, 1-особлива

RECEPTIONDATE

М

Дата (РРРР-ММ-ДД)

Дата прийому товару

RECEPTIONTIME

O

Час (год: хв)

Час прийому товару

ORDERNUMBER

О

Рядок (50)

Номер замовлення

ORDERDATE

О

Дата (РРРР-ММ-ДД)

Дата замовлення

DESADVNUMBER

М

Рядок (16)

Номер повідомлення про відвантаження

DESADVDATE

О

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

DELIVERYNOTENUMBER

О

Рядок (16)

Номер накладної

DELIVERYNOTEDATE

O

Дата (РРРР-ММ-ДД)

Дата накладної

CAMPAIGNNUMBER

О

Рядок (16)

Номер договору на поставку

DOCTYPE

О

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

SUPPLIERORDENUMBER

O

Рядок (35)

Номер замовлення в обліковій системі постачальника

SUPPLIERORDERDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

TRANSPORTID

O

Число позитивне

Номер транспортного засобу

TOTALPACKAGES

O

Число десяткове

Загальна кількість упаковок

SUPORDER

O

Рядок (35)

Номер замовлення постачальника

KDKNUM

O

Рядок (35)

Номер загального замовлення КДК

ORDRTYPE

O

Рядок (35)

Тип замовлення

INFO

O

Число (13)

Додаткова інформація

BUYERACTNUMBER

Номер документа (акта) покупця

GOODSTOTALAMOUNT

М

Число десяткове

Всього без ПДВ

INVOICETOTALAMOUNT

М

Число десяткове

Сума за рахунком

TOTALVAT

O

Число позитивне

Загальна ставка ПДВ

TOTALAMOUNT

O

Число позитивне

Сума по документу без ПДВ

TOTALAMOUNTWITHVAT

O

Число позитивне

Сума по документу з ПДВ

HEAD

Початок основного блоку

SUPPLIER

М

Число (13)

GLN постачальника

SUPPLIERNAME

O

Рядок (70)

Ім’я постачальника

BUYER

М

Число (13)

GLN покупця

BUYERCODE

O

Рядок (35)

Код покупця

DELIVERYPLACE

М

Число (13)

GLN місця доставки

FINALRECIPIENT

O

Число (13)

GLN кінцевого отримувача

LOGISTICPARTNER

O

Число (13)

GLN перевізника

SENDER

О

Число (13)

GLN відправника

SENDERNAME

O

Рядок (70)

Ім’я відправника

SENDERPHONE

O

Рядок (35)

Телефон відправника

SENDERCITY

O

Рядок (70)

Місто відправника

SENDERADRESS

O

Рядок (70)

Адреса відправника

RECIPIENT

М

Число (13)

GLN одержувача

RECIPIENTCODE

О

Рядок (35)

Код отримувача

RECIPIENTNAME

O

Рядок (70)

Ім’я одержувача

RECIPIENTCONTACTFACE

O

Рядок (70)

Контактна особа

RECIPIENTPHONE

O

Рядок (35)

Телефон одержувача

RECIPIENTCITY

O

Рядок (35)

Місто одержувача

RECIPIENTADRESS

O

Рядок (70)

Адреса одержувача

INVOICEPARTNER

O

Число (13)

GLN платника

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

PACKINGSEQUENCE

Робота з товарними позиціями (початок блоку)

HIERARCHICALID

М

Число позитивне

Номер ієрархії упаковки

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер товарної позиції

PRODUCT

М

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDSUPPLIER

О

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

О

Рядок (16)

Артикул в БД покупця

BUYERPARTNUMBER

О

Рядок (16)

Внутрішній системний номер артикулу в БД покупця

ACCEPTEDQUANTITY

М

Число позитивне

Прийнята кількість товару

ACCEPTEDUNIT

O

Рядок (3)

Одиниці виміру

DELIVERQUANTITY

М

Число позитивне

Кількість товару, що поставляється

ORDERQUANTITY

М

Число позитивне

Замовлена кількість товару

DELTAQUANTITY

O

Число позитивне

Розбіжність

PRICE

O

Число десяткове

Ціна однієї одиниці продукції без ПДВ

PRICEWITHVAT

O

Число десяткове

Ціна однієї одиниці продукції з ПДВ

AMOUNT

O

Число десяткове

Сума товару (без ПДВ)

AMOUNTWITHVAT

O

Число десяткове

Сума товару (з ПДВ)

CONDITIONSTATUS

О

Рядок (3)

Статус кондиції

DESCRIPTION

О

Рядок (70)

Опис продукту

PACKAGEID

O

Число позитивне

Ідентифікатор упаковки

VAT

O

Число позитивне

Ставка ПДВ (%)

POSITION

Товарні позиції (закінчення блоку)

PACKINGSEQUENCE

Робота з товарними позиціями (закінчення блоку)

HEAD

Закінчення основного блоку

RECADV

Закінчення документа

Рахунок (INVOICE)

Рахунок (INVOICE) є повідомленням; в якому містяться дані по оплаті наданих послуг і товарів. В Рахунку обов’язково вказується ціна продукту без ПДВ; ставка ПДВ для кожної товарної позиції і підраховується сумарна вартість Замовлення.

Назва поля

Тип

Формат

Опис

INVOICE

Початок документа

DOCUMENTNAME

М

Рядок (16)

Назва документа (380 - Рахунок)

NUMBER

М

Рядок (16)

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

DATE

М

Дата (РРРР-ММ-ДД)

Дата створення рахунку

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Дата поставки

DELIVERYTIME

O

Час (год: хв)

Час поставки

CURRENCY

М

Рядок (3)

Код валюти

ORDERNUMBER

М

Рядок (50)

Номер замовлення

ORDERDATE

М

Дата (РРРР-ММ-ДД)

Дата замовлення

DELIVERYNOTENUMBER

М

Рядок (16)

Номер накладної

DELIVERYNOTEDATE

М

Дата (РРРР-ММ-ДД)

Дата накладної

RECADVNUMBER

O

Рядок (16)

Номер пов. про прийом

RECADVDATE

O

Дата (РРРР-ММ-ДД)

Дата пов. про прийом

REFERENCEINVOICENUMBER

O

Рядок (15)

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

REFERENCEINVOICEDATE

O

Дата (РРРР-ММ-ДД)

Дата рахунку

GOODSTOTALAMOUNT

М

Число десяткове

Всього без ПДВ

POSITIONSAMOUNT

М

Число десяткове

Всього за позиціями

VATSUM

М

Число десяткове

Сума ПДВ

INVOICETOTALAMOUNT

М

Число десяткове

Сума за рахунком

TAXABLEAMOUNT

М

Число десяткове

База оподаткування

DISCOUNTAMOUNT

О

Число позитивне

Сума знижки

CONDITIONSAMOUNT

О

Число позитивне

Узгоджена сума оплати

FREIGHTCHARGE

О

Число позитивне

Плата за перевезення вантажу

PAYMENTORDERNUMBER

О

Рядок (35)

Номер платіжно-розрахункового документа або зеленої марки

FISCALNUMBER

О

Рядок (35)

ІПН

REGISTRATIONNUMBER

О

Рядок (35)

ЄДРПОУ

VATNUMBER

О

Рядок (16)

Номер свід. ПДВ

CAMPAIGNNUMBER

О

Рядок (16)

Номер договору на поставку

MANAGER

О

Рядок (35)

Ім’я менеджера

ACCOUNTING

О

Рядок (35)

Ім’я головного бухгалтера

VAT

М

Число позитивне

Ставка ПДВ,%

DOCUMENTSAFTERGOODSRECEIPT

Момент подання документів на поставку, можливі значення: 0 - До початку поставки товару; 1 - Після поставки товару

DOCTYPE

О

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

HEAD

Початок основного блоку

SUPPLIER

М

Число (13)

GLN постачальника

SUPPLIERNAME

O

Рядок (70)

Ім’я постачальника

SUPPLIERADRESS

O

Рядок (70)

Адреса постачальника

SUPPLIERCITY

O

Рядок (70)

Місто постачальника

SUPPLIERZIP

O

Рядок (35)

Індекс постачальника

BUYER

М

Число (13)

GLN покупця

BUYERNAME

O

Рядок (35)

Ім’я покупця

BUYERADRESS

O

Рядок (35)

Адреса покупця

BUYERCITY

O

Рядок (35)

Місто покупця

BUYERZIP

O

Число позитивне

Індекс покупця

BUYERINN

O

Число позитивне

ІПН покупця

DELIVERYPLACE

M

Число (13)

GLN місця доставки

DELIVERYTERMS

О

Тип відвантаження; можливі значення: 1 - Самовивіз; 2 - Доставка постачальником

CONSEGNOR

О

Число (13)

GLN вантажовідправника

INVOICEPARTNER

O

Число (13)

GLN платника

INVOICEPARTNERINN

O

Число позитивне

ІПН платника

FINALRECIPIENT

O

Число (13)

GLN кінцевого консигнатора

ORDERPARTNER

O

Число (13)

GLN замовника

CONSEGNOR

О

Число (13)

GLN вантажовідправника

CONSEGNORNAME

O

Рядок (35)

Ім’я вантажовідправника

CONSEGNORADRESS

O

Рядок (35)

Адреса вантажовідправника

CONSEGNORCITY

O

Рядок (35)

Місто вантажовідправника

CONSEGNORZIP

O

Число позитивне

Індекс вантажовідправника

CONSIGNEE

О

Число (13)

GLN вантажоодержувача

CONSIGNEENAME

O

Рядок (35)

Ім’я вантажоодержувача

CONSIGNEEADRESS

O

Рядок (35)

Адреса вантажоодержувача

CONSIGNEECITY

O

Рядок (35)

Місто вантажоодержувача

CONSIGNEEZIP

O

Число позитивне

Індекс вантажоодержувача

CONSIGNEEINN

O

Число позитивне

ІПН вантажоодержувача

SENDER

М

Число (13)

GLN відправника повідомлення

RECIPIENT

М

Число (13)

GLN одержувача повідомлення

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

BANKNAME

O

Рядок (70)

Найменування банку

BANKMFONUMBER

О

Число (6)

МФО банку

BANKACCOUNT

Рядок (35)

Номер р/р

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число * 1, 100 +

Номер позиції.

PRODUCT

М

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDSUPPLIER

О

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

О

Рядок (16)

Артикул в БД покупця

BUYERPARTNUMBER

О

Рядок (16)

внутрішній системний номер артикулу в БД покупця

PRODINN

O

Число позитивне

ІПН виробника/імпортера

INVOICEDQUANTITY

М

Число позитивне

Кількість за рахунком

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

INVOICEUNIT

O

Рядок (3)

Одиниці виміру

UNITPRICE

М

Число десяткове

Ціна за одиницю (без ПДВ)

ADVICEPRICE

O

Число десяткове

Рекомендована ціна (державою)

GROSSPRICE

O

Число десяткове

Ціна за одиницю з ПДВ

GROSSAMOUNT

O

Число десяткове

Сума з ПДВ

AMOUNT

М

Число десяткове

Сума товару (без ПДВ)

COUNTRYORIGIN

О

Рядок (2)

Країна виробник

CUSTOMSTARIFFNUMBER

О

Рядок (35)

Номер державної митної декларації (ВМД)

CUSTOMSTARIFFNUMBERDATE

О

Дата (РРРР-ММ-ДД)

Дата ВМД

FOREIGNTRADECODE

О

Рядок (35)

Код товара по УКТВЕД11 (для України)

DESCRIPTION

О

Рядок (70)

Опис продукту

AMOUNTTYPE

М

Число (3)

Службове поле

TAX

Логістика (початок блоку)

FUNCTION

М

Число (1)

5 - мито, 6 - грошовий збір, 7 - податок

TAXTYPECODE

М

Рядок (3)

Код податку (ПДВ)

TAXRATE

М

Число (3)

Ставка податку (ПДВ,%)

TAXAMOUNT

М

Число десяткове

ПДВ

CATEGORY

М

Рядок (1)

S - стандартна, А - змішана, Z - нульовий збір

TAX

Логістика (закінчення блоку)

PRODUCTIONCODE

Рядок (16)

Код алкогольної продукції

BOTTLING

Партія розливу (початок блоку)

BOTTLINGNUMBER

Число (2)

Номер партії розливу

BOTTLINGDATE

Дата (РРРР-ММ-ДД)

Дата партії розливу

BOTTLING

Партія розливу (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

INVOICE

Закінчення документа

Коригування рахунку (KORINVOICE)

Назва поля

Тип

Формат

Опис

INVOICE

Початок документа

DOCUMENTNAME

М

Рядок (16)

Назва документа (380 - Рахунок)

NUMBER

М

Рядок (16)

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

DATE

М

Дата (РРРР-ММ-ДД)

Дата створення рахунку

INVOICENUMBER

Рядок (16)

номер ТН (номер RECADV)

INVOICEDATE

Дата (РРРР-ММ-ДД)

дата ТН

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Дата поставки

DELIVERYTIME

O

Час (год: хв)

Час поставки

CURRENCY

М

Рядок (3)

Код валюти

ORDERNUMBER

М

Рядок (50)

Номер замовлення

ORDERDATE

М

Дата (РРРР-ММ-ДД)

Дата замовлення

DELIVERYNOTENUMBER

М

Рядок (16)

Номер накладної

DELIVERYNOTEDATE

М

Дата (РРРР-ММ-ДД)

Дата накладної

RECADVNUMBER

O

Рядок (16)

Номер пов. про прийом

RECADVDATE

O

Дата (РРРР-ММ-ДД)

Дата пов. про прийом

REFERENCEINVOICENUMBER

O

Рядок (15)

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

REFERENCEINVOICEDATE

O

Дата (РРРР-ММ-ДД)

Дата рахунку

GOODSTOTALAMOUNT

М

Число десяткове

Всього без ПДВ

POSITIONSAMOUNT

М

Число десяткове

Всього по позиціях

VATSUM

М

Число десяткове

Сума ПДВ

INVOICETOTALAMOUNT

М

Число десяткове

Сума за рахунком

TAXABLEAMOUNT

М

Число десяткове

База оподаткування

DISCOUNTAMOUNT

О

Число позитивне

Сума знижки

CONDITIONSAMOUNT

О

Число позитивне

Узгоджена сума оплати

FREIGHTCHARGE

О

Число позитивне

Плата за перевезення вантажу

PAYMENTORDERNUMBER

О

Рядок (35)

Номер платіжно-розрахункового документа або зеленої марки

FISCALNUMBER

О

Рядок (35)

ІПН

REGISTRATIONNUMBER

О

Рядок (35)

ЄДРПОУ

VATNUMBER

О

Рядок (16)

Номер свід. ПДВ

CAMPAIGNNUMBER

О

Рядок (16)

Номер договору на поставку

MANAGER

О

Рядок (35)

Ім’я менеджера

ACCOUNTING

О

Рядок (35)

Ім’я головного бухгалтера

VAT

М

Число позитивне

Ставка ПДВ,%

HEAD

Початок основного блоку

SUPPLIER

М

Число (13)

GLN постачальника

SUPPLIERNAME

O

Рядок (70)

Ім’я постачальника

SUPPLIERADRESS

O

Рядок (70)

Адреса постачальника

SUPPLIERCITY

O

Рядок (70)

Місто постачальника

SUPPLIERZIP

O

Рядок (35)

Індекс постачальника

BUYER

М

Число (13)

GLN покупця

BUYERID

BUYERNAME

O

Рядок (35)

Ім’я покупця

BUYERADRESS

O

Рядок (35)

Адреса покупця

BUYERCITY

O

Рядок (35)

Місто покупця

BUYERZIP

O

Число позитивне

Індекс покупця

BUYERINN

O

Число позитивне

ІПН покупця

DELIVERYPLACE

M

Число (13)

GLN місця доставки

CONSEGNOR

О

Число (13)

GLN вантажовідправника

INVOICEPARTNER

O

Число (13)

GLN платника

INVOICEPARTNERINN

O

Число позитивне

ІПН платника

FINALRECIPIENT

O

Число (13)

GLN кінцевого консигнатора

ORDERPARTNER

O

Число (13)

GLN замовника

CONSEGNOR

О

Число (13)

GLN вантажовідправника

CONSEGNORNAME

O

Рядок (35)

Ім’я вантажовідправника

CONSEGNORADRESS

O

Рядок (35)

Адреса вантажовідправника

CONSEGNORCITY

O

Рядок (35)

Місто вантажовідправника

CONSEGNORZIP

O

Число позитивне

Індекс вантажовідправника

CONSIGNEE

О11

Число (13)

GLN вантажоодержувача

CONSIGNEENAME

O

Рядок (35)

Ім’я вантажоодержувача

CONSIGNEEADRESS

O

Рядок (35)

Адреса вантажоодержувача

CONSIGNEECITY

O

Рядок (35)

Місто вантажоодержувача

CONSIGNEEZIP

O

Число позитивне

Індекс вантажоодержувача

CONSIGNEEINN

O

Число позитивне

ІПН вантажоодержувача

SENDER

М

Число (13)

GLN відправника повідомлення

RECIPIENT

М

Число (13)

GLN одержувача повідомлення

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

BANKNAME

O

Рядок (70)

Найменування банку

BANKMFONUMBER

О

Число (6)

МФО банку

BANKACCOUNT

Рядок (35)

Номер р/р

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число * 1, 100 +

Номер позиції.

PRODUCT

М

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDSUPPLIER

О

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

О

Рядок (16)

Артикул в БД покупця

BUYERPARTNUMBER

О

Рядок (16)

внутрішній системний номер артикулу в БД покупця

PRODINN

O

Число позитивне

ІПН виробника/імпортера

INVOICEDQUANTITY

М

Число позитивне

Кількість за рахунком

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

INVOICEDQUANTITYBEFORE

INVOICEDQUANTITYAFTER

INVOICEUNIT

O

Рядок (3)

Одиниці виміру

UNITPRICEBEFORE

UNITPRICEAFTER

UNITPRICE

М

Число десяткове

Ціна за одиницю (без ПДВ)

ADVICEPRICE

O

Число десяткове

Рекомендована ціна (державою)

GROSSPRICE

O

Число десяткове

Ціна за одиницю з ПДВ

GROSSAMOUNT

O

Число десяткове

Сума з ПДВ

AMOUNT

М

Число десяткове

Сума товару (без ПДВ)

AMOUNTBEFORE

AMOUNTAFTER

AMOUNTWITHVAT

О

Число десяткове

Сума товару (з ПДВ)

AMOUNTWITHVATBEFORE

AMOUNTWITHVATAFTER

COUNTRYORIGIN

О

Рядок (2)

Країна виробник

CUSTOMSTARIFFNUMBER

О

Рядок (35)

Номер державної митної декларації (ВМД)

CUSTOMSTARIFFNUMBERDATE

О

Дата (РРРР-ММ-ДД)

Дата ВМД

FOREIGNTRADECODE

О

Рядок (35)

Код товара по УКТВЕД11 (для України)

DESCRIPTION

О

Рядок (70)

Опис продукту

AMOUNTTYPE

М

Число (3)

Службове поле

TAX

Податки (початок блоку)

FUNCTION

М

Число (1)

5 - мито, 6 - грошовий збір, 7 - податок

TAXTYPECODE

М

Рядок (3)

Код податку (ПДВ)

TAXRATE

М

Число (3)

Ставка податку (ПДВ,%)

TAXAMOUNT

М

Число десяткове

ПДВ

TAXAMOUNTBEFORE

TAXAMOUNTAFTER

CATEGORY

М

Рядок (1)

S - стандартна, А - змішана, Z - нульовий збір

TAX

Податки (закінчення блоку)

PRODUCTIONCODE

Рядок (16)

Код алкогольної продукції

BOTTLING

Партія розливу (початок блоку)

BOTTLINGNUMBER

Число (2)

Номер партії розливу

BOTTLINGDATE

Дата (РРРР-ММ-ДД)

Дата партії розливу

BOTTLING

Партія розливу (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

INVOICE

Закінчення документа

Комерційний документ (COMDOC)

COMDOC (ЕлектроннийДокумент) – документ, призначений для обміну в електронному вигляді юридично значимими документами (за умови укладення між контрагентами договору «Про визнання електронних документів» та використання електронно-цифрового підпису).

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

ТипСхеми

О

0 чи 1

0 - стандартна схема (з попереднім узгодженням); 1 - нестандартна схема (без попереднього узгодження)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ПричинаАнулювання

Причина, з якої документ анулюється (вважається недійсним)

ДатаАнулювання

Дата (РРРР-ММ-ДД)

Дата, з якої документ анулюється (вважається недійсним)

НомерЗамовлення

О

Рядок (20)

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

ПроцентШтрафу

О

Відсоток штрафу

ДатаЗамовлення

О

Дата (РРРР-ММ-ДД)

Дата здійснення замовлення

НомерДоговоруПоставки

О

Номер договору, за яким здійснюється поставка

ДатаДоговоруПоставки

О

Дата (РРРР-ММ-ДД)

Дата договору, за яким здійснюється поставка

ПлановаДатаДоставки

Дата (РРРР-ММ-ДД)

Планова дата доставки

МісцеСкладання

Місце складання документу

НомерТовУзгодження

О

Рядок (16)

Номер товарного узгодження

ДатаТовУзгодження

О

Дата (РРРР-ММ-ДД)

Дата товарного узгодження

НомерКонтракту

О

Рядок (16)

Номер контракту

ДатаКонтракту

О

Дата (РРРР-ММ-ДД)

Дата контракту

ТермінДії

О

Кількість входжень вузла: Min = 0; Max = 1

Термін, на період якого документ вважається чинним (початок блоку)

Початок

М

Дата (РРРР-ММ-ДД)

Дата початку дії документу

Кінець

М

Дата (РРРР-ММ-ДД)

Дата закінчення терміну дії документу

ТермінДії

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

ТермінПідпису

О

Термін, у межах якого можна підписати документ (початок блоку)

Початок

Дата (РРРР-ММ-ДД)

Дата початку терміну дії підписання

Кінець

Дата (РРРР-ММ-ДД)

Дата закінчення терміну дії підписання

ТермінПідпису

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

ПеріодНаданняПослуг

Термін, на період якого надаються послуги (початок блоку)

Початок

О

Дата (РРРР-ММ-ДД)

Дата початку періоду, на час якого надаються послуги

Кінець

О

Дата (РРРР-ММ-ДД)

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

ПеріодНаданняПослуг

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

МісцеСкладання

О

Рядок (100)

Місце укладання документу

Коментар

О

Рядок (50)

Максимальна кількість тегів – 10. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

ДокументЩоАнулюється

Документ, що аннулюється (початок блоку)

НомерДокументу

М

Рядок (20)

Номер документу, що анулюється

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата документу, що анулюється

ДокументЩоАнулюється

Документ, що аннулюється (завершення блоку)

Відхилив

До заповнення реквізитами компанії, що відхиляє документ (початок блоку)

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична; Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

Блок індивідуального податкового номера

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво платника ПДВ (податку на додану вартість)

МФО

О

Рядок

МФО банку

Телефон

О

Рядок (20)

Телефон контрагента

ІПН

Блок індивідуального податкового номера

Відхилив

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

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична; Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Банк

Банк контрагента

Телефон

О

Рядок (20)

Телефон

GUID

О

Рядок (36)

Глобальний унікальний ідентифікатор (GUID) контрагента

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

ВОсобіДиректора

Директор

ЮрАдреса

О

Юридична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ЮрАдреса

Юридична адреса контрагента (завершення блоку)

ФактАдреса

О

Фактична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ФактАдреса

Фактична адреса контрагента (завершення блоку)

ПоштАдреса

О

Поштова адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ПоштАдреса

Поштова адреса контрагента (завершення блоку)

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Текст

O

Рядок

Тег призначений для передачі значного об’єму тексту (наприклад, текст договору, додаткової угоди, тощо). Розмір тексту необмежений. Весь текст має бути вкладений в конструкцію: <![CDATA[текст]]>

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

АртикулПродавця

О

Рядок (10)

Артикул продавця

КодУКТЗЕД

О

Integer (10)

Код товару згідно з УКТ ЗЕД; для COMDOC 006 значення не менше 4 і не більше 10 символів

Найменування

М

Рядок (50)

Найменування товарної позиції

ЗаявленаКількість

О

Decimal (#.00)

Заявлена кількість товарних позицій

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ПунктНавантаженняАдреса

М

Рядок (200)

Адреса навантаження Для COMDOC 018 «ПунктНавантаженняАдреса» і «ПунктРозвантаженняАдреса» заповнюється в одній клітинці через дефіс

ПунктРозвантаженняАдреса

М

Рядок (200)

Адреса розвантаження Для COMDOC 018 «ПунктНавантаженняАдреса» і «ПунктРозвантаженняАдреса» заповнюється в одній клітинці через дефіс

ТЗНомерАвто

М

Рядок (10)

Державний номер автомобіля

ТЗНомерПричіп

О

Рядок (10)

Державний номер причепа

НомерТТН

М

Рядок (20)

Номер товарно-транспортної накладної

ДатаТТН

М

Дата (РРРР-ММ-ДД)

Дата товарно-транспортної накладної

МасаБрутто

М

Decimal (#.00)

Вага товару

ДовжинаВантажу

О

Decimal (#.00)

Довжина вантажу

ОбємВантажу

О

Decimal (#.00)

Об’єм вантажу

КількістьМісць

О

Decimal (#.00)

Кількість вантажних місць, палет

СтрокТранспортування

О

Decimal (#.00)

Термін доставки, днів

Примітка

О

Рядок (200)

Примітка

МісцеПроведенняРоботи

О

Місце проведення роботи

КількістьОдВЯщику

О

Кількість одиниць в ящику (шт/кг)

ФактичнаКількістьЯщиків

О

Фактична кількість ящиків

КількістьПоНакладній

О

Кількість по накладній

ПоставляємаКількість

О

Кількість доставлених одиниць

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ЦінаФакт

Фактична ціна

ЦінаПостачальника

Ціна постачальника

ЦінаПоДокументу

Ціна по документу

СумаНакладна

По накладній

СумаПрийнято

Прийнята сума

Номер

О

Номер

Дата

О

Дата (РРРР-ММ-ДД)

Дата

НакладнаНомер

Номер накладної

НомерЗамовлення

О

Рядок (20)

Номер замовлення

ШтрихкодТрансУпаковкиSSCC

О

Число (14, 18)

Штрихкод транспортной упаковки SSCC

МаршрутВідправлено

Пункт відправлення товару (Для COMDOC 023 пункти «Відправлено» і «Отримано» заповнюються в одній клітинці «Маршрут»)

МаршрутОтримано

Пункт отримання товару (Для COMDOC 023 пункти «Відправлено» і «Отримано» заповнюються в одній клітинці «Маршрут»)

Кількість

М

Decimal (#.00)

Кількість одиниць товару

Вага

О

Вага

Сума

О

Decimal (#.00)

Сума вартості товару

СумаСтрахування

О

Сума страхування

Платник

О

ПІБ платника

Відправник

О

ПІБ відправника

Отримувач

О

ПІБ отримувача

АдресаДоставки

О

Адреса доставки

ЗонаДоставки

О

Зона доставки

КількістьПромо

О

Кількість товарів промо

СтавкаПДВ

Ставка податку на додану вартість

Текст

О

Рядок (100)

Додаткова інформація

ІД

Ідентифікатори позиції (початок блоку)

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Штрихкод

ІД

Ідентифікатори позиції (завершення блоку)

АртикулПокупця

О

Рядок (10)

Артикул покупця

АртикулПродавця

О

Рядок (10)

Артикул продавця

КодУКТЗЕД

Код товару згідно з УКТ ЗЕД

Найменування

М

Рядок (50)

Найменування товарної позиції

МісцеПроведенняРоботи

Місце проведення роботи

ЗаявленаКількість

О

Decimal (#.00)

Заявлена кількість товарних позицій

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

БазоваЦіна

Базова ціна

Ціна

Ціна

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

СумаЗнижки

Сума знижки

ПроцентЗнижки

О

Integer (10)

Процент знижки

ДатаПродажу

О

Дата (РРРР-ММ-ДД)

Дата продажу

ФактЦенаПродажи

Фактична ціна продажу

ФактЦенаВозвПокуп

Фактична ціна повернення покупки

ФактЦенаВозвКомис

Фактична комісія при поверненні

СумКомитенту

Сума комітенту

СумаВинагороди

Сума винагороди

СумаНестач

Decimal (#.00)

Сума недостачі

СумаШтрафу

Decimal (#.00)

Сума штрафу

Вага

Вага

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Надлишки

О

Надлишки (початок блоку)

Кількісні

М

Decimal (#.00)

Кількісні надлишки

Цінові

М

Decimal (#.00)

Цінові надлишки

Надлишки

Надлишки (завершення блоку)

Нестачі

О

Нестачі (початок блоку)

Кількісні

М

Decimal (#.00)

Кількісні нестачі

Цінові

М

Decimal (#.00)

Цінові нестачі

Нестачі

Нестачі (завершення блоку)

ДоПовернення

Повернення (початок блоку)

Кількість

М

Decimal (#.00)

Кількість товарних одиниць до повернення

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

ДоПовернення

Повернення (завершення блоку)

Взаєморозрахунки

O

Взаєморозрахунки (початок блоку)

Документ

M

Min=1; Max=1

Ініціатор процесу завжди заповнює. В акті з розходженнями може бути відсутнім

Дата

M

Дата (РРРР-ММ-ДД)

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

Номер

M

Рядок (20)

В акті з розходженнями може бути відсутнім

Найменування

O

Рядок (50)

Тип документу

ВидОперації

O

Рядок (20)

Вид Операції. Доступно для заповнення лише Ініціатору процесу

Підрозділ

O

Рядок (30)

Підрозділ. Доступно для заповнення лише Ініціатору процесу

НомерПодатковоїНакладної

O

Рядок (20)

Номер Податкової Накладної. Доступно для заповнення лише Ініціатору процесу

СумаПодатковоїНакладної

O

Decimal (#.00)

Сума Податкової Накладної. Доступно для заповнення лише Ініціатору процесу

НомерДоговору

O

Рядок (20)

Номер Договору

Дебет

O

Decimal (#.00)

Заповнюється <Дебет> або <Кредит> по документу в рамках одного Контагенту

Кредит

O

Decimal (#.00)

Заповнюється <Дебет> або <Кредит> по документу в рамках одного Контагенту

Текст

O

Рядок (100)

Коментар до позиції

Документ

Взаєморозрахунки

Взаєморозрахунки (завершення блоку)

ЦінаРегулярна

Регулярна ціна (початок блоку)

ЦінаБезПДВ

Ціна без ПДВ

ЦінаЗПДВ

Ціна з ПДВ

ЦінаЗіЗнижкоюБезПДВ

Ціна зі знижкою без ПДВ

ЦінаЗіЗнижкоюЗПДВ

Ціна зі знижкою з ПДВ

ЦінаРегулярна

Регулярна ціна (завершення блоку)

СтараЦіна

Стара ціна (початок блоку)

ЦінаБезПДВ

Ціна без ПДВ

ЦінаЗПДВ

Ціна з ПДВ

ЦінаЗіЗнижкоюБезПДВ

Ціна зі знижкою без ПДВ

ЦінаЗіЗнижкоюЗПДВ

Ціна зі знижкою з ПДВ

СтараЦіна

Стара ціна (завершення блоку)

ПромоЦіна

Промо ціна (початок блоку)

ЦінаБезПДВ

Ціна без ПДВ

ЦінаЗПДВ

Ціна з ПДВ

ПромоЦіна

Промо ціна (завершення блоку)

ВсьогоПоДокументу

Підсумкові значення за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ за всіма позиціями

ПДВ

Сума ПДВ за всіма позиціями

Сума

О

Decimal (#.00)

Сума за всіма позиціями

ВсьогоНадлишків

Всього надлишків за всіма позиціями

ВсьогоНестач

Всього нестач за всіма позиціями

Дебет

Сума дебету за всіма позиціями

Кредит

Сума кредиту за всіма позиціями

ВсьогоПоДокументу

Підсумкові значення за документом (завершення блоку)

НомерДокументу

М

Рядок (20)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата документу

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

Текст

О

Рядок (100)

Додаткова інформація

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

Сума

О

Decimal (#.00)

Сума

Кількісні

Кількісні

Цінові

Цінові

Причина

O

Кількість входжень вузла: Min = 0; Max = 1

Причина для повернення (початок блоку)

Код

M

Integer (3)

Код причини повернення: 1-Зіпсований 2- Брак 3- Бій 4- Невідповідність ціни 5- Відсутність в замовленні 6- Недовіз 7- Без документів 8- Пересорт 9- Невідповідність штрих-коду 10- Відсутність в БД 11- Нетоварний вигляд 12- Бомбаж 13- Розвакуумація 14- Понад заказу 15- Невідповідність назви 16- Невідповідність грамовки 17- Відсутність сертифікатів 18- Відсутність терміну придатності 19- Відсутність ветеринарного свідоцтва 20- Відсутність акцизних марок 21- Відсутність інформаціі для покупців 22- Відсутність рекомендованої ціни на тютюнових виробах 23- Відсутність дати виготовлення 24- Відсутність кінцевого терміну реалізації 25- Надлишки 26- Малий термін 27- Протерміновано 28- Лог дані 29- Паллетизация

Опис

O

Рядок (50)

Найменування причини повернення

Кількість

M

Decimal (#.00)

Кількість товарних одиниць до повернення

ОдиницяВиміру

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

НаСуму

O

Сумарна вартість товару до повернення

Причина

Причина для повернення (завершення блоку)

ДоПовернення

О

Товар, що підлягає поверненню (початок блоку)

Код

М

Integer (3)

Код причини повернення: 1-Зіпсований 2- Брак 3- Бій 4- Невідповідність ціни 5- Відсутність в замовленні 6- Недовіз 7- Без документів 8- Пересорт 9- Невідповідність штрих-коду 10- Відсутність в БД 11- Нетоварний вигляд 12- Бомбаж 13- Розвакуумація 14- Понад заказу 15- Невідповідність назви 16- Невідповідність грамовки 17- Відсутність сертифікатів 18- Відсутність терміну придатності 19- Відсутність ветеринарного свідоцтва 20- Відсутність акцизних марок 21- Відсутність інформаціі для покупців 22- Відсутність рекомендованої ціни на тютюнових виробах 23- Відсутність дати виготовлення 24- Відсутність кінцевого терміну реалізації 25- Надлишки 26- Малий термін 27- Протерміновано

Опис

О

Рядок (50)

Найменування причини повернення

НаСуму

О

Сумарна вартість товару до повернення

Кількість

М

Decimal (#.00)

Кількість товарних одиниць до повернення

ОдиницяВиміру

М

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

ПричинаПовернення

О

Причина повернення товару (початок блоку)

Код

М

Рядок (3)

Код причини повернення. Допустимі значення: 12E - Товар повертається згідно умов договору

Опис

О

Рядок (30)

Найменування причини повернення

ПричинаПовернення

Причина повернення товару (завершення блоку)

ДоПовернення

Товар, що підлягає поверненню (завершення блоку)

РозходженняПоРядку

Розходження (початок блоку)

Сума

О

Decimal (#.00)

Сума

ЦінаНеПрийнята

Ціна розходження

КількістьНеПрийнята

Кількість розходження

СумаНеПрийнята

Сума розходження

РозходженняПоРядку

Розходження (завершення блоку)

ЦінаПостачальника

Ціна постачальника

Текст

О

Рядок (100)

Додаткова інформація

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ЗагальнеПоКонтрагентам

M

Min=1; Max=1

(початок блоку)

ЗагальнеПоКонтрагенту

M

Min=2; Max=2

Ініціатор процесу завжди заповнює (початок блоку)

Текст

O

Рядок (100)

СальдоПочатковеДебет

M

Decimal (#.00)

СальдоПочатковеКредит

M

Decimal (#.00)

ОборотиЗаПеріодДебет

M

Decimal (#.00)

ОборотиЗаПеріодКредит

M

Decimal (#.00)

СальдоКінцевеДебет

M

Decimal (#.00)

СальдоКінцевеКредит

M

Decimal (#.00)

ЗагальнеПоКонтрагенту

(завершення блоку)

ЗагальнеПоКонтрагентам

(завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

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

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

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

МісцеСкладання

Місце складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична; Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

Блок індивідуального податкового номера

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво платника ПДВ (податку на додану вартість)

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Причина

O

Кількість входжень вузла: Min = 0; Max = 1

Причина для повернення (початок блоку)

Код

M

Integer (3)

Код причини повернення: 1-Зіпсований; 2- Брак; 3- Бій; 4- Невідповідність ціни; 5- Відсутність в замовленні; 6- Недовіз; 7- Без документів; 8- Пересорт; 9- Невідповідність штрих-коду; 10- Відсутність в БД; 11- Нетоварний вигляд; 12- Бомбаж; 13- Розвакуумація; 14- Понад заказу; 15- Невідповідність назви; 16- Невідповідність грамовки; 17- Відсутність сертифікатів; 18- Відсутність терміну придатності; 19- Відсутність ветеринарного свідоцтва; 20- Відсутність акцизних марок; 21- Відсутність інформаціі для покупців; 22- Відсутність рекомендованої ціни на тютюнових виробах; 23- Відсутність дати виготовлення; 24- Відсутність кінцевого терміну реалізації; 25- Надлишки; 26- Малий термін; 27- Протерміновано; 28- Лог дані; 29- Паллетизация

Опис

O

Рядок (50)

Найменування причини повернення

Кількість

M

Decimal (#.00)

Кількість товарних одиниць до повернення

ОдиницяВиміру

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам;

НаСуму

O

Сумарна вартість товару до повернення

Причина

Причина для повернення (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_005

Видаткова накладна (COMDOC_006)

Видаткова накладна (COMDOC_006)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

НомерЗамовлення

О

Рядок (20)

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

ДатаЗамовлення

О

Дата (РРРР-ММ-ДД)

Дата здійснення замовлення

МісцеСкладання

Місце складання документу

ДокПідстава

M

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант;

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

АртикулПродавця

О

Рядок (10)

Артикул продавця

КодУКТЗЕД

О

Integer (10)

Код товару згідно з УКТ ЗЕД; для COMDOC 006 значення не менше 4 і не більше 10 символів

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ без знижки

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

СумаЗіЗнижкоюБезПДВ

О

Decimal (#.00)

Сума без ПДВ зі знижкою

СумаЗіЗнижкоюЗПДВ

О

Decimal (#.00)

Сума з ПДВ зі знижкою

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

ЦінаРегулярна

О

Регулярна ціна (початок блоку)

ЦінаБезПДВ

О

Decimal (#.00)

Цiна без ПДВ

ЦінаЗіЗнижкоюБезПДВ

О

Decimal (#.00)

Цiна без ПДВ зі знижкою

ЦінаЗіЗнижкоюЗПДВ

О

Decimal (#.00)

Цiна з ПДВ зі знижкою

ЦінаРегулярна

Регулярна ціна (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума по всім позиціям без ПДВ без знижки

ВсьогоЗіЗнижкоюБезПДВ

О

Decimal (#.00)

Сума по всім позиціям без ПДВ зі знижкою

ВсьогоЗіЗнижкоюЗПДВ

О

Decimal (#.00)

Сума по всім позиціям з ПДВ зі знижкою

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_006

Прибуткова накладна (COMDOC_007)

Прибуткова накладна (COMDOC_007)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

НомерЗамовлення

О

Рядок (20)

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

ДатаЗамовлення

О

Дата (РРРР-ММ-ДД)

Дата здійснення замовлення

МісцеСкладання

Місце складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» …

Допустимі значення: 001 = Договір; 002 = Додаткова угода; 003 = Протокол розбіжностей; 004 = Акт приймання продукції (товару) за кількістю та якістю; 005 = Акт про виявлені недоліки; 006 = Видаткова накладна; 007 = Прибуткова накладна; 008 = Товарна специфікація; 009 = Акт невідповідності; 010 = Накладна; 011 = Повідомлення про повернення; 012 = Накладна на повернення; 013 = Акт виконаних робіт; 014 = Акт звірки взаєморозрахунків; 015 = Акт взаємозаліку; 016 = Рахунок-фактура; 017 = Акт про виявлення невідповідностей; 018 = Акт наданих послуг; 019 = Анулювання; 020 = Звіт комітенту; 021 = Повідомлення про відмову від підписання документу; 022 = Накладна на переміщення; 023 = Специфікація послуг по перевезеннях; 024 = Звіт комітенту по еквайрингу; 025 = Рахунок по еквайрингу; 026 = Зведена специфікація послуг; 027 = Товарна накладна; 028 = Заявка на транспортно-експедиційне обслуговування; 029 = Акт звірки взаєморозрахунків зведений

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Парамети

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Парамети

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_007

Товарна специфікація (COMDOC_008)

Товарна специфікація (COMDOC_008)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипСхеми

О

0 чи 1

0 - стандартна схема (з попереднім узгодженням); 1 - нестандартна схема (без попереднього узгодження)

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ТермінДії

О

Кількість входжень вузла: Min = 0; Max = 1

Термін, на період якого документ вважається чинним (початок блоку)

Початок

М

Дата (РРРР-ММ-ДД)

Дата початку дії документу

Кінець

М

Дата (РРРР-ММ-ДД)

Дата закінчення терміну дії документу

ТермінДії

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

НомерЗамовлення

О

Рядок (20)

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

ДатаЗамовлення

О

Дата (РРРР-ММ-ДД)

Дата здійснення замовлення

МісцеСкладання

О

Рядок (100)

Місце укладання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

АртикулПродавця

О

Рядок (10)

Артикул продавця

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

ЦінаРегулярна

Регулярна ціна (початок блоку)

ЦінаБезПДВ

Ціна без ПДВ

ЦінаЗПДВ

Ціна з ПДВ

ЦінаРегулярна

Регулярна ціна (завершення блоку)

СтавкаПДВ

Ставка податку на додану вартість

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_008

Акт невідповідності (COMDOC_009)

Акт невідповідності (COMDOC_009)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

Початок документу

Заголовок

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

Рядок (16)

Номер документу

ТипДокументу

Рядок (50)

Акт невідповідності

КодТипуДокументу

«009»

009

ДатаДокументу

Дата (РРРР-ММ-ДД)

Дата складання документу

НомерЗамовлення

Рядок (20)

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

ДатаЗамовлення

Дата (РРРР-ММ-ДД)

Дата здійснення замовлення

МісцеСкладання

Місце складання документу

Заголовок

Заголовок (завершення блоку)

Сторони

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

Рядок (50)

Назва контрагента

КодКонтрагента

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

Рядок (12)

Індивідуальний податковий номер контрагента

GLN

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

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

Параметр

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Таблиця

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

Integer (3)

Номер позиції

АртикулПокупця

Рядок (10)

Артикул покупця

Найменування

Рядок (50)

Найменування товарної позиції

ЗаявленаКількість

Decimal (#.00)

Заявлена кількість товарних позицій

ПрийнятаКількість

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

Decimal (#.00)

Ціна за одиницю без ПДВ

Текст

Рядок (100)

Додаткова інформація

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ЕлектроннийДокумент

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Повідомлення про повернення (COMDOC_011)

Повідомлення про повернення (COMDOC_011)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

НомерЗамовлення

О

Рядок (20)

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

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

Найменування

М

Рядок (50)

Найменування товарної позиції

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

ДоПовернення

Повернення (початок блоку)

Кількість

М

Decimal (#.00)

Кількість товарних одиниць до повернення

ДоПовернення

Повернення (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_011

Накладна на повернення (COMDOC_012)

Накладна на повернення (COMDOC_012)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

НомерЗамовлення

О

Рядок (20)

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

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Парамети

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Парамети

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

АртикулПокупця

О

Рядок (10)

Артикул покупця

Найменування

М

Рядок (50)

Найменування товарної позиції

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

ДоПовернення

Повернення (початок блоку)

Кількість

М

Decimal (#.00)

Кількість товарних одиниць до повернення

ДоПовернення

Повернення (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_012

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

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

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Парамети

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Парамети

О

Параметри (завершення блоку)

Текст

O

Рядок

Тег призначений для передачі значного об’єму тексту (наприклад, текст договору, додаткової угоди, тощо). Розмір тексту необмежений. Весь текст має бути вкладений в конструкцію: <![CDATA[текст]]>

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_013

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

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

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

МісцеСкладання

Місце складання документу

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

О

Integer (10)

Індивідуальний податковий номер

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво платника ПДВ (податку на додану вартість)

МФО

О

Рядок

МФО банку

Телефон

О

Рядок (20)

Телефон контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Парамети

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Парамети

О

Параметри (завершення блоку)

Текст

О

Рядок (100)

Додаткова інформація

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_016

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

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

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Парамети

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Парамети

О

Параметри (завершення блоку)

Текст

O

Рядок

Тег призначений для передачі значного об’єму тексту (наприклад, текст договору, додаткової угоди, тощо). Розмір тексту необмежений. Весь текст має бути вкладений в конструкцію: <![CDATA[текст]]>

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_018

Анулювання (COMDOC_019)

Анулювання (COMDOC_019)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ПричинаАнулювання

М

Рядок ()

Причина анулювання

ДатаАнулювання

М

Дата (РРРР-ММ-ДД)

Дата анулювання

МісцеСкладання

Місце складання документу

Заголовок

Заголовок (завершення блоку)

ДокументЩоАнулюється

Документ, що аннулюється (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокументЩоАнулюється

Документ, що аннулюється (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

ЕлектроннийДокумент

О

Завершення блоку

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_019

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

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

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Відхилив

До заповнення реквізитами компанії, що відхиляє документ (початок блоку)

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

О

Integer (10)

Індивідуальний податковий номер

МФО

О

Рядок

МФО банку

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон контрагента

Відхилив

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

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

О

Integer (10)

Індивідуальний податковий номер

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво платника ПДВ (податку на додану вартість)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Текст

О

Рядок (100)

Додаткова інформація

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_021

Накладна на переміщення (COMDOC_022)

Накладна на переміщення (COMDOC_022)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

МФО

О

Рядок

МФО банку

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Банк

Банк контрагента

Телефон

О

Рядок (20)

Телефон контрагента

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_022

Специфікація послуг перевізника (COMDOC_023)

Специфікація послуг перевізника (COMDOC_023)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

Номер

О

Номер

Дата

О

Дата (РРРР-ММ-ДД)

Дата

МаршрутВідправлено

Пункт відправлення товару (Для COMDOC 023 пункти «Відправлено» і «Отримано» заповнюються в одній клітинці «Маршрут»)

МаршрутОтримано

Пункт отримання товару (Для COMDOC 023 пункти «Відправлено» і «Отримано» заповнюються в одній клітинці «Маршрут»)

Кількість

М

Decimal (#.00)

Кількість одиниць товару

Вага

О

Вага

Сума

О

Decimal (#.00)

Сума вартості товару

СумаСтрахування

О

Сума страхування

Платник

О

ПІБ платника

Відправник

О

ПІБ відправника

Отримувач

О

ПІБ отримувача

АдресаДоставки

О

Адреса доставки

ЗонаДоставки

О

Зона доставки

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_023

Звіт комітенту по еквайрингу (COMDOC_024)

Звіт комітенту по еквайрингу (COMDOC_024)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

МісцеСкладання

Місце складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_024

Рахунок по еквайрингу (COMDOC_025)

Рахунок по еквайрингу (COMDOC_025)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ТермінДії

О

Кількість входжень вузла: Min = 0; Max = 1

Термін, на період якого документ вважається чинним (початок блоку)

Початок

М

Дата (РРРР-ММ-ДД)

Дата початку дії документу

Кінець

М

Дата (РРРР-ММ-ДД)

Дата закінчення терміну дії документу

ТермінДії

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

МісцеСкладання

О

Рядок (100)

Місце укладання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

ЮрАдреса

О

Юридична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ЮрАдреса

Юридична адреса контрагента (завершення блоку)

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_025

Зведена специфікація послуг (COMDOC_026)

Зведена специфікація послуг (COMDOC_026)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

О

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

КодУКТЗЕД

О

Integer (10)

Код товару згідно з УКТ ЗЕД; для COMDOC 006 значення не менше 4 і не більше 10 символів

Найменування

М

Рядок (50)

Найменування товарної позиції

ПрийнятаКількість

О

Decimal (#.00)

Прийнята кількість товарних позицій

ОдиницяВиміру

О

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

О

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_026

Товарна накладна (COMDOC_027)

Товарна накладна (COMDOC_027)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Строка (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ПлановаДатаДоставки

Дата (РРРР-ММ-ДД)

Планова дата доставки

МісцеСкладання

Місце складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Строка (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Строка (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Строка (50)

Назва контрагента

КодКонтрагента

М

Строка (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Строка (12)

Індивідуальний податковий номер контрагента

IBAN

О

Строка

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Строка (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Строка (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

АртикулПокупця

О

Строка (10)

Артикул покупця

Найменування

М

Строка (50)

Найменування товарної позиції

НакладнаНомер

Номер накладної

НомерЗамовлення

О

Строка (20)

Номер замовлення

ШтрихкодТрансУпаковкиSSCC

О

Число (14, 18)

Штрихкод транспортной упаковки SSCC

ЗаявленаКількість

О

Decimal (#.00)

Заявлена кількість товарних позицій

КількістьОдВЯщику

О

Кількість одиниць в ящику (шт/кг)

ФактичнаКількістьЯщиків

О

Фактична кількість ящиків

ПоставляємаКількість

О

Кількість доставлених одиниць

ОдиницяВиміру

О

Строка (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

Вага

Вага

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ЕлектроннийДокумент

О

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_027

Заявка на транспортно-експедиційне обслуговування (COMDOC_028)

Заявка на транспортно-експедиційне обслуговування (COMDOC_028)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

ЮрАдреса

О

Юридична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ЮрАдреса

Юридична адреса контрагента (завершення блоку)

ФактАдреса

О

Фактична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ФактАдреса

Фактична адреса контрагента (завершення блоку)

ПоштАдреса

О

Поштова адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ПоштАдреса

Поштова адреса контрагента (завершення блоку)

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

МасаБрутто

М

Decimal (#.00)

Вага товару

ДовжинаВантажу

О

Decimal (#.00)

Довжина вантажу

ОбємВантажу

О

Decimal (#.00)

Об’єм вантажу

КількістьМісць

О

Decimal (#.00)

Кількість вантажних місць, палет

СтрокТранспортування

О

Decimal (#.00)

Термін доставки, днів

Примітка

О

Рядок (200)

Примітка

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ЕлектроннийДокумент

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_028

Акт звірки взаєморозрахунків зведений (COMDOC_029)

Акт звірки взаєморозрахунків зведений (COMDOC_029)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (20)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ПеріодНаданняПослуг

M

Термін, на період якого надаються послуги (початок блоку)

Початок

M

Дата (РРРР-ММ-ДД)

Дата початку періоду, на час якого надаються послуги

Кінець

M

Дата (РРРР-ММ-ДД)

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

ПеріодНаданняПослуг

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

ТермінПідпису

M

Термін, дії підписання документу (початок блоку)

Початок

M

Дата (РРРР-ММ-ДД)

Дата початку терміну дії підписання

Кінець

M

Дата (РРРР-ММ-ДД)

Дата закінчення терміну дії підписання

ТермінПідпису

Термін, дії підписання документу (завершення блоку)

МісцеСкладання

О

Рядок (100)

Місце укладання документу

ДокПідстава

M

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (20)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво ПДВ контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

ЮрАдреса

О

Юридична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ЮрАдреса

Юридична адреса контрагента (завершення блоку)

ФактАдреса

О

Фактична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ФактАдреса

Фактична адреса контрагента (завершення блоку)

ПоштАдреса

О

Поштова адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ПоштАдреса

Поштова адреса контрагента (завершення блоку)

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

M

Кількіть входжень вузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

Номер

О

Номер

Дата

О

Дата (РРРР-ММ-ДД)

Дата

Текст

О

Рядок (100)

Додаткова інформація

Взаєморозрахунки

O

Взаєморозрахунки (початок блоку)

Документ

M

Min=1; Max=1

Ініціатор процесу завжди заповнює. В акті з розходженнями може бути відсутнім

Дата

M

Дата (РРРР-ММ-ДД)

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

Номер

M

Рядок (20)

В акті з розходженнями може бути відсутнім

Найменування

O

Рядок (50)

Тип документу

ВидОперації

O

Рядок (20)

Вид Операції. Доступно для заповнення лише Ініціатору процесу

Підрозділ

O

Рядок (30)

Підрозділ. Доступно для заповнення лише Ініціатору процесу

НомерПодатковоїНакладної

O

Рядок (20)

Номер Податкової Накладної. Доступно для заповнення лише Ініціатору процесу

СумаПодатковоїНакладної

O

Decimal (#.00)

Сума Податкової Накладної. Доступно для заповнення лише Ініціатору процесу

НомерДоговору

O

Рядок (20)

Номер Договору

Дебет

O

Decimal (#.00)

Заповнюється <Дебет> або <Кредит> по документу в рамках одного Контагенту

Кредит

O

Decimal (#.00)

Заповнюється <Дебет> або <Кредит> по документу в рамках одного Контагенту

Текст

O

Рядок (100)

Коментар до позиції

Документ

Взаєморозрахунки

Взаєморозрахунки (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ЗагальнеПоКонтрагентам

M

Min=1; Max=1

(початок блоку)

ЗагальнеПоКонтрагенту

M

Min=2; Max=2

Ініціатор процесу завжди заповнює (початок блоку)

Текст

O

Рядок (100)

СальдоПочатковеДебет

M

Decimal (#.00)

СальдоПочатковеКредит

M

Decimal (#.00)

ОборотиЗаПеріодДебет

M

Decimal (#.00)

ОборотиЗаПеріодКредит

M

Decimal (#.00)

СальдоКінцевеДебет

M

Decimal (#.00)

СальдоКінцевеКредит

M

Decimal (#.00)

ЗагальнеПоКонтрагенту

(завершення блоку)

ЗагальнеПоКонтрагентам

(завершення блоку)

ЕлектроннийДокумент

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_029

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

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

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ПеріодНаданняПослуг

Термін, на період якого надаються послуги (початок блоку)

Початок

О

Дата (РРРР-ММ-ДД)

Дата початку періоду, на час якого надаються послуги

Кінець

О

Дата (РРРР-ММ-ДД)

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

ПеріодНаданняПослуг

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

МісцеСкладання

О

Рядок (100)

Місце укладання документу

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична; Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Найменування

М

Рядок (50)

Найменування товарної позиції

Дата

О

Дата (РРРР-ММ-ДД)

Дата

НомерЗамовлення

О

Рядок (20)

Номер замовлення

ПроцентШтрафу

О

Відсоток штрафу

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаНестач

Decimal (#.00)

Сума недостачі

СумаШтрафу

Decimal (#.00)

Сума штрафу

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_030

Накладна на зворотну тару (COMDOC_031)

Накладна на зворотну тару (COMDOC_031)

Назва поля

Тип

Формат

Опис

ЕлектроннийДокумент

М

Початок документу

Заголовок

М

Кількість входжень вузла: Min = 1; Max = 1

Заголовок (початок блоку)

НомерДокументу

М

Рядок (16)

Номер документу

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

НомерЗамовлення

О

Рядок (20)

Номер замовлення

ДокПідстава

О

Кількість входжень вузла: Min = 0; Max = 10

Документ-підстава (початок блоку)

НомерДокументу

М

Рядок (30)

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

ТипДокументу

М

Рядок (50)

Типи документів: Договір, Додаткова угода…(типи коммерційних документів)

КодТипуДокументу

М

«001» / «002» / «003» …

Допустимі значення: 001 => Договір; 002 => Додаткова угода; 003 => Протокол розбіжностей…

ДатаДокументу

М

Дата (РРРР-ММ-ДД)

Дата складання документу

ДокПідстава

Документ-підстава (завершення блоку)

Заголовок

Заголовок (завершення блоку)

Сторони

M

Мількість входжень вузла: Min = 1; Max = 1

Сторони, між якими укладено документ (початок блоку)

Контрагент

М

Кількість входжень вузла: Min = 2; Max = 10

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

СтатусКонтрагента

М

Рядок (30)

Допустимі значення: Покупець; Отримувач; Продавець; Замовник; Виконавець; Перевізник; Платник; Підрядник; Відправник; Вантажоодержувач; Вантажовідправник; Експедитор; Клієнт; Консультант

ВидОсоби

М

Рядок (20)

Допустимі значення: Юридична; Фізична

НазваКонтрагента

М

Рядок (50)

Назва контрагента

КодКонтрагента

М

Рядок (8)

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

ІПН

М

Рядок (12)

Індивідуальний податковий номер контрагента

СвідоцтвоПДВ

О

Integer (10)

Свідоцтво платника ПДВ (податку на додану вартість)

МФО

О

Integer (6)

МФО банку контрагента

ПоточРах

О

Рядок

Поточний рахунок контрагента

Банк

Банк контрагента

IBAN

О

Рядок

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

Телефон

О

Рядок (20)

Телефон

GLN

M

Integer (13)

Глобальний номер розташування (GLN) контрагента

ЮрАдреса

О

Юридична адреса контрагента (початок блоку)

Індекс

М

Integer (5)

Індекс

Область

О

Рядок (50)

Область

Місто

М

Рядок (50)

Місто

Вулиця

М

Рядок (50)

Вулиця

ЮрАдреса

Юридична адреса контрагента (завершення блоку)

Контрагент

Контрагент (завершення блоку)

Сторони

Сторони, між якими укладено документ (завершення блоку)

Параметри

О

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

Параметр

O

Рядок (50)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Параметри

О

Параметри (завершення блоку)

Таблиця

О

Кількітьходженьвузла: Min = 0; Max = 1

Таблиця (початок блоку)

Рядок

M

Кількість входжень вузла: Min = 1;Max = 9999

Рядок (початок блоку). У кожного наступного блоку ідентифікатор (ІД) збільшується на одиницю

НомПоз

М

Integer (3)

Номер позиції

Штрихкод

M

Integer (13)

Максимальна кількість тегів – 99. У кожного наступного тега ідентифікатор (ІД) збільшується на одиницю.

Найменування

М

Рядок (50)

Найменування товарної позиції

ОдиницяВиміру

M

Рядок (10)

Одиниці виміру: шт. – штука; уп. – упаковка; л. – літр; послуга; кг. – кілограм; г. – грам…

БазоваЦіна

M

Decimal (#.00)

Ціна за одиницю без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Ціна

О

Decimal (#.00)

Ціна за одиницю з ПДВ

Кількість

М

Decimal (#.00)

Кількість товарних одиниць

ВсьогоПоРядку

О

Кількість входжень вузла: Min = 0; Max = 1

Загальна сума по рядку (початок блоку)

СумаБезПДВ

О

Decimal (#.00)

Сума без ПДВ

СумаПДВ

О

Decimal (#.00)

Сума ПДВ

Сума

О

Decimal (#.00)

Сума

ВсьогоПоРядку

Загальна сума по рядку (завершення блоку)

СтавкаПДВ

Ставка податку на додану вартість

Рядок

Рядок (завершення блоку)

Таблиця

Таблиця (завершення блоку)

ВсьогоПоДокументу

О

Сумарні значення позицій за документом (початок блоку)

СумаБезПДВ

M

Decimal (#.00)

Сума без ПДВ

ПДВ

О

Decimal (#.00)

Сума ПДВ в одиниці товару (послуги)

Сума

О

Decimal (#.00)

Сума

ВсьогоПоДокументу

О

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

ЕлектроннийДокумент

Завершення документу

Одиниці виміру: «г», «кг», «л», «м», «мм», «м2», «м3», «шт», «кор», «пач», «піддон», «пак», «штука дрібна», «uauzd_MIL», «пляш», «рул», «послуга», «uauzd_CMT», «грн», «ящ», «Пар», «год.», «пог.м», «компл», «Тонна», «Блок», «Набір», «паков», «банк», «од»

Пример COMDOC_031

Податкова накладна (DECLAR)

Імена файлів формуються відповідно до значення елементів заголовка документа (DECLARHEAD) за таким принципом:

_images/to_declar.png

  • позиції з 1 по 4 включно містять код ДПІ отримувача, до якої подається оригінал або копія документа (4 символа), який складається з коду області, на території якої розташовується податкова інспекція (відділення) (значення елемента C_REG, доповненого зліва нулем до 2 символів), та коду адміністративного району, на території якого розташовується податкова інспекція (відділення) (значення елемента C_RAJ, доповненого зліва нулем до 2 символів);

  • позиції з 5 по 14 включно містять код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта) (значення елемента TIN, доповненого зліва нулями до 10 символів);

  • позиції з 15 по 17 включно містять код документа (значення елемента C_DOC);

  • позиції з 18 по 20 містять підтип документа (значення елемента C_DOC_SUB);

  • позиції з 21 по 22 містять номер версії документа (значення елемента C_DOC_VER, доповненого зліва нулем до 2 символів);

  • позиція 23 містить ознаку стану документа (значення елемента C_DOC_STAN);

  • позиції з 24 по 25 містять номер нового звітного (уточнюючого) документа у звітному періоді (значення елемента C_DOC_TYPE, доповненого зліва нулем до 2 символів). Для звітного документа позиції 24…25 міститимуть значення 00;

  • позиції з 26 по 32 містять порядковий номер документа, що може подаватись декілька разів в одному звітному періоді (значення елемента C_DOC_CNT, доповненого зліва нулями до 7 символів). Якщо звіт подається лише один раз, то позиції 26…32 міститимуть значення 0000001;

  • позиція 33 містить числовий код типу звітного періоду (1-місяць, 2-квартал, 3-півріччя, 4-дев’ять місяців, 5-рік) (значення елемента PERIOD_TYPE);

  • позиції з 34 по 35 містять значення звітного місяця (значення елемента PERIOD_MONTH доповненого зліва нулем до 2 символів);

  • позиції з 36 по 39 містять значення звітного року (значення елемента PERIOD_YEAR);

  • позиції з 40 по 43 містять код податкової інспекції, до якої подається оригінал документа (значення елемента C_STI_ORIG, доповненого зліва нулями до 4 символів). Якщо документ є оригіналом, а не копією, то позиції 40…43 будуть відповідати позиціям 1…4;

Файл має розширення xml., наприклад: 23010000223816J0100109100000000151220102301.xml

Податкова накладна (DECLAR)

Назва поля

Зміст

Коментар

DECLAR

Початок документу

DECLARHEAD

Завершення основного блоку

TIN

Код платника

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

C_DOC

Код документа

J12 – податкова накладна (юр. особа) F12 – податкова накладна (фіз. особа)

C_DOC_SUB

Підтип документа

Відповідає значенню елемента C_DOC_SUB з довідника звітних документів

C_DOC_VER

Номер версії

Відповідає значенню елемента C_DOC_VER з довідника звітних документів

C_DOC_TYPE

№ нового звітного документа

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

C_DOC_CNT

№ однотипного документа в періоді

Якщо в одному звітному періоді подається кілька однотипних документів, то значення даного елемента містить порядковий номер для кожного документа в даному періоді. Перший (звітний) документ має номер 1. При формуванні електронного документа, що є новим звітним (уточнюючим) до поданого раніше (звітного) (значення елемента C_DOC_TYPE 0), нумерація однотипних документів в періоді (значення елемента C_DOC_CNT) повинна залишатись незмінною щодо нумерації звітного документа, показники якого виправляються

C_REG

Код області ДПІ отримувача

Код області заповнюється згідно з довідником державних податкових інспекцій

C_RAJ

Код адміністративного району ДПІ отримувача

Код адміністративного району заповнюється згідно з довідником державних податкових інспекцій

PERIOD_MONTH

Звітній місяць

Звітним місяцем вважається останній місяць у звітному періоді (для місяців - це порядковий номер місяця, для I, II, III, IV кварталів - це 3, 6, 9, 12 місяць відповідно, для I та II півріч - 6 та 12 відповідно, для 9 місяців - 9, для року - 12)

PERIOD_TYPE

Тип звітного періоду

1-місяць, 2-квартал, 3-півріччя, 4 - дев’ять місяців, 5-рік

PERIOD_YEAR

Звітний рік

Формат рррр

C_STI_ORIG

Код ДПІ, до якої подається оригінал документа

Код ДПІ вибирається з довідника інспекцій, є числовим значенням, яке відповідає формулі: значення елемента C_REG*100 + значення елемента C_RAJ

C_DOC_STAN

Стан документа

Приймає фіксовані значення: 1 - звітний документ; 2 - новий звітний документ;3 - уточнюючий документ

LINKED_DOCS

Перелік пов’язаних документів. Даний елемент є вузловим і складається з ряду елементів з іменем DOC, кожний з яких містить інформацію про окремий

Містить відповідний перелік документів: для основного документа – посилання на додатки, які подаються до нього; для додатка – посилання на основний документ; для квитанції – на документ, що квитується. Елемент DOC має обов’язкові атрибути : NUM - Номер пов’язаного документа в переліку TYPE - Тип зв’язку. Даний атрибут приймає фіксовані значення : 1 – посилання на додаток, 2 – посилання на основний документ, 3 – посилання на документ, що квитувався

D_FILL

Формат ддммрррр

Дата заповнення документа платником

SOFTWARE

Сигнатура програмного забезпечення

Текстовий рядок - ідентифікатор програмного засобу, за допомогою якого сформовано документ

DECLARHEAD

Завершення основного блоку

DECLARBODY

Початок змістового блоку

R01G1

Зведена податкова накладна

1 – так, 0 – ні

R03G10S

Складена на операції, звільнені від оподаткування

Ставиться помітка «Без ПДВ» у разі складання податкової накладної на операції з постачання товарів/послуг, які звільняються від оподаткування (п. 17 Порядку № 1307)

HORIG1

Позначка «Видається покупцю»

1 – так, 0 – ні

HTYPR

Залишається у продавця (тип причини)

Зазначається тип причини: 01 - Збільшення компенсації вартості поставлених товарів/послуг; 02 - Постачання неплатнику податку; 03 - Постачання товарів/послуг у рахунок оплати праці фізичним особам, які перебувають у трудових відносинах із платником податку; 04 - Постачання у межах балансу для невиробничого використання; 05 - Ліквідація основних засобів за самостійним рішенням платника податку; 06 - Переведення виробничих основних засобів до складу невиробничих; 07 - Вивезення товарів за межі митної території України; 08 - Постачання для операцій, які не є об’єктом оподаткування податком на додану вартість; 09 - Постачання для операцій, які звільнені від оподаткування податком на додану вартість; 10 - Визначення при анулюванні реєстрації платника податку податкових зобов’язань за товарами/послугами, необоротними активами, суми податку по яких були включені до складу податкового кредиту та не були використані в оподатковуваних операціях у межах господарської діяльності; 11 - Складена за щоденними підсумками операцій. 12 - Постачання неплатнику, в якій зазначається назва покупця; 13 - Використання виробничих або невиробничих засобів, інших товарів/послуг не в господарській діяльності; 14 - Складена отримувачем (покупцем) послуг від нерезидента; 15 - Складена на суму перевищення ціни придбання товарів/послуг над фактичною ціною їх постачання; 16 - Складена на суму перевищення балансової (залишкової) вартості необоротних активів над фактичною ціною їх постачання; 17 - Складена на суму перевищення собівартості самостійно виготовлених товарів/послуг над фактичною ціною їх постачання В інших випадках у верхній лівій частині податкової накладної тип причини не зазначається (нулі, прочерки та інші знаки чи символи не проставляються)

HFILL

Дата виписки податкової накладної

Формат ддммрррр

HNUM

Порядковый номер ПН

Ціле число

HNUM1

Код діяльностi

Ціле число

HNAMESEL

Особа (платник податку) - продавець

Найменування; прізвище, ім’я, по батькові - для фізичної особи-підприємця

HNAMEBUY

Особа (платник податку) - покупець

Найменування; прізвище, ім’я, по батькові - для фізичної особи-підприємця

HKSEL

Індивідуальний податковий номер продавця

Ціле число

HNUM2

Числовий номер філії

Ціле число

HTINSEL

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

Ціле число, максимальна кількість знаків 10; заповнюється із GLN номера (код ЄДРПОУ)

HKBUY

Індивідуальний податковий номер покупця

Ціле число

HFBUY

Код філії покупця

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

HTINBUY

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

Ціле число, максимальна кількість знаків 10; заповнюється із GLN номера (код ЄДРПОУ)

R04G11

Загальна сума з ПДВ, що підлягає сплаті

R03G11+ R01G7 + R01G109 + R01G9 + R01G8 + R01G10 + R02G11

R03G11

Загальна сума податку на додану вартість (ПДВ)

R03G7 + R03G109

R03G7

Загальна сума ПДВ за основною ставкою

R01G7 * 20%. Тег R03G7 заповнюється складанням усіх тегів RXXXXG11_10 по позиціях, для яких у тегу RXXXXG008 вказано 20% ставка, після чого значення округляється до 2-х знаків після коми

R03G109

Загальна сума ПДВ за ставкою 7%

R01G109 * 7%. Тег R03G109 заповнюється складанням усіх тегів RXXXXG11_10 по позиціях, для яких у тегу RXXXXG008 вказано 7% ставка, після чого значення округляється до 2-х знаків після коми

R01G7

Усього обсяги постачання за основною ставкою (код ставки 20)

Дорівнює сумі по графі 10 для обсягів за ставкою 20%

R01G109

Усього обсяги постачання за ставкою 7% (код ставки 7)

Дорівнює сумі по графі 10 для обсягів за ставкою 7%

R01G9

Усього обсяги постачання при експорті товарів за ставкою 0% (код ставки 901)

Загальна сума коштів, що підлягають сплаті, з урахуванням податку на додану вартість. Дорівнює сумі по графі 10 для обсягів за ставкою 0%

R01G8

Усього обсяги постачання на митній території України за ставкою 0% (код ставки 902)

Дорівнює сумі по графі 10 для обсягів за ставкою 0%

R01G10

Усього обсяги операцій, звільнених від оподаткування (код ставки 903)

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

R02G11

Дані щодо зворотної (заставної) тари

Зворотна (заставна) тара -загальна сума коштів.

RXXXXG3S

Найменування товару/послуги №1

Номенклатура товарів/послуг продавця

RXXXXG3S

Найменування товару/послуги №2

Номенклатура товарів/послуг продавця

……………………………………

RXXXXG4

Код товару згідно з УКТ ЗЕД товару №1

Код товару згідно з УКТ ЗЕД

RXXXXG4

Код товару згідно з УКТ ЗЕД товару №2

Код товару згідно з УКТ ЗЕД

……………………………………

RXXXXG32

Код-ознака імпортованого товару №1

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

RXXXXG32

Код-ознака імпортованого товару №2

……………………………………

RXXXXG33

Код послуги №1 згідно з ДКПП

заповнюється із довідника ДКПП

RXXXXG33

Код послуги №2 згідно з ДКПП

заповнюється із довідника ДКПП

……………………………………

RXXXXG4S

Одиниця виміру товару/послуги №1

Умовне позначення одиниці виміру товару №1 українською (Довідник 1 / {Довідник 2 )

RXXXXG4S

Одиниця виміру товару/послуги №2

Умовне позначення одиниці виміру товару №2 українською (Довідник 1 / {Довідник 2 )

……………………………………

RXXXXG105_2S

Код одиниці виміру товару/послуги №1

Для користувача доступний список одиниць виміру з довідника (Довідник 1 / {Довідник 2 )

RXXXXG105_2S

Код одиниці виміру товару/послуги №2

Для користувача доступний список одиниць виміру з довідника (Довідник 1 / {Довідник 2 )

……………………………………

RXXXXG5

Кількість товарів №1

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

RXXXXG5

Кількість товарів №2

……………………………………

RXXXXG6

Ціна позиції №1 без урахування ПДВ

Ціна постачання одиниці товару / послуги без урахування ПДВ

RXXXXG6

Ціна позиції №2 без урахування ПДВ

……………………………………

RXXXXG008

Ціле число

Код ставки

RXXXXG009

Ціле число

Код пільги R003G10S

RXXXXG010

Обсяги постачання (база оподаткування) без урахування ПДВ

Число з плаваючою точкою Графа 10 = Графа 6 * Графа 7

RXXXXG11_10

Сума податку на додану вартість

Сума ПДВ для кожної позиції таблиці

RXXXXG011

Код виду діяльності сільськогосподарського товаровиробника

Число від 1 до … 999

HBOS

Прізвище особи, яка склала податкову накладну

Текст (ініціали та прізвище)

HKBOS

Реєстраційний номер облікової картки платника податків або серія та/або номер паспорта

Ціле число

R003G10S

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

Текст

DECLARBODY

Завершення змістового блоку

DECLAR

Завершення документу

Звіт про продажі (SLSRPT)

Звіт про продажі (SLSRPT) відправляє покупець постачальнику, вказуючи місце продажу, період, ціну, продану кількість.

Назва поля

Тип

Формат

Опис

SLSRPT

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

CAMPAIGNNUMBER

O

Рядок (35)

Номер продавця в обліковій системі замовника

TIME

О

Час (год: хв)

Час складання документа

SALESPERIOD

Період продажів (початок блоку)

FROMDATE

M

Дата (РРРР-ММ-ДД)

Дата продажів з

FROMTIME

О

Час (год: хв)

Час продажів з

TODATE

О

Дата (РРРР-ММ-ДД)

Дата продажів по

TOTIME

О

Час (год: хв)

Дата продажів по

SALESPERIOD

Період продажів (закінчення блоку)

SALESADMINISTRATOR

Контакти адміністратора (початок блоку)

NAME

O

Рядок (70)

Ім’я

TELEPHON

O

Рядок (70)

Телефон

FAX

O

Рядок (70)

Факс

EMAIL

O

Рядок (70)

Електронна пошта

SALESADMINISTRATOR

Контакти адміністратора (закінчення блоку)

CURRENCY

M

Рядок (3)

Код валюти

SLSRPTTOTALAMOUNT

О

Рядок (70)

Всього без ПДВ

HEAD

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN постачальника

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

PLACE

Логістика (початок блоку)

PLACENUMBER

M

Число позитивне

Номер місця продажу

PLACE

M

Число (13)

GLN місця продажу

VENDORCODE

О

Рядок (35)

Код виробника

PARTNERCODE

О

Рядок (35)

Код партнера

CUSTOMERNAME

О

Рядок (70)

Ім’я покупця

CUSTOMERCITY

О

Рядок (35)

Місто покупця

COUNTRYCODE

О

Рядок (2)

Двозначний код країни

SENDERMAIL

О

Рядок (70)

Електронна пошта

CUSTOMERTOTALAMOUNT

О

Рядок (70)

Всього без ПДВ

SALESPERIOD

Період продажів (початок блоку)

FROMDATE

O

Дата (РРРР-ММ-ДД)

Дата продажів з

FROMTIME

O

Час (год: хв)

Час продажів з

TODATE

O

Дата (РРРР-ММ-ДД)

Дата продажів по

TOTIME

O

Час (год: хв)

Дата продажів по

SALESPERIOD

Період продажів (закінчення блоку)

POSITION

Товарні позиції (початок блоку)

PRODUCTNUMBER

M

Число позитивне

Номер позиції

PRODUCT

M

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDSUPPLIER

O

Рядок (35)

Артикул в БД постачальника

PRODUCTIDBUYER

O

Рядок (35)

Артикул в БД покупця

PRODUCTIDMDLS

O

Рядок (35)

Артикул в БД складу

PRODUCTNAME

O

Рядок (70)

Опис продукту

PRICELISTNUMBER

O

Рядок (35)

Номер прайс-листа

AMOUNT

O

Число десяткове

Сума проданого товару

PRICE

M

Число десяткове

Ціна продукту

SOLDQUANTITY

M

Число позитивне

Продана кількість

DEALCODE

INVOICENUMBER

O

Рядок (16)

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

INVOICEDATE

O

Дата (РРРР-ММ-ДД)

Дата рахунку

SHIPMENTDATE

O

Дата (РРРР-ММ-ДД)

Дата відвантаження

RETURNEDQUANTITY

O

Число позитивне

Повернена кількість

POSITION

Товарні позиції (закінчення блоку)

PLACE

Логістика (закінчення блоку)

HEAD

Закінчення основного блоку

SLSRPT

Закінчення документа

Звіт про інвентаризацію (INVRPT)

Звіт про інвентаризацію (INVRPT) відправляє покупець постачальнику, вказуючи кількість товару в конкретному магазині

Назва поля

Тип

Формат

Опис

INVRPT

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

CAMPAIGNNUMBER

O

Рядок (70)

Номер договору на поставку

INVENTORYPERIOD

Період інвентаризації (початок блоку)

FROMDATE

М

Дата (РРРР-ММ-ДД)

Дата з

FROMTIME

О

Час (год: хв)

Час з

TODATE

М

Дата (РРРР-ММ-ДД)

Дата за

TOTIME

О

Час (год: хв)

Час по

INVENTORYPERIOD

Період інвентаризації (закінчення блоку)

CONTACTFACE

Контактна інформація (початок блоку)

NAME

O

Рядок (70)

Ім’я

TELEPHON

O

Рядок (70)

Телефон

FAX

O

Рядок (70)

Факс

EMAIL

O

Рядок (70)

Електронна пошта

CONTACTFACE

Контактна інформація (закінчення блоку)

CURRENCY

O

Рядок (3)

Код валюти

TIME

O

Час (год: хв)

Час створення документа

HEAD

Початок основного блоку

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

HEADOFFICE

O

Число (13)

GLN головного офісу продавця

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

DELIVERYPLACE

M

Число (13)

GLN місця доставки

VENDORCODE

О

Рядок (35)

Код виробника

SENDERMAIL

О

Рядок (70)

Електронна пошта відправника

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер позиції

PRODUCT

M

Число (8, 10, 14)

Штрих-код продукту

LOCATION

O

Число (13)

GLN місця продажу

LOCATIONTYPE

PRODUCTIDSUPPLIER

O

Рядок (35)

Артикул в БД постачальника

PRODUCTIDBUYER

O

Рядок (35)

Артикул в БД покупця

PRODUCTIDMDLS

O

Рядок (35)

Артикул в БД складу

PRODUCTNAME

O

Рядок (70)

Опис продукту

ACTUALQUANTITY

M

Число позитивне

Фактична кількість

ACTUALUNITS

O

Рядок (3)

Одиниці виміру

ACTUALQUANTITYEND

O

Число позитивне

Загальний залишок на кінець

SOLDQUANTITY

O

Число позитивне

Продана кількість

SOLDUNITS

O

Рядок (3)

Одиниця виміру

RECEIVEDQUANTITY

O

Число позитивне

Прийнята кількість

RECEIVEDUNITS

O

Рядок (3)

Одиниця виміру

DELIVEREDQUANTITY

O

Число позитивне

Відвантажено

CORRECTIONQUANTITY

O

Число позитивне

Відкоригована кількість

CORRECTIONQUANTITYEND

O

Число ціле

Доступний залишок на кінець

CORRECTIONUNITS

O

Рядок (3)

Одиниця виміру

DAMAGEDQUANTITY

O

Число позитивне

Пошкоджена кількість

DAMAGEDUNITS

O

Рядок (3)

Одиниця виміру

PRICE

O

Число десяткове

Ціна продукту

PRICEUNITS

О

Рядок (3)

Одиниця виміру

CONDITIONSTATUSINFO

О

Рядок (70)

Опис статусу кондиції

CONDITIONSTATUS

О

Рядок (3)

Статус кондиції

PACKAGEID

O

Рядок (15)

Партія товару

SOLDQUANTITYEU

О

Число позитивне

Продана кількість

BACKORDERS

О

Число позитивне

Невиконані продажі

TOTALSELLINQUANTITY

О

Число позитивне

Всього товару

SELLINQUANTITY

О

Число позитивне

Кількість в продажу

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

INVRPT

Закінчення документа

Інформація про контрагента для постачальника (PARTIN)

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

Назва поля

Тип

Формат

Опис

PARTIN

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата

CONTRACTNUMBER

M

Рядок (70)

Номер договору

CONTRACTDATE

M

Дата (РРРР-ММ-ДД)

Дата договору

HEAD

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN постачальника

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

COMPANIES

Компанії (початок блоку)

PARTYQUALIFIER

M

Рядок (35)

Фізична адреса магазину. Значення тільки DP

COMPANY

M

Число (13)

GLN магазину

NAME

M

Рядок (35)

Назва магазину

STREET

M

Рядок (35)

Вулиця

BUILDING

M

Рядок (8)

Номер будівлі

SECONDBUILDING

O

Рядок (8)

Номер другої будівлі (якщо компанія займає кілька будівель)

FLATNUMBER

M

Рядок (8)

Номер офісу

CITY

M

Рядок (2)

Місто

ZIPCODE

M

Рядок (35)

Індекс

COUNTRYCODE

M

Рядок (2)

двозначний код країни

FISCALNUMBER

M

Рядок (35)

ІПН

REGISTRATIONNUMBER

M

Рядок (35)

Код ЄДРПОУ

RCEO

M

Рядок (35)

ЗКПО

OKVD

M

Рядок (35)

Код КОАТУУ

CONTACTS

Контакти магазину (початок блоку)

CONTACTCODE

M

Рядок (2)

ОС - менеджер, SA - директор

NAME

M

Рядок (35)

ПІБ

EMAIL

M

Рядок (35)

Електронна пошта

FAX

O

Рядок (35)

Факс

TELEPHONE

M

Рядок (35)

Телефон

ADDITIONALNUMBER

O

Рядок (35)

Додатковий номер

MOBILENUMBER

O

Рядок (35)

Мобільний номер

WWW

O

Рядок (70)

Сайт

CONTACTS

Контакти магазину (закінчення блоку)

COMPANIES

Компанії (закінчення блоку)

HEAD

Закінчення основного блоку

PARTIN

Закінчення документа

Інформація про контрагента для роздрібної мережі (PARTIN)

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

Назва поля

Тип

Формат

Опис

PARTIN

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата

CONTRACTNUMBER

M

Рядок (70)

Номер договору

CONTRACTDATE

M

Дата (РРРР-ММ-ДД)

Дата договору

HEAD

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN постачальника

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

COMPANIES

Адреса компанії (початок блоку)

PARTYQUALIFIER

M

Рядок (2)

Адреса компанії: СО - юридична, SU - фізична

COMPANY

M

Число (13)

GLN магазину

NAME

M

Рядок (35)

Назва магазину

STREET

M

Рядок (70)

Вулиця

BUILDING

M

Рядок (8)

Номер будівлі

SECONDBUILDING

O

Рядок (8)

Номер другої будівлі (якщо компанія займає кілька будівель)

FLATNUMBER

M

Рядок (8)

Номер офісу

CITY

M

Рядок (35)

Місто

ZIPCODE

M

Рядок (35)

Індекс

COUNTRYCODE

M

Рядок (2)

Код країни

FISCALNUMBER

M

Рядок (35)

ІПН

REGISTRATIONNUMBER

M

Рядок (35)

Код ЄДРПОУ

RCEO

M

Рядок (35)

ЗКПО

SIC

M

Рядок (35)

ЗКГНГ

GOVREFN

O

Рядок (35)

ОДРН

OKVD

M

Рядок (35)

Код КОАТУУ

EXECUTIVE

відповідальний співробітник

SPECINST

CONTACTS

Контакти (початок блоку)

CONTACTCODE

M

Рядок (2)

ОС - менеджер, SA - директор

NAME

O

Рядок (35)

ПІБ

EMAIL

M

Рядок (70)

Електронна пошта

FAX

O

Рядок (35)

Факс

TELEPHONE

O

Рядок (35)

Телефон

ADDITIONALNUMBER

O

Рядок (35)

Додатковий номер

MOBILENUMBER

O

Рядок (35)

Мобільний номер

WWW

O

Рядок (70)

Сайт

CONTACTS

Контакти (закінчення блоку)

RETAILCONTACTS

Контакти з боку роздрібної мережі (початок блоку)

NAME

М

Рядок (35)

ПІБ

EMAIL

М

Рядок (70)

Електронна пошта

RETAILCONTACTS

Контакти з боку роздрібної мережі (закінчення блоку)

CURRACCOUNT

М

Рядок (35)

Розрахунковий рахунок

BENEFICIARY

М

Рядок (2)

Відомості про вигодонабувача: 1 - юридична особа, 2 - фізична особа, 3 - індивідуальний підприємець

BANKNAMECODE

М

Рядок (35)

Банківський ідентифікаційний код (БИК)

BANKINTID

М

Рядок (70)

Міжнародний код банку

PERFORMERBANKNAME

М

Рядок (70)

Найменування банку

IBLN

М

Рядок (35)

IBAN (міжнародний номер банківського рахунку; використовується при міжнародних розрахунках)

COUNTRYNAME

М

Рядок (2)

Код країни банку

CORRACCOUNT

М

Рядок (70)

Кореспондентський рахунок банку

FINBENEFICIARY

М

Рядок (35)

Кінцевий бенефіціар (Кінцевий одержувач коштів)

REGCAPITAL

М

Рядок (35)

Зареєстрований статутний капітал

VALUECAPITAL

М

Рядок (35)

Величина статутного фонду

PAIDCAPITAL

М

Рядок (35)

Сплачений статутний капітал

REGDATE

М

Дата (РРРР-ММ-ДД)

Дата державної реєстрації

REGNUMBER

М

Рядок (35)

Номер державної реєстрації

NOTIFNAME

М

Рядок (35)

Найменування реєструючого органу

REGPLACE

М

Рядок (35)

Місце реєстрації

LICENSE

Ліцензія (початок блоку)

LISTYPE

М

Рядок (2)

Тип ліцензії: IP - ліцензія на імпорт, TL - звільнення від податків, EX - ліцензія на експорт, AV - інша

LICNUM

М

Рядок (35)

Номер ліцензії

LICTYPE

М

Рядок (35)

Вид ліцензії

LICDATE

М

Дата (РРРР-ММ-ДД)

Дата видачі ліцензії

LICREGNUM

М

Рядок (35)

Реєстраційний номер

LICSTART

М

Дата (РРРР-ММ-ДД)

Дата початку дії ліцензії

LICEND

М

Дата (РРРР-ММ-ДД)

Дата закінчення дії ліцензії

LICGIVEN

М

Рядок (70)

Ким видано ліцензію

LICENSE

Ліцензія (закінчення блоку)

COMPANIES

Адреса компанії (закінчення блоку)

COMPANIES

Адреса компанії (початок блоку)

PARTYQUALIFIER

М

Рядок (2)

Адреса компанії: СО - юридична, SU - фізична

STREET

М

Рядок (35)

Вулиця

BUILDING

М

Рядок (8)

Номер будівлі

SECONDBUILDING

О

Рядок (8)

Номер другої будівлі (якщо компанія займає кілька будівель)

FLATNUMBER

М

Рядок (8)

Номер квартири або офісу

CITY

М

Рядок (35)

Місто

ZIPCODE

М

Рядок (16)

Індекс

COMPANIES

Адреса компанії (закінчення блоку)

HEAD

Закінчення основного блоку

PARTIN

Закінчення документа

Комерційна дискусія (COMDIS)

Комерційну дискусію (COMDIS) відправляє покупець постачальнику на основі Рахунка (INVOICE), вказуючи прийнятий або не прийнятий рахунок, і якщо не прийнятий, то з якої причини

Назва поля

Тип

Формат

Опис

COMDIS

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

DOCNAME

М

Рядок (7)

Тип документа

DOCNUMBER

М

Рядок (16)

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

DOCDATE

О

Дата (РРРР-ММ-ДД)

Дата рахунку

DOCACTION

М

« 1 »,« 3 »,« 5 »,« 8 »

1 - рахунок прийнятий, 3 - умовно прийнятий, 5 - тільки для інформації, 8 - не прийнятий

DELIVERYDATE

О

Дата (РРРР-ММ-ДД)

Дата поставки

EARLIESTDELIVERY

О

Дата (РРРР-ММ-ДД)

Найбільш рання дата доставки

ORDERNUMBER

О

Рядок (16)

Номер замовлення

ORDERDATE

О

Дата (РРРР-ММ-ДД)

Дата замовлення

DESADVNUMBER

О

Рядок (16)

Номер пов. про відвантаження

RECADVNUMBER

O

Рядок (16)

Номер пов. про прийом

HEAD

Початок основного блоку

BUYER

М

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN постачальника

SENDER

М

Число (13)

GLN відправника

RECIPIENT

М

Число (13)

GLN одержувача

DELIVERYPLACE

М

Число (13)

GLN доставки

DETAILS

Подробиці (початок блоку)

LINE

Рядок позиції (початок блоку)

DISPUTEDINLINE

М

Число позитивне

Номер позиції в рахунку

PRODUCT

О

Число (8, 10, 14)

Штрихкод продукту

DESCRIPTION

О

Рядок (70)

Опис продукту

AMOUNTSUBJECT

O

Число десяткове

Сума позиції

AMOUNTSUBJECTCURRENCY

О

Рядок (3)

Код валюти

QUANTITY

О

Число позитивне

Кількість, що поставляється

UNIT

O

Рядок (3)

Одиниці виміру

PRICE

O

Число десяткове

Ціна продукту

TAX

Логістика (початок блоку)

TAXRATE

O

Число (3)

Ставка податку (ПДВ,%)

TAXAMOUNT

O

Число десяткове

ПДВ

TAX

Логістика (закінчення блоку)

AMOUNTSUBJECTREASON

М

Рядок (3)

Причина дискусії: 1 - для інформації, 3 - товар був пошкоджений, 4 - недопоставка, 9 - помилка в накладній, 14 - неправильна поставка, 17 - ушкодження при транспортуванні, 26 - податки, 32 - товари не доставили, 35 - товари повернули, 56 - неправильна знижка, 10E - неправильний штрихкод

INFO

O

Рядок (70)

Вільний текст

LINE

Рядок позиції (початок блоку)

DETAILS

Подробиці (закінчення блоку)

HEAD

Закінчення основного блоку

COMDIS

Закінчення документа

Інструкція з доставки (INSDES)

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

Назва поля

Тип

Формат

Опис

INSDES

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

TIME

О

Час (год: хв)

Час документа

DELIVERYDATE

О

Дата (РРРР-ММ-ДД)

Дата доставки

DELIVERYTIME

О

Час (год: хв)

Час доставки

DELIVERYINFO

О

Рядок (70)

Інформація з доставки

ORDERNUMBER

О

Рядок (16)

Номер замовлення

ORDERDATE

О

Дата (РРРР-ММ-ДД)

Дата замовлення

CAMPAIGNNUMBER

О

Рядок (35)

Номер договору на поставку

AMOUNT

О

Число десяткове

Ціна

CURRENCY

О

Рядок (3)

Код валюти

CONTACT

Контактна інформація (початок блоку)

NAME

О

Рядок (70)

Ім’я

EMAIL

О

Рядок (70)

Електронна пошта

FAX

О

Рядок (70)

Факс

TELEPHONE

О

Рядок (70)

Телефон

CONTACT

Контактна інформація (закінчення блоку)

TRANSPORTTYPE

О

Рядок (3)

Тип транспортування: 20 - залізничний, 30 - дорожній, 40 - повітряний, 60 - спарений, 100 - кур’єрська служба

TOTALAMOUNT

О

Число десяткове

Загальна ціна продукції, що поставляється

CURRENCY

О

Рядок (3)

Код валюти

HEAD

Початок основного блоку

ORDEREDBY

М

Число (13)

Замовник

LOGISTICPROVIDER

М

Число (13)

Провайдер логістичних послуг

SUPPLIER

О

Число (13)

Постачальник

BUYER

О

Число (13)

Покупець

DELIVERYPLACE

M

Число (13)

Місце доставки

SENDER

M

Число (13)

Відправник

RECIPIENT

M

Число (13)

Одержувач

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер позиції

PRODUCT

М

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDSUPPLIER

О

Рядок (35)

Артикул в БД постачальника

PRODUCTIDBUYER

О

Рядок (35)

Артикул в БД покупця

QUANTITY

М

Число позитивне

кількість, що поставляється

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

QUANTITYUNIT

О

Рядок (3)

Одиниці виміру

SSCC

О

Число (14, 18)

Штрих-код транспортної упаковки

AMOUNT

О

Число десяткове

Ціна

DELIVERYDATE

О

Дата (РРРР-ММ-ДД)

Дата доставки даної продукції

DELIVERYTIME

О

Час (год: хв)

Час доставки

DELIVERYPLACE

M

Число (13)

Місце доставки

INFO

О

Рядок (70)

Примітка

PRICE

O

Число десяткове

Ціна продукту

PRICE

O

Число десяткове

Ціна продукту

VAT

O

Число позитивне

Ставка ПДВ,%

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

INSDES

Закінчення документа

Повідомлення про відвантаження для розподільного центру (DESSCC)

Повідомлення про відвантаження для розподільного центру (DESSCC) Крос-докінг відправляється постачальником у відповідь на документ Інструкція по доставці (INSDES). Постачальник вказує позиції, які будуть поставлені, і їх кількість. В даному документі є можливість внести інформацію по кожній палеті, тому документ Повідомлення про відвантаження для РЦ дуже докладно описує кожну поставку

Назва поля

Тип

Формат

Опис

DESSCC

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

DELIVERYDATE

О

Дата (РРРР-ММ-ДД)

Дата доставки

DELIVERYTIME

О

Час (год: хв)

Час доставки

ORDERNUMBER

О

Рядок (16)

Номер замовлення

ORDERDATE

О

Дата (РРРР-ММ-ДД)

Дата замовлення

DELIVERYNOTENUMBER

М

Рядок (16)

Номер накладної

DELIVERYNOTEDATE

О

Дата (РРРР-ММ-ДД)

Дата накладної

CAMPAIGNNUMBER

О

Рядок (16)

Номер договору на поставку

TRANSPORTID

O

Рядок (70)

Номер транспортного засобу

TRANSPORTMARK

O

Рядок (70)

Марка машини

TRANSPORTERNAME

O

Рядок (70)

Ім’я водія

SELFSHIPMENT

Самовивіз; можливі значення: 0 -Ні, 1 - Так

HEAD

Початок основного блоку

SUPPLIER

О

Число (13)

Постачальник

BUYER

О

Число (13)

Покупець

DELIVERYPLACE

M

Число (13)

Місце доставки (РЦ)

SENDER

M

Число (13)

Відправник

RECIPIENT

M

Число (13)

Одержувач

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

PACKINGSEQUENCE

Робота з товарними позиціями (початок блоку)

HIERARCHICALID

М

Число позитивне

Порядковий номер палети

SSCC

М

Число (14, 18)

Штрихкод транспортної упаковки

LOCATION

М

Число (13)

Місце доставки упаковки

DOCNUMBER

M

Рядок (16)

Номер документа

DOCDATE

M

Дата (РРРР-ММ-ДД)

Дата документа

VOLUME

O

Число позитивне

Об’єм

WEIGHT

O

Число десяткове

Вага

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер позиції

PRODUCT

М

Число (8, 10, 14)

Штрихкод продукту

PRODUCTIDBUYER

О

Рядок (35)

Артикул в БД покупця

DELIVEREDQUANTITY

М

Число позитивне

Кількість, що поставляється

ORDEREDQUANTITY

О

Рядок (3)

Замовлена кількість

DESCRIPTION

О

Рядок (70)

Опис продукту

COUNTRYORIGIN

О

Рядок (2)

Країна виробник (для імпортного товару)

CUSTOMSTARIFFNUMBER

О

Рядок (35)

Номер державної митної декларації (ВМД)

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

PRICE

O

Число десяткове

Ціна продукту

VAT

O

Число позитивне

Ставка ПДВ,%

UNIT

O

Рядок (3)

Одиниці виміру

DELIVEREDUNIT

O

Рядок (3)

Одиниці виміру

PRODUCTIDSUPPLIER

О

Рядок (35)

Артикул в БД постачальника

BOTTLINGDATE

О

Дата (РРРР-ММ-ДД)

Дата розливу

POSITION

Товарні позиції (закінчення блоку)

PACKINGSEQUENCE

Робота з товарними позиціями (закінчення блоку)

HEAD

Закінчення основного блоку

DESSCC

Закінчення документа

Акт звірки взаєморозрахунків (COACSU)

Акт звірки взаєморозрахунків (COACSU) використовується для звірки взаєморозрахунків з контрагентом (постачальником) і дозволяє оперативно і точно звіряти сальдо з контрагентом за певний період

Назва поля

Тип

Формат

Опис

COACSU

Початок документа

ACTION

О

« 49E »,« 397 »

49E - оригінал документа, 397 - документ у відповідь

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

COACSUNUMBER

О

Рядок (16)

Номер Акта звірки, за яким йде підтвердження

PERIOD

Період (початок блоку)

FROMDATE

М

Дата (РРРР-ММ-ДД)

Дата початку періоду

FROMTIME

O

Час (год: хв)

Час початку періоду

TODATE

M

Дата (РРРР-ММ-ДД)

Дата кінця періоду

TOTIME

O

Час (год: хв)

Час кінця періоду

PERIOD

Період (закінчення блоку)

CONTACTS

Контакти (початок блоку)

CONTACTCODE

O

Рядок (16)

ОС - менеджер, SA - директор

NAME

О

Рядок (35)

Ім’я контакту

EMAIL

О

Рядок (35)

Електронна адреса

CONTACTS

Контакти (закінчення блоку)

OPENINGBALANCE

O

Число десяткове

Початкове сальдо

CLOSINGBALANCE

O

Число десяткове

Закриття балансу

PAYABLEAMOUNT

O

Число десяткове

Сальдо по товарах

RETURNABLEPACAMOUNT

О

Число десяткове

Сальдо тари

CURRENCY

O

Рядок (3)

Код валюти

CARRIERNAME

O

Рядок (3)

Назва перевізника/постачальника

CARRIERINN

O

Число (12)

ІПН перевізника/постачальника

INFO

O

Рядок (70)

Додаткова інформація

HEAD

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN постачальника

SENDER

M

Число (13)

GLN відправника повідомлення

RECIPIENT

M

Число (13)

GLN одержувача повідомлення

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число * 1, 100]

Номер позиції

DOCNUMBER

M

Рядок (16)

Номер документа

PRODUCTIONCODE

О

Рядок (16)

Код алкогольної продукції

PRODINN

O

Число позитивне

ІПН виробника/імпортера

PARTYNAME

О

Рядок (70)

Назва виробника

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Дата поставки

LICENSE

О

Рядок (70)

Серія, номер ліцензії

LICGIVEN

М

Рядок (70)

Ким видано ліцензію

LICSTART

М

Дата (РРРР-ММ-ДД)

Дата початку дії ліцензії

LICEND

М

Дата (РРРР-ММ-ДД)

Дата закінчення дії ліцензії

COUNTRYORIGIN

О

Рядок (2)

Країна виробник

CUSTOMSTARIFFNUMBER

О

Рядок (30)

Номер державної митної декларації (ВМД)

VOLUME

О

Число позитивне

Об`єм

VOLUMEUNIT

O

Рядок (3)

Одиниці виміру

DOCDATE

M

Дата (РРРР-ММ-ДД)

Дата документа

DOCNAME

O

Рядок (7)

Тип документа

DOCTYPE

O

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

LOCATION

O

Число (13)

GLN точки продажу

PAYMENTNUMBER

O

Рядок (16)

Номер платіжного документа

PAYBLEAMOUNT

О

Число десяткове

Сума до оплати

PAIDAMOUNT

M

Число десяткове

Сплачена сума

RETURNABLEPACAMOUNT

О

Число десяткове

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

INCOMINGPACAMOUNT

О

Число десяткове

Сума прибуткової тари

DESCRIPTION

О

Рядок (70)

Опис

CAMPAIGNNUMBER

О

Рядок (16)

Номер договору на поставку

RECADVNUMBER

O

Рядок (16)

Номер пов. про прийом

RECADVDATE

O

Дата (РРРР-ММ-ДД)

Дата пов. про прийом

DELIVERYNOTENUMBER

О

Рядок (16)

Номер накладної

INVOICEAMOUNT

О

Число десяткове

Сума накладної

ACTION

О

« 1 »,« 8 »

1 - позиція прийнята, 8 - не прийнята

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

COACSU

Закінчення документа

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

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

Назва поля

Тип

Формат

Опис

ACT

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

PERIOD

М

Дата (РРРР-ММ-ДД)

Період

CAMPAIGNNUMBER

М

Рядок (16)

Номер договору на поставку

POSITIONSAMOUNT

М

Число десяткове

Сума по всіх позиціях без ПДВ

VATSUM

М

Число десяткове

Сума ПДВ

TOTALAMOUNT

М

Число десяткове

Загальна сума з ПДВ

CURRENCY

М

Рядок (3)

Код валюти

DOCTYPE

М

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

INFO

О

Рядок (70)

Інформація

HEAD

Початок основного блоку

PERFORMER

М

Число (13)

GLN виконавця

PERFORMERNAME

О

Рядок (70)

Назва виконавця

PERFORMERNDSNUMBER

О

Рядок (35)

Номер свід. ПДВ виконавця

PERFORMERFISCALNUMBER

О

Рядок (35)

ІПН виконавця

PERFORMERREGISTRATIONNUMBER

О

Рядок (35)

Номер реєстрації виконавця

PERFORMERDIRECTOR

О

Рядок (70)

Відповідальний з боку виконавця

PERFORMERACCOUNT

О

Рядок (35)

Код виконавця

PERFORMERTELEPHONE

О

Рядок (35)

Телефон виконавця

PERFORMERADRESS

О

Рядок (70)

Адреса виконавця

PERFORMERBANKNAME

О

Рядок (35)

Назва банку виконавця

PERFORMERBANKNUMBER

О

Рядок (35)

МФО банку виконавця

PERFORMERBANKACCOUNT

О

Рядок (35)

Номер р/р виконавця

CUSTOMER

М

Число (13)

GLN замовника

CUSTOMERNAME

О

Рядок (70)

Назва замовника

CUSTOMERNDSNUMBER

О

Рядок (35)

Номер свід.НДС замовника

CUSTOMERFISCALNUMBER

О

Рядок (35)

ІПН замовника

CUSTOMERREGISTRATIONNUMBER

О

Рядок (35)

Номер реєстрації замовника

CUSTOMERDIRECTOR

О

Рядок (70)

Відповідальний від замовника

CUSTOMERACCOUNT

О

Рядок (35)

Код замовника

CUSTOMERTELEPHONE

О

Рядок (35)

Телефон замовника

CUSTOMERADRESS

О

Рядок (35)

Адреса замовника

CUSTOMERBANKNAME

О

Рядок (35)

Назва банку замовника

CUSTOMERBANKNUMBER

О

Рядок (35)

МФО банку замовника

CUSTOMERBANKACCOUNT

О

Рядок (35)

Номер р/р замовника

SENDER

М

Число (13)

GLN відправника

RECIPIENT

М

Число (13)

GLN одержувача

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число [* 1, 100]

Номер позиції

MATERIALASSETS

О

Рядок (70)

Опис продукту

QUANTITY

O

Число позитивне

кількість товару

QUANTITYUNIT

O

Число позитивне

Кількість в упаковці

QUANTITYFORSPECIAL

O

Число позитивне

Кількість в спец.упаковці

PRICE

М

Число десяткове

Ціна за одиницю (без ПДВ)

PRICEFORSPECIAL

O

Число позитивне

Ціна спец.укпаковки (без ПДВ)

AMOUNT

М

Число десяткове

Сума товару (без ПДВ)

PENALTYAMOUNT

О

Число десяткове

Сума штрафу

TOTALAMOUNT

О

Число десяткове

Загальна ціна продукції, що поставляється

TAXRATE

М

Число (3)

Ставка податку (ПДВ,%)

INFO

О

Рядок (70)

Інформація

DATE

О

Дата (РРРР-ММ-ДД)

Дата

SERVICEMADEDATE

О

Дата (РРРР-ММ-ДД)

Дата надання послуги

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

ACT

Закінчення документа

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

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

Назва поля

Тип

Формат

Опис

ACTSET

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

CURRENCY

М

Рядок (3)

Код валюти

CAMPAIGNNUMBER

O

Рядок (16)

Номер договору

CAMPAIGNDATE

O

Дата (РРРР-ММ-ДД)

Дата договору

DIRECTOR

O

Рядок (60)

Директор

MANAGER

O

Рядок (60)

Менеджер

TOTALAMOUNT

М

Число десяткове

Сума за документом

HEAD

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN постачальника

SENDER

M

Число (13)

GLN відправника повідомлення

RECIPIENT

M

Число (13)

GLN одержувача повідомлення

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число [* 1, 100 +]

Номер позиції

PRODUCTNAME

O

Рядок (70)

Опис продукту

PRODUCT

M

Рядок (16)

Найменування товару або послуги

AMOUNT

M

Число десяткове

Сума

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

ACTSET

Закінчення документа

Інструкція з транспортування (IFTMIN)

Інструкція з транспортування (IFTMIN) відправляється замовником оператору логістичних послуг. В даному документі вказуються остаточні деталі поставки

Назва поля

Тип

Формат

Опис

IFTMIN

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Дата поставки

DELIVERYTIME

О

Час (год: хв)

Час доставки

DOCTYPE

О

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

DOCUMENT

Дані про документи (початок блоку)

DOCITEM

Дані про документ (початок блоку)

DOCTYPE

О

Рядок (2)

Тільки для ТМ Фоззі: ON - IFTMIN робиться на базі замовлення

DOCNUMBER

О

Рядок (16)

Номер документа перевізника

DOCITEM

Дані про документ (закінчення блоку)

DOCUMENT

Дані про документи (закінчення блоку)

INSUARENCEVALUE

O

Число десяткове

Застрахована вартість

DECLAREDVALUE

O

Число десяткове

Задекларована ціна поставки

CASHONDELIVERY

O

Число десяткове

Сума оплати за фактом поставки

TOTALPACKAGES

O

Число десяткове

Загальна кількість упаковок

PLACEOFDESPATCH

O

Рядок (60)

Назва місця відвантаження

CONSIGNORNUMBER

O

Рядок (16)

Номер вантажовідправника

CUSTOMERNUMBER

O

Рядок (16)

Номер замовника логістичних послуг

COMPAIGNNUMBER

O

Рядок (16)

Номер договору

EQUIPMENTTYPE

O

Рядок (3)

Тип упаковки обладнання (палети, …)

EQUIPMENTQUANTITY

O

Число десяткове

Кількість обладнання

TOTALWEIGHT

O

Число десяткове

Загальна вага вантажу

TOTALWEIGHTUNITS

O

Рядок (3)

Одиниця виміру

INFO

O

Рядок (70)

Вільний текст

HEAD

Початок основного блоку

CONSIGNOR

M

Число (13)

GLN вантажовідправника

DELIVERYPLACE

M

Число (13)

GLN місця доставки

SENDER

M

Число (13)

GLN відправника повідомлення

RECIPIENT

M

Число (13)

GLN одержувача повідомлення

POSITIONS

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число * 1, 100 +

Номер позиції

SSCC

M

Число (18)

SSCC (Serial Shipping Container Code) - серійний код транспортної упаковки

PACKAGETYPE

O

Рядок (3)

Тип упаковки

PACKAGEQUANTITY

O

Число десяткове

Кількість упаковок

PACKAGEQUANTITYUNITS

O

Рядок (3)

Одиниця виміру

PACKAGEWIGHT

O

Число десяткове

Вага

PACKAGEWEIGHTUNITS

O

Рядок (3)

Одиниця виміру

DELIVERYPLACE

M

Число (13)

Місце доставки позиції

DESCRIPTION

O

Рядок (70)

Опис продукту

INFO

O

Рядок (70)

Вільний текст

PRODUCTIDBUYER

O

Рядок (35)

Артикул в БД покупця

MAXPACKAGEQUANTITY

O

Число десяткове

Максимальна кількість упаковок

POSITIONS

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

IFTMIN

Закінчення документа

Повідомлення про повернення (RETANN)

Повідомлення про повернення (RETANN) використовується для повідомлення постачальника про товари, які не були прийняті і з якої причини

Назва поля

Тип

Формат

Опис

RETANN

Початок документа

NUMBER

M

Рядок (16)

Номер документа

ACTION

О

Число позитивне

9 - оригінал документа, 5 - заміна документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

ORDERNUMBER

O

Рядок (16)

Номер замовлення

ORDERDATE

O

Дата (РРРР-ММ-ДД)

Дата замовлення

DESADVNUMBER

O

Рядок (16)

Номер повідомлення про відвантаження

DESADVDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

RECADVNUMBER

O

Рядок (16)

Номер повідомлення про прийом

RECADVDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про прийом

REQUESTNUMBER

Номер запиту

REQUESTDATE

O

Дата (РРРР-ММ-ДД)

Дата запиту

RETURNDATE

O

Дата (РРРР-ММ-ДД)

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

RETURNNOTENUMBER

O

Рядок (16)

Номер накладної на повернення

RETURNNOTEDATE

O

Дата (РРРР-ММ-ДД)

Дата накладної на повернення

RETURNTYPE

O

Рядок (70)

Причина повернення товару

CAMPAIGNNUMBER

O

Рядок (16)

Номер договору на поставку

INFO

O

Рядок (70)

Додаткова інформація

VERSION

O

Рядок (70)

Версія документа

HEAD

Початок основного блоку

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

DELIVERYPLACE

M

Число (13)

GLN місця доставки

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер позиції

PRODUCT

M

Число (13)

Штрих-код продукту

PRODUCTIDSUPPLIER

O

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

O

Рядок (16)

Артикул в БД покупця

RETURNQUANTITY

M

Число десяткове

Повернена кількість

RETURNQUANTITYUNIT

O

Рядок (3)

Одиниця виміру

DELIVEREDQUANTITY

O

Число десяткове

Доставлена кількість

DELIVEREDQUANTITYUNIT

O

Рядок (3)

Одиниця виміру

PRICE

O

Число десяткове

Ціна

PRICEWITHVAT

О

Число десяткове

Ціна з ПДВ

TAXRATE

О

Число (3)

Ставка податку (ПДВ,%)

AMOUNT

O

Число десяткове

Сума

CURRENCY

O

Рядок (3)

Код валюти

DESNUMBER

O

Рядок (20)

Номер повідомлення про відвантаження

DESDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

DESCRIPTION

O

Рядок (70)

Опис продукту

AMOUNTWITHVAT

О

Рядок (16)

Вартість позиції з ПДВ

BATCHNUMBER

О

Рядок (70)

Серійний номер позиції

ACTION

Дії (початок блоку)

CODE

O

Число (3)

Код дії: 4 - пошкодження, 15 - товар застарів, 12E - товар буде повернений, 14E - товар буде знищений, 15E - товар повинен бути відновлений / відремонтований

DESCRIPTION

O

Рядок (70)

Опис причини (пошкодження)

ACTION

Дії (закінчення блоку)

VAT

O

Число позитивне

Ставка ПДВ,%

QUANTITYOFCUINTU

O

Число позитивне

Кількість в упаковці

WEIGHT

O

Число десяткове

Вага

WEIGHTUNIT

O

Рядок (3)

Одиниці виміру

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

RETANN

Закінчення документа

Інструкція про повернення (RETINS)

Документ Інструкція про повернення (RETINS) відправляється у відповідь на Повідомлення про повернення (RETANN) і використовуватися для підтвердження або редагування дати та часу прибуття постачальника

Назва полів

Тип

Формат

Опис

RETINS

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

RETURNDATE

O

Дата (РРРР-ММ-ДД)

Дата повернення

RETURNTIME

O

Час (год: хв)

Час повернення

RETANNNUMBER

O

Рядок (16)

Номер повідомлення про повернення

RETANNDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про повернення

TOTALRETURNWEIGHT

O

Число десяткове

Загальна вага товару, що повертається

CAMPAIGNNUMBER

O

Рядок (16)

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

INFO

O

Рядок (70)

Додаткова інформація

VERSION

О

Число позитивне

Версія документа

HEAD

Початок основного блоку

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

DELIVERYPLACE

M

Число (13)

GLN місця доставки

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер позиції

PRODUCT

M

Число (13)

Штрих-код продукту

PRODUCTIDSUPPLIER

O

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

O

Рядок (16)

Артикул в БД покупця

RETURNQUANTITY

M

Число десяткове

Повернена кількість

RETURNQUANTITYUNIT

O

Рядок (3)

Одиниця виміру

DESCRIPTION

O

Рядок (70)

Опис продукту

AMOUNTWITHVAT

О

Рядок (16)

Вартість позиції з ПДВ

PRICE

O

Число десяткове

Ціна без ПДВ

PRICEWITHVAT

O

Число десяткове

Ціна з ПДВ

VAT

O

Число позитивне

Ставка ПДВ

BATCHNUMBER

О

Рядок (70)

Серійний номер позиції

DESNUMBER

O

Рядок (20)

Номер повідомлення про відвантаження

DESDATE

O

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

ACTION

Дії (початок блоку)

CODE

O

Число (3)

Код дії: 12Е - повернення прийнято, 13Е - утилізувати товар, 14Е - знищити товар, 15Е - ремонт товару, 16Е - затримати на експертизу, 17Е - в поверненні відмовлено

DESCRIPTION

O

Рядок (70)

Опис причини (пошкодження)

ACTION

Дії (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

RETINS

Закінчення документа

Замовлення транспортування (IFTMBF)

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

Призначення поля

Тип

Формат

Опис

IFTMBF

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

O

Дата (РРРР-ММ-ДД)

Дата документа

TIME

O

Час (ГГ: ХХ)

Час документа

DOCTYPE

О

Рядок (1)

Тип документа: O - оригінал, R - заміна, D - видалення

VERSION

O

Число десяткове

Версія замовлення транспортування

TRANSPORTATIONCONDITION

О

Рядок (1)

Умови транспортування

TRANSPORTATIONCOST

O

Число (10)

Вартість транспортування

DATEFROM

O

Дата (РРРР-ММ-ДД)

Дата завантаження / прибуття транспорту

TIMEFROM

O

Час (год: хв)

Час завантаження / прибуття транспорту

DELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Дата доставки

DELIVERYTIME

O

Час (год: хв)

Час доставки

PORTOFLOADING

O

Рядок (70)

Місце погрузки (Морський порт)

INFO

O

Рядок (70)

Додаткова інформація

TOTALWEIGHT

O

Число десяткове

Загальна вага

TOTALWEIGHTUNIT

O

Рядок (3)

Одиниці виміру

TOTALVOLUME

O

Число десяткове

Загальний об’єм

TOTALVOLUMEUNIT

O

Рядок (3)

Одиниці виміру

TOTALEQUIPMENTQUANTITY

O

Число десяткове

Загальна кількість обладнання

ORDERNUMBER

O

Рядок (35)

Номер замовлення товару

CAMPAIGNNUMBER

O

Рядок (35)

Номер договору на поставку

TRANSPORTDETAILS

Дані по транспорту (початок блоку)

TRANSPORTATIONTYPE

O

Рядок (1, 2)

Тип перевезення (згідно з довідником): 1 - в межах країни; 10 - транспорт (вантажник), який доставляє вантаж до машини перевізника; 11- за межі країни; 13 - транспорт, який досягає місця призначення; 25 - перевізник, відповідальний від місця відвантаження до місця доставки; 30 - перевезення товару після доставки до пункту призначення TRANSPORTTYPE | O | Рядок (2, 3) | Тип транспорту (згідно з довідником): 10 - морський; 20 - залізничний; 30 - автомобільний; 40 - повітряний; 50 - змішаний; 80 - річковий; 100 - кур’єрська доставка

TRANSPORTDETAILS

Дані по транспорту (закінчення блоку)

CONTACT

Контакти (початок блоку)

NAME

O

Рядок (70)

Ім’я

EMAIL

O

Рядок (70)

Електронна пошта

FAX

O

Рядок (70)

Факс

TELEPHONE

O

Рядок (70)

Телефон

CONTACT

Контакти (закінчення блоку)

HEAD

Дані по маршруту (початок основного блоку)

ORDEREDBY

М

Число (13)

Замовник

LOGISTICPROVIDER

M

Число (13)

GLN провайдера логістичних послуг

BUYER

M

Число (13)

GLN покупця

SUPPLIERNAME

O

Рядок (70)

Ім’я постачальника

SUPPLIERADRESS

O

Рядок (70)

Адреса постачальника

SUPPLIERCONTACTFACE

O

Рядок (70)

Контактна особа вантажовідправника

CONSIGNEE

M

Число (13)

GLN вантажоодержувача

CONSIGNEENAME

O

Рядок (70)

Ім’я вантажоодержувача

CONSIGNEEADRESS

O

Рядок (70)

Адреса вантажоодержувача

CONSIGNEECONTACTFACE

O

Рядок (70)

Контактна особа вантажоодержувача

CONSIGNOR

M

Число (13)

GLN вантажовідправника

CONSIGNORNAME

O

Рядок (70)

Ім’я вантажовідправника

CONSIGNORCOUNTRY

O

Рядок (2)

Країна вантажовідправника (Код країни за стандартом ISO-3166 (2 букви))

CONSIGNORCITY

O

Рядок (35)

Місто вантажовідправника

CONSIGNORADRESS

O

Рядок (70)

Адреса вантажовідправника

CONSIGNORCONTACTFACE

O

Рядок (70)

Контактна особа вантажовідправника

DELIVERYPLACE

M

Число (13)

GLN місця доставки

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

GOODSDETAILS

Дані по вантажу (початок блоку)

NUMBER

M

Число позитивне

Номер позиції

EQUIPMENTQUANTITY

O

Кількість

EQUIPMENLENGTH

O

Число (2)

Довжина контейнера: 20 - 20 футів 40 - 40 футів 45 - 45 футів 48 - 48 футів

EQUIPMENTID

O

Рядок (13)

Номер контейнера

PACKAGEQUANTITY

O

Число десяткове

Кількість упаковок

PACKAGETYPE

M

Рядок (2, 3)

Тип упаковки: 09 - поворотна палета; 201 - европалета; CT - картонна коробка; PK - упаковка

INPACKAGE

Упаковка (початок блоку)

QUANTITY

O

Число позитивне

Кількість в одній упаковці

TYPE

O

Рядок (2, 3)

Тип упаковки

INPACKAGE

Упаковка (закінчення блоку)

HANDLING

O

Рядок (3)

Опис вантажу: BIG - нестандартний; CRU - б’ється; EAT - харчові продукти; HWC - перевозити з обережністю; VAL - цінний/дорогий вантаж

TEMPERATURE

Температура (початок блоку)

MIN

O

Число позитивне

Мінімальна температура

MAX

O

Число позитивне

Максимальна температура

TEMPERATURE

Температура (закінчення блоку)

AMOUNT

O

Число десяткове

Ціна упаковки

CURRENCY

O

Рядок (3)

Код валюти

PRODUCT

O

Число (8, 10, 14)

Штрих-код продукту

DESCRIPTION

O

Рядок (70)

Назва продуктів в упаковці

DELIVERYPLACE

M

Число (13)

Місце доставки однієї позиції

WEIGHT

O

Число десяткове

Вага

WEIGHTUNIT

O

Рядок (3)

Одиниці виміру

PRODUCTIDBUYER

O

Рядок (35)

Артикул в БД покупця

GOODSDETAILS

Дані по вантажу (закінчення блоку)

EQUIPMENTDETAILS

Дані по транспорту (початок блоку)

EQUIPMENTTYPE

O

Рядок (2, 3)

тип обладнання; СN - контейнер (згідно з довідником)

EQUIPMENTAMOUNT

O

Число десяткове

кількість обладнання

EQUIPMENTCODE

O

Рядок (4)

Розмір і тип обладнання (контейнера)

EQUIPMENTDESCRIPTION

O

Рядок (70)

опис обладнання/контейнера (вимоги)

EQUIPMENTDETAILS

Дані по транспорту (закінчення блоку)

PALLETAMOUNT

O

Число позитивне

Кількість палет

TONNAGE

O

Число позитивне

Вантажопідйомність

LENGTHROUTE

O

Число позитивне

Довжина маршруту

ZONE

O

Рядок (35)

Зона

ZONEDETAILS

O

Рядок (70)

Подробиці

TRANSPORTTYPE

O

Рядок (2, 3)

Тип транспорту: 10 - морський; 20 - залізничний; 30 - автомобільний; 40 - повітряний; 50 - змішаний; 80 - річковий; 100 - кур’єрська доставка

INFO

O

Рядок (70)

Додаткова інформація

TRANSPORTLIMIT

Транспортні обмеження (початок блоку)

REGION

O

Рядок (70)

Регіон

UNLOADTYPE

O

Рядок (70)

Очікування

LENGTH

O

Число позитивне

Довжина

HEIGHT

O

Число позитивне

Висота

PERMISSIONS

O

Рядок (70)

Права

TAILLIFT

O

TRANSPORTLIMIT

Транспортні обмеження (закінчення блоку)

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер позиції

DELIVERYPLACE

O

Число (13)

Місце доставки

DELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Дата доставки позиції

DELIVERYTIME

O

Час (год: хв)

Час доставки позиції

POSITION

Товарні позиції (закінчення блоку)

HEAD

Дані по маршруту (закінчення основного блоку)

IFTMBF

Закінчення документа

Підтвердження замовлення на транспортування (IFTMBC)

Підтвердження замовлення на транспортування (IFTMBC) відправляється у відповідь на документ Замовлення транспортування (IFTMBF). Відправляється провайдером логістичних послуг в сторону клієнта / мережі. При формуванні IFTMBC у відповідь на IFTMBF деякі поля на WEB заповнюються автоматично, так як і при формуванні наступної версії IFTMBC у відповідь на IFTMBF. Всі дані з попереднього IFTMBC переносяться в новий

Назва поля

Тип

Формат

Опис

IFTMBC

Початок документа

NUMBER

M

Рядок (16)

Номер підтвердження замовлення

DATE

O

Дата (РРРР-ММ-ДД)

Дата підтвердження замовлення

TIME

O

Час (год: хв)

Час підтвердження замовлення

VERSION

O

Число десяткове

версія підтвердження замовлення

IFTMBFNUMBER

M

Рядок (16)

Номер замовлення

IFTMBFDATE

O

Дата (РРРР-ММ-ДД)

Дата замовлення

IFTMBFTIME

O

Час (год: хв)

Час замовлення

IFTMBFVERSION

O

Число десяткове

версія замовлення

HEAD

Початок основного блоку

ORDEREDBY

О

Число (13)

GLN замовника транспортування

LOGISTICPROVIDER

О

Число (13)

GLN провайдера логістичних послуг

CONSIGNEE

О

Число (13)

GLN вантажоодержувача

CONSIGNOR

O

Число (13)

GLN вантажовідправника

CONSIGNORNAME

O

Рядок (70)

Ім’я вантажовідправника

CONSIGNORCOUNTRY

O

Рядок (2)

Країна вантажовідправника (Код країни за стандартом ISO-3166 (2 букви))

CONSIGNORCITY

O

Рядок (35)

Місто вантажовідправника

CONSIGNORADRESS

O

Рядок (70)

Адреса вантажовідправника

CONSIGNORCONTACTFACE

O

Рядок (70)

Контактна особа вантажовідправника

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

CARRIERAGENTNAME

O

Рядок (70)

Назва агента перевізника

CARRIERAGENTADRESS

O

Рядок (150)

Адреса агента перевізника

CARRIERAGENTADRESSABROAD

O

Рядок (150)

Адреса агента перевізника за кордоном

EQUIPMENTDETAILS

Дані по транспорту (початок блоку)

NUMBER

O

Число позитивне

номер позиції (контейнера)

EQUIPMENTTYPE

O

Рядок (2, 3)

СN - контейнер

EQUIPMENTCODE

O

Рядок (4)

Розмір і тип контейнера (ISO 6346)

EQUIPMENTID

O

Стоку (13)

Номер контейнера

EQUIPMENTDESCRIPTION

O

Стоку (70)

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

TRANSPORTMEANS

Дані про транспортний засіб (початок блоку)

TRANSPORTID

O

Стоку (10)

Номер транспортного засобу

TRANSPORTTRAILERID

O

Стоку (10)

Номер причепа транспортного засобу

DRIVERNAME

O

Стоку (70)

ПІБ водія ТЗ

DRIVERPHONE

O

Стоку (40)

Телефон водія ТЗ

TRANSPORTMEANS

Дані про транспортний засіб (закінчення блоку)

EQUIPMENTDETAILS

Дані по транспорту (закінчення блоку)

SEALINE

O

Рядок (16)

Номер лінії

LADINGBILLNUMBER

O

Рядок (16)

Номер коносамента

CUSTOMSCODE

O

Рядок (16)

Код митного поста

CARGOEVENTS

Події про перевезення (початок блоку)

NUMBER

O

Число позитивне

номер позиції (події)

TRANSPORTTYPE

O

Рядок (2,3)

Тип транспорту: 10 - морський, 20 - залізничний, 30 - автомобільний, 40 - повітряний, 50 - змішаний, 80 - річковий, 100 - кур’єрська доставка

TRANSPORTNAME

O

Стоку (70)

Назва транспорту/судна

CARGOEVENT

O

Рядок (2,3)

Тип події: CL - погрузка/готовність вантажу до відправлення (CargoLoaded) CMD - відправлення вантажу за основним маршрутом (CargoMainDeparture) CTA - прибуття вантажу в проміжну точку (CargoTransshipmentArrival) CTD - відправлення вантажу з проміжної точки (CargoTransshipmentDeparture) CMA - прибуття вантажу за основним маршрутом (CargoMainArrival) CD - доставка вантажу в кінцеву точку (CargoDelivery) EER - повернення порожнього обладнання (EmptyEquipmentReturn)

CARGOLOCATION

O

Стоку (13)

GLN місця події

CARGOLOCATIONNAME

O

Рядок (70)

Назва місця події

CARGOEVENTDATE

O

Дата (РРРР-ММ-ДД)

Дата події

CARGOEVENTTIME

O

Час (год: хв)

Час події

CARGOEVENTINFO

O

Рядок (70)

Додаткова інформація

CARGOEVENTS

Події про перевезення (закінчення блоку)

ACTION

O

Стоку (2)

Дія: 01 - заявка відхилена (подальші дії по ланцюжку неприпустимі) 09 - заявка прийнята (подальші дії по ланцюжку неприпустимі)

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

O

Число позитивне

номер позиції

DELIVERYPLACE

M

Число (13)

Місце доставки

DELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Дата доставки позиції

DELIVERYTIME

O

Час (год: хв)

Час доставки позиції

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

IFTMBC

Закінчення документа

Звіт про надані послуги (MSCONS)

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

Назва поля

Тип

Формат

Опис

MSCONS

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

COMPAIGNNUMBER

O

Рядок (70)

Номер договору

PERIOD

Період звіту (початок блоку)

FROMDATE

O

Дата (РРРР-ММ-ДД)

Дата з

FROMTIME

O

Час (год: хв)

Час з

TODATE

O

Дата (РРРР-ММ-ДД)

Дата за

TOTIME

O

Час (год: хв)

Час по

PERIOD

Період звіту (закінчення блоку)

INFO

O

Число (13)

Додаткова інформація

EDIINTERCHANGEID

O

Рядок (70)

Номер транзакції

HEAD

Початок основного блоку

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

SENDER

M

Число (13)

GLN відправника

RECIPIENT

M

Число (13)

GLN одержувача

LOCATION

Місцезнаходження (початок блоку)

LOCATIONNUMBER

M

Число позитивне

Номер місця продажу

LOCATION

M

Число (13)

GLN місця продажу

LOCATIONID

O

Рядок (35)

Внутрішній код місця продажу

ORDERNUMBER

O

Рядок (35)

Номер замовлення

ORDERDATE

O

Дата (РРРР-ММ-ДД)

Дата замовлення

EXPDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Очікувана дата поставки

FACTDELIVERYDATE

O

Дата (РРРР-ММ-ДД)

Фактична дата поставки

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

M

Число позитивне

Номер позиції

PRODUCT

M

Число (8, 10, 14)

Штрих-код продукту

DESCRIPTION

O

Рядок (70)

Опис

PRODUCTIDSUPPLIER

O

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

O

Рядок (16)

Артикул в БД покупця

PRICE

O

Число десяткове

Ціна продукту

ORDEREDQUANTITY

M

Число позитивне

Замовлена ​​кількість

ORDERUNIT

О

Рядок (3)

Одиниці виміру

DELIVEREDQUANTITY

O

Число позитивне

Відвантажено

PENALTYQUANTITY

O

Число позитивне

Кількість товару, з якої виставлені штрафи

PENALTYUNIT

О

Рядок (3)

Одиниці виміру

PENALTYSUM

O

Число позитивне

Сума штрафу по позиції

PENALTYDESCRIPTION

O

Рядок (70)

Опис штрафу

DELAYDAYS

O

Число позитивне

Кількість днів запізнення

POSITION

Товарні позиції (закінчення блоку)

LOCATION

Місцезнаходження (закінчення блоку)

HEAD

Закінчення основного блоку

MSCONS

Закінчення документа

Неструктурований документ (CONDRA)

НАЗВА ПОЛЯ

Тип

Формат

Опис

CONDRA

Початок документа

DATE

O

Дата (РРРР-ММ-ДД)

Дата надходження на платформу EDI Network

NUMBER

M

Рядок (16)

Номер документа

CONTRACTNUMBER

О

Номер договору

COMPNUMBER

Рядок (1000)

Складовий номер (вільний текст до 1000 символів)

CONTRACTDATE

Дата договору

HEAD

Початок основного блоку

SENDER

M

Число (13)

GLN відправника повідомлення

RECIPIENT

M

Число (13)

GLN одержувача повідомлення

TYPE

O

Рядок (70)

Тип неструктурованого документа

INFO

O

Рядок (70)

Інформаційне поле

DOCGUID

O

Рядок (70)

Ідентифікатор документа

TRANSGUID

O

Рядок (70)

Ідентифікатор транспортного контейнера

SUM

О

Число десяткове

Сума документа

CONTENT

Вкладення (початок блоку)

FILENAME

O

Рядок (70)

Назва файлу

SIGNNAME

O

Рядок (70)

Назва файлу підпису

CONTENT

Вкладення (закінчення блоку)

HEAD

Закінчення основного блоку

CONDRA

Закінчення документа

Електронна специфікація (PRODUCTLIST)

PRODUCTLIST - узгоджене між контрагентами в паперовому вигляді доповнення до договору поставки (Специфікація). Документ призначений для підтримки покупцем на платформі EDIN актуального асортименту, для зміни і узгодження цін, введення і видалення товарних позицій. Документ необхідний для оптимізації / автоматизації процесу узгодження цін між ТМ і постачальником

Назва поля

Тип

Формат

Опис

PRODUCTLIST

M

Початок документа

NUMBER

M

Рядок (16)

Номер документа

DATE

M

Дата (РРРР-ММ-ДД)

Дата документа

CONTRACTNUMBER

M

Рядок (20)

Номер контракту

CONTRACTDESCRIPTION

O

Рядок (70)

Опис контракту

CONTRACTEXPIRYDATE

M

Дата (РРРР-ММ-ДД)

Дата закінчення дії контракту

CONTRACTGLN

M

Число (13)

GLN контракту

CAMPAIGNNUMBER

M

Рядок (20)

Номер договору

CAMPAIGNDATE

M

Дата (РРРР-ММ-ДД)

Дата договору

REVIEWDEADLINE

О

Число (3)

Термін подачі на розгляд

AGREEMENTNUMBER

О

Число (3)

Допустима кількість погоджень

DISCOUNTWORKSTATUS

M

0,1

Робота з ціною зі знижкою: 0 - ні, 1 - так

PROLONGATIONCONTRACT

O

Число

Автоматична пролонгація контракту. Можна вибрати зі значень 1 або 0. При зазначеному значенні 1 постачальник при формуванні док-та AGREEM на підставі PRODUCTLIST може вказати в тезі DOCENDDATE будь-яку дату. При зазначеному значенні 0 дата в тезі DOCENDDATE не повинна перевищувати дату закінчення дії контракту (тег CONTRACTEXPIRYDATE).

REGIONID

О

Рядок (100)

Код регіону

HEAD

M

Початок основного блоку

BUYER

M

Число (13)

GLN покупця

SUPPLIER

M

Число (13)

GLN продавця

RECIPIENT

M

Число (13)

GLN одержувача

SENDER

M

Число (13)

GLN відправника

POSITION

М

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер товарної позиції

ACTION

O

Число (4,2)

Можливі значення: 4 - видалення товарної позиції, 2 - введення товарної позиції (новинка); при вказаному значенні 2 позиція в товарному довіднику підсвічується червоним і на неї можна створити COMDOC 008.

PRODUCT

M

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDBUYER

M

Рядок (15)

Внутрішній номер в БД

DESCRIPTION

M

Рядок (255)

Опис продукту

UCCFEA

M

Число (4-10)

Код УКТ ЗЕД

DISCOUNTPRICE

O

Число десяткове (10)

Ціна зі знижкою без ПДВ

DISCOUNTPRICEWITHVAT

О

Число десяткове (10)

Ціна зі знижкою з ПДВ

DISCOUNTDATEFROM

O

Дата (РРРР-ММ-ДД)

Початок дії ціни зі знижкою

DISCOUNTDATETO

O

Дата (РРРР-ММ-ДД)

Закінчення дії ціни зі знижкою

PRICE

M

Число десяткове (10)

Ціна без ПДВ

PRICEWITHVAT

O

Число десяткове (10)

Ціна з ПДВ

PRICEDATEFROM

O

Дата (РРРР-ММ-ДД)

Початок дії ціни

PRICEDATETO

O

Дата (РРРР-ММ-ДД)

Закінчення дії ціни

PROMO

O

Число десяткове

Промо ціна без ПДВ

PROMOWITHVAT

O

Число десяткове

Промо ціна з ПДВ

PROMODATEFROM

O

Дата (РРРР-ММ-ДД)

Початок дії промо ціни

PROMODATETO

O

Дата (РРРР-ММ-ДД)

Закінчення дії промо ціни

PROMOQUANTITY

O

Число

кількість товару

VAT

M

Число десяткове (20, 7, 0)

Ставка ПДВ,%

UNIT

M

Рядок (3)

Одиниці виміру

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

PRODUCTLIST

Закінчення документа

Реєстр (REESTR)

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

Название

Тип

Формат

Описание

REESTR

Начало документа

NUMBER

М

Строка (4)

Номер документа (лічильник)

DATE

М

Дата (ГГГГ-ММ-ДД)

Дата документу

PAYMFACTFIN

М

Decimal (#.00)

Плата за факторингове фінансування

HEAD

Начало основного блока

SUPPLIER

М

Cтрока (13)

GLN постачальника

FAKTOR

М

Cтрока (13)

GLN Фактора

DOCUMENTS

Документы (начало блока)

DOCUMENT

Документ (начало блока)

COUNTER

М

INTEGER

Рядок № 1 лічильник нумерації

BUYERNAME

М

Cтрока (50)

Назва покупця

BUYEREDRPO

М

Код платника

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

DOCUMENTDATE

М

Дата (ГГГГ-ММ-ДД)

Дата документа COMDOC

DOCUMENTNUM

М

Cтрока (20)

Номер документа COMDOC

DOCUMENTSUM

М

Decimal (#.00)

Сумма документа

DOCUMENTPREPAYMENT

М

INTEGER

Процентна ставка авансу

PREPAYMENTDATE

DELIVERYDATE

М

Дата (ГГГГ-ММ-ДД)

Дата авансировання

CONTRACTNUM

М

Cтрока (20)

Номер договору поставки

PLANPAYMENTDATE

М

Дата (ГГГГ-ММ-ДД)

Планова дата оплати

PREPAYMENTSUM

М

Decimal (#.00)

Сума авансировання

DOCUMENT

Документ (окончание блока)

DOCUMENTS

Документы (окончание блока)

HEAD

Окончание основного блока

CONTRFACTNUM

М

Cтрока (20)

Номер договору поставки

CONTRFACTDATE

М

Дата (ГГГГ-ММ-ДД)

Дата договору поставки

REESTR

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

Товарне узгодження (AGREEM)

Товарне узгодження (AGREEM) або пропозиція щодо зміни цін формується постачальником на підставі узгодженого товарного довідника і відправляється в торговельну мережу

НАЗВА ПОЛЯ

ТИП

ФОРМАТ

ОПИС

AGREEM

М

Початок документа

NUMBER

М

Рядок (15)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

CONTRACTNUMBER

М

Рядок (20)

Номер контракту

CONTRACTEXPIRYDATE

М

Дата (РРРР-ММ-ДД)

Дата закінчення дії контракту

CAMPAIGNNUMBER

М

Рядок (20)

Номер договору

CAMPAIGNDATE

М

Дата (РРРР-ММ-ДД)

Дата закінчення дії договору

DOCSTARTDATE

М

Дата (РРРР-ММ-ДД)

Дата початку дії нової ціни

DOCENDDATE

М

Дата (РРРР-ММ-ДД)

Дата закінчення дії нової ціни

PRICETYPE

М

підтип документа (дія) * Regular - змінити регулярну ціну * Promo - змінити промо ціну * DelSKU - вивести товар з асортименту * PrestopSKU - тимчасово призупинити поставку

DOCACTION

М

Число (1)

ознака документа (2 - підтвердження)

HEAD

Початок основного блоку

SUPPLIER

M

Число (13)

GLN продавця

BUYER

M

Число (13)

GLN покупця

RECIPIENT

O

Рядок (35)

GLN одержувача

SENDER

M

Число (13)

GLN відправника

ATTACHMENT

Вкладення

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер позиції в документі

PRODUCT

M

Рядок (20)

Штрихкод продукту

PRODUCT_NAME

М

Найменування

PRODUCTIDBUYER

М

Рядок (15)

Артикул покупця

POSITIONIDBUYER

М

id товарної позиції

DESCRIPTION

M

Опис продукту

PRICEWITHOUTVAT

М

Ціна без ПДВ

PRICEWITHVAT

M

Ціна з ПДВ

PRICEWITHOUTVAT_CHNG

О

Нова ціна без ПДВ

PRICEWITHVAT_CHNG

M

Нова ціна з ПДВ

DIFFPRICE

M

% зміни ціни

DISCOUNTPRICEWITHOUTVAT

O

Ціна зі знижкою без ПДВ

DISCOUNTPRICEWITHVAT

O

Ціна зі знижкою з ПДВ

DISCOUNTVAL

O

% знижки

DISCOUNTPRICEWITHOUTVAT_CHNG

O

Нова ціна зі знижкою без ПДВ

DISCOUNTPRICEWITHVAT_CHNG

O

Нова ціна зі знижкою з ПДВ

DIFFDISCOUNTPRICE

O

% зміни ціни зі знижкою

DISCOUNTVAL_CHNG

O

% нової знижки

PROMO

O

Рядок (70)

промоціна

PROMOWITHVAT

O

промоціна з ПДВ

PROMODISCOUNT

O

Дата (РРРР-ММ-ДД)

% промознижки

POSITIONACTION

O

Поставка не пізніше зазначеного часу

VAT

О

Ставка ПДВ,%

UNIT

O

Одиниці виміру

STATUS

M

Прийняти/відхилити

OCERTS

O

Сертифікат/-и (початок блоку)

CERT_NUM

O

Рядок (16)

№ сертифіката

CERT_TYPE

Тип сертифіката

BATCH

Рядок (35)

Серійний номер сертифікату

START_DATE

O

Дата (РРРР-ММ-ДД)

Дата початку сертифіката

END_DATE

O

Дата (РРРР-ММ-ДД)

Дата закінчення сертифіката

URL

посилання

OCERTS

Сертифікат/-и (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

HEAD

Закінчення основного блоку

AGREEM

Закінчення документа

Коригування до податкової накладної (DECLARj12)

DECLARj12 - «Коригування до податкової накладної» / РКНН (Розрахунок коригування кількісних і вартісних показників до податкової накладної). Створюється на основі Податкової накладної (DECLAR)

НАЗВА ПОЛЯ

ТИП

ФОРМАТ

ЗМІСТ

КОМЕНТАР

DECLAR

Початок документа

DECLARHEAD

Основна інформація по документу (початок блоку)

TIN

Код платника

Значенням елемента є код платника згідно з ЄДРПОУ (Реєстраційний (обліковий) номер з Тимчасового реєстру ДПА України) або реєстраційний номер облікової картки платника (номер паспорта, записаний як послідовність двох великих літер української абетки та шести цифр)

C_DOC

Рядок

Код документа

J12 – податкова накладна (юр. особа), F12 – податкова накладна (фіз. особа)

C_DOC_SUB

Рядок

Підтип документа

Відповідає значенню елемента C_DOC_SUB з довідника звітних документів

C_DOC_VER

Рядок

Номер версії

Відповідає значенню елемента C_DOC_VER з довідника звітних документів

C_DOC_TYPE

Число позитивне

№ нового звітного документа

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

C_DOC_CNT

Число позитивне

№ однотипного документа в періоді

Якщо в одному звітному періоді подається кілька однотипних документів, то значення даного елемента містить порядковий номер для кожного документа в даному періоді. Перший (звітний) документ має номер 1. При формуванні електронного документа, що є новим звітним (уточнюючим) до поданого раніше (звітного) (значення елемента C_DOC_TYPE 0), нумерація однотипних документів в періоді (значення елемента C_DOC_CNT) повинна залишатись незмінною щодо нумерації звітного документа, показники якого виправляються

C_REG

Код області ДПІ отримувача

Код області заповнюється згідно з довідником державних податкових інспекцій

C_RAJ

Код адміністративного району ДПІ отримувача

Код адміністративного району заповнюється згідно з довідником державних податкових інспекцій

PERIOD_MONTH

Звітній місяць

Звітним місяцем вважається останній місяць у звітному періоді (для місяців - це порядковий номер місяця, для I, II, III, IV кварталів - це 3, 6, 9, 12 місяць відповідно, для I та II півріч - 6 та 12 відповідно, для 9 місяців - 9, для року - 12)

PERIOD_TYPE

Тип звітного періоду

1-місяць, 2-квартал, 3-півріччя, 4 - дев’ять місяців, 5-рік

PERIOD_YEAR

Звітний рік

Формат рррр

C_STI_ORIG

Код ДПІ, до якої подається оригінал документа

Код ДПІ вибирається з довідника інспекцій, є числовим значенням, яке відповідає формулі: значення елемента C_REG*100 + значення елемента C_RAJ

C_DOC_STAN

Стан документа

Приймає фіксовані значення: • 1 - звітний документ • 2 - новий звітний документ • 3 - уточнюючий документ

LINKED_DOCS

Перелік пов’язаних документів. Даний елемент є вузловим і складається з ряду елементів з іменем DOC, кожний з яких містить інформацію про окремий

Містить відповідний перелік документів: для основного документа – посилання на додатки, які подаються до нього; для додатка – посилання на основний документ; для квитанції – на документ, що квитується. Елемент DOC має обов’язкові атрибути : NUM - Номер пов’язаного документа в переліку TYPE - Тип зв’язку. Даний атрибут приймає фіксовані значення : 1 – посилання на додаток, 2 – посилання на основний документ, 3 – посилання на документ, що квитувався

D_FILL

Дата (ДДММРРРР)

Дата заповнення документа платником

SOFTWARE

Сигнатура програмного забезпечення

Текстовий рядок - ідентифікатор програмного засобу, за допомогою якого сформовано документ

DECLARHEAD

Основна інформація по документу (закінчення блоку)

DECLARBODY

Зміст документа (початок блоку)

R01G1

Число від 1 до 9

Зведена податкова накладна

1 – так, 0 – ні

R03G10S

Рядок

Складена на операції, звільнені від оподаткування

Ставиться помітка «Без ПДВ» у разі складання податкової накладної на операції з постачання товарів/послуг, які звільняються від оподаткування (п. 17 Порядку № 1307)

HORIG1

Позначка «Видається покупцю»

1 – так, 0 – ні

HTYPR

Залишається у продавця (тип причини)

Зазначається тип причини: 01 - Збільшення компенсації вартості поставлених товарів/послуг; 02 - Постачання неплатнику податку; 03 - Постачання товарів/послуг у рахунок оплати праці фізичним особам, які перебувають у трудових відносинах із платником податку; 04 - Постачання у межах балансу для невиробничого використання; 05 - Ліквідація основних засобів за самостійним рішенням платника податку; 06 - Переведення виробничих основних засобів до складу невиробничих; 07 - Вивезення товарів за межі митної території України; 08 - Постачання для операцій, які не є об’єктом оподаткування податком на додану вартість; 09 - Постачання для операцій, які звільнені від оподаткування податком на додану вартість; 10 - Визначення при анулюванні реєстрації платника податку податкових зобов’язань за товарами/послугами, необоротними активами, суми податку по яких були включені до складу податкового кредиту та не були використані в оподатковуваних операціях у межах господарської діяльності; 11 - Складена за щоденними підсумками операцій. 12 - Постачання неплатнику, в якій зазначається назва покупця; 13 - Використання виробничих або невиробничих засобів, інших товарів/послуг не в господарській діяльності; 14 - Складена отримувачем (покупцем) послуг від нерезидента; 15 - Складена на суму перевищення ціни придбання товарів/послуг над фактичною ціною їх постачання; 16 - Складена на суму перевищення балансової (залишкової) вартості необоротних активів над фактичною ціною їх постачання; 17 - Складена на суму перевищення собівартості самостійно виготовлених товарів/послуг над фактичною ціною їх постачання В інших випадках у верхній лівій частині податкової накладної тип причини не зазначається (нулі, прочерки та інші знаки чи символи не проставляються)

HERPN0

Відмітка: Підлягає реєстрації в ЄРПН постачальником (продавцем)

1 – так, 0 – ні

HERPN

Відмітка: Підлягає реєстрації в ЄРПН отримувачем (покупцем)

1 – так, 0 – ні

HFILL

Дата (ДДММРРРР)

Дата виписки податкової накладної

HNUM

Ціле число

Порядковый номер ПН

HNUM1

Ціле число

Код діяльностi

HPODFILL

Дата (ДДММРРРР)

Дата виписки РКПН

HPODNUM

Ціле число

Порядковый номер РКПН

HPODNUM1

Ціле число

Код діяльностi

HPODNUM2

Ціле число

Числовий номер філії

HNAMESEL

Особа (платник податку) - продавець

Найменування; прізвище, ім’я, по батькові - для фізичної особи-підприємця)

HNAMEBUY

Особа (платник податку) - покупець

Найменування; прізвище, ім’я, по батькові - для фізичної особи-підприємця)

HKSEL

Ціле число

Індивідуальний податковий номер продавця

HTINSEL

M

Ціле число (10)

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

Загальний тип «Код ЄДРПОУ (ДРФО підприємця: числа, або № паспорта)». На WEB у блоці «Продавець», заповнюється із GLN номера (код ЄДРПОУ)

HKBUY

Ціле число

Індивідуальний податковий номер покупця

HTINBUY

М

Ціле число (10)

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

Загальний тип «Код ЄДРПОУ (ДРФО підприємця: числа, або № паспорта)». На WEB у блоці «Покупець», заповнюється із GLN номера (код ЄДРПОУ)

HFBUY

Ціле число

Код філії покупця

HNUM2

Ціле число

Числовий номер філії

R001G03

Число з плаваючою точкою

Сума коригування

Сума коригування податкового зобов’язання та податкового кредиту (- / +), у тому числі: R02G9 та R02G111.

R02G9

Число з плаваючою точкою

Сума коригування за основною ставкою

Сума коригування податкового зобов’язання та податкового кредиту за основною ставкою (- / +). Тег R02G9 заповнюється складанням усіх тегів RXXXXG11_10 по позиціях, для яких у тегу RXXXXG008 вказано 20% ставка, після чого значення округляються до 2-х знаків після коми включно

R02G111

Число з плаваючою точкою

Сума коригування за ставкою 7 %

Сума коригування податкового зобов’язання та податкового кредиту за ставкою 7 % (- / +). Тег R02G111 заповнюється складанням усіх тегів RXXXXG11_10 по позиціях, для яких у тегу RXXXXG008 вказано 7% ставка, після чого значення округляються до 2-х знаків після коми включно

R01G9

Число з плаваючою точкою

Усього підлягають коригуванню обсяги постачання без урахування податку на додану вартість, що оподатковуються за основною ставкою (-) (+) (код ставки 20)

Підсумкова сума повинна сходитись з сумою документа-підстави (інакше помилки): - при формуванні DECLARJ12 на основі COMDOC012 різниця між R01G9 і ВсьогоПоДокументу/СумаБезПДВ повинна складати 0 грн - при формуванні DECLARJ12 на основі DOCCORINVOICE різниця між R01G9 і CorrectionTaxableAmount не повинна перевищувати 0.02 грн

R01G111

Число з плаваючою точкою

Усього підлягають коригуванню обсяги постачання без урахування податку на додану вартість, що оподатковуються за ставкою 7 % (-) (+) (код ставки 7)

Підсумкова сума повинна сходитись з сумою документа-підстави (інакше помилки): - при формуванні DECLARJ12 на основі COMDOC012 різниця між R01G111 і ВсьогоПоДокументу/СумаБезПДВ повинна складати 0 грн - при формуванні DECLARJ12 на основі DOCCORINVOICE різниця між R01G111 і CorrectionTaxableAmount не повинна перевищувати 0.02 грн

R006G03

Число з плаваючою точкою

Усього підлягають коригуванню обсяги постачання без урахування податку на додану вартість, що оподатковуються за ставкою 0 % (-) (+) (код ставки 901)

Підсумкова сума повинна сходитись з сумою документа-підстави (інакше помилки): - при формуванні DECLARJ12 на основі COMDOC012 різниця між R006G03 і ВсьогоПоДокументу/СумаБезПДВ повинна складати 0 грн - при формуванні DECLARJ12 на основі DOCCORINVOICE різниця між R006G03 і CorrectionTaxableAmount не повинна перевищувати 0.02 грн

R007G03

Число з плаваючою точкою

Усього підлягають коригуванню обсяги постачання без урахування податку на додану вартість, що оподатковуються за ставкою 0% (-) (+) (код ставки 902)

Підсумкова сума повинна сходитись з сумою документа-підстави (інакше помилки): - при формуванні DECLARJ12 на основі COMDOC012 різниця між R007G03 і ВсьогоПоДокументу/СумаБезПДВ повинна складати 0 грн - при формуванні DECLARJ12 на основі DOCCORINVOICE різниця між R007G03 і CorrectionTaxableAmount не повинна перевищувати 0.02 грн

R01G11

Число з плаваючою точкою

Усього підлягають коригуванню обсяги операцій, звільнених від оподаткування (-) (+) (код ставки 903)

Підсумкова сума повинна сходитись з сумою документа-підстави (інакше помилки): - при формуванні DECLARJ12 на основі COMDOC012 різниця між R01G11 і ВсьогоПоДокументу/СумаБезПДВ повинна складати 0 грн - при формуванні DECLARJ12 на основі DOCCORINVOICE різниця між R01G11 і CorrectionTaxableAmount не повинна перевищувати 0.02 грн

RXXXXG001

Номер рядка податкової накладної, що коригується або додається

RXXXXG21

М

Число від 1 до … 9999

Код причини

Причина коригування: 101 - Зміна ціни 102 - Зміна кількості 103 - Повернення товару або авансових платежів 104 - Зміна номенклатури 201 - Коригування зведеної податкової накладної, складеної відповідно до пункту 198.5 статті 198 ПКУ 202 - Коригування зведеної податкової накладної, складеної відповідно до пункту 199.1 статті 199 ПКУ 203 - Коригування зведеної податкової накладної, складеної відповідно до абзацу 11 пункту 201.4 статті 201 ПКУ 301 - Виправлення помилки (пункт 24 Порядку заповнення податкової накладної) 302 - Усунення неоднозначностей 303 - Зменшення обсягу при нульовій кількості 304 - Зменшення кількості при нульовому обсягу

RXXXXG22

М

Число від 1 до … 9999

Номер групи коригування

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

RXXXXG3S

Найменування товару/послуги

Номенклатура товарів/послуг продавця

RXXXXG4

Код товару згідно з УКТ ЗЕД товару

RXXXXG4S

Одиниця виміру товару

RXXXXG105_2S

Текст

RXXXXG5

Число з плаваючою точкою

Кількість товарів

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

RXXXXG6

Число з плаваючою точкою

Ціна позиції без урахування ПДВ

Ціна постачання одиниці товару / послуги без урахування ПДВ

RXXXXG7

Число з плаваючою точкою

Зміна ціни (-) (+)

Зміна ціни (-) (+) при коригуванні вартості

RXXXXG8

Число з плаваючою точкою

Кількість постачання товарів/послуг

Кількість постачання товарів/послуг при коригуванні вартості

RXXXXG008

Ціле число

Ставка ПДВ

RXXXXG009

Ціле число

Код пільги R003G10S

RXXXXG010

Число з плаваючою точкою

Графа 10 = Графа 6 * Графа 7

Сума без ПДВ

RXXXXG11_10

Число, 6 знаків після коми

Сума податку на додану вартість

R0301G1D

Дата (ДДММРРРР)

Дата складання податкової накладної

R0301G2

Число від 1 до … 9999999

Порядковий номер податкової накладної

R0301G3

Число

Порядковий номер податкової накладної

Ознака спеціальної податкової накладної. Допустимі значення: 2, 3, 4, 5, 7

R0301G4

Число від 1 до … 9999

Порядковий номер податкової накладної

R0301G5

Реєстраційний номер податкової накладної

R0302G1D

Дата (ДДММРРРР)

Дата складання розрахунку коригування до податкової накладної

R0302G2

Число від 1 до … 9999999

Порядковий номер розрахунку коригування

R0302G3

Число

Порядковий номер розрахунку коригування

R0302G4

Число від 1 до … 9999

Порядковий номер розрахунку коригування

R0302G5

Реєстраційний номер розрахунку коригування

HBOS

Рядок

Прізвище особи, яка склала податкову накладну

HKBOS

Ціле число

Реєстраційний номер облікової картки платника податків

R003G10S

Рядок

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

DECLARBODY

Зміст документа (закінчення блоку)

DECLAR

Закінчення документа

Товарна накладна (DOCUMENTINVOICE)

DOCUMENTINVOICE - Товарна накладна.Документ може бути створений на підставі RECADV

НАЗВА ПОЛЯ

ТИП

ФОРМАТ

ОПИС

Document-Invoice

Початок документа

Invoice-Header

М

Початок основного блоку

InvoiceNumber

М

Рядок (16)

номер ТН (номер RECADV)

InvoiceDate

М

Дата (РРРР-ММ-ДД)

дата ТН

InvoiceCurrency

М

Рядок (3)

валюта

InvoicePostDate

O

Дата (РРРР-ММ-ДД)

дата відправки ТН

InvoicePostTime

O

Час (год: хв)

час відправки ТН

DocumentFunctionCode

М

TN/CTN

Код типу документа: TN - товарна накладна CTN - коригувальна товарна накладна

ContractNumber

О

Рядок (16)

номер договору на поставку

ContractDate

М

Дата (РРРР-ММ-ДД)

дата контракту

Invoice-Header

Закінчення основного блоку

Invoice-Reference

Підстава (початок блоку)

Order

Замовлення (початок блоку)

BuyerOrderNumber

О

Рядок (50)

Номер замовлення

BuyerOrderDate

О

Дата (РРРР-ММ-ДД)

Дата замовлення

Order

Замовлення (закінчення блоку)

TaxInvoice

М

Податкова накладна (початок блоку)

TaxInvoiceNumber

М

Рядок (35)

номер податкової накладної

TaxInvoiceDate

М

Дата (РРРР-ММ-ДД)

дата податкової накладної (повинна збігатися з датою товарною накладною)

TaxInvoice

Податкова накладна (закінчення блоку)

DespatchAdvice

М

Повідомлення про відвантаження (початок блоку)

DespatchAdviceNumber

М

Рядок (16)

Номер повідомлення про відвантаження

DespatchAdvice

Повідомлення про відвантаження (закінчення блоку)

ReceivingAdvice

Повідомлення про прийом (початок блоку)

ReceivingAdviceNumber

М

Рядок (16)

Номер повідомлення про прийом (RECADV). У разі коригування повернення, має бути вказаний номер акта на повернення

DeliveryDate

O

Дата (РРРР-ММ-ДД)

Дата приймання. В разі коригування повернення, має бути вказана дата акту на повернення

ReceivingAdvice

Повідомлення про прийом (закінчення блоку)

Invoice-Reference

Підстава (закінчення блоку)

Invoice-Parties

Блок контрагентів (початок)

Buyer

Блок покупця (початок)

ILN

М

Число (13)

GLN покупця

TaxID

М

Рядок (35)

Податковий ідентифікаційний номер покупця

UtilizationRegisterNumber

М

Рядок (35)

ЄДРПОУ покупця

Name

М

Рядок (175)

назва покупця

StreetAndNumber

М

Рядок (35)

вулиця і номер будинку покупця

CityName

М

Рядок (35)

місто покупця

PostalCode

М

Рядок (9)

поштовий код покупця

Country

O

Рядок (3)

код країни покупця (код ISO 3166)

PhoneNumber

М

Рядок (35)

телефон покупця

Buyer

Блок покупця (закінчення)

Seller

Блок продавця (початок)

ILN

М

Число (13)

GLN продавця

TaxID

М

Рядок (35)

Податковий ідентифікаційний номер продавця

CodeByBuyer

М

Рядок (35)

номер договору на поставку

UtilizationRegisterNumber

М

Рядок (35)

ЄДРПОУ продавця

Name

М

Рядок (175)

назва продавця

StreetAndNumber

М

Рядок (35)

вулиця і номер будинку продавця

CityName

М

Рядок (35)

місто продавця

PostalCode

М

Рядок (9)

поштовий код продавця

Country

O

Рядок (3)

код країни продавця (код ISO 3166)

PhoneNumber

М

Рядок (35)

телефон продавця

Seller

Блок продавця (закінчення)

DeliveryPoint

M

Точка доставки (початок)

ILN

М

Число (13)

GLN точки доставки (МЕТРО)

DeliveryPlace

М

Рядок (35)

код точки доставки (не повинен перевищувати два знаки)

DeliveryPoint

Точка доставки (закінчення)

Invoicee

Рахунок (початок блоку)

ILN

M

Число (13)

GLN для виставлення рахунку

Invoicee

Рахунок (закінчення блоку)

Payer

Платник (початок блоку)

ILN

M

Число (13)

GLN платника

Payer

Платник (закінчення блоку)

Invoice-Parties

Блок контрагентів (закінчення)

Invoice-Lines

Рядки ТН (початок блоку)

Line

Рядок (початок блоку)

Line-Item

Позиція (початок блоку)

LineNumber

М

Ціле число

номер позиції в табличній частині

ExternalItemCode

M

Рядок (18)

код товару згідно з довідника УКТ ЗЕД

EAN

М

Число (14)

Штрих-код продукту

BuyerItemCode

О

Рядок (16)

Артикул в БД покупця

ItemDescription

М

Рядок (210)

Опис товару

InvoiceQuantity

M

Число позитивне

Замовлена ​​кількість (кількість товару за накладною)

UnitOfMeasure

О

Рядок (3)

Одиниці виміру

InvoiceUnitNetPrice

M

Число позитивне

Ціна однієї одиниці без ПДВ

TaxRate

M

Число позитивне

Ставка ПДВ (20%, 7%, 0%)

TaxCategoryCode

M

E / S

Код категорії податку: E - звільнений від сплати податку S - стандартний податок

TaxAmount

M

Число позитивне

Сума ПДВ по артикулу = сума сум без ПДВ по артикулах * ставку (округляється до 2 знаків)

NetAmount

M

Число позитивне

Всього без ПДВ (обчислюється)

Line-Item

Позиція (закінчення блоку)

Line

Рядок (закінчення блоку)

Invoice-Lines

Рядки ТН (закінчення блоку)

Invoice-Summary

Підсумки (початок блоку)

TotalLines

M

Ціле число

Кількість рядків в документі

TotalNetAmount

M

Число позитивне

Загальна сума без ПДВ

TotalTaxAmount

M

Число позитивне

Сума ПДВ

TotalGrossAmount

M

Число позитивне

Загальна сума з ПДВ

Tax-Summary

Податки (початок блоку)

Tax-Summary-Line

Рядок податків (початок блоку)

TaxRate

M

Число позитивне

Розмір податку

TaxCategoryCode

M

E / S

Код категорії податку: E - звільнений від сплати податку S - стандартний податок

TaxAmount

M

Число позитивне

Сума податку для кожної категорії податку

TaxableAmount

M

Число позитивне

Оподаткована сума за обраною категорією податку

Tax-Summary-Line

Рядок податків (закінчення блоку)

Tax-Summary

Податки (закінчення блоку)

Invoice-Summary

Підсумки (закінчення блоку)

Document-Invoice

Закінчення документа

Коригування до товарної накладної (DOCCORINVOICE)

НАЗВА ПОЛЯ

ТИП

ФОРМАТ

ОПИС

Document-Invoice

Початок документа

Invoice-Header

М

Початок основного блоку

InvoiceNumber

М

Рядок (16)

номер ТН (номер RECADV)

InvoiceDate

М

Дата (РРРР-ММ-ДД)

дата ТН

InvoiceCurrency

М

Рядок (3)

валюта

InvoicePostDate

O

Дата (РРРР-ММ-ДД)

дата відправки ТН

InvoicePostTime

O

Час (год: хв)

час відправки ТН

DocumentFunctionCode

М

TN/CTN

Код типу документа: TN - товарна накладна CTN - коригувальна товарна накладна

ContractNumber

О

Рядок (16)

номер договору на поставку

ContractDate

М

Дата (РРРР-ММ-ДД)

дата контракту

CorrectionReason

М

NAC / PAC, NRC / PRC

причина коригування: NAC - коригування приймання на - PAC - коригування приймання на + NRC - коригування повернення на - PRC - коригування повернення на +

Invoice-Header

Закінчення основного блоку

Invoice-Reference

Підстава (початок блоку)

Order

Замовлення (початок блоку)

BuyerOrderNumber

О

Рядок (50)

Номер замовлення

BuyerOrderDate

О

Дата (РРРР-ММ-ДД)

Дата замовлення

Order

Замовлення (закінчення блоку)

TaxInvoice

М

Податкова накладна (початок блоку)

TaxInvoiceNumber

М

Рядок (35)

номер податкової накладної

TaxInvoiceDate

М

Дата (РРРР-ММ-ДД)

дата податкової накладної (повинна збігатися з датою товарної накладної)

CorrectionTaxInvoiceNumber

М

Рядок (35)

Номер коригування до податкової накладної (РКНН)

CorrectionTaxInvoiceDate

М

Дата (РРРР-ММ-ДД)

Дата коригування до податкової накладної (РКНН)

TaxInvoice

Податкова накладна (закінчення блоку)

DespatchAdvice

М

Повідомлення про відвантаження (початок блоку)

DespatchAdviceNumber

М

Рядок (16)

Номер повідомлення про відвантаження

DespatchAdvice

Повідомлення про відвантаження (закінчення блоку)

ReceivingAdvice

Повідомлення про прийом (початок блоку)

ReceivingAdviceNumber

М

Рядок (16)

номер повідомлення про прийом (RECADV). У разі коригування повернення, має бути вказаний номер акта на повернення

DeliveryDate

O

Дата (РРРР-ММ-ДД)

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

ReceivingAdvice

Повідомлення про прийом (закінчення блоку)

DeliveryNote

Повідомлення про доставку (початок блоку)

DeliveryNoteNumber

DeliveryNoteDate

DeliveryNote

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

Invoice-Reference

Підстава (закінчення блоку)

Invoice-Parties

Блок контрагентів (початок)

Buyer

Блок покупця (початок)

ILN

М

Число (13)

GLN покупця

TaxID

М

Рядок (35)

Податковий ідентифікаційний номер покупця

VatPayerCertificate

O

Рядок (35)

Номер платника ПДВ

UtilizationRegisterNumber

М

Рядок (35)

ЄДРПОУ покупця

Name

М

Рядок (175)

назва покупця

StreetAndNumber

М

Рядок (35)

вулиця і номер будинку покупця

CityName

М

Рядок (35)

місто покупця

PostalCode

М

Рядок (9)

поштовий код покупця

Country

O

Рядок (3)

код країни покупця (код ISO 3166)

PhoneNumber

М

Рядок (35)

телефон покупця

Buyer

Блок покупця (закінчення)

Seller

Блок продавця (початок)

ILN

М

Число (13)

GLN продавця

TaxID

М

Рядок (35)

Податковий ідентифікаційний номер продавця

CodeByBuyer

М

Рядок (35)

номер договору на поставку

UtilizationRegisterNumber

М

Рядок (35)

ЄДРПОУ продавця

Name

М

Рядок (175)

назва продавця

StreetAndNumber

М

Рядок (35)

вулиця і номер будинку продавця

CityName

М

Рядок (35)

місто продавця

PostalCode

М

Рядок (9)

поштовий код продавця

Country

O

Рядок (3)

код країни продавця (код ISO 3166)

PhoneNumber

М

Рядок (35)

телефон продавця

Seller

Блок продавця (закінчення)

DeliveryPoint

M

Точка доставки (початок блоку)

ILN

М

Число (13)

GLN точки доставки (МЕТРО)

DeliveryPlace

М

Рядок (35)

код точки доставки (не повинен перевищувати два знаки)

DeliveryPoint

Точка доставки (закінчення блоку)

Invoicee

Рахунок (початок блоку)

ILN

M

Число (13)

GLN для виставлення рахунку

Invoicee

Рахунок (закінчення блоку)

Payer

Платник (початок блоку)

ILN

M

Число (13)

GLN платника

Payer

Платник (закінчення блоку)

Invoice-Parties

Блок контрагентів (закінчення)

Invoice-Lines

Рядки ТН (початок блоку)

Line

Рядок (початок блоку)

Line-Item

Позиція (початок блоку)

LineNumber

М

Ціле число

номер позиції в табличній частині

ExternalItemCode

О

Рядок (18)

код товару згідно з довідника УКТ ЗЕД

EAN

М

Число (14)

Штрих-код продукту

BuyerItemCode

О

Строка (16)

Артикул в БД покупця

ItemDescription

М

Рядок (210)

Опис товару

InvoiceQuantity

M

Число позитивне

Замовлена кількість (кількість товару за накладною)

UnitOfMeasure

О

Рядок (3)

Одиниці виміру

InvoiceUnitNetPrice

M

Число позитивне

Ціна однієї одиниці без ПДВ

TaxRate

M

Число позитивне

Ставка ПДВ (20%, 7%, 0%)

TaxCategoryCode

M

E/S

Код категорії податку: E - звільнений від сплати податку S - стандартний податок

TaxAmount

M

Число позитивне

Сума ПДВ по артикулу = сума сум без ПДВ по артикулах * ставку (округляється до 2 знаків)

NetAmount

M

Число позитивне

Всього без ПДВ (обчислюється)

CorrectionInvoiceQuantity

M / -

Число позитивне

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

CorrectionInvoiceUnitNetPrice

M / -

Число десяткове

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

CorrectionNetAmount

M

Число десяткове

Сума без ПДВ з урахуванням коригування

Line-Item

Позиція (закінчення блоку)

Line

Рядок (закінчення блоку)

Invoice-Lines

Рядки ТН (закінчення блоку)

Invoice-Summary

Підсумки (початок блоку)

TotalLines

M

Ціле число

Кількість рядків в документі

TotalNetAmount

M

Число позитивне

Загальна сума без ПДВ

TotalTaxAmount

M

Число позитивне

Сума ПДВ

TotalGrossAmount

M

Число позитивне

Загальна сума з ПДВ

Tax-Summary

Податки (початок блоку)

Tax-Summary-Line

Рядок податків (початок блоку)

TaxRate

M

Число позитивне

Розмір податку

TaxCategoryCode

M

E/S

Код категорії податку: E - звільнений від сплати податку S - стандартний податок

TaxAmount

M

Число позитивне

Сума податку для кожної категорії податку

TaxableAmount

M

Число позитивне

Оподаткована сума за обраною категорією податку

CorrectionTaxAmount

M

Число позитивне

Коригувальна сума податку для кожної категорії податку

CorrectionTaxableAmount

M

Число позитивне

Коригувальна оподаткована сума за обраною категорією податку

CorrectionGrossAmount

M

Число позитивне

Коригувальна сума з ПДВ

Tax-Summary-Line

Рядок податків (закінчення блоку)

Tax-Summary

Податки (закінчення блоку)

Invoice-Summary

Підсумки (закінчення блоку)

Document-Invoice

Закінчення документа

Додаток до повідомлення про відвантаження (QUOTES)

Документ QUOTES відправляється на підставі відправленого документа DESADV (Повідомлення про відвантаження). Багато полей на WEB автоматично заповнюються з DESADV

Назва поля

Тип

Формат

Опис

QUOTES

Початок документа

NUMBER

М

Рядок (16)

Номер документа

DATE

М

Дата (РРРР-ММ-ДД)

Дата документа

DELIVERYDATE

М

Дата (РРРР-ММ-ДД)

Очікувана дата доставки

DELIVERYTIME

О

Час (год: хв)

Очікуваний час доставки

ORDERNUMBER

М

Рядок (50)

Номер замовлення на поставку

ORDERDATE

М

Дата (РРРР-ММ-ДД)

Дата замовлення на поставку

DESADVNUMBER

М

Рядок (16)

Номер повідомлення про відвантаження

DESADVDATE

М

Дата (РРРР-ММ-ДД)

Дата повідомлення про відвантаження

DELIVERYNOTENUMBER

М

Рядок (16)

Номер накладної

DELIVERYNOTEDATE

М

Дата (РРРР-ММ-ДД)

Дата накладної

CAMPAIGNNUMBER

О

Рядок (70)

Номер договору на поставку (контракту)

HEAD

Початок основного блоку

SUPPLIER

М

Число (13)

GLN постачальника

BUYER

М

Число (13)

GLN покупця

DELIVERYPLACE

М

Число (13)

GLN місця доставки

SENDER

М

Число (13)

GLN відправника повідомлення

RECIPIENT

М

Число (13)

GLN одержувача повідомлення

PACKINGSEQUENCE

Робота з товарними позиціями (початок блоку)

HIERARCHICALID

М

Число позитивне

Номер ієрархії упаковки

POSITION

Товарні позиції (початок блоку)

POSITIONNUMBER

М

Число позитивне

Номер товарної позиції

PRODUCT

М

Число (8, 10, 14)

Штрих-код продукту

PRODUCTIDSUPPLIER

О

Рядок (16)

Артикул в БД постачальника

PRODUCTIDBUYER

О

Рядок (16)

Артикул в БД покупця

DELIVEREDQUANTITY

М

Число позитивне

Кількість, що поставляється

DELIVEREDUNIT

О

Рядок (3)

Одиниці виміру

ORDEREDQUANTITY

О

Число позитивне

Замовлена ​​кількість

ORDERUNIT

О

Рядок (3)

Одиниці виміру

CUSTOMSTARIFFNUMBER

О

Рядок (30)

Номер державної митної декларації (ВМД)

PRICE

О

Число десяткове

Ціна продукту без ПДВ

PRICEWITHVAT

О

Число десяткове

Ціна продукту з ПДВ

DESCRIPTION

О

Рядок (70)

Опис продукту

BATCHNUMBERS

Список серійних номерів (початок блоку)

BATCHNUMBER

М

Рядок (150)

Серійний номер позиції (обмеження в 150 символів)

BATCHNUMBERS

Список серійних номерів (закінчення блоку)

POSITION

Товарні позиції (закінчення блоку)

PACKINGSEQUENCE

Робота з товарними позиціями (закінчення блоку)

HEAD

Закінчення основного блоку

QUOTES

Закінчення документа

Статус (STATUS)

Статус (STATUS) служить для оповіщення користувача, наприклад: щодо того, що документ, який він відправив, був доставлений на платформу EDI-N і прочитаний адресатом.

Назва поля

Тип

Формат

Опис

STATUS

Початок документа

EXITEICID

М

Рядок (14)

Номер транзакції EDI Network

CUSTOMERICID

М

Рядок (14)

Номер документа постачальника

VERSION

O

Число десяткове

Версія замовлення транспорту

FROM

М

Число (13)

GLN одержувача повідомлення (SENDER повідомлення, по котрому йде статус)

TO

M

Число (13)

GLN відправника повідомлення (RECIPIENT повідомлення, по котрому йде статус)

DELIVERYPLACE

M

Число (13)

GLN точки доставки (DELIVERYPLACE повідомлення, по котрому йде статус)

DATE

O

Дата (РРРР-ММ-ДД)

Дата надходження на платформу EDI Network

STATUS

М

Число (1)

Статус повідомлення: 0 - доставлено на платформу EDI Network; 1 - повідомлення прочитано одержувачем; 2 - помилка обробки документа; Для зворотних статусів (від РМ): 3 - документ отриманий мережею; 4 - помилка обробки документа на стороні мережі; 6 - відправляється ТМ АТБ на свій IFTMBF інтегровано (для IFTMBС)

DOCNUMBER

O

Рядок (16)

Номер документа

DESCRIPTION

O

Рядок (70)

Опис

DATEIN

М

Дата (РРРР-ММ-ДД)

Дата надходження на платформу EDI Network

TIMEIN

М

Час (чч: мм: сс)

Час надходження на платформу EDI Network

DATEOUT

О

Дата (РРРР-ММ-ДД)

Дата прочитання документа одержувачем

TIMEOUT

О

Час (чч: мм: сс)

Час прочитання документа одержувачем

SIZEINBYTES

М

Число позитивне

Розмір документа в байтах

MESSAGECLASS

М

Рядок (6)

Клас повідомлення: ORDER, ORDRSP, DESADV, RECADV, INVOICE, IFTMBF, DECLAR, DECLARJ12

STATUSONFILENAME

М

ім’я файлу, на який отримано статус

STATUS

Закінчення документа

Звіт про відвантаження (CONTRL)

Звіт про відвантаження (CONTRL) являється завершаючим документом в логіці документообігу з ТМ Фоззі - відправляється Поставщиком у відповідь на RECADV (Повідомлення про прийом)

Назва поля

Тип

Формат

Опис

CONTRL

Початок документа

NUMBER

M

Рядок (16)

Номер документа RECADV (Повідомлення про прийом)

DATE

M

Дата (РРРР-ММ-ДД ГГ:ММ:СС)

Поточна дата

RECADVDATE

M

Дата (РРРР-ММ-ДД)

Дата документа RECADV (Повідомлення про прийом)

ORDERNUMBER

M

Рядок (16)

Номер документа ORDER (Замовлення)

ORDERDATE

M

Дата (РРРР-ММ-ДД)

Дата документа ORDER (Замовлення)

RECIPIENT

M

Число (13)

GLN одержувача

SUPPLIER

M

Число (13)

GLN постачальника

BUYER

M

Число (13)

GLN покупця

ACTION

M

Число (1)

Допустиме значення «1»

CONTRL

Закінчення документа

Платформа EDIN 2.0

Робота з Платформою EDIN 2.0

Вхід на платформу

Для входу на платформу необхідно перейти за посиланням https://edo-v2.edi-n.com/auth

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

_images/101.png

Після успішної авторизації відкриється основне меню для вибору сервісу платформи EDIN, що об’єднані в категорії Документообіг («EDI», «ETTN», «АТС»), Дистрибуція («Виробник», «Дистриб’ютор»), Master Data («Сертифікати», «Е-Специфікація», «Товари»), Додатково («DOCflow», «Tender», «Wiki»).

_images/rabota_s_platformoj_01.png

При подальшому переході в сервіс (кнопка «Відкрити» під іконкою), наприклад EDI:

_images/102.png

Підказка

Для повернення до меню сервісів, товарного довідника потрібно натиснути кнопку пресуха

Загальний вигляд платформи

Платформа складається з трьох основних частин: функціонал переходу по каталогам папок (1), функціонал перегляду (2) і пошуку документів (3):

_images/103.png

Вибір номера GLN організації

Якщо користувачеві доступні номери GLN декількох організацій: для відкриття інформації потрібної Вам компанії необхідно вибрати відповідний номер GLN зі списку - «Компанія»:

_images/106.png

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

Перегляд каталогів платформи

При первинному вході на платформу буде виконаний вхід в каталог документів - «Вхідні».

_images/107.png

Для переходу в потрібний Вам каталог необхідно його вибрати:

  1. Каталог «Вхідні». В даному каталозі будуть розміщені всі вхідні документи для організації від контрагентів.

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

  3. Каталог «Важливі». В даному каталозі будуть розміщені всі зазначені документи як важливі.

  4. Каталог «Чернетки». В даному каталозі будуть розміщені всі документи які були створені, але не відправлені.

  5. Каталог «Архів». В даному каталозі будуть розміщені всі оброблені і архівні документи, які перенесені в архів.

  6. Каталог «Пошук». В даному полі можна задати критерії пошуку документів. Результат пошуку буде відображатися в збереженому каталозі, який буде розміщений в полі - «Історія пошуку».

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

Для створення документа на платформі необхідно натиснути кнопку - «Створити»

_images/108.png

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

_images/10.png

Перегляд документів на платформі

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

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

_images/109.png

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

_images/110.png

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

_images/111.png

  1. Таблиця. На платформі у вигляді таблиці буде відображатися наступна інформація по документу: Компанія, Тип, Номер документу, Інформація, Дата документу.

_images/112.png

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

_images/113.png

Також додані фільтри по Роздрібним мережам, і статусу прочитання документа: всі, прочитані або не прочитані.

_images/114.png _images/115.png

Також можливо вибрати кількість документів, що будуть відображатись в журналі на сторінці (20, 40, 60, 100).

Дії з документом

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

_images/117.png

  1. Тип документа.

  2. Вказується інформація в якому каталозі відкрито цей документ.

  3. Вибираються типи документів, які можна створити на підставі відкритого. Для формування потрібного документа досить натиснути на тип документа, що формується.

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

  5. Дані Відправника / Отримувача.

  6. Основна інформація по документу.

  7. Таблична частина документа з товарами.

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

  9. Можливість приховати панель з даними про документ, ланцюжок документів та кнопку «Архівувати» (п. 10-12)

  10. Сірим виділені типи документів в ланцюжку. При натисканні на документ виконується його відкриття.

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

  12. Інформація про час отримання документа на платформі і часу прочитання.

  13. При натисканні на кнопку «Друк» документ можна роздрукувати.

Пошук документів

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

_images/29.png

Потім потрібно ввести назву та вибрати параметри. За потребою можна користуватись випадаючим списком. Після цього натисніть - «Пошук» (1). Усі елементи пошуку повині бути розділені комами, також є елементи із конкретним значенням та без: «Номер: 123, #Відправлені,» (2).

_images/030.png

Натиснувши на дискету та ввівши назву можна зберегти данні рядку пошуку (1). Переглянути збережений пошук можна в блоці «Збережений пошук» (2). Збережений пошук відноситься тільки до певного статусу документа: «Вхідні», «Вихідні». У блоці «Збережений пошук» за замовчуванням доступні фільтри по документам за сьогодні та вчора (3). Вилучити збережений пошук можна за допомогою хрестика (4).

_images/031.png

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

_images/032.png

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

  1. Номер — пошук документа за номером.

    1. «Номер: 123» - знайти документ за конкретним номером

    2. «Номер: 123+» - знайти документ, номер якого починається на 123

    3. «Номер: 123 + 22» - знайти документ, номер якого починається на 123 та закінчується на 22, де між 123 і 22 може бути будь-який набір символів

    4. «-Номер: 123» - знайти всі документи, крім документа з номером 123

    5. «-Номер: 123+» - знайти всі документи, крім документа, номер якого починається на 123

    6. «Номер: (123 & 234)» - знайти документи з номерами 123 і 234

_images/033.png

  1. Дата — пошук документа за датою.

Підказка

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

  1. «Дата документа: 2019.09.01» - знайти всі документи за конкретною датою

  2. «Дата документа: 2019.09.01-2019.09.04» - знайти всі документи за період

  3. «Дата документа: 2019.09.01-» - знайти всі документи, починаючи з конкретної дати і закінчуючи сьогоднішнім днем

  4. «Дата документа: -2019.09.01» - знайти всі документи до зазначеної дати

_images/034.png

  1. GLN — пошук документа за GLN.

    1. «Вантажовідправник: 9864067481452» — знайти всі документи контрагента за допомогою пошукових елементів «Відправник», «Вантажовідправник», «Постачальник», «Одержувач», «Вантажоодержувач», «Замовник», «Покупець», «Виконавець», «Місце доставки» та GLN

    2. «-Місце доставки: 9864067481452,» - знайти всі документи контрагента, крім тих, що містять зазначений GLN

_images/035.png

  1. Мережа — пошук документа за назвою мережі.

«Мережа: АТБ,»

У рядку пошуку є можливість додавати додаткові критерії пошуку. Для цього в рядку вводимо символ «#». Після цього система видасть можливі критерії пошуку:

  1. #{Назва типу документа} - пошук за типом документа Приклад: «#Замовлення,».

  2. #{Назва статусу документа} - пошук за статусом документа Приклад: «#Відправлені,».

  3. #{Назва періоду документа} - пошук за періодом створення документа Приклад: #Сьогодні - пошук всіх документів, в яких дата створення - поточна дата, #За місяць - пошук всіх документів за поточний місяць

_images/17.png

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

  1. У журналі документів є можливість відзначити документи як «Важливі». Подивитися коментарі в документі, а також поставити мітки.

_images/20.png

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

Для додавання товару в довідник необхідно натиснути кнопку - Додати товар.

_images/25.png

Потім потрібно заповнити обов’язкові поля в документі:

  • Найменування.

  • Штрих-код.

  • Ціна без ПДВ.

  • Одиниця виміру товару.

  • Ставка ПДВ.

  • Після заповнення натиснути кнопку - «Додати товар».

_images/26.png

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

_images/27.png

Щоб знайти потрібний товар у рядку пошуку потрібно ввести назву або штрих-код, або артикул товару.

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

Після внесення змін потрібно зберегти зміни.

_images/28.png

Щоб знайти потрібний товар певної мережі необхідно обрати необхідну мережу:

_images/36.png

Результат:

_images/37.png

Масове завантаження

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

Підказка

Необхідний формат для завантаження товарного довідника — .xls

Підказка

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

_images/38.png

Результат після завантаження:

_images/40.png

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

_images/41.png _images/42.png

Далі необхідно вибрати певну мережу для додавання та натиснути кнопку «Створити»:

_images/43.png _images/44.png

Товари успішно додано у мережу:

_images/45.png

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

_images/39.png

Інструкція по роботі з комерційними документами (додаванню ключів, підписанням)

1 Налаштування підпису

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

_images/dodavannyu_klyuchiv01.png

  1. Зчитати ключі у вкладці «Ключі» :

_images/dodavannyu_klyuchiv01.png

Підказка

Після ініціалізації бібліотеки підписання, система надасть можливість додати ключ для підписання

_images/dodavannyu_klyuchiv02.png

  1. Додати ключ для підписання

_images/dodavannyu_klyuchiv03.png

  1. Ввести пароль та натиснути — «Встановити ключ»

_images/dodavannyu_klyuchiv04.png

  1. Закрити вкладку «Доступні ключі»

_images/dodavannyu_klyuchiv05.png

Підказка

Аналогічно можна додати печатку (за необхідністю)

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

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

  • Для створення комерційного документу «з нуля» потрібно натиснути кнопку «Створити» та вибрати зі списку комерційний документ, наприклад «Видаткову накладну»

_images/dodavannyu_klyuchiv024.png

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

_images/dodavannyu_klyuchiv025.png

Розглянемо приклад на основі «Видаткової накладної»

  1. Для відправки комерційного документа необхідно створити комерційний документ: відкрийте необхідний документ та в доступному списку документів для створення натисніть “Видаткова накладна”:

_images/dodavannyu_klyuchiv6.png

  1. Заповнити всі обовʼязкові поля комерційного документа, які позначені червоною зірочкою *, наприклад «Номер документа» є обов’язковим полем:

_images/dodavannyu_klyuchiv026.png

  1. Обовʼязково «Зберегти» необхідний документ (1)

  2. Натиснути кнопку «Підписати» (2)

_images/dodavannyu_klyuchiv08.png

Зʼявиться повідомлення, що документ успішно підписаний

_images/dodavannyu_klyuchiv09.png

Важливо

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

Якщо доступних для зчитування ключів немає, є можливість іх додати після натискання кнопки «Підписати» (див. Додати ключ для підписання )

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

_images/dodavannyu_klyuchiv10.png

Комерційний документ додається в папку «Вихідні»:

_images/dodavannyu_klyuchiv023.png

3 Робота з вхідним комерційним документом

Підписання

Одержувачу необхідно:

  1. Відкрити папку «Вхідні»

  2. Вибрати необхідний документ

_images/dodavannyu_klyuchiv011.png

Як ми бачимо, документ потребує підписання (тікет під номером 2 на схемі — «не активний»)

  1. Натиснути кнопку «Підписати та відправити у відповідь»

  2. Додати ключ для підписання (за необхідністю)

  3. Вибрати ключ для підписання та натиснути кнопку «Підписати» комерційний документ

Важливо

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

_images/dodavannyu_klyuchiv012.png

Після відправки тікет під номером 2 на схемі стане «активним»

_images/dodavannyu_klyuchiv013.png

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

Відмова

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

  1. Відкрити папку «Вхідні»

  2. Вибрати необхідний документ

  3. Натиснути — «Відмова від підписання»

_images/dodavannyu_klyuchiv014.png

  1. Додати ключ для підписання (за необхідністю)

    1. Ввести текст відмови, вибрати необхідний ключ та натиснути — «Підписати»

_images/dodavannyu_klyuchiv015.png

Після підписання тікет під номером 3 на схемі стане «активним»

_images/dodavannyu_klyuchiv016.png

Важливо

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

Анулювання

Важливо

Для подачі запиту на анулювання комерційний документ повинен бути підписаний (тікет під номером 2 на схемі — «активний»)

_images/dodavannyu_klyuchiv017.png

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

  1. Відкрити папку «Вхідні» або «Вихідні»

  2. Вибрати необхідний документ

  3. Натиснути — «Запит на анулювання»

  4. Додати ключ для підписання (за необхідністю)

    1. Ввести текст анулювання, вибрати необхідний ключ та натиснути — «Підписати»

_images/dodavannyu_klyuchiv018.png

Після підписання тікет під номером 4 на схемі стане «активним»

_images/dodavannyu_klyuchiv022.png
Підтвердження

Важливо

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

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

  1. Натиснути — «Підтвердження запита на анулювання»

_images/dodavannyu_klyuchiv020.png

  1. Додати ключ для підписання (за необхідністю)

  2. Вибрати необхідний ключ та натиснути — «Підписати»

_images/dodavannyu_klyuchiv019.png

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

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

Робота з токеном

Для успішної роботи з токеном Вам потрібно встановити додаткове програме забезпечення: розширення «ІІТ Користувач ЦСК-1. Бібліотека підпису (web-р.)» для браузера та web-бібліотеку підпису користувача ЦСК.

1 Встановлення розширення «ІІТ Користувач ЦСК-1. Бібліотека підпису (web-р.)

Оберіть встановлений браузер:

Для браузера Google Chrome — https://chrome.google.com/webstore/detail/%D1%96%D1%96%D1%82-%D0%BA%D0%BE%D1%80%D0%B8%D1%81%D1%82%D1%83%D0%B2%D0%B0%D1%87-%D1%86%D1%81%D0%BA-1-%D0%B1%D1%96%D0%B1%D0%BB/jffafkigfgmjafhpkoibhfefeaebmccg?hl=uk

Для браузера Opera — https://addons.opera.com/uk/extensions/details/iit-end-user-ca-1-sign-webextension/?display=uk

Для браузера Mozilla Firefox — https://eu.iit.com.ua/download/productfiles/eusw@iit.com.ua.xp

Розглянемо процес встановлення розширення для браузера Google Chrome:

  1. Відкрийте браузер Google Chrome та пошукову систему Google

  2. Перейдіть за посиланням

Відкриється посилання:

_images/Robota_z_tokenom_01.png

  1. Натисніть кнопку «Додати в Chrome», а потім — «Додати розширення»

_images/Robota_z_tokenom_02.png

Розширення додане:

_images/Robota_z_tokenom_03.png

2 Робота з розширенням «ІІТ Користувач ЦСК-1. Бібліотека підпису (web-р.)

Є два способи додавання довіреного сайту до web-розширення:

2.1 Додавання довіреного сайту через платформу EDI-N

  1. Зайдіть на платформу EDI-N

_images/Robota_z_tokenom_04.png

  1. Зчитайте ключі у вкладці «Ключі» :

_images/Robota_z_tokenom_005.png

  1. При першій ініціалізації бібліотеки підписання підтвердіть дозвіл web-сайту до бібліотеки підпису користувача ЦСК, натисніть — «OK»

_images/Robota_z_tokenom_006.png _images/Robota_z_tokenom_07.png

  1. Зайдіть у web-розширення для перевірки додавання довіреного сайту

_images/Robota_z_tokenom_08.png
2.2 Додавання довіреного сайту через web-розширення

  1. Зайдіть у web-розширення, додайте довірений сайт та натисніть кнопку «Додати»

_images/Robota_z_tokenom_09.png

Сайт додано:

_images/Robota_z_tokenom_10.png

3 Встановлення web-бібліотеки підпису користувача ЦСК

  1. Перейдіть за посиланням для скачування інсталяційного файлу:

Розглянемо процес інсталювання на прикладі ОС Microsoft Windows:

  1. Для інсталяції програми запустіть програму інсталяції (майстер інсталяції) EUSignWebInstall.exe з інсталяційного носія (оптичного диску чи ін.)

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

_images/Robota_z_tokenom_11.png

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

_images/Robota_z_tokenom_12.png

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

_images/Robota_z_tokenom_13.png

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

_images/Robota_z_tokenom_14.png

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

_images/Robota_z_tokenom_15.png

Йде інсталяція:

_images/Robota_z_tokenom_16.png

  1. Для завершення програми інсталяції натисніть «Завершити»

_images/Robota_z_tokenom_17.png

4 Робота з токеном на web-платформі EDI-N

  1. Вставте токен у USB порт для роботи з необхідним ключом електроного підпису (далі — КЕП)

  2. Зайдіть на платформу EDI-N

_images/Robota_z_tokenom_18.png

  1. Зчитайте ключі у вкладці «Ключі» :

_images/Robota_z_tokenom_019.png

  1. При першій ініціалізації бібліотеки підписання підтвердіть дозвіл web-сайту до бібліотеки підпису користувача ЦСК, натисніть — «OK»

_images/Robota_z_tokenom_020.png _images/Robota_z_tokenom_21.png

  1. Введіть пароль для ініціалізації КЕП

_images/Robota_z_tokenom_022.png

КЕП успішно доданий:

_images/Robota_z_tokenom_023.png

Інструкція по завантаженню реєстру комерційних документів

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

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

  • за типом документу «Комерційний документ» (#Комерційний документ,)

  • за мережею (#Мережа: Назва мережі,)

_images/Instruktsiya_po_zavantazhennyu_reyestru_komdok_01.png

У скачуваний реєстр зберігаються дані по всіх типах наявних комерційних документів у відповідному розділі («Вхідні» або «Вихідні») за останній 31 день.

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

_images/Instruktsiya_po_zavantazhennyu_reyestru_komdok_02.png

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

_images/Instruktsiya_po_zavantazhennyu_reyestru_komdok_03.png

За замовчуванням у результаті пошуку за типом документу та мережею в розділі «Вхідні» відображаються документи зі статусами «#Прочитані,», «#Непрочитані,», в розділі «Вихідні» – зі статусами «#Відправлені,», «#Доставлені,», «#Помилка,».

Також користувач може ввести всі ці статуси в рядок пошуку – в цьому випадку кнопка «Завантажити реєстр документів» відображається.

_images/Instruktsiya_po_zavantazhennyu_reyestru_komdok_04.png

Але якщо користувач введе в рядок пошуку не всі можливі статуси для кожного розділу – кнопка «Завантажити реєстр документів» зникне.

Дані в Excel-файлі:

  • Название компании-отправителя

  • Код ЕГРПОУ компании-отправителя

  • Название компании-получателя

  • Код ЕГРПОУ компании-получателя

  • Номер документа

  • Название подтипа коммерческого документа

  • Дата документа

  • Номер документа-основани

  • Дата документа-основания

  • Сумма без НДС

  • Сумма НДС

  • Сумма с НДС

  • Статус подписания

Додатково в рядку пошуку можна вказати дати, за які необхідно отримати реєстр, наприклад, «Дата документа: 2019.12.01-2019.12.31,» (вказаний період не повинен перевищувати 31 день, інакше кнопка не відображається).

_images/Instruktsiya_po_zavantazhennyu_reyestru_komdok_05.png

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

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

Формування документів EDIN 2.0

Формування та відправка документа «Замовлення» (ORDER) на платформі EDI Network 2.0

Вступ

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

Формування ORDER

Щоб сформувати Замовлення (ORDER), увійдіть в розділ «EDI» і натисніть на кнопку Створити. У вікні що зявилося виберіть необхідний тип документиа, а саме - «Замовлення».

_images/ORDERS_na_EDI_Network_2.0_001.png

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

_images/ORDERS_na_EDI_Network_2.0_002.png

  1. Відправник - дані відправника документу (мережі), не підлягають редагуванню

  2. Одержувач - дані одержувача (постачальника), для пошуку контрагента натисніть на лупу

  3. Тип документа - поле для вибору типу: Оригінал замовлення, Заміна, Видалення, Фіктивність замовлення, Передзамовлення, Замовлення на послугу/маркетинг;

  4. № - номер замовлення

  5. від - дата підтвердження, за замовчуванням вказана поточна дата

  6. Постачальник - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  7. Покупець - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  8. Місце доставки - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

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

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

_images/ORDERS_na_EDI_Network_2.0_003.png

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

_images/ORDERS_na_EDI_Network_2.0_004.png

Блоки Доп інфо, Транспортування, Рампи необов’язкові для заповнення, це поля для вказання додоткової інформації по замовленню, як то валюта та наявність акції, чи умови транспортування с вказанням рампи та точного часу відвантаження. За необхідності ці блоки можна розгорнути, потім, для зручності, їх можна згорнути знову.

Блок Разом розраховується автоматично після заповнення позицій.

_images/ORDERS_na_EDI_Network_2.0_005.png

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

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

_images/ORDERS_na_EDI_Network_2.0_006.png

При додаванні позиціїі з товарного довідника, можливий пошук позицій за штрихкодом. Обов’язкові поля поміченні червоною зірочкою * - без цих полів позиція не додасться!

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

_images/ORDERS_na_EDI_Network_2.0_007.png

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

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

Важливо

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

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

_images/ORDERS_na_EDI_Network_2.0_008.png

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

Формування та відправка документа «Замовлення» (ORDER) для ВІТМАРК-УКРАЇНА

Для формування замовлення для виробника ВІТМАРК-УКРАЇНА, створіть докумень аналогіччно - натисніть на кнопку Створити та виберіть Замовлення (ORDER). Документ створиться автоматично. У новому документі, всі поля позначені червоною зірочкою ***** є обов’язковими до заповнення**.

При заповненні даних Одержувача, вкажіть GLN 9864232321439 ВІТМАРК-УКРАЇНА.

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

Стовбці помічені зеленим обов’язкові для заповнення, червоним - опціональні. Для ВІТМАРК-УКРАЇНА також обовязковим є стовбець Артикул Покупця (незважаючи на те що він виділений червоним!).

_images/ORDERS_na_EDI_Network_2.0_009.png

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

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

У разі неправильного заповнення .XLS файлу Excel, при завантаженні висвітиться повідомлення про помилку з уточненням:

_images/ORDERS_na_EDI_Network_2.0_010_error.png

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

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

_images/ORDERS_na_EDI_Network_2.0_008.png

Формування та відправка документа «Підтвердження замовлення» (ORDRSP) на платформі EDI Network 2.0

Вступ

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

Формування ORDRSP у відповідь на вхідне Замовлення

Щоб сформувати «Підтвердження замовлення (ORDRSP)» на підставі Замовлення (ORDER), увійдіть в папку «Вхідні» і виберіть замовлення, за яким потрібно зробити підтвердження.

_images/ORDRSP_na_EDI_Network_2_01.png

Для пошуку достатньо ввести коректний номер документа в полі «Пошук». Документи також можливо шукати за Відправником, Датою документа і Одержувачем.

_images/ORDRSP_na_EDI_Network_2_02.png

Для формування ORDRSP виберіть «Підтвердження замовлення» на формі-підказкою, документ створиться автоматично.З Замовлення заповнені поля переносяться в «Підтвердження замовлення». Всі поля, позначені червоною зірочкою *обов’язкові для заповнення.

_images/ORDRSP_na_EDI_Network_2_03.png

  1. Одержувач - дані одержувача (мережі), не підлягають редагування

  2. Підтвердження замовлення - поле «Тип документа»

  3. № - номер замовлення

  4. від - дата підтвердження, за замовчуванням вказана поточна дата

  5. Покупець - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  6. Постачальник - автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  7. Місце доставки - автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

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

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

_images/ORDRSP_na_EDI_Network_2_04.png

Блоки Доп інфо, Рампи необов’язкові для заповнення, блок Всього розраховується автоматично.

У блоці Позиції відображається таблиця-перелік замовлених товарних позицій і основна інформація по позиціях. Товарні позиції переносяться з Замовлення, їх можна підтвердити, видалити, змінити.

Всі зміни за позиціями тільки після узгодження з мережею!

Можливі наступні «Дії над вибраними» позиціями: Буде доставлено або Відмовлено. У колонці Дії - відображається статус дії в обраній позиції. Можливі наступні статуси: Буде доставлено, Зміни кількості, або Відмовлено.

_images/ORDRSP_na_EDI_Network_2_05.png

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

Можливо також додати іншу позицію з Товарного довідника, заповнивши форму Додати позицію під кнопкою Додати.

_images/ORDRSP_na_EDI_Network_2_06.png

Важливо

Увага! Підтверджена кількість товарних позицій не може перевищувати зазначену в замовленні!

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

_images/ORDRSP_na_EDI_Network_2_11.png

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

Також є можливість сформувати документ «Підтвердження замовлення» (ORDRSP) з розділу «Вхідні», при натисканні зеленої кнопки «Створити», і вибравши тип документа «Підтвердження замовлення »у вікні Створити документ.

_images/ORDRSP_na_EDI_Network_2_07.png

Створений таким чином документ «Підтвердження замовлення» (ORDRSP) є аналогічним до документу, створеному на основі замовлення, однак всі поля в такому віпадку необхідно заповнювати самостійно. У новому документі, всі поля позначені червоною зірочкою ***** є обов’язковими до заповнення**.

Одержувач - необхідно заповнити за допомогою кнопки «Пошук контрагента» (лупа) або ж за допомогою кнопки «Вказати себе» (будинок). Форма Пошук контрагента дає можливість знайти контрагента по GLN, ІПН, за назвою компанії або за назвою мережі (при виборі відповідного чекера).

_images/ORDRSP_na_EDI_Network_2_08.png

Блок Доп інфо заповнювати необов’язково, в ньому відображається додаткова інформація, ви можете відкрити або приховати цей блок натиснувши на кнопку Розгорнути / Згорнути.

_images/ORDRSP_na_EDI_Network_2_09.png

Блок Рампи заповнюється інформацією про умови відвантаження і точці відвантаження.

_images/ORDRSP_na_EDI_Network_2_10.png

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

_images/ORDRSP_na_EDI_Network_2_11.png

Формування та відправка документа «Повідомлення про відвантаження» (DESADV) на платформі EDI Network 2.0

Вступ

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

Формування Повідомлення про відвантаження (DESADV)

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

Розглянемо формування «Повідомлення про відвантаження» на підставі «Підтвердження замовлення».

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

_images/DESADV_na_EDI_Network_2_01.png

У відкритому документі, на формі-підказці, котра дозволяє створити документ на основі Підтвердження замовлення, виберіть зі списку «Повідомлення про відвантаження».

_images/DESADV_na_EDI_Network_2_02.png

Документ створений на основі Замовлення або Підтвердження замовлення створиться автоматично. Дані деяких полів пененесутся з документа підстави. Всі поля, позначені червоною зірочкою *** обов’язкові до заповнення **.

_images/DESADV_na_EDI_Network_2_03.png

  1. Одержувач - дані одержувача (мережі), компанія

  2. ПОВІДОМЛЕННЯ ПРО ВІДВАНТАЖЕННЯ № - номер замовлення

  3. від - дата повідомлення про відвантаження, за замовчуванням вказана поточна дата

  4. Доставка буде проведена - дата і час доставки

  5. Постачальник - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  6. Покупець - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  7. Місце доставки - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  8. За накладної № - номер накладної, повинен повністю збігатися з номером оригіналу паперової накладної

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

Важливо

Увага! Номер накладної повинен повністю збігатися з номером оригіналу паперової накладної.

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

Всі зміни за позиціями тільки після узгодження з мережею!

_images/DESADV_na_EDI_Network_2_04.png

Важливо

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

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

Важливо

Увага! Кількість товарних позицій, що поставляється не може перевищувати кількість зазначену в замовленні!

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

Якщо змінилася ціна, внесіть зміни в колонку «Ціна з ПДВ». Всі зміни відобразяться в блоці Всього:

  • Кількість позицій

  • Кількість, що поставляється

  • Сума без ПДВ

  • Сума з ПДВ

  • Всього податків

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

_images/DESADV_na_EDI_Network_2_05.png

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

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

_images/DESADV_na_EDI_Network_2_06.png

Створений таким чином документ «Повідомлення про відвантаження» (DESADV) є аналогічним до документу, створеному на основі Замовлення, однак всі поля в такому віпадку необхідно заповнювати самостійно. У новому документі, всі поля позначені червоною зірочкою ***** ** є обов’язковими до заповнення**.

Блок Доп інфо, або Транспортування заповнювати необов’язково, в ньому відображається додаткова інформація, ви можете відкрити або приховати цей блок натиснувши на Розгорнути / Згорнути.

_images/DESADV_na_EDI_Network_2_07.png

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

Формування та відправка документа «Рахунок» (INVOICE) на платформі EDI Network 2.0

Вступ

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

Формування документа «Рахунок»

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

Розглянемо формування документа «Рахунок» на підставі «Замовлення».

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

_images/INVOICE_na_EDI_Network_2_01.png

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

_images/INVOICE_na_EDI_Network_2_02.png

Документ створений на основі Замовлення або Підтвердження замовлення створиться автоматично. Дані деяких полів пененесутся з документа підстави. Всі поля, позначені червоною зірочкою *** обов’язкові до заповнення **.

_images/INVOICE_na_EDI_Network_2_03.png

Важливо

Увага! Номер накладної повинен повністю збігатися з номером оригіналу паперової накладної.

  1. Відправник - дані відправника рахунку (постачальника)

  2. Одержувач - дані одержувача (мережі), компанія

  3. РАХУНОК № - номер рахунку

  4. від - дата повідомлення про відвантаження, за замовчуванням вказана поточна дата

  5. Постачальник - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  6. Покупець - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  7. Місце доставки - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  8. Валюта рахунку - вибрати валюту: Гривня, Долар США, Євро

  9. Зі ставкою ПДВ - вибрати ставку податку на додану вартість: 0%, 7%, 20%

  10. Накладна № - номер накладної повинен повністю збігатися з номером оригіналу паперової накладної

  11. від - дата накладної

  12. Поставка повинна бути проведена - дата і час доставки

Важливо

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

Нижче на сторінці створеного документа знаходиться необов’язкова для заповнення (якщо інше не зазначено в договорі) інформація про постачальника (доп. інфо), а також підсумок за кількістю і за сумою з/без ПДВ за позиціями.

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

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

Всі зміни за позиціями тільки після узгодження з мережею!

_images/INVOICE_na_EDI_Network_2_04.png

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

Важливо

Увага! Кількість товарних позицій, що поставляється не може перевищувати кількість зазначену в замовленні!

_images/INVOICE_na_EDI_Network_2_05.png

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

_images/INVOICE_na_EDI_Network_2_06.png

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

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

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

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

_images/INVOICE_na_EDI_Network_2_07.png

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

Формування документа «Інструкція про транспортування» (IFTMIN) на платформі EDI Network 2.0

Вступ

Дана інструкція описує порядок формування та відправки документа «Інструкція про транспортування» (IFTMIN). Інструкція з транспортування (IFTMIN) відправляється замовником оператору логістичних послуг. В даному документі вказуються остаточні деталі поставки.

Формування документа «Інструкція про транспортування» (IFTMIN) для торгової мережі Фоззі

Створення документа відбувається на підставі «Замовлення». Щоб сформувати «Інструкцію про транспортування (IFTMIN)» на підставі Замовлення (ORDER), увійдіть в папку «Вхідні» і виберіть замовлення, за яким потрібно зробити інструкцію. Для пошуку достатньо ввести коректний номер документа в полі «Пошук». Документи також можливо шукати за Відправником, Датою документа і Одержувачем.

_images/IFTMIN_na_EDI_Network_2_01.png

Для формування IFTMIN виберіть «Інструкція про транспортування» на формі-підказці, документ створиться автоматично.

_images/IFTMIN_na_EDI_Network_2_02.png

Документ створений на основі Замовлення частково заповнюється автоматично (дані деяких полів пененосяться з документа підстави). Всі поля, позначені червоною зірочкою *** обов’язкові до заповнення **.

_images/IFTMIN_na_EDI_Network_2_07.png
Заповнення документа (IFTMIN) для торгової мережі Фоззі

  1. Інструкція про транспортування № документа повинен бути наступного формату X_Y, де:

  • Х - це порядковий номер машини, на поставку

  • Y - це загальна кількість машин, на поставку

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

Мінімальна к-ть 1, Максимальна - 99. Х повинен бути менше або рівним Y. Наприклад: 2_5

  1. Від (Дата) - фактична дата відправки поставки, за замовчуванням вказана поточна дата

  2. Оговорена дата поставки - попередня дата відправки поставки, за замовчуванням вказана поточна дата

  3. Номер замовлення - може підтягуватись автоматично із Замовлення

  4. Місце доставки - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  5. Вантадовідправник - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  6. Тип упаковки - вибір з доступного переліку транспортних упаковок

  7. Фактична кількість палет - кількість палет, що відвантажується в вантажний транспорт

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

  9. Максимальна кількість палет - максимальна місткість палет (вантажний транспорт)

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

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

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

_images/IFTMIN_na_EDI_Network_2_05.png

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

Формування документа «Інструкція про транспортування» (IFTMIN) «з нуля»

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

_images/IFTMIN_na_EDI_Network_2_04.png

У вікні з’явиться Форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою * - обов’язкові для заповнення.

_images/IFTMIN_na_EDI_Network_2_03.png
Заповнення документа (IFTMIN) «з нуля»

  1. Інструкція про транспортування № - номер документу

  2. Від (Дата) - фактична дата відправки поставки, за замовчуванням вказана поточна дата

  3. Оговорена дата поставки - попередня дата відправки поставки, за замовчуванням вказана поточна дата

  4. Місце доставки - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  5. Вантадовідправник - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

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

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

Блоки Інформація про вантаж та Додаткова інформація заповнювати необов’язково, в них відображається додаткова інформація, яку ви можете відкрити або приховати натиснувши на Розгорнути / Згорнути.

_images/IFTMIN_na_EDI_Network_2_06.png

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

_images/IFTMIN_na_EDI_Network_2_05.png

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

Формування та відправка документа «Повідомлення про прийом» (RECADV) на платформі EDI Network 2.0

Вступ

Дана інструкція описує порядок формування та відправки документа «Повідомлення про прийом» (RECADV) на платформі EDI Network 2.0. Повідомлення про прийом (RECADV) використовується для оповіщення постачальників про прийом товарів. Даний документ інформує про кількість отриманих товарних позицій і може вказувати на розбіжності між фактично отриманим товаром і зазначеним у документації. В результаті роздрібна мережа ще до приходу машини на рампу має точну інформацію про постачання і дана інформація вже завантажена в облікову систему мережі.

Формування Повідомлення про прийом (RECADV)

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

Розглянемо формування «Повідомлення про прийом» на підставі «Підтвердження замовлення».

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

_images/RECADV_na_EDI_Network_2_01.png

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

_images/RECADV_na_EDI_Network_2_02.png

Документ створений на основі Повідомлення про відвантаження або Підтвердження замовлення частково заповнюється автоматично (дані деяких полів пененесутся з документа підстави). Всі поля, позначені червоною зірочкою *** обов’язкові до заповнення **.

_images/RECADV_na_EDI_Network_2_03.png

  1. Одержувач - дані одержувача (мережі), компанія

  2. Повідомлення про прийом № - номер замовлення

  3. від - дата Повідомлення про прийом, за замовчуванням вказана поточна дата

  4. Дата приймання - дата і час приймання

  5. Постачальник - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  6. Покупець - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  7. Місце доставки - заповнюється автоматично, або за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

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

_images/RECADV_na_EDI_Network_2_04.png

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

Важливо

Увага! Кількість товарних позицій, що поставляється не може перевищувати кількість зазначену в замовленні!

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

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

_images/RECADV_na_EDI_Network_2_05.png

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

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

_images/RECADV_na_EDI_Network_2_06.png

Створений таким чином документ «Повідомлення про прийом» (RECADV) є аналогічним до документу, створеному на основі Підтвердження замовлення, однак всі поля в такому віпадку необхідно заповнювати самостійно. У новому документі, всі поля позначені червоною зірочкою * є обов’язковими до заповнення.

Блок Додаткова інформація заповнювати необов’язково, в ньому відображається додаткова інформація, ви можете відкрити або приховати цей блок натиснувши на Розгорнути / Згорнути.

_images/RECADV_na_EDI_Network_2_07.png

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

Формування та відправка документа «Інструкція по доставці» (INSDES) на платформі EDI Network 2.0

Вступ

Дана інструкція описує порядок формування та відправки документа «Інструкція по доставці» (INSDES) на платформі EDI Network 2.0. «Інструкція по доставці» (INSDES) відправляється мережею постачальнику з указанням того, яку продукцію і яку кількість торних позицій необхідно доставити у вказаний термін. В результаті постачальник ще до отримання Замовлення має точну інформацію про постачання.

Формування Інструкції по доставці (INSDES) торговою мережею

Формування і відправка документа здійснюється інтегровано на стороні торгової мережі (на підставі Замовлення), а з web можливо створити документ тільки «з нуля».

_images/INSDES_na_EDI_Network_2_01.png

Всі поля, позначені червоною зірочкою * - обов’язкові до заповнення.

_images/INSDES_na_EDI_Network_2_02.png

  1. Відправник - дані відправника (мережі), компанія

  2. Одержувач - дані одержувача (постачальника), компанія

  3. Інструкція по доставці № - номер інструкції

  4. Від - дата Інструкції по доставці

  5. Інструкція на замовлення - номер замовлення

  6. Від - дата Замовлення

  7. Покупець - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  8. Постачальник - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

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

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

_images/INSDES_na_EDI_Network_2_03.png

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

Формування документа Інструкція про повернення (RETINS)

Вступ

Документ Інструкція про повернення (RETINS) відправляється Постачальником у відповідь на Повідомлення про повернення (RETANN) від мережі, і використовується для підтвердження або редагування дати та часу прибуття постачальника. Документ не потребує підпису.

Формування документа Інструкція про повернення (RETINS)

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

_images/pics_formirovanie_RETINS_na_EDI_Network_2.0_002.png

У документі, що відкрився, виберіть Інструкція про повернення на формі-підказці, новий документ створиться автоматично.

_images/pics_formirovanie_RETINS_na_EDI_Network_2.0_003.png

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

Деякі дані можливо редагувати. Обов’язкові поля, позначені червоною зірочкою *, мають бути заповнені!

_images/pics_formirovanie_RETINS_na_EDI_Network_2.0_004.png

  1. № - номер документу

  2. Постачальник - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  3. Покупець - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  4. Місце доставки - заповнюється за допомогою кнопки «Пошук контрагента», або за допомогою кнопки «Вказати себе»

  5. Дата повернення - дата та час повернення товарів, переноситься із Повідомлення про повернення

  6. Дія - поле для вибору типу дії, може бути Змінено, Прийнято, Відмовлено;

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

Нище блок, де вказана додаткова інформація, як-то версія документу, та інформація по позиціям. Щоб переглянути додаткову інформацію, натисніть на Розгорнути.

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

_images/pics_formirovanie_RETINS_na_EDI_Network_2.0_005.png

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

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

_images/pics_formirovanie_RETINS_na_EDI_Network_2.0_006.png

Інструкція по роботі з документом «Прайс-лист» для PAMPIK (Лелека Трейд) на web-платформі

1 Формуваня документа «Прайс-лист»

Для входу на web платформу EDIN необхідно перейти за посиланням: https://edo-v2.edi-n.com/.

Для формування документу на платформі необхідно натиснути на кнопку «Створити»:

_images/PricatPampikInstruction_EDIN_2_0_01n.png

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

_images/PricatPampikInstruction_EDIN_2_0_02n.png

Відкриється форма документа:

_images/PricatPampikInstruction_EDIN_2_0_03n.png

Після цього обрати одержувача документа — PAMPIK (Лелека Трейд). В полі «Одержувач» необхідно натиснути на кнопку «Пошук», після цього в модальном окні вказати GLN компанії 9864066874774 та натиснути на кнопку «Вибрати».

_images/PricatPampikInstruction_EDIN_2_0_04n.png

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

_images/PricatPampikInstruction_EDIN_2_0_05n.png

Відкриється форма документа для мережі PAMPIK (Лелека Трейд):

_images/PricatPampikInstruction_EDIN_2_0_06n.png

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

  • Прайс-лист № — можна внести власний номер (при встановленій позначці номер присвоюється автоматично)

  • Від (дата прайс-листа) — поточна дата

  • Період дії з — дата початку дії цін

  • Період дії по — дата закінчення дії цін

  • Покупець — необхідно натиснути на кнопку «Пошук», після цього в модальном окні вибрати PAMPIK (Лелека Трейд)

  • Постачальник — автоматично вказується відправник документу

  • Валюта — необхідно обрати «Гривня»

  • Тип прайс-листа — Прайс-лист (повний), Доповнення прайс-листа

Всі інші поля не є обов’язковими для заповнення.

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

_images/PricatPampikInstruction_EDIN_2_0_07n.png

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

_images/PricatPampikInstruction_EDIN_2_0_08n.png

2 Додавання товарних позицій

2.1 Додавання товарних позицій за допомогою Шаблону

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

_images/PricatPampikInstruction_EDIN_2_0_09n.png

На Ваш комп’ютер буде завантажено файл з назвою pricat_products_sample.xls. Відкривши його, необхідно внести інформацію по товару.

Обов’язкові для заповнення поля (поля відмічені зеленим кольором):

  • Штрихкод

  • Найменування

  • Ціна

  • Ставка ПДВ

  • Ціна з ПДВ

Важливо

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

Підказка

В полі «Ставка ПДВ» необхідно вказати значення «0» або «7», або «20».

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

_images/PricatPampikInstruction_EDIN_2_0_10n.png
2.2 Додавання позицій з товарного довідника

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

_images/PricatPampikInstruction_EDIN_2_0_11n.png

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

_images/PricatPampikInstruction_EDIN_2_0_12n.png

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

_images/PricatPampikInstruction_EDIN_2_0_13n.png

Інструкція щодо додавання продукції до товарного довідника — https://wiki.edi-n.com/uk/latest/general_2_0/rabota_s_platformoj_EDIN_2.0.html#id10.

3 Збереження та відправка документу

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

Формування Податкової Накладний на підставі Прибуткової накладної (COMDOC_007)

1 Початкові налаштування

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

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

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

1.3 Зайти на портал: https://edo-v2.edi-n.com/auth і ввести логін і пароль:

_images/Formuvannya_Podatkovoyi_Nakladnyy_01.png

1.4 Перед початком роботи з податковою накладною необхідно одноразово надати інформацію про реквізити компанії - зверніться до технічної підтримки або до Вашого менеджера.

Необхідно вказати:

  • Код ЄДРПОУ

  • Код ІПН

  • Правильну назву компанії

  • № свідоцтва платника ПДВ

  • Вулицю і будинок (юр. адреса)

  • Індекс (юр. адреса)

  • Місто (юр. Адреса)

  • Країну (вибирайте зі списку Україну)

  • Область (вибирайте зі списку)

  • ДПІ (вибирайте зі списку податкову, в яку подаєте звітність)

  • Менеджер (можна вказати «-»)

  • Бухгалтер (П.І.Б. головного бухгалтера)

  • Директор (П.І.Б. директора)

  • Посада (посада директора: генеральний, виконавчий, директор)

  • Підписант (П.І.Б. та ІПН підписувача)

  • Телефон

  • Форма власності (юр. чи фіз. особа)

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

Важливо

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

2 Формування Податкової накладної

Перед створенням Податкової накладної рекомендується перевірити товарний довідник, тому що інформація по позиціях підтягується саме з нього. Він знаходиться в правому верхньому кутку:

_images/Formuvannya_Podatkovoyi_Nakladnyy_02.png

2.1 Перейдіть в пункт меню «Вхідні»:

_images/Formuvannya_Podatkovoyi_Nakladnyy_03.png

2.2 Виберіть підписаний і вже відправлений «Комерційний документ» Прибуткова накладна, на підставі якого будете формувати і відправляти електронну Податкову накладну.

_images/Formuvannya_Podatkovoyi_Nakladnyy_04.png

2.3 Далі в відритому «Комерційному документі» необхідно натиснути на кнопку Податкова накладна.

_images/Formuvannya_Podatkovoyi_Nakladnyy_05.png

2.4 При створенні Податкової накладної потрібно обрати ставку ПДВ:

_images/Formuvannya_Podatkovoyi_Nakladnyy_06.png

2.5 Всі необхідні поля для заповнення позначені червоними зірочками *. Також важливо попозиційно вносити код УКТ ЗЕД. Після внесення всіх даних необхідно натиснути кнопку «Зберегти». Якщо частина необхідних реквізитів не заповнена, з’являться підказки, які поля потрібно заповнити.

_images/Formuvannya_Podatkovoyi_Nakladnyy_07.png

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

2.7 Після натискання кнопки «Відправити» ЕПН відправляється на реєстрацію до Єдиного реєстру податкових накладних.

3 Отримання квитанції про реєстрацію

3.1 Після відправки податкової накладної необхідно дочекатися отримання Квитанції №1 з ЄРПН. Існує два статуси:

  1. «Зареєстровано в ЄРПН і відправлено покупцеві»:

_images/Formuvannya_Podatkovoyi_Nakladnyy_08.png

  1. «Помилка при реєстрації в ЄРПН»:

_images/Formuvannya_Podatkovoyi_Nakladnyy_09.png

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

_images/Formuvannya_Podatkovoyi_Nakladnyy_10.png

3.3 Натиснути кнопку «Розшифрувати» для відповідної квитанції.

Важливо

Для зчитування квитанції потрібно використовувати ті ж ключі, що були використані при підписанні «Податкової накладної»

_images/Formuvannya_Podatkovoyi_Nakladnyy_11.png

3.4 Після розшифровки текст квитанції стане доступний для читання. Її можна вивантажити в форматі .rpl (можливе завантаження в M.E.Doc), .pdf, а також роздрукувати.

_images/Formuvannya_Podatkovoyi_Nakladnyy_12.png

Формування Коригувальної ПН на підставі Накладної на повернення

Початкові налаштування

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

Підготуйте діючий електронний цифровий підпис особи (осіб), за допомогою якого буде здійснюватися підписання електронної податкової накладної (DECLAR). Якщо ключі не на зовнішніх носіях (диск, флеш-накопичувач), а на вашому ПК - потрібно знати шлях до ключів в файловій системі.

Зайдіть на портал: https://edo-v2.edi-n.com і введіть логін і пароль.

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

Необхідно вказати:

  • Код ЄДРПОУ

  • Код ІПН

  • Правильну назву компанії

  • № свідоцтва платника ПДВ

  • Вулицю і будинок (юр. адреса)

  • Індекс (юр. адреса)

  • Місто (юр. Адреса)

  • Країну (вибирайте зі списку Україну)

  • Область (вибирайте зі списку)

  • ДПІ (вибирайте зі списку податкову, в яку подаєте звітність)

  • Підписант (П.І.Б. та ІПН підписувача)

  • Телефон

  • Форма власності (юр. чи фіз. особа)

Формування документа «Коригування до Податкової накладної (DECLAR_J12)»

Даний документ формується на підставі Комерційного документа (СOMDOC) “Накладна на повернення”.

Перед відправкою коригування необхідно підписати і відправити Комерційний документ «Накладна на повернення».

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

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_01.png

Для того, щоб сформувати документ “Коригування до Податкової накладної”, необхідно зайти в Комерційний документ “Накладна на повернення”.

Далі у відкритому документі на формі-підказці натисніть —> Розрахунок коригування до податкової накладної.

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_02.png

Заповнення документа «Коригування до Податкової накладної (DECLAR_J12)»

Всі необхідні поля для заповнення позначені червоними зірочками *.

У новому вікні в випадаючому списку оберіть ставку ПДВ для Розрахунку коригування до податкової накладної. Виберіть необхідний параметр:

  • 20%

  • 19%

  • 0%

  • 7%

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_03.png

Розділ А розраховується автоматично.

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_04.png

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

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_05.png

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

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_06.png

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

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_07.png

Всі інші поля ви заповнюєте самостійно згідно з чинним податковим законодавством України.

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_08.png

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

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

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_09.png

Після натискання кнопки «Надіслати» накладна відправляється на реєстрацію до Єдиного реєстру податкових накладних.

Отримання статусу про реєстрацію

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

  1. Зареєстровано в ЄРПН

Свідчить про те, що Коригувальна податкова накладна була успішно зареєстрована в ЄРПН вашим контрагентом.

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_011.png

  1. Помилка при реєстрації в ЄРПН

Свідчить про те, що Коригувальна податкова накладна була відхилена вашим контрагентом.

_images/Koryhuvalnoi_PN_iz_Nakladnoi_na_povernennia_010.png

Також помилку реєстрації (квитанцію) можна переглянути, зайшовши в документ.

  1. Відправлений на перевірку в торговельну мережу

Документ перевіряється на стороні торгової мережі перед відправкою на реєстрацію.

Інструкція по роботі з мережею Фоззі за схемою «Match Invoice» на платформі EDI Network 2.0

Вступ

Дана інструкція описує порядок формування документів для документотобігу із мережею Фоззі за схемою «Match Invoice».

Інструкція описує порядок формування документів від постачальника «Підтвердження замовлення» (ORDRSP) і «Повідомлення про відвантаження» (DESADV) у відповідь на Замовлення по мережі Фоззі.

1. Формування вихідного документа «Підтвердження замовлення»(ORDRSP) у відповідь на Замовлення (ORDER)

Важливо!

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

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

Для зручності пошуку скористайтесь фільтрами - наведіть курсор на поле пошуку й виберіть фільтри - наприклад Мережа-Фоззі, тип документа Замовлення.

_images/pics_robota_s_Fozzy_01.png

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

_images/pics_robota_s_Fozzy_02.png

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

_images/pics_robota_s_Fozzy_03.png

У відкритому вікні з’явиться форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою *обов’язкові для заповнення. Інформація про Покупця, Постачальника та Місце доставки автоматично заповниться із Замовлення.

_images/pics_robota_s_Fozzy_04.png

  1. Номер - може збігатися з номером замовлення.

  2. Дата - дата підтвердження, автоматично вказується поточна дата.

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

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

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

_images/pics_robota_s_Fozzy_05.png

Інформація по позиціям, автоматично переноситься із Замовлення:

  1. Номер - номер позиції

  2. Найменування - назва позиції іх товарного довідника

  3. Штрихкод - штрихкод товарної позиції, полегшує пошук, переноситься автоматично з замовлення

  4. Артикул покупця- дані заповнюються автоматично з документа підстави

  5. Замовлена кількість- кількість автоматично переноситься з замовлення

  6. Мінімальна кількість замовлення автоматично переноситься з замовлення

  7. Підтверджена кількість - фактична підтверджена кількість, що буде доставлена

  8. Дії - вибираються зі списку в залежності від ситуації: Буде доставлено, або Відмовлено, а при зміні Підтвердженої кількості автоматично зміниться на Зміна кількості

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

_images/pics_robota_s_Fozzy_06.png

2. Формування вихідного документа «Повідомлення про відвантаження»(DESADV)

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

Перейдіть в розділ Вихідні, у виберіть другому фільтрі - Фоззі, в третьому - тип документа Підтвердження замовлення.

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

У вікні з’явиться форма для заповнення необхідних даних документа, деякі поля заповняться із Замовлення. Всі поля, позначені червоною зірочкою * обов’язкові до заповнення.

_images/pics_robota_s_Fozzy_07.png

  1. Покупець

  2. Місце доставки

  3. Кінцевий одержувач

  4. Повідомлення на Замовлення № - автоматично переноситься з замовлення

  5. Номер підтвердження Замовлення № - автоматично переноситься з замовлення

  6. Номер Повідомлення про відвантаження - на кожну одиницю транспорту потрібно своє повідомлення з порядковиим номером (якщо № авто=1, то повідомлення=1)

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

Важливо!

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

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

_images/pics_robota_s_Fozzy_08.png

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

  1. К-ть відвантаженого товару - кількість що поставляється в одиниці транспорту

  2. К-ть замовленного товару - поле заповнюється з документу-основи

  3. Одиниці виміру - одиниці вимірювання кількості

  4. Ціна без ПДВ - ціна за позицію

  5. Сума без ПДВ - сумма по позиціям

  6. Ставка ПДВ - виберіть % ставки із списку

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

Важливо!

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

3. Формування документа «Інструкція з транспортування» (IFTMIN)

Важливо!

У разі створення декількох «Повідомленнь про відвантаження»(DESADV), необхідно на кожне сформувати свою Інструкцію з транспортування» (IFTMIN).

Створення документа відбувається на підставі «Замовлення».

_images/pics_robota_s_Fozzy_09.png

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

_images/pics_robota_s_Fozzy_10.png

У відкритому документі, натисніть на формі-підказці на «Інструкція по транспортуванню». У вікні з’явиться Форма для заповнення необхідних реквізитів документа. Всі поля, позначені червоною зірочкою * обов’язкові для заповнення.

_images/pics_robota_s_Fozzy_11.png

  1. Номер документа повинен бути наступного формату X_Y, де:

  • Х - це порядковий номер машини, на поставку (порядковий № Повідомлення про відвантаження)

  • Y - це загальна кількість машин, на поставку (загальна кількість Повідомлень про відвантаження)

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

Мінімальна к-ть 1, Максимальна - 99. Х повинен бути менше або рівним Y. Наприклад: 2_5

  1. Дата - фактична дата відправки поставки

  2. Номер замовлення - підтягується автоматично із замовлення

  3. Місце доставки - підтягується автоматично із замовлення

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

  5. Тип пакування - вибрати з випадаючого списку

  6. Фактична кількість палет - кількість палет, що відвантажується в вантажний транспорт

  7. Максимальна кількість палет - максимальна місткість палет (вантажний транспорт)

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

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

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

4 Обробка відповіді від мережі Фоззі

Мережа у відповідь на «Повідомлення про відвантаження»(DESADV) може відправити «Повідомлення про прийом» (RECADV) в якості остаточного підтвердження поставки або «Акт невідповідності» (COMDOC 009) в разі виникнення кількісних чи цінових товарних розбіжностей.

4.1 Обробка вхідного документа «Повідомлення про прийом» (RECADV)

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

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

У журналі документів, а також в самому документі, червоним буде виділено попередження Поставка потребує закриття

_images/pics_robota_s_Fozzy_12.png

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

4.2 Обробка вхідного документа «Акт невідповідності» (COMDOC 009)

У випадку розходження між відправленною і фактично прийнятою кількістю товару чи виникненням цінової розбіжності – мережа надсилає Вам «Акт невідповідності» (COMDOC 009)

_images/pics_robota_s_Fozzy_13_pred_net.png

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

_images/pics_robota_s_Fozzy_14.png

Після ознайомлення з документом необхідно повторно відправити «Повідомлення про відвантаження»(DESADV) з правками кількості/ціни згідно розбіжностей вказаних в «Акті невідповідності» (COMDOC 009) мережі Фоззі.

Увага

В «Повідомлення про відвантаження»(DESADV) потрібно вносити правки лише згідно вказаних розбіжностей в «Акті невідповідності» (COMDOC 009). В іншому документ DESADV повинен бути ідентичним до попередньо відправленого (детально в розділі 2).

У відповідь на відправлений відредагований документ «Повідомлення про відвантаження»(DESADV) повинен надійти документ «Повідомлення про прийом» (RECADV), котрий необхідно буде «закрити» (детально в розділі 4.1).

Інтеграція

API

Авторизація

Після підключення послуги для роботи з API, користувач отримує логін, пароль і api_key для авторизації. Авторизація API відбувається за допомогою передачі цих ключових параметрів в HTTP POST запиті:

  • email - рядок; логін користувача;

  • password - рядок, пароль користувача на платформі EDIN 2.0

  • api_key - рядок, пароль доступу до API

Після авторизації відбувається передача унікального cookie токена «SID». HTTP-заголовок відповіді сервера в вигляді «Set-Cookie» використовується для подальшої відправки файлів «Cookie». В кожному наступному запиті (виклику методу) повинен бути присутнім HTTP-заголовок (Header) «Cookie», який для коректного виконання запитів повинен містити токен «SID» зі значенням, отриманим при авторизації.

В сучасних популярних браузерах і Rest клієнтах відбувається автоматичне збереження і передача токена на сервер під час сесії, однак при використанні деяких інтеграційних рішень, самописних REST-клієнтів цей обов’язковий параметр може не передаватись - його необхідно примусово передавати в заголовку (Header) «Cookie». Після авторизації час життя сесії при бездіяльності користувача становить 10 хвилин.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/authorization

Параметри, що передаються в URL (разом з адресою методу)

Обов’язкові параметри:

email - рядок; логін користувача;

password - рядок, пароль користувача на платформі EDIN 2.0

api_key - рядок, пароль доступу до API

При авторизації json-тіло запиту відсутнє (інші дані передавати не потрібно). При успішній авторизації отримуємо у відповідь «токен» (наприклад,``“SID=65daca25-74ba-4c85-8183-71b404a348c0“`` ), необхідний для подальшої роботи.

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/oas/authorization“ -d „email=uaEDSsender&password=111&api_key=66B4814DEC28B4CA17DE56338A52D7DB“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

Перевірки

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

Перевірка активності сервера (метод не потребує проходження авторизації):

Метод запиту

HTTP GET

URL запиту

https://edo-v2.edi-n.com/ping

Підказка

Також можливо виконати запит у вигляді curl-рядка: curl -X GET „https://edo-v2.edi-n.com/ping“

Перевірка активності сесії:

Метод запиту

HTTP GET

URL запиту

https://edo-v2.edi-n.com/api/auth_check

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка: curl -X GET „https://edo-v2.edi-n.com/api/auth_check“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

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

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

За допомогою методу api/eds/doc можливо швидко створити чернетку документа конкретного зазначеного типу для конкретного одержувача.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/doc?gln=9864065702429&doc_type=orders&doc_number=sdsd334&doc_date=1505497243&recipient=9864065702428&family=edi

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

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

doc_type - рядок; конкретний тип документа

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

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

recipient - рядок(13); gln отримувача

family - рядок; «група» документів, можливі значення: - edi - uzd - reports - certificats - factoring

{«…»} - тіло http запиту - json документа

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/eds/doc?gln=9864065702429&doc_type=orders&doc_number=sdsd334&doc_date=1505497243&recipient=9864065702428&family=edi“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються поля документа (зі специфікацією документів ви можете ознайомитися у відповідному розділі).

RESPONSE

В відповідь передається «ID створеної чернетки» (довжина 36 символів), наприклад, fb285cdb-31f8-4d59-b89b-77e30e608e12.

Приклади

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

{
     "NUMBER": "6422722fb78c4509b06eac43758e1545",
     "DATE": "2019-02-15",
     "TIME": "00:00",
     "ORDERNUMBER": "6422722fb78c4509b06eac43758e1545",
     "ORDERDATE": "2019-02-15",
     "DELIVERYDATE": "2019-02-30",
     "DELIVERYTIME": "10:00",
     "CAMPAIGNNUMBER": "334455",
     "CURRENCY": "UAH",
     "LIMES": [],
     "HEAD": [
             {
                     "BUYER": "4820128010004",
                     "SUPPLIER": "9864065702429",
                     "DELIVERYPLACE": "4820128019007",
                     "INVOICEPARTNER": "4820128010004",
                     "SENDER": "4820128010004",
                     "RECIPIENT": "9864065702429",
                     "POSITION": [
                             {
                                     "POSITIONNUMBER": "1",
                                     "PRODUCT": "5029053540900",
                                     "PRODUCTIDBUYER": "527209",
                                     "DESCRIPTION": "пироженко",
                                     "PRICE": 510,
                                     "PRICEWITHVAT": 571.2,
                                     "VAT": "12.00",
                                     "AMOUNT": 0,
                                     "AMOUNTWITHVAT": 0,
                                     "ORDEREDQUANTITY": 64,
                                     "ACCEPTEDQUANTITY": 64,
                                     "PRODUCTTYPE": "1"
                             },
                             {
                                     "POSITIONNUMBER": "2",
                                     "PRODUCT": "5029053540924",
                                     "PRODUCTIDBUYER": "527215",
                                     "DESCRIPTION": "мороженко",
                                     "PRICE": 510,
                                     "PRICEWITHVAT": 571.2,
                                     "VAT": "12.00",
                                     "AMOUNT": 0,
                                     "AMOUNTWITHVAT": 0,
                                     "ORDEREDQUANTITY": 32,
                                     "ACCEPTEDQUANTITY": 32,
                                     "PRODUCTTYPE": "1"
                             },
                             ...
                             {
                                     "POSITIONNUMBER": "48",
                                     "PRODUCT": "5029053543987",
                                     "PRODUCTIDBUYER": "100307632",
                                     "DESCRIPTION": "водочка",
                                     "PRICE": 1751.6,
                                     "PRICEWITHVAT": 1961.79,
                                     "VAT": "12.00",
                                     "AMOUNT": 0,
                                     "AMOUNTWITHVAT": 0,
                                     "ORDEREDQUANTITY": 12,
                                     "ACCEPTEDQUANTITY": 12,
                                     "PRODUCTTYPE": "1"
                             }
                     ]
             }
     ],
     "ACTION": "29"
     }

Приклад тіла відповіді (json):

Повертаємий текст - ID створеної чернетки (36 символів)

fb285cdb-31f8-4d59-b89b-77e30e608e12

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

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

За допомогою методу /api/eds/doc/send можлива відправка чернетки в певний ланцюжок.

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/doc/send

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

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

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

doc_hash - рядок; хеш документа

chain_hash - рядок; хеш ланцюжка (можливо взяти з відповіді методу api/eds/chains/search )

chain_uuid - рядок; ID ланцюжка

Примітка

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

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

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X PATCH „https://edo-v2.edi-n.com/api/eds/doc/send?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&doc_hash=704DD5F0A71FCB730D2B1AEA84FEE3FB&chain_hash=704DD5F0A71FCB730D2B1AEA84FEE3FB&chain_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&partner_id=11“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів (фільтр) запиту методу API

Найменування

Тип

Формат

Опис

extra_fields

Map<String, String>

масив об’єктів; набір індексів

multi_extra_fields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка

Таблиця 2 - Опис extra_fields параметрів

id параметра

Найменування параметра

Тип

Формат

Опис параметра

1

created_from

UUID

ідентифікатор документа або ланцюжка

2

is_signed

TINYINT

відмітка про підписання

3

encrypted

TINYINT

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

4

comdoc_reestr_id

INT

id факторингового Реєстру на підставі комерційного документа

5

comdoc_reestr_is_active

TINYINT

відмітка про активність факторингового договору

6

ftpex_file_name

VARCHAR

найменування файлу, відправленого по FTP

7

ftpex_file_date

INT

дата/час відправки документа по FTP

8

inv_date

INT

дата документа invrpt (Звіт про інвентаризацію)

9

inv_num

VARCHAR

номер документа invrpt (Звіт про інвентаризацію)

11

sub_doc_type_id

INT

id підтипу документа

12

sub_status_id

INT

id статусу документа (стан ланцюжка документів)

13

action

VARCHAR

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

14

buyer_uuid

VARCHAR

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

15

consignee_uuid

VARCHAR

вантажоодержувач

16

consignor_uuid

VARCHAR

вантажовідправник

17

customer_uuid

VARCHAR

покупець

18

performer_uuid

VARCHAR

виконавець

19

supplier_uuid

VARCHAR

постачальник

20

delivery_place_uuid

VARCHAR

місце доставки

21

contract_date

VARCHAR

дата договору

22

contract_number

VARCHAR

номер договору

23

delivery_date

M

INT

дата доставки

24

order_number

M

VARCHAR

номер замовлення

25

order_date

INT

дата замовлення

26

return_date

INT

дата повернення

27

summ

VARCHAR

сума з ПДВ

28

parent_chain_hash

MD5

хеш ланцюжка

29

period

VARCHAR

крайня дата підпису документа

31

trans_id

VARCHAR

id транзакції

32

ttn

VARCHAR

номер накладної

33

doc_start_date

VARCHAR

початок терміну підписання документа

34

doc_end_date

VARCHAR

закінчення терміну підписання документа

35

delivery_note_number

VARCHAR

номер накладної

42

contract_gln

VARCHAR

GLN місце доставки при товарному узгодженні (Agreem-> Comdoc)

43

doc_date

INT

дата з документа

44

delivery_agreement_number

VARCHAR

кількість узгоджень

45

delivery_agreement_date

INT

дата узгодження

46

varn

VARCHAR

ЮЗД id документа

47

other_info

TEXT

додаткові дані

48

sub_doc_date

INT

дата підтипу документа

49

sub_doc_number

VARCHAR

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

50

doc_error

TEXT

помилка при роботі з документом

51

doc_info

TEXT

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

52

old_doc_id

INT

id документа

53

sub_status_date

INT

дата статусу документа (стан ланцюжка документів)

54

from_doc_id

INT

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

56

doc_num

VARCHAR

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

57

sender

VARCHAR

GLN відправника

58

recipient

VARCHAR

GLN одержувача

59

file_name

VARCHAR

найменування прикладаємого (вкладення) файлу

60

xml_hash

VARCHAR

хеш змісту документа

61

answer_doc_id

INT

id COMDOC документа відправленного у відповідь

80

identifier

VARCHAR

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

82

compound_number

VARCHAR

складовий номер

85

doc_process

TINYINT

87

users

VARCHAR

88

basis_doc_subtype

INT

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

89

basis_doc_number

INT

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

90

basis_doc_date

INT

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

Тип поля: M - mandatory (обов’язкове до заповнення), O - optional (опціональне)

RESPONSE

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

Приклади

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

{
  "extra_fields": {
    "sender": "4820128010004",
    "doc_num": "ORG00000014",
    "buyer_uuid": "4820128010004",
    "delivery_date": "1551477600",
    "order_number": "6422722fb78c4509b06eac43758e1545",
    "supplier_uuid": "9864065702429",
    "contract_number": "334455",
    "delivery_place_uuid": "4820128019007",
    "order_date": "1550181600",
    "doc_date": "1555432208",
    "action": "29"
  }
}

Приклад тіла відповіді (json):

У цьому методі json-тіло відповіді відсутнє.

Повертаємий текст – «OK»

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

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

За допомогою методу api/eds/docs/search можливо швидко зробити пошук по заданим критеріям, наприклад, отримати список документів з певним статусом, або за проміжок часу.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/docs/search?gln=9864065702429

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

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

{«…»} - тіло http запиту - json з критеріями пошуку (Таблиця_2)

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

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/eds/docs/search?gln=9864065702429“ -d {json с критериями поиска(Таблиця_2)} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 2 - Опис json-параметрів (фільтр) запиту методу API

Параметр

Тип

Формат

Опис

Об’єкт StorageQuery

extraParams

List<ExtraQueryParameters>

масив об’єктів;

multiExtraParams

List<ExtraQueryParameters>

масив об’єктів;

type

M

List<XDocType>

масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа

statuses

M

List<Integer>

масив; список статусів (станів) документів, за якими буде відбуватися відбір: 0 - все 1 - open 2 - sent 3 - delivered 4 - inbox 5 - read 6 - error 7 - deleted

tags

List<Long>

масив; тег

exchangeStatus

O

List<Integer>

масив; статус документообігу

docs

List<Long>

масив; документи

direction

M

Direction

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

limit

O

Limitation

объект; фільтр відбору (налаштування виводу даних)

number

O

String

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

family

O

int

сімейство (EDI / UZD); можливі значення: 1 - edi

partnerId

Long

id роздрібної мережі

chainHash

String

хеш-значення, отримане в результаті обробки ланцюжка

docHash

String

хеш-значення, отримане в результаті обробки документа

docDate

O

DateTimeRange

об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по

docCreate

O

DateTimeRange

об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по

docRead

O

DateTimeRange

об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по

docChanged

O

DateTimeRange

об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по

archive

Boolean

відмітка наявності архівної ознаки документа

important

boolean

відмітка важливий документ

visible

boolean

відмітка видимості

loadBody

boolean

відмітка наявності тіла документа

loadComments

boolean

відмітка наявності коментарів до документа

loadStatuses

boolean

відмітка наявності статусів документа

loadTags

boolean

відмітка наявності тегів документа

loadChain

boolean

відмітка наявності ланцюжка документів

Таблиця 3 - Опис параметрів об’єкта ExtraQueryParameters

Параметр

Тип

Формат

Опис

Об’єкт ExtraQueryParameters

operator

enum (AND, OR)

type

M

enum (EQUALS, EQUALS_UUID, EQUALS_MD5, LIKE, MORE, MORE_EQ, LESS, LESS_EQ, IN)

fieldName

String

найменування параметру

value

String

id параметра

Таблиця 4 - Опис параметрів об’єкта Direction

Параметр

Тип

Формат

Опис

Об’єкт Direction

type

enum (EQ, OR, IN)

тип вибірки; можливі значення: » EQ » / » OR » / » IN » * EQ - відбираються тільки документи в яких збігаються зазначені і sender, і receiver; * OR - відбираються документи в яких збігаються АБО sender, АБО receiver; * IN - відбираються документи в яких sender або receiver один з тих, які вказані в масивах sender і receiver

sender

M/O

List<String>

масив; відправники; GLN відправників - обов’язковий, але може бути порожнім якщо зазначений масив GLN одержувачів (receiver)

receiver

M/O

List<String>

масив; одержувачі; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначений масив GLN відправників (sender)

Таблиця 5 - Опис параметрів об’єкта Limitation

Параметр

Тип

Формат

Опис

Об’єкт Limitation

offset

O

int

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

count

O

int

ліміт вибірки (кількість)

Таблиця 6 - Опис параметрів об’єкта DateTimeRange

Параметр

Тип

Формат

Опис

Об’єкт DateTimeRange

startTimestamp

long

початок часового діапазону

finishTimestamp

long

закінчення часового діапазону

Таблиця 7 - Опис параметрів об’єкта XDocType

Параметр

Тип

Формат

Опис

Об’єкт XDocType

опис_параметрів_

type

int

id типу документа/квитанції

title

String

назва документа/квитанции

description

String

опис документа/квитанції (найменування кирилицею)

Таблиця 8 - Опис fieldName параметрів (объект ExtraQueryParameters)

id параметра

Найменування параметра

Тип

Формат

Опис параметра

1

created_from

UUID

ідентифікатор документа або ланцюжка

2

is_signed

TINYINT

відмітка про підписання

3

encrypted

TINYINT

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

4

comdoc_reestr_id

INT

id факторингового Реєстру на підставі комерційного документа

5

comdoc_reestr_is_active

TINYINT

відмітка про активність факторингового договору

6

ftpex_file_name

VARCHAR

найменування файлу, відправленого по FTP

7

ftpex_file_date

INT

дата/час відправки документа по FTP

8

inv_date

INT

дата документа invrpt (Звіт про інвентаризацію)

9

inv_num

VARCHAR

номер документа invrpt (Звіт про інвентаризацію)

11

sub_doc_type_id

INT

id підтипу документа

12

sub_status_id

INT

id статусу документа (стан ланцюжка документів)

13

action

VARCHAR

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

14

buyer_uuid

VARCHAR

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

15

consignee_uuid

VARCHAR

вантажоодержувач

16

consignor_uuid

VARCHAR

вантажовідправник

17

customer_uuid

VARCHAR

покупець

18

performer_uuid

VARCHAR

виконавець

19

supplier_uuid

VARCHAR

постачальник

20

delivery_place_uuid

VARCHAR

місце доставки

21

contract_date

VARCHAR

дата договору

22

contract_number

VARCHAR

номер договору

23

delivery_date

M

INT

дата доставки

24

order_number

M

VARCHAR

номер замовлення

25

order_date

INT

дата замовлення

26

return_date

INT

дата повернення

27

summ

VARCHAR

сума з ПДВ

28

parent_chain_hash

MD5

хеш ланцюжка

29

period

VARCHAR

крайня дата підпису документа

31

trans_id

VARCHAR

id транзакції

32

ttn

VARCHAR

номер накладної

33

doc_start_date

VARCHAR

початок терміну підписання документа

34

doc_end_date

VARCHAR

закінчення терміну підписання документа

35

delivery_note_number

VARCHAR

номер накладної

42

contract_gln

VARCHAR

GLN місце доставки при товарному узгодженні (Agreem-> Comdoc)

43

doc_date

INT

дата з документа

44

delivery_agreement_number

VARCHAR

кількість узгоджень

45

delivery_agreement_date

INT

дата узгодження

46

varn

VARCHAR

ЮЗД id документа

47

other_info

TEXT

додаткові дані

48

sub_doc_date

INT

дата підтипу документа

49

sub_doc_number

VARCHAR

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

50

doc_error

TEXT

помилка при роботі з документом

51

doc_info

TEXT

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

52

old_doc_id

INT

id документа

53

sub_status_date

INT

дата статусу документа (стан ланцюжка документів)

54

from_doc_id

INT

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

56

doc_num

VARCHAR

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

57

sender

VARCHAR

GLN відправника

58

recipient

VARCHAR

GLN одержувача

59

file_name

VARCHAR

найменування прикладаємого (вкладення) файлу

60

xml_hash

VARCHAR

хеш змісту документа

61

answer_doc_id

INT

id COMDOC документа відправленного у відповідь

80

identifier

VARCHAR

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

82

compound_number

VARCHAR

складовий номер

85

doc_process

TINYINT

87

users

VARCHAR

88

basis_doc_subtype

INT

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

89

basis_doc_number

INT

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

90

basis_doc_date

INT

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

Таблиця 9 - Опис DocType параметрів (объект XDocType)

Тип

Назва

Опис (найменування кирилицею)

0

all

всі

1

invoice

Рахунок

2

orders

Замовлення

3

recadv

Повідомлення про прийом

4

desadv

Повідомлення про відвантаження

5

ordrsp

Підтвердження замовлення

6

pricat

Прайс-лист

10

declar

Податкова накладна

11

insdes

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

13

slsrpt

Звіт про продажі

14

invrpt

Звіт про інвентаризацію

15

coacsu

Акт звірки взаєморозрахунків

16

actset

Акт взаємозаліку

17

iftmin

Інструкція про транспортування

18

retann

Повідомлення про повернення

19

iftmbf

Замовлення транспортування

21

mscons

Звіт про надані послуги

25

retins

Інструкція з повернення

28

comdoc

Комерційний документ

29

declarj12

Коригування до податкової накладної

30

condra

Не структурований документ

42

iftmbc

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

59

documentinvoice

Товарна накладна

67

doccorinvoice

doccorinvoice

75

waybill

Товарно-транспортна накладна (ТТН)

79

addbill

addbill

98

quotes

Додаток до Повідомлення про відвантаження

*Тип* поля: M - mandatory (обов’язкове до заповнення), O - optional (опціональне)

RESPONSE

Таблиця 10 - Опис json-параметрів, які можуть передаватися в відповіді на метод API

Параметр

Формат

Опис

items

List<XDoc_>

масив об’єктів; перелік документів

totalCount

int

кількість документів

Таблиця 11 - Опис параметрів об’єкта XDocStatus

Параметр

Формат

Опис

Об’єкт XDocStatus

детальніше

state

int

id статусу

title

String

статус

Таблиця 12 - Опис параметрів об’єкта XDoc

Таблиця 13 - Опис параметрів об’єкта XTag

Параметр

Формат

Опис

Об’єкт XTag

id

long

id тега

name

String

зміст тега

shortName

String

коротка назва тега

Таблиця 14 - Опис параметрів об’єкта XStatus

Параметр

Формат

Опис

Об’єкт XStatus

docId

long

id документа/квитанції

date

long

дата статусу; формат unix timestamp

type

int

тип статусу

text

String

зміст статусу

Таблиця 15 - Опис параметрів об’єкта XDocSignInfo

Параметр

Формат

Опис

Об’єкт XDocSignInfo

doc_id

long

id документа/квитанції

date

long

дата підписання; формат unix timestamp

count

short

кількість підписів

info

String

додаткова інформація

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 16 - Опис параметрів об’єкта XDocCommentsList

Параметр

Формат

Опис

Об’єкт XDocCommentsList

XDocCommentsList

List<XDocComment>

масив об’єктів; коментарі до документа

Таблиця 17 - Опис параметрів об’єкта XDocComment

Параметр

Формат

Опис

Об’єкт XDocComment

id

long

id коментаря

docUUID

UUID

унікальний ідентифікатор документа

createTimestamp

long

дата створення коментаря у форматі timestamp

authorLogin

String

автор коментаря

comment

String

зміст коментаря

Таблиця 18 - Опис параметрів об’єкта XDocAttachment

Параметр

Формат

Опис

Об’єкт XDocAttachment

id

long

id вкладення

docUUID

UUID

унікальний ідентифікатор документа

fileName

String

найменування файлу

createDate

long

дата створення вкладення; формат unix timestamp

type

String

тип вкладення

base64content

String

зміст вкладення в BASE64

content

byte[]

зміст вкладення в цілочисельному вигляді

Таблиця 19 - Опис параметрів об’єкта XDocBodyForms

Параметр

Формат

Опис

Об’єкт XDocBodyForms

forms

HashMap<String, XDocBody>

масив об’єктів; тіло документа

Таблиця 20 - Опис параметрів об’єкта XDocBody

Параметр

Формат

Опис

Об’єкт XDocBody

type

XDocBodyType

об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6

base64content

String

зміст тіла документа в BASE64

Таблиця 21 - Опис параметрів об’єкта XDocBodyType

Параметр

Формат

Опис

Об’єкт XDocBodyType

id

int

id типу тіла документа

name

String

назва типу тіла документа

Таблиця 22 - Опис DocStatus параметрів (об’єкт XDocStatus)

id статусу

статус

0

ALL - будь-який статус

1

OPEN - чернетка (відправник)

2

SENT - відправлений (відправник)

3

DELIVERED - прочитаний (відправник)

4

INBOX - доставлений / вхідний (одержувач)

5

READ - прочитаний (одержувач)

6

ERROR - помилка

7

DELETED - видалений

Приклади (json)

Отримати всі вхідні (отримані) документи на певний GLN без чернеток (масив statuses не містить «1»)
{
    "direction": {
        "sender": [],
        "receiver": [
            "9864232304302"
        ],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вхідні (відправлені) документи на певний GLN без чернеток (масив statuses не містить «1»)
{
    "direction": {
        "sender": [
            "9864232304302"
        ],
        "receiver": [],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вхідні (отримані) документи на певний GLN без чернеток (масив statuses не містить «1»), у яких номер містить підрядок «1001»
{
    "direction": {
        "sender": [],
        "receiver": [
            "9864232304302"
        ],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "number": "1001",
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вихідні (відправлені) документи по GLN без чернеток (масив statuses не містить «1»), які створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp)
{
    "direction": {
        "sender": [
            "9864232304302"
        ],
        "receiver": [],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ],
    "docDate": {
        "startTimestamp": "1556668800",
        "finishTimestamp": "1559347199"
    }
}

Приклад тіла відповіді (json):

{
    "items": [
        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 1017,
            "doc_uuid": "e18a05d5-983b-4ebc-95f3-c35eccc7d611",
            "uuidSender": "4820128010004",
            "uuidReceiver": "9864065702429",
            "docNumber": "8663c3f48bea4f96a281238e847b1639",
            "dateCreated": 1549961913,
            "dateChanged": 1549961913,
            "dateRead": 0,
            "docDate": 1547503200,
            "chain_id": 1006,
            "chain_uuid": "60e487d3-871f-4b3a-9254-1d3f0e7a032f",
            "family": 1,
            "hash": "30745386780343D0C2F4C65C7F06D60F",
            "type": {
                "type": 1,
                "title": "invoice",
                "description": "Счет"
            },
            "status": {
                "status": 4,
                "title": "inbox"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "order_date": "1551477600",
                "delivery_date": "1547503200",
                "ftpex_file_name": "highload_invoice_test.xml",
                "sender": "4820128010004",
                "buyer_uuid": "4820128010004",
                "doc_num": "8663c3f48bea4f96a281238e847b1639",
                "order_number": "747401",
                "doc_date": "1547503200",
                "recipient": "9864065702429",
                "ftpex_file_date": "1549961913",
                "supplier_uuid": "9864065702429",
                "delivery_place_uuid": "4820128019007"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        }
    ],
    "totalCount": 0
}

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

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

За допомогою методу api/eds/chain і заданих параметрів можливо отримати (вивантажити) необхідні дані конкретного ланцюжка документів.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/chain?gln=9864065702429&chain_uuid=9fe45d32-35c7-44d0-9131-7257fc0c0f39&load_docs=true&load_bodies=true&load_package=true&load_comments=true&load_tags=true&load_statuses=true

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

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

chain_uuid - рядок; ID ланцюжка

Опціональні url-параметри (boolean фільтри):

load_docs - чи завантажувати документи, що відносяться до ланцюжка

load_bodies - чи завантажувати тіла документів

load_package - чи завантажувати пакети

load_comments - чи завантажувати коментарі

load_tags - чи завантажувати теги до документів

load_statuses - чи завантажувати статуси до документів

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/eds/chain?gln=9864065702429&chain_uuid=9fe45d32-35c7-44d0-9131-7257fc0c0f39&load_docs=true&load_bodies=true&load_package=true&load_comments=true&load_tags=true&load_statuses=true“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Таблиця 5 - Опис параметрів об’єкта XChainStatus)

Параметр

Формат

Опис

Об’єкт XChainStatus

state

int

id статусу

title

String

статус

Таблиця 6 - Опис параметрів об’єкта XDocStatus)

Параметр

Формат

Опис

Об’єкт XDocStatus

детальніше

state

int

id статусу

title

String

статус

Таблиця 7 - Опис параметрів об’єкта XDoc)

Таблиця 8 - Опис параметрів об’єкта XTag)

Параметр

Формат

Опис

Об’єкт XTag

id

long

id тега

name

String

зміст тега

shortName

String

коротка назва тега

Таблиця 9 - Опис параметрів об’єкта XStatus)

Параметр

Формат

Опис

Об’єкт XStatus

docId

long

id документа/квитанції

date

long

дата статусу; формат unix timestamp

type

int

тип статусу

text

String

зміст статусу

Таблиця 10 - Опис параметрів об’єкта XDocSignInfo)

Параметр

Формат

Опис

Об’єкт XDocSignInfo

doc_id

long

id документа/квитанції

date

long

дата підписання; формат unix timestamp

count

short

кількість підписів

info

String

додаткова інформація

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 11 - Опис параметрів об’єкта XDocCommentsList)

Параметр

Формат

Опис

Об’єкт XDocCommentsList

XDocCommentsList

List<XDocComment>

масив об’єктів; коментарі до документа

Таблиця 12 - Опис параметрів об’єкта XDocComment)

Параметр

Формат

Опис

Об’єкт XDocComment

id

long

id коментаря

docUUID

UUID

унікальний ідентифікатор документа

createTimestamp

long

дата створення коментаря у форматі timestamp

authorLogin

String

автор коментаря

comment

String

зміст коментаря

Таблиця 13 - Опис параметрів об’єкта XDocAttachment)

Параметр

Формат

Опис

Об’єкт XDocAttachment

id

long

id вкладення

docUUID

UUID

унікальний ідентифікатор документа

fileName

String

найменування файлу

createDate

long

дата створення вкладення; формат unix timestamp

type

String

тип вкладення

base64content

String

зміст вкладення в BASE64

content

byte[]

зміст вкладення в цілочисельному вигляді

Таблиця 14 - Опис параметрів об’єкта XDocBodyForms)

Параметр

Формат

Опис

Об’єкт XDocBodyForms

forms

HashMap<String, XDocBody>

масив об’єктів; тіло документа

Таблиця 15 - Опис параметрів об’єкта XDocBody)

Параметр

Формат

Опис

Об’єкт XDocBody

type

XDocBodyType

об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6

base64content

String

зміст тіла документа в BASE64

Таблиця 16 - Опис параметрів об’єкта XDocBodyType)

Параметр

Формат

Опис

Об’єкт XDocBodyType

id

int

id типу тіла документа

name

String

назва типу тіла документа

Таблиця 17 - Опис параметрів об’єкта XDocType)

Параметр

Тип

Формат

Опис

Об’єкт XDocType

опис_параметрів

type

int

id типу документа/квитанції

title

String

назва документа/квитанции

description

String

опис документа/квитанції (найменування кирилицею)

Таблиця 18 - Опис DocStatus параметрів (об’єкт XDocStatus)

id статусу

статус

0

ALL - будь-який статус

1

OPEN - чернетка (відправник)

2

SENT - відправлений (відправник)

3

DELIVERED - прочитаний (відправник)

4

INBOX - доставлений / вхідний (одержувач)

5

READ - прочитаний (одержувач)

6

ERROR - помилка

7

DELETED - видалений

Таблиця 19 - Опис DocType параметрів (об’єкт XDocType)

Тип

Назва

Опис (найменування кирилицею)

0

all

всі

1

invoice

Рахунок

2

orders

Замовлення

3

recadv

Повідомлення про прийом

4

desadv

Повідомлення про відвантаження

5

ordrsp

Підтвердження замовлення

6

pricat

Прайс-лист

10

declar

Податкова накладна

11

insdes

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

13

slsrpt

Звіт про продажі

14

invrpt

Звіт про інвентаризацію

15

coacsu

Акт звірки взаєморозрахунків

16

actset

Акт взаємозаліку

17

iftmin

Інструкція про транспортування

18

retann

Повідомлення про повернення

19

iftmbf

Замовлення транспортування

21

mscons

Звіт про надані послуги

25

retins

Інструкція з повернення

28

comdoc

Комерційний документ

29

declarj12

Коригування до податкової накладної

30

condra

Не структурований документ

42

iftmbc

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

59

documentinvoice

Товарна накладна

67

doccorinvoice

doccorinvoice

75

waybill

Товарно-транспортна накладна (ТТН)

79

addbill

addbill

98

quotes

Додаток до Повідомлення про відвантаження

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклади url-запитів:

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

Приклад тіла відповіді (json):

{
    "id": 1,
    "uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
    "packageID": 0,
    "type": {
        "type": 5,
        "title": "ordrsp",
        "description": "Подтверждение заказа"
    },
    "docsCount": 13,
    "lastInDocID": 1,
    "lastOutDocID": 29,
    "partnerId": 0,
    "important": false,
    "status": {
        "status": 2,
        "title": "sent"
    },
    "visualStatus": 0,
    "archive": false,
    "childs": [
        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 1,
            "doc_uuid": "bf8dacb1-7b61-4c9c-ab36-ac37620db051",
            "uuidSender": "9864232304319",
            "uuidReceiver": "9864232304302",
            "docNumber": "1001",
            "dateCreated": 1555487166,
            "dateChanged": 1555487166,
            "dateRead": 1555497325,
            "docDate": 1555448400,
            "chain_id": 1,
            "chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
            "family": 1,
            "hash": "A1FF5B519289B936A09E99514277F429",
            "type": {
                "type": 2,
                "title": "orders",
                "description": "Заказ"
            },
            "status": {
                "status": 5,
                "title": "read"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "sub_doc_type_id": "2",
                "buyer_uuid": "9864232304319",
                "doc_num": "1001",
                "order_number": "1001",
                "ftpex_file_date": "1555487160",
                "supplier_uuid": "9864232304302",
                "delivery_place_uuid": "9864232304562",
                "order_date": "1555448400",
                "delivery_date": "1556485200",
                "ftpex_file_name": "order_20190417104600_475593380.xml",
                "contract_number": "Дог 1",
                "sender": "9864232304319",
                "doc_date": "1555448400",
                "recipient": "9864232304302",
                "action": "0"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        },

        ...

        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 29,
            "doc_uuid": "cb2f183f-ccbc-467b-9eb2-90b2c1ff8f5c",
            "uuidSender": "9864232304302",
            "uuidReceiver": "9864232304319",
            "docNumber": "АФ00-000001",
            "dateCreated": 1556115021,
            "dateChanged": 1556115022,
            "dateRead": 0,
            "docDate": 1556116482,
            "chain_id": 1,
            "chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
            "family": 1,
            "hash": "0F9CEEC0717992EB76A848F2E106D2D0",
            "type": {
                "type": 5,
                "title": "ordrsp",
                "description": "Подтверждение заказа"
            },
            "status": {
                "status": 2,
                "title": "sent"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "order_date": "1555448400",
                "delivery_date": "1556485200",
                "contract_number": "Дог 1",
                "sender": "9864232304319",
                "buyer_uuid": "9864232304319",
                "doc_num": "АФ00-000001",
                "order_number": "1001",
                "doc_date": "1556116482",
                "action": "4",
                "supplier_uuid": "9864232304302",
                "delivery_place_uuid": "9864232304562"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        }
    ],
    "hash": "ABB416F3FF3B5027D212D62DD9F99E94"
}

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

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

За допомогою методу api/eds/doc/body можливо швидко отримати контент документа без підписів/печаток, а також тіло підпису, тіло печатки. У запиті повинен бути присутнім ідентифікатор авторизованого користувача (GLN), ID документа (doc_uuid), тип тіла документа.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/doc/body?gln=9864065702429&doc_uuid=97c06d02-7c3c-4467-aaac-4a808078609f&body_type=JSON&response_type=base64

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

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

body_type - тип тіла документа; можливі значення: - CONTENT: base64 контенту без підписів/печаток - JSON: json документа - SIGN: base64 тіло підпису - STAMP: base64 тіло печатки - CRYPTED: шифровані вихідні дані

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/eds/doc/body?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&body_type=JSON“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

В відповіді в json-тілі передається рядок значень в форматі Base64.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

У цьому методі в json-тілі відповіді передається рядок значень в форматі Base64.

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

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

За допомогою метода api/oas/user можливо отримати інформацію про користувача, наприклад ID користувача, ID аккаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу і інші ідентифікатори.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/user

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/user“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт User

id

long

id користувача; число

accountId

long

id аккаунта

login

String

логін користувача; рядок 50 символів

stringEmails

String

E-mail; рядок 255 символів

emails

List<String>

масив адрес E-mail

blocked

int

відмітка про блокування; число; 0 - немає, 1 - так

allowFTP

int

відмітка доступу до FTP; число; 0 - немає, 1 - так

autoSending

boolean

автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)

statusFile

int

створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання

isAdmin

boolean

відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

{
  "id": 5020571,
  "accountId": 29824,
  "login": "uaEDSsender",
  "stringEmails": "test@qw.we",
  "emails": [
    "test@qw.we"
  ],
  "blocked": 0,
  "allowFTP": 1,
  "autoSending": true,
  "statusFile": 1,
  "isAdmin": false,
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [

    ],
    "companies": [

    ],
    "users": [

    ]
  },
  "identificators": [
    {
      "guid": {

      },
      "manager": "#",
      "id": 133187,
      "gln": "9864065702429",
      "companyId": 29824,
      "retailerId": 0,
      "name": "EDS_1",
      "companyType": "jur",
      "companyInn": "1010101010",
      "companyKpp": "90000031",
      "zip": "112233",
      "city": "г. Львов",
      "street": "ул. Хмурится, 6",
      "phone": "#",
      "otherInfo": "[]",
      "account": {
        "platform": "EVO",
        "id": 29824,
        "name": "Test_EDS1",
        "ownership": "#",
        "inn": "1010101010",
        "kpp": "100000001",
        "mail": "test@qw.we",
        "phone": "12345678901",
        "ndsNumber": "#",
        "bankAccount": "#",
        "bankName": "#",
        "bankMfo": "#",
        "bankAddress": "#",
        "identificators": [

        ],
        "companies": [

        ],
        "users": [

        ]
      }
    }
  ]
}

Отримання інформації по GLN номерами, пов’язаним з авторизованим користувачем (на рівні аккаунту)

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

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

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/account/identifiers

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/account/identifiers“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт Identificator

guid

String

GUID організації

taxNum

String

Податковий ідентифікаційний номер; рядок 50 символів

ndsNum

String

№ свідоцтва ПДВ; рядок 50 символів

manager

String

ПІБ менеджера; рядок 100 символів

accountant

String

ПІБ бухгалтера; рядок 100 символів

id

long

ID користувача

gln

String

GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів

companyId

long

id аккаунта; число

retailerId

long

id мережі (ритейлера); число

name

String

назва організації; рядок 100 символів

companyType

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

companyInn

String

код ІПН компанії; рядок 50 символів

companyKpp

String

код ЄДРПОУ/КПП; рядок 50 символів

companyOgrn

String

Основний Державний Реєстраційний Номер; рядок 15 символів

companyTaxDepartmentID

String

ідентифікатор відділення податкової інспекції

dirLastName

String

прізвище директора; рядок 150 символів

dirFirstName

String

ім’я директора; рядок 150 символів

apartment

String

квартира; рядок 20 символів

zip

String

поштовий індекс; рядок 20 символів

city

String

місто; рядок 50 символів

street

String

назва вулиці; рядок 100 символів

regionCode

String

код регіону; рядок 3 символу

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

phone

String

№ телефону; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

otherInfo

String

коментарі

email

String

E-mail; рядок 255 символів

metroCode

String

код точки доставки; рядок 20 символів

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

  [
{
  "guid": {},
  "manager": "#",
  "id": 133187,
  "gln": "9864065702429",
  "companyId": 29824,
  "retailerId": 0,
  "name": "EDS_1",
  "companyType": "jur",
  "companyInn": "1010101010",
  "companyKpp": "90000031",
  "zip": "112233",
  "city": "г. Львов",
  "street": "ул. Хмурится, 6",
  "phone": "#",
  "otherInfo": "[]",
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [],
    "companies": [],
    "users": []
  }
}
]

Отримання переліку роздрібних мереж, які пов’язані із заданим GLN

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/oas/retailers можливо отримати перелік всіх роздрібних мереж-контрагентів користувача.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про роздрібні мережі

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

id

long

ідентифікатор роздрібної мережі

name

String

найменування роздрібної мережі

gln

String

GLN роздрібної мережі

aliasName

String

брендування роздрібної мережі

type

String

тип/ознака роздрібної мережі (type=1)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
{
    "id": 9,
    "name": "АТБ-маркет",
    "gln": "4820128010004",
    "aliasName": "АТБ-маркет",
    "type": 1
},
{
    "id": 17,
    "name": "Метро",
    "gln": "4820086630009",
    "aliasName": "Метро",
    "type": 1
},
{
    "id": 39,
    "name": "Край",
    "gln": "4820104810017",
    "aliasName": "Край",
    "type": 1
},
{
    "id": 55,
    "name": "Ватсонс",
    "gln": "4829900001605",
    "aliasName": "Ватсонс",
    "type": 1
},
{
    "id": 56,
    "name": "ЕпіцентрК (НЕАКТУАЛЬНО)",
    "gln": "9991027012934",
    "type": 1
}
]

Отримання переліку GLN номерів, які пов’язані із заданою роздрібною мережею

Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html`__ .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/retailer/identificators?retailer_id=11

Параметры, передаваемые в URL (вместе с адресом метода)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

retailer_id - число; ідентифікатор роздрібної мережі (з попередніх методів)

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „/api/oas/retailer/identificators?retailer_id=11“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про контрагентів

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт Identificator

guid

String

GUID організації

taxNum

String

Податковий ідентифікаційний номер; рядок 50 символів

ndsNum

String

№ свідоцтва ПДВ; рядок 50 символів

manager

String

ПІБ менеджера; рядок 100 символів

accountant

String

ПІБ бухгалтера; рядок 100 символів

id

long

ID користувача

gln

String

GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів

companyId

long

id аккаунта; число

retailerId

long

id мережі (ритейлера); число

name

String

назва організації; рядок 100 символів

companyType

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

companyInn

String

код ІПН компанії; рядок 50 символів

companyKpp

String

код ЄДРПОУ/КПП; рядок 50 символів

companyOgrn

String

Основний Державний Реєстраційний Номер; рядок 15 символів

companyTaxDepartmentID

String

ідентифікатор відділення податкової інспекції

dirLastName

String

прізвище директора; рядок 150 символів

dirFirstName

String

ім’я директора; рядок 150 символів

apartment

String

квартира; рядок 20 символів

zip

String

поштовий індекс; рядок 20 символів

city

String

місто; рядок 50 символів

street

String

назва вулиці; рядок 100 символів

regionCode

String

код регіону; рядок 3 символу

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

phone

String

№ телефону; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

otherInfo

String

коментарі

email

String

E-mail; рядок 255 символів

metroCode

String

код точки доставки; рядок 20 символів

Таблиця 2 - Опис параметрів об’єкта Account)

Параметр

Формат

Опис

Об’єкт Account

accountId

long

ID аккаунта

companyId

long

ID компанії

company

Company

об’єкт; дані про компанію

mfo

String

МФО банку

paymentAccount

String

розрахунковий рахунок

tariffId

int

ID тарифу

fullName

String

ПІП користувача

phone

String

телефон

email

String

Email

dirPosition

String

посада директора

activityBase

String

підстава діяльності

isIndivOffer

int

відмітка про наявність індивідуального договору; 0 - нет, 1 - есть

adminAccountId

long

ID аккаунта в Адмінці

addInfo

String

додаткова інформація

whiteList

List<String>

масив; список білих ip адрес

decryptType

int

тип розшифровки; 1 - WEB; 2 - Cryptex

cryptexServer

String

адреса cryptex-сервера на стороні клієнта

status

int

статус; 0 - заблокований; 1 - активний

accountInfo

AccountInfo_

об’єкт; додаткова інформація про аккаунт

adminAccount

AdminAccount_

об’єкт; данні по аккаунту в Адмінці

Таблиця 3 - Опис параметрів об’єкта Company)

Параметр

Формат

Опис

Об’єкт Company

id

long

id компанії; число

account

Account

об’єкт; дані аккаунта

name

String

повне найменування організації або ПІБ індивідуального підприємця

ownership

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

edrpou

String

код ЄДРПОУ/КПП; рядок 50 символів

inn

String

код ІПН; рядок 50 символів

mail

String

пошта

phone

String

№ телефону; рядок 50 символів

ndsNumber

String

№ свідоцтва ПДВ; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

bankAddress

String

адреса банку; рядок 150 символів

users

List<User>

масив об’єктів;

Таблиця 4 - Опис параметрів об’єкта User)

Параметр

Формат

Опис

Об’єкт User

id

long

id користувача; число

accountId

long

id аккаунта

login

String

логін користувача; рядок 50 символів

stringEmails

String

E-mail; рядок 255 символів

emails

List<String>

масив адрес E-mail

blocked

int

відмітка про блокування; число; 0 - немає, 1 - так

allowFTP

int

відмітка доступу до FTP; число; 0 - немає, 1 - так

autoSending

boolean

автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)

statusFile

int

створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання

isAdmin

boolean

відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
    {
        "guid": {},
        "id": 82208,
        "gln": "5790000017089",
        "companyId": 19,
        "retailerId": 16404,
        "name": "ECCO - EDITEL",
        "companyInn": "№",
        "companyKpp": "№",
        "city": "№",
        "street": "№",
        "account": {
            "platform": "EVO",
            "id": 19,
            "name": "eXite-Ukraine",
            "ownership": "ФОП",
            "inn": "-",
            "kpp": "#",
            "mail": "DikhtyarZ@exite-edi.com",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    },
    {
        "guid": {},
        "manager": "#",
        "id": 126701,
        "gln": "5790000833054",
        "companyId": 19,
        "retailerId": 16404,
        "name": "ECCO - EDITEL SUPPLIER",
        "companyInn": "#",
        "companyKpp": "#",
        "zip": "#",
        "city": "#",
        "street": "#",
        "phone": "#",
        "account": {
            "platform": "EVO",
            "id": 19,
            "name": "eXite-Ukraine",
            "ownership": "ФОП",
            "inn": "-",
            "kpp": "#",
            "mail": "DikhtyarZ@exite-edi.com",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    }
]

Отримання переліку всіх мереж

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/oas/allretailers можливо отримати список всіх мереж, пов’язаних з авторизованим користувачем.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/allretailers

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/allretailers“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

id

число

ідентифікатор роздрібної мережі

name

рядок

ім’я роздрібної мережі

gln

рядок (13)

номер GLN організації

aliasName

рядок

бренд ТЗ, альтернативне ім’я

type

число

тип мережі, 1 - пряма, 2 - роумінгова

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно).

Приклад тіла відповіді (json):

[
  {
    "id": 7,
    "name": "Варус (ОМЕГА)",
    "gln": "4820110632160",
    "aliasName": "Варус(ОМЕГА))",
    "type": 1
  },
  {
    "id": 8,
    "name": "Старый Колос",
    "gln": "4829900003845",
    "aliasName": "Олд_Колос",
    "type": 1
  },
  {
    "id": 9,
    "name": "АТБ-маркет",
    "gln": "4820128010004",
    "aliasName": "АТБ-маркет",
    "type": 1
  },
  {
    "id": 17297,
    "name": "Интеграция",
    "gln": "1234567890123",
    "aliasName": "Интеграция",
    "type": 2
  }
]

Отримання переліку доступних одиниць виміру

Для роботи з цим методом користувач повинен бути авторизованим .

Метод api/oas/units дозволяє відобразити довідник одиниць виміру.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/units

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/units“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про доступні одиницях вимірювань

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

id

long

ідентифікатор одиниці виміру

name

String

найменування

nameOKEI

String

найменування згідно державного класифікатора

shortNameOKEI

String

сокращение згідно державного класифікатора

OKEI

String

код державного класифікатора

KSPOVO

String

код КСПОВО

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
{
    "id": 1,
    "name": "GRM",
    "nameOKEI": "Грамм",
    "shortNameOKEI": "г",
    "OKEI": "163",
    "KSPOVO": "0303"
},
{
    "id": 2,
    "name": "KGM",
    "nameOKEI": "Килограмм",
    "shortNameOKEI": "кг",
    "OKEI": "166",
    "KSPOVO": "0301"
},
{
    "id": 3,
    "name": "LTR",
    "nameOKEI": "Литр",
    "shortNameOKEI": "л",
    "OKEI": "112",
    "KSPOVO": "0138"
},
...
{
    "id": 45,
    "name": "OD",
    "nameOKEI": "Единица (продукции)",
    "shortNameOKEI": "од",
    "KSPOVO": "2431"
}
]

Отримання інформації про організацію по Назві/ІПН/КПП/GLN

Для роботи з цим методом користувач повинен бути авторизованим .

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального аккаунта.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/identifiers

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

query - рядок; назва/ІПН/КПП/GLN організації; «Над яким здійснюється дія»

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/identifiers?gln=9864065702429&query=EDS_1“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт Identificator

guid

String

GUID організації

taxNum

String

Податковий ідентифікаційний номер; рядок 50 символів

ndsNum

String

№ свідоцтва ПДВ; рядок 50 символів

manager

String

ПІБ менеджера; рядок 100 символів

accountant

String

ПІБ бухгалтера; рядок 100 символів

id

long

ID користувача

gln

String

GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів

companyId

long

id аккаунта; число

retailerId

long

id мережі (ритейлера); число

name

String

назва організації; рядок 100 символів

companyType

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

companyInn

String

код ІПН компанії; рядок 50 символів

companyKpp

String

код ЄДРПОУ/КПП; рядок 50 символів

companyOgrn

String

Основний Державний Реєстраційний Номер; рядок 15 символів

companyTaxDepartmentID

String

ідентифікатор відділення податкової інспекції

dirLastName

String

прізвище директора; рядок 150 символів

dirFirstName

String

ім’я директора; рядок 150 символів

apartment

String

квартира; рядок 20 символів

zip

String

поштовий індекс; рядок 20 символів

city

String

місто; рядок 50 символів

street

String

назва вулиці; рядок 100 символів

regionCode

String

код регіону; рядок 3 символу

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

phone

String

№ телефону; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

otherInfo

String

коментарі

email

String

E-mail; рядок 255 символів

metroCode

String

код точки доставки; рядок 20 символів

Таблиця 2 - Опис параметрів об’єкта Account)

Параметр

Формат

Опис

Об’єкт Account

accountId

long

ID аккаунта

companyId

long

ID компанії

company

Company

об’єкт; дані про компанію

mfo

String

МФО банку

paymentAccount

String

розрахунковий рахунок

tariffId

int

ID тарифу

fullName

String

ПІП користувача

phone

String

телефон

email

String

Email

dirPosition

String

посада директора

activityBase

String

підстава діяльності

isIndivOffer

int

відмітка про наявність індивідуального договору; 0 - нет, 1 - есть

adminAccountId

long

ID аккаунта в Адмінці

addInfo

String

додаткова інформація

whiteList

List<String>

масив; список білих ip адрес

decryptType

int

тип розшифровки; 1 - WEB; 2 - Cryptex

cryptexServer

String

адреса cryptex-сервера на стороні клієнта

status

int

статус; 0 - заблокований; 1 - активний

accountInfo

AccountInfo_

об’єкт; додаткова інформація про аккаунт

adminAccount

AdminAccount_

об’єкт; данні по аккаунту в Адмінці

Таблиця 3 - Опис параметрів об’єкта Company)

Параметр

Формат

Опис

Об’єкт Company

id

long

id компанії; число

account

Account

об’єкт; дані аккаунта

name

String

повне найменування організації або ПІБ індивідуального підприємця

ownership

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

edrpou

String

код ЄДРПОУ/КПП; рядок 50 символів

inn

String

код ІПН; рядок 50 символів

mail

String

пошта

phone

String

№ телефону; рядок 50 символів

ndsNumber

String

№ свідоцтва ПДВ; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

bankAddress

String

адреса банку; рядок 150 символів

users

List<User>

масив об’єктів;

Таблиця 4 - Опис параметрів об’єкта User)

Параметр

Формат

Опис

Об’єкт User

id

long

id користувача; число

accountId

long

id аккаунта

login

String

логін користувача; рядок 50 символів

stringEmails

String

E-mail; рядок 255 символів

emails

List<String>

масив адрес E-mail

blocked

int

відмітка про блокування; число; 0 - немає, 1 - так

allowFTP

int

відмітка доступу до FTP; число; 0 - немає, 1 - так

autoSending

boolean

автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)

statusFile

int

створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання

isAdmin

boolean

відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

  [
{
  "guid": {},
  "manager": "#",
  "id": 133187,
  "gln": "9864065702429",
  "companyId": 29824,
  "retailerId": 0,
  "name": "EDS_1",
  "companyType": "jur",
  "companyInn": "1010101010",
  "companyKpp": "90000031",
  "zip": "112233",
  "city": "г. Львов",
  "street": "ул. Хмурится, 6",
  "phone": "#",
  "otherInfo": "[]",
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [],
    "companies": [],
    "users": []
  }
}
]

API v2

Авторизація

Після підключення послуги для роботи з API, користувач отримує логін, пароль і api_key для авторизації. Авторизація API відбувається за допомогою передачі цих ключових параметрів в HTTP POST запиті:

  • email - рядок; логін користувача;

  • password - рядок, пароль користувача на платформі EDIN 2.0

  • api_key - рядок, пароль доступу до API

Після авторизації відбувається передача унікального cookie токена «SID». HTTP-заголовок відповіді сервера в вигляді «Set-Cookie» використовується для подальшої відправки файлів «Cookie». В кожному наступному запиті (виклику методу) повинен бути присутнім HTTP-заголовок (Header) «Cookie», який для коректного виконання запитів повинен містити токен «SID» зі значенням, отриманим при авторизації.

В сучасних популярних браузерах і Rest клієнтах відбувається автоматичне збереження і передача токена на сервер під час сесії, однак при використанні деяких інтеграційних рішень, самописних REST-клієнтів цей обов’язковий параметр може не передаватись - його необхідно примусово передавати в заголовку (Header) «Cookie». Після авторизації час життя сесії при бездіяльності користувача становить 10 хвилин.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/authorization

Параметри, що передаються в URL (разом з адресою методу)

Обов’язкові параметри:

email - рядок; логін користувача;

password - рядок, пароль користувача на платформі EDIN 2.0

api_key - рядок, пароль доступу до API

При авторизації json-тіло запиту відсутнє (інші дані передавати не потрібно). При успішній авторизації отримуємо у відповідь «токен» (наприклад,``“SID=65daca25-74ba-4c85-8183-71b404a348c0“`` ), необхідний для подальшої роботи.

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/oas/authorization“ -d „email=uaEDSsender&password=111&api_key=66B4814DEC28B4CA17DE56338A52D7DB“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

Перевірки

Доступні методи для перевірки активності сесії та сервера:

Перевірка активності сервера (метод не потребує проходження авторизації):

Метод запиту

HTTP GET

URL запиту

https://edo-v2.edi-n.com/ping

Підказка

Також можливо виконати запит у вигляді curl-рядка: curl -X GET „https://edo-v2.edi-n.com/ping“

Перевірка активності сесії:

Метод запиту

HTTP GET

URL запиту

https://edo-v2.edi-n.com/api/auth_check

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка: curl -X GET „https://edo-v2.edi-n.com/api/auth_check“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

Робота з довідниками

Отримання інформації по авторизованому користувачеві

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою метода api/oas/user можливо отримати інформацію про користувача, наприклад ID користувача, ID аккаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу і інші ідентифікатори.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/user

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/user“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт User

id

long

id користувача; число

accountId

long

id аккаунта

login

String

логін користувача; рядок 50 символів

stringEmails

String

E-mail; рядок 255 символів

emails

List<String>

масив адрес E-mail

blocked

int

відмітка про блокування; число; 0 - немає, 1 - так

allowFTP

int

відмітка доступу до FTP; число; 0 - немає, 1 - так

autoSending

boolean

автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)

statusFile

int

створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання

isAdmin

boolean

відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

{
  "id": 5020571,
  "accountId": 29824,
  "login": "uaEDSsender",
  "stringEmails": "test@qw.we",
  "emails": [
    "test@qw.we"
  ],
  "blocked": 0,
  "allowFTP": 1,
  "autoSending": true,
  "statusFile": 1,
  "isAdmin": false,
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [

    ],
    "companies": [

    ],
    "users": [

    ]
  },
  "identificators": [
    {
      "guid": {

      },
      "manager": "#",
      "id": 133187,
      "gln": "9864065702429",
      "companyId": 29824,
      "retailerId": 0,
      "name": "EDS_1",
      "companyType": "jur",
      "companyInn": "1010101010",
      "companyKpp": "90000031",
      "zip": "112233",
      "city": "г. Львов",
      "street": "ул. Хмурится, 6",
      "phone": "#",
      "otherInfo": "[]",
      "account": {
        "platform": "EVO",
        "id": 29824,
        "name": "Test_EDS1",
        "ownership": "#",
        "inn": "1010101010",
        "kpp": "100000001",
        "mail": "test@qw.we",
        "phone": "12345678901",
        "ndsNumber": "#",
        "bankAccount": "#",
        "bankName": "#",
        "bankMfo": "#",
        "bankAddress": "#",
        "identificators": [

        ],
        "companies": [

        ],
        "users": [

        ]
      }
    }
  ]
}
Отримання інформації по GLN номерами, пов’язаним з авторизованим користувачем (на рівні аккаунту)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального аккаунта.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/account/identifiers

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/account/identifiers“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт Identificator

guid

String

GUID організації

taxNum

String

Податковий ідентифікаційний номер; рядок 50 символів

ndsNum

String

№ свідоцтва ПДВ; рядок 50 символів

manager

String

ПІБ менеджера; рядок 100 символів

accountant

String

ПІБ бухгалтера; рядок 100 символів

id

long

ID користувача

gln

String

GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів

companyId

long

id аккаунта; число

retailerId

long

id мережі (ритейлера); число

name

String

назва організації; рядок 100 символів

companyType

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

companyInn

String

код ІПН компанії; рядок 50 символів

companyKpp

String

код ЄДРПОУ/КПП; рядок 50 символів

companyOgrn

String

Основний Державний Реєстраційний Номер; рядок 15 символів

companyTaxDepartmentID

String

ідентифікатор відділення податкової інспекції

dirLastName

String

прізвище директора; рядок 150 символів

dirFirstName

String

ім’я директора; рядок 150 символів

apartment

String

квартира; рядок 20 символів

zip

String

поштовий індекс; рядок 20 символів

city

String

місто; рядок 50 символів

street

String

назва вулиці; рядок 100 символів

regionCode

String

код регіону; рядок 3 символу

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

phone

String

№ телефону; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

otherInfo

String

коментарі

email

String

E-mail; рядок 255 символів

metroCode

String

код точки доставки; рядок 20 символів

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

  [
{
  "guid": {},
  "manager": "#",
  "id": 133187,
  "gln": "9864065702429",
  "companyId": 29824,
  "retailerId": 0,
  "name": "EDS_1",
  "companyType": "jur",
  "companyInn": "1010101010",
  "companyKpp": "90000031",
  "zip": "112233",
  "city": "г. Львов",
  "street": "ул. Хмурится, 6",
  "phone": "#",
  "otherInfo": "[]",
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [],
    "companies": [],
    "users": []
  }
}
]
Отримання переліку роздрібних мереж, які пов’язані із заданим GLN

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/oas/retailers можливо отримати перелік всіх роздрібних мереж-контрагентів користувача.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про роздрібні мережі

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

id

long

ідентифікатор роздрібної мережі

name

String

найменування роздрібної мережі

gln

String

GLN роздрібної мережі

aliasName

String

брендування роздрібної мережі

type

String

тип/ознака роздрібної мережі (type=1)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
{
    "id": 9,
    "name": "АТБ-маркет",
    "gln": "4820128010004",
    "aliasName": "АТБ-маркет",
    "type": 1
},
{
    "id": 17,
    "name": "Метро",
    "gln": "4820086630009",
    "aliasName": "Метро",
    "type": 1
},
{
    "id": 39,
    "name": "Край",
    "gln": "4820104810017",
    "aliasName": "Край",
    "type": 1
},
{
    "id": 55,
    "name": "Ватсонс",
    "gln": "4829900001605",
    "aliasName": "Ватсонс",
    "type": 1
},
{
    "id": 56,
    "name": "ЕпіцентрК (НЕАКТУАЛЬНО)",
    "gln": "9991027012934",
    "type": 1
}
]
Отримання переліку GLN номерів, які пов’язані із заданою роздрібною мережею

Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html`__ .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/retailer/identificators?retailer_id=11

Параметры, передаваемые в URL (вместе с адресом метода)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

retailer_id - число; ідентифікатор роздрібної мережі (з попередніх методів)

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „/api/oas/retailer/identificators?retailer_id=11“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про контрагентів

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт Identificator

guid

String

GUID організації

taxNum

String

Податковий ідентифікаційний номер; рядок 50 символів

ndsNum

String

№ свідоцтва ПДВ; рядок 50 символів

manager

String

ПІБ менеджера; рядок 100 символів

accountant

String

ПІБ бухгалтера; рядок 100 символів

id

long

ID користувача

gln

String

GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів

companyId

long

id аккаунта; число

retailerId

long

id мережі (ритейлера); число

name

String

назва організації; рядок 100 символів

companyType

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

companyInn

String

код ІПН компанії; рядок 50 символів

companyKpp

String

код ЄДРПОУ/КПП; рядок 50 символів

companyOgrn

String

Основний Державний Реєстраційний Номер; рядок 15 символів

companyTaxDepartmentID

String

ідентифікатор відділення податкової інспекції

dirLastName

String

прізвище директора; рядок 150 символів

dirFirstName

String

ім’я директора; рядок 150 символів

apartment

String

квартира; рядок 20 символів

zip

String

поштовий індекс; рядок 20 символів

city

String

місто; рядок 50 символів

street

String

назва вулиці; рядок 100 символів

regionCode

String

код регіону; рядок 3 символу

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

phone

String

№ телефону; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

otherInfo

String

коментарі

email

String

E-mail; рядок 255 символів

metroCode

String

код точки доставки; рядок 20 символів

Таблиця 2 - Опис параметрів об’єкта Account)

Параметр

Формат

Опис

Об’єкт Account

accountId

long

ID аккаунта

companyId

long

ID компанії

company

Company

об’єкт; дані про компанію

mfo

String

МФО банку

paymentAccount

String

розрахунковий рахунок

tariffId

int

ID тарифу

fullName

String

ПІП користувача

phone

String

телефон

email

String

Email

dirPosition

String

посада директора

activityBase

String

підстава діяльності

isIndivOffer

int

відмітка про наявність індивідуального договору; 0 - нет, 1 - есть

adminAccountId

long

ID аккаунта в Адмінці

addInfo

String

додаткова інформація

whiteList

List<String>

масив; список білих ip адрес

decryptType

int

тип розшифровки; 1 - WEB; 2 - Cryptex

cryptexServer

String

адреса cryptex-сервера на стороні клієнта

status

int

статус; 0 - заблокований; 1 - активний

accountInfo

AccountInfo_

об’єкт; додаткова інформація про аккаунт

adminAccount

AdminAccount_

об’єкт; данні по аккаунту в Адмінці

Таблиця 3 - Опис параметрів об’єкта Company)

Параметр

Формат

Опис

Об’єкт Company

id

long

id компанії; число

account

Account

об’єкт; дані аккаунта

name

String

повне найменування організації або ПІБ індивідуального підприємця

ownership

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

edrpou

String

код ЄДРПОУ/КПП; рядок 50 символів

inn

String

код ІПН; рядок 50 символів

mail

String

пошта

phone

String

№ телефону; рядок 50 символів

ndsNumber

String

№ свідоцтва ПДВ; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

bankAddress

String

адреса банку; рядок 150 символів

users

List<User>

масив об’єктів;

Таблиця 4 - Опис параметрів об’єкта User)

Параметр

Формат

Опис

Об’єкт User

id

long

id користувача; число

accountId

long

id аккаунта

login

String

логін користувача; рядок 50 символів

stringEmails

String

E-mail; рядок 255 символів

emails

List<String>

масив адрес E-mail

blocked

int

відмітка про блокування; число; 0 - немає, 1 - так

allowFTP

int

відмітка доступу до FTP; число; 0 - немає, 1 - так

autoSending

boolean

автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)

statusFile

int

створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання

isAdmin

boolean

відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
    {
        "guid": {},
        "id": 82208,
        "gln": "5790000017089",
        "companyId": 19,
        "retailerId": 16404,
        "name": "ECCO - EDITEL",
        "companyInn": "№",
        "companyKpp": "№",
        "city": "№",
        "street": "№",
        "account": {
            "platform": "EVO",
            "id": 19,
            "name": "eXite-Ukraine",
            "ownership": "ФОП",
            "inn": "-",
            "kpp": "#",
            "mail": "DikhtyarZ@exite-edi.com",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    },
    {
        "guid": {},
        "manager": "#",
        "id": 126701,
        "gln": "5790000833054",
        "companyId": 19,
        "retailerId": 16404,
        "name": "ECCO - EDITEL SUPPLIER",
        "companyInn": "#",
        "companyKpp": "#",
        "zip": "#",
        "city": "#",
        "street": "#",
        "phone": "#",
        "account": {
            "platform": "EVO",
            "id": 19,
            "name": "eXite-Ukraine",
            "ownership": "ФОП",
            "inn": "-",
            "kpp": "#",
            "mail": "DikhtyarZ@exite-edi.com",
            "phone": "1111111111",
            "ndsNumber": "#",
            "bankAccount": "#",
            "bankName": "#",
            "bankMfo": "#",
            "bankAddress": "#",
            "identificators": [],
            "companies": [],
            "users": []
        }
    }
]
Отримання переліку всіх мереж

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/oas/allretailers можливо отримати список всіх мереж, пов’язаних з авторизованим користувачем.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/allretailers

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/allretailers“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

id

число

ідентифікатор роздрібної мережі

name

рядок

ім’я роздрібної мережі

gln

рядок (13)

номер GLN організації

aliasName

рядок

бренд ТЗ, альтернативне ім’я

type

число

тип мережі, 1 - пряма, 2 - роумінгова

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно).

Приклад тіла відповіді (json):

[
  {
    "id": 7,
    "name": "Варус (ОМЕГА)",
    "gln": "4820110632160",
    "aliasName": "Варус(ОМЕГА))",
    "type": 1
  },
  {
    "id": 8,
    "name": "Старый Колос",
    "gln": "4829900003845",
    "aliasName": "Олд_Колос",
    "type": 1
  },
  {
    "id": 9,
    "name": "АТБ-маркет",
    "gln": "4820128010004",
    "aliasName": "АТБ-маркет",
    "type": 1
  },
  {
    "id": 17297,
    "name": "Интеграция",
    "gln": "1234567890123",
    "aliasName": "Интеграция",
    "type": 2
  }
]
Отримання переліку доступних одиниць виміру

Для роботи з цим методом користувач повинен бути авторизованим .

Метод api/oas/units дозволяє відобразити довідник одиниць виміру.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/units

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/units“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Відповідь: масив об’єктів даних про доступні одиницях вимірювань

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

id

long

ідентифікатор одиниці виміру

name

String

найменування

nameOKEI

String

найменування згідно державного класифікатора

shortNameOKEI

String

сокращение згідно державного класифікатора

OKEI

String

код державного класифікатора

KSPOVO

String

код КСПОВО

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

[
{
    "id": 1,
    "name": "GRM",
    "nameOKEI": "Грамм",
    "shortNameOKEI": "г",
    "OKEI": "163",
    "KSPOVO": "0303"
},
{
    "id": 2,
    "name": "KGM",
    "nameOKEI": "Килограмм",
    "shortNameOKEI": "кг",
    "OKEI": "166",
    "KSPOVO": "0301"
},
{
    "id": 3,
    "name": "LTR",
    "nameOKEI": "Литр",
    "shortNameOKEI": "л",
    "OKEI": "112",
    "KSPOVO": "0138"
},
...
{
    "id": 45,
    "name": "OD",
    "nameOKEI": "Единица (продукции)",
    "shortNameOKEI": "од",
    "KSPOVO": "2431"
}
]
Отримання інформації про організацію по Назві/ІПН/КПП/GLN

Для роботи з цим методом користувач повинен бути авторизованим .

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального аккаунта.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/identifiers

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

query - рядок; назва/ІПН/КПП/GLN організації; «Над яким здійснюється дія»

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/oas/identifiers?gln=9864065702429&query=EDS_1“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт Identificator

guid

String

GUID організації

taxNum

String

Податковий ідентифікаційний номер; рядок 50 символів

ndsNum

String

№ свідоцтва ПДВ; рядок 50 символів

manager

String

ПІБ менеджера; рядок 100 символів

accountant

String

ПІБ бухгалтера; рядок 100 символів

id

long

ID користувача

gln

String

GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів

companyId

long

id аккаунта; число

retailerId

long

id мережі (ритейлера); число

name

String

назва організації; рядок 100 символів

companyType

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

companyInn

String

код ІПН компанії; рядок 50 символів

companyKpp

String

код ЄДРПОУ/КПП; рядок 50 символів

companyOgrn

String

Основний Державний Реєстраційний Номер; рядок 15 символів

companyTaxDepartmentID

String

ідентифікатор відділення податкової інспекції

dirLastName

String

прізвище директора; рядок 150 символів

dirFirstName

String

ім’я директора; рядок 150 символів

apartment

String

квартира; рядок 20 символів

zip

String

поштовий індекс; рядок 20 символів

city

String

місто; рядок 50 символів

street

String

назва вулиці; рядок 100 символів

regionCode

String

код регіону; рядок 3 символу

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

phone

String

№ телефону; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

otherInfo

String

коментарі

email

String

E-mail; рядок 255 символів

metroCode

String

код точки доставки; рядок 20 символів

Таблиця 2 - Опис параметрів об’єкта Account)

Параметр

Формат

Опис

Об’єкт Account

accountId

long

ID аккаунта

companyId

long

ID компанії

company

Company

об’єкт; дані про компанію

mfo

String

МФО банку

paymentAccount

String

розрахунковий рахунок

tariffId

int

ID тарифу

fullName

String

ПІП користувача

phone

String

телефон

email

String

Email

dirPosition

String

посада директора

activityBase

String

підстава діяльності

isIndivOffer

int

відмітка про наявність індивідуального договору; 0 - нет, 1 - есть

adminAccountId

long

ID аккаунта в Адмінці

addInfo

String

додаткова інформація

whiteList

List<String>

масив; список білих ip адрес

decryptType

int

тип розшифровки; 1 - WEB; 2 - Cryptex

cryptexServer

String

адреса cryptex-сервера на стороні клієнта

status

int

статус; 0 - заблокований; 1 - активний

accountInfo

AccountInfo_

об’єкт; додаткова інформація про аккаунт

adminAccount

AdminAccount_

об’єкт; данні по аккаунту в Адмінці

Таблиця 3 - Опис параметрів об’єкта Company)

Параметр

Формат

Опис

Об’єкт Company

id

long

id компанії; число

account

Account

об’єкт; дані аккаунта

name

String

повне найменування організації або ПІБ індивідуального підприємця

ownership

String

форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа

edrpou

String

код ЄДРПОУ/КПП; рядок 50 символів

inn

String

код ІПН; рядок 50 символів

mail

String

пошта

phone

String

№ телефону; рядок 50 символів

ndsNumber

String

№ свідоцтва ПДВ; рядок 50 символів

bankAccount

String

розрахунковий рахунок банку; рядок 50 символів

bankName

String

назва банку; рядок 100 символів

bankMfo

String

МФО банку, код-реквізит банку

bankAddress

String

адреса банку; рядок 150 символів

users

List<User>

масив об’єктів;

Таблиця 4 - Опис параметрів об’єкта User)

Параметр

Формат

Опис

Об’єкт User

id

long

id користувача; число

accountId

long

id аккаунта

login

String

логін користувача; рядок 50 символів

stringEmails

String

E-mail; рядок 255 символів

emails

List<String>

масив адрес E-mail

blocked

int

відмітка про блокування; число; 0 - немає, 1 - так

allowFTP

int

відмітка доступу до FTP; число; 0 - немає, 1 - так

autoSending

boolean

автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox)

statusFile

int

створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання

isAdmin

boolean

відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

  [
{
  "guid": {},
  "manager": "#",
  "id": 133187,
  "gln": "9864065702429",
  "companyId": 29824,
  "retailerId": 0,
  "name": "EDS_1",
  "companyType": "jur",
  "companyInn": "1010101010",
  "companyKpp": "90000031",
  "zip": "112233",
  "city": "г. Львов",
  "street": "ул. Хмурится, 6",
  "phone": "#",
  "otherInfo": "[]",
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [],
    "companies": [],
    "users": []
  }
}
]

Робота з документами

Створення чернетки документа

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою POST методу api/eds/doc можливо швидко створити чернетку документа конкретного зазначеного типу для конкретного одержувача.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/doc?gln=9864065702429&doc_type=orders

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_type - рядок; конкретний тип документа

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/doc?gln=9864065702429&doc_type=orders“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються поля документа (зі специфікацією документів ви можете ознайомитися у відповідному розділі).

RESPONSE

Таблиця 1 - Опис json-параметрів, що можуть передаватися у відповідь (об’єкт створеного документа-чернетки) на метод API.

Параметр

Формат

Опис

Об’єкт XDoc

body

XDocBodyForms_

об’єкт; тіла документів

attachments

List<XDocAttachment_>

масив об’єктів; вкладення (може не використовуватися)

comments

XDocCommentsList_

об’єкт (в якому масив об’єктів); список коментарів

doc_id

long

id документа

doc_uuid

UUID

унікальний ідентифікатор документа/квитанції

uuidSender

String

унікальний ідентифікатор відправника

uuidReceiver

String

унікальний ідентифікатор одержувача

docNumber

String

номер документа

dateCreated

long

дата створення документа (unix timestamp)

dateChanged

long

дата останньої зміни документа (unix timestamp)

dateRead

long

дата прочитання документа (unix timestamp)

docDate

long

дата документа, зазначена в документі

chain_id

long

id ланцюжка документів

chain_uuid

UUID

унікальний ідентифікатор ланцюжка документів

family

int

сімейство (EDI / UZD)

hash

String

хеш-значення, отримане в результаті обробки

type

XDocType

об’єкт; тип документа

status

XDocStatus_

об’єкт; статус пари документів у відправника і одержувача

exchange_status

String

сабстатус документа

is_archive

boolean

відмітка; Архівний документ чи ні

signInfo

XDocSignInfo_

об’єкт; дані про підписи

chain

XChain

объект; дані пов’язаних ланцюжків

extraFields

Map<String, String>

масив об’єктів; набір індексів (аналог індексних таблиць)

tags

List<XTag_>

масив об’єктів; прикріплені теги

statuses

List<XStatus_>

масив об’єктів; статуси обробки відправлених документів

multiExtraFields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

Приклади

Приклад тіла запиту (json):

{
     "NUMBER": "6422722fb78c4509b06eac43758e1545",
     "DATE": "2019-02-15",
     "TIME": "00:00",
     "ORDERNUMBER": "6422722fb78c4509b06eac43758e1545",
     "ORDERDATE": "2019-02-15",
     "DELIVERYDATE": "2019-02-30",
     "DELIVERYTIME": "10:00",
     "CAMPAIGNNUMBER": "334455",
     "CURRENCY": "UAH",
     "LIMES": [],
     "HEAD": [
             {
                     "BUYER": "4820128010004",
                     "SUPPLIER": "9864065702429",
                     "DELIVERYPLACE": "4820128019007",
                     "INVOICEPARTNER": "4820128010004",
                     "SENDER": "4820128010004",
                     "RECIPIENT": "9864065702429",
                     "POSITION": [
                             {
                                     "POSITIONNUMBER": "1",
                                     "PRODUCT": "5029053540900",
                                     "PRODUCTIDBUYER": "527209",
                                     "DESCRIPTION": "пироженко",
                                     "PRICE": 510,
                                     "PRICEWITHVAT": 571.2,
                                     "VAT": "12.00",
                                     "AMOUNT": 0,
                                     "AMOUNTWITHVAT": 0,
                                     "ORDEREDQUANTITY": 64,
                                     "ACCEPTEDQUANTITY": 64,
                                     "PRODUCTTYPE": "1"
                             },
                             {
                                     "POSITIONNUMBER": "2",
                                     "PRODUCT": "5029053540924",
                                     "PRODUCTIDBUYER": "527215",
                                     "DESCRIPTION": "мороженко",
                                     "PRICE": 510,
                                     "PRICEWITHVAT": 571.2,
                                     "VAT": "12.00",
                                     "AMOUNT": 0,
                                     "AMOUNTWITHVAT": 0,
                                     "ORDEREDQUANTITY": 32,
                                     "ACCEPTEDQUANTITY": 32,
                                     "PRODUCTTYPE": "1"
                             },
                             ...
                             {
                                     "POSITIONNUMBER": "48",
                                     "PRODUCT": "5029053543987",
                                     "PRODUCTIDBUYER": "100307632",
                                     "DESCRIPTION": "водочка",
                                     "PRICE": 1751.6,
                                     "PRICEWITHVAT": 1961.79,
                                     "VAT": "12.00",
                                     "AMOUNT": 0,
                                     "AMOUNTWITHVAT": 0,
                                     "ORDEREDQUANTITY": 12,
                                     "ACCEPTEDQUANTITY": 12,
                                     "PRODUCTTYPE": "1"
                             }
                     ]
             }
     ],
     "ACTION": "29"
     }

Приклад тіла відповіді (json):

Повертаємий текст - об’єкт створеного документа-чернетки:

{
  "attachments": [],
  "body": {
    "forms": {
      "json": {
        "type": {
          "id": 2,
          "name": "json"
        }
      }
    }
  },
  "chain_id": 0,
  "comments": [],
  "dateChanged": 0,
  "dateCreated": 1574421527,
  "dateRead": 0,
  "docDate": 1565211600,
  "docNumber": "2019-08-08-TEST-001",
  "doc_id": 143,
  "doc_uuid": "6ffc8dfa-1cd5-4137-82cf-29b5969c2e74",
  "extraFields": {
    "basis_doc_date": "1565211600",
    "basis_doc_number": "1",
    "basis_doc_subtype": "007",
    "doc_date": "1565211600",
    "doc_num": "2019-08-08-TEST-001",
    "order_number": "1",
    "recipient": "9864232319979",
    "sender": "9864232319962",
    "sub_doc_type_id": "006"
  },
  "family": 1,
  "hash": "D4733FDDDEBE23B4E38DC5F257604234",
  "is_archive": false,
  "multiExtraFields": {},
  "status": {
    "status": 1,
    "title": "open"
  },
  "statuses": [],
  "tags": [],
  "type": {
    "description": "Коммерческий документ",
    "title": "comdoc",
    "type": 28
  },
  "uuidReceiver": "9864232319979",
  "uuidSender": "9864232319962"
}
Відправка чернетки

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу /api/eds/doc/send можлива відправка чернетки в певний ланцюжок.

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/doc/send?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа

Опціональні url-параметри:

doc_hash - рядок; хеш документа

chain_hash - рядок; хеш ланцюжка (можливо взяти з відповіді методу api/eds/chains/search )

chain_uuid - рядок; ID ланцюжка

partner_id - число; id торгової мережі (можливо отримати з довідника торгових мереж)

chain_type - число; тип ланцюжка документів; 0 - звичайний, 1 - особливий (ТМ Фоззі)

Примітка

Наявність ритейлера при документообігу автоматично визначається платформою (тобто якщо Відправник або Одержувач є ритейлером, то створений ланцюжок буде мати позначку конкретного ритейлера)

Увага: У запиті в тілі json присутні обов’язкові (повинні передаватися) і опціональні параметри (колонка Тип).

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X PATCH „https://edo-v2.edi-n.com/api/eds/doc/send?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів (фільтр) запиту методу API

Найменування

Тип

Формат

Опис

extra_fields

Map<String, String>

масив об’єктів; набір індексів

multi_extra_fields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка

Таблиця 2 - Опис extra_fields параметрів

id параметра

Найменування параметра

Тип

Формат

Опис параметра

1

created_from

UUID

ідентифікатор документа або ланцюжка

2

is_signed

TINYINT

відмітка про підписання

3

encrypted

TINYINT

відмітка про шифрування

4

comdoc_reestr_id

INT

id факторингового Реєстру на підставі комерційного документа

5

comdoc_reestr_is_active

TINYINT

відмітка про активність факторингового договору

6

ftpex_file_name

VARCHAR

найменування файлу, відправленого по FTP

7

ftpex_file_date

INT

дата/час відправки документа по FTP

8

inv_date

INT

дата документа invrpt (Звіт про інвентаризацію)

9

inv_num

VARCHAR

номер документа invrpt (Звіт про інвентаризацію)

11

sub_doc_type_id

INT

id підтипу документа

12

sub_status_id

INT

id статусу документа (стан ланцюжка документів)

13

action

VARCHAR

статус документа за здійсненими діями користувача

14

buyer_uuid

VARCHAR

відправник документа

15

consignee_uuid

VARCHAR

вантажоодержувач

16

consignor_uuid

VARCHAR

вантажовідправник

17

customer_uuid

VARCHAR

покупець

18

performer_uuid

VARCHAR

виконавець

19

supplier_uuid

VARCHAR

постачальник

20

delivery_place_uuid

VARCHAR

місце доставки

21

contract_date

VARCHAR

дата договору

22

contract_number

VARCHAR

номер договору

23

delivery_date

M

INT

дата доставки

24

order_number

M

VARCHAR

номер замовлення

25

order_date

INT

дата замовлення

26

return_date

INT

дата повернення

27

summ

VARCHAR

сума з ПДВ

28

parent_chain_hash

MD5

хеш ланцюжка

29

period

VARCHAR

крайня дата підпису документа

31

trans_id

VARCHAR

id транзакції

32

ttn

VARCHAR

номер накладної

33

doc_start_date

VARCHAR

початок терміну підписання документа

34

doc_end_date

VARCHAR

закінчення терміну підписання документа

35

delivery_note_number

VARCHAR

номер накладної

42

contract_gln

VARCHAR

GLN місце доставки при товарному узгодженні (Agreem-> Comdoc)

43

doc_date

INT

дата з документа

44

delivery_agreement_number

VARCHAR

кількість узгоджень

45

delivery_agreement_date

INT

дата узгодження

46

varn

VARCHAR

ЮЗД id документа

47

other_info

TEXT

додаткові дані

48

sub_doc_date

INT

дата підтипу документа

49

sub_doc_number

VARCHAR

номер підтипу документа

50

doc_error

TEXT

помилка при роботі з документом

51

doc_info

TEXT

коментар до документа

52

old_doc_id

INT

id документа

53

sub_status_date

INT

дата статусу документа (стан ланцюжка документів)

54

from_doc_id

INT

порядковий номер документа в ланцюжку

56

doc_num

VARCHAR

номер документа

57

sender

VARCHAR

GLN відправника

58

recipient

VARCHAR

GLN одержувача

59

file_name

VARCHAR

найменування прикладаємого (вкладення) файлу

60

xml_hash

VARCHAR

хеш змісту документа

61

answer_doc_id

INT

id COMDOC документа відправленного у відповідь

80

identifier

VARCHAR

ідентифікатор документа в системі клієнта

82

compound_number

VARCHAR

складовий номер

85

doc_process

TINYINT

87

users

VARCHAR

88

basis_doc_subtype

INT

підтип документа-підстави

89

basis_doc_number

INT

номер документа-підстави

90

basis_doc_date

INT

дата документа-підстави

Тип поля: M - mandatory (обов’язкове до заповнення), O - optional (опціональне)

RESPONSE

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

Приклади

Приклад тіла запиту (json):

{
  "extra_fields": {
    "sender": "4820128010004",
    "doc_num": "ORG00000014",
    "buyer_uuid": "4820128010004",
    "delivery_date": "1551477600",
    "order_number": "6422722fb78c4509b06eac43758e1545",
    "supplier_uuid": "9864065702429",
    "contract_number": "334455",
    "delivery_place_uuid": "4820128019007",
    "order_date": "1550181600",
    "doc_date": "1555432208",
    "action": "29"
  }
}

Приклад тіла відповіді (json):

У цьому методі json-тіло відповіді відсутнє.

Повертаємий текст – «OK»

Пошук документів (з фільтрацією), вибір списку документів

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/eds/docs/search можливо швидко зробити пошук по заданим критеріям, наприклад, отримати список документів з певним статусом, або за проміжок часу.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/docs/search?gln=9864065702429

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

{«…»} - тіло http запиту - json з критеріями пошуку (Таблиця_2)

Увага: У запиті в тілі json присутні обов’язкові (повинні передаватися) і опціональні параметри (колонка Тип).

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/eds/docs/search?gln=9864065702429“ -d {json с критериями поиска(Таблиця_2)} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 2 - Опис json-параметрів (фільтр) запиту методу API

Параметр

Тип

Формат

Опис

Об’єкт StorageQuery

extraParams

List<ExtraQueryParameters>

масив об’єктів;

multiExtraParams

List<ExtraQueryParameters>

масив об’єктів;

type

M

List<XDocType>

масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа

statuses

M

List<Integer>

масив; список статусів (станів) документів, за якими буде відбуватися відбір: 0 - все 1 - open 2 - sent 3 - delivered 4 - inbox 5 - read 6 - error 7 - deleted

tags

List<Long>

масив; тег

exchangeStatus

O

List<Integer>

масив; статус документообігу

docs

List<Long>

масив; документи

direction

M

Direction

об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів

limit

O

Limitation

объект; фільтр відбору (налаштування виводу даних)

number

O

String

номер документа

family

O

int

сімейство (EDI / UZD); можливі значення: 1 - edi

partnerId

Long

id роздрібної мережі

chainHash

String

хеш-значення, отримане в результаті обробки ланцюжка

docHash

String

хеш-значення, отримане в результаті обробки документа

docDate

O

DateTimeRange

об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по

docCreate

O

DateTimeRange

об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по

docRead

O

DateTimeRange

об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по

docChanged

O

DateTimeRange

об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по

archive

Boolean

відмітка наявності архівної ознаки документа

important

boolean

відмітка важливий документ

visible

boolean

відмітка видимості

loadBody

boolean

відмітка наявності тіла документа

loadComments

boolean

відмітка наявності коментарів до документа

loadStatuses

boolean

відмітка наявності статусів документа

loadTags

boolean

відмітка наявності тегів документа

loadChain

boolean

відмітка наявності ланцюжка документів

Таблиця 3 - Опис параметрів об’єкта ExtraQueryParameters

Параметр

Тип

Формат

Опис

Об’єкт ExtraQueryParameters

operator

enum (AND, OR)

type

M

enum (EQUALS, EQUALS_UUID, EQUALS_MD5, LIKE, MORE, MORE_EQ, LESS, LESS_EQ, IN)

fieldName

String

найменування параметру

value

String

id параметра

Таблиця 4 - Опис параметрів об’єкта Direction

Параметр

Тип

Формат

Опис

Об’єкт Direction

type

enum (EQ, OR, IN)

тип вибірки; можливі значення: » EQ » / » OR » / » IN » * EQ - відбираються тільки документи в яких збігаються зазначені і sender, і receiver; * OR - відбираються документи в яких збігаються АБО sender, АБО receiver; * IN - відбираються документи в яких sender або receiver один з тих, які вказані в масивах sender і receiver

sender

M/O

List<String>

масив; відправники; GLN відправників - обов’язковий, але може бути порожнім якщо зазначений масив GLN одержувачів (receiver)

receiver

M/O

List<String>

масив; одержувачі; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначений масив GLN відправників (sender)

Таблиця 5 - Опис параметрів об’єкта Limitation

Параметр

Тип

Формат

Опис

Об’єкт Limitation

offset

O

int

зміщення першого елемента списку щодо верхньої межі вибірки (за замовчуванням 0)

count

O

int

ліміт вибірки (кількість)

Таблиця 6 - Опис параметрів об’єкта DateTimeRange

Параметр

Тип

Формат

Опис

Об’єкт DateTimeRange

startTimestamp

long

початок часового діапазону

finishTimestamp

long

закінчення часового діапазону

Таблиця 7 - Опис параметрів об’єкта XDocType

Параметр

Тип

Формат

Опис

Об’єкт XDocType

опис_параметрів_

type

int

id типу документа/квитанції

title

String

назва документа/квитанции

description

String

опис документа/квитанції (найменування кирилицею)

Таблиця 8 - Опис fieldName параметрів (объект ExtraQueryParameters)

id параметра

Найменування параметра

Тип

Формат

Опис параметра

1

created_from

UUID

ідентифікатор документа або ланцюжка

2

is_signed

TINYINT

відмітка про підписання

3

encrypted

TINYINT

відмітка про шифрування

4

comdoc_reestr_id

INT

id факторингового Реєстру на підставі комерційного документа

5

comdoc_reestr_is_active

TINYINT

відмітка про активність факторингового договору

6

ftpex_file_name

VARCHAR

найменування файлу, відправленого по FTP

7

ftpex_file_date

INT

дата/час відправки документа по FTP

8

inv_date

INT

дата документа invrpt (Звіт про інвентаризацію)

9

inv_num

VARCHAR

номер документа invrpt (Звіт про інвентаризацію)

11

sub_doc_type_id

INT

id підтипу документа

12

sub_status_id

INT

id статусу документа (стан ланцюжка документів)

13

action

VARCHAR

статус документа за здійсненими діями користувача

14

buyer_uuid

VARCHAR

відправник документа

15

consignee_uuid

VARCHAR

вантажоодержувач

16

consignor_uuid

VARCHAR

вантажовідправник

17

customer_uuid

VARCHAR

покупець

18

performer_uuid

VARCHAR

виконавець

19

supplier_uuid

VARCHAR

постачальник

20

delivery_place_uuid

VARCHAR

місце доставки

21

contract_date

VARCHAR

дата договору

22

contract_number

VARCHAR

номер договору

23

delivery_date

M

INT

дата доставки

24

order_number

M

VARCHAR

номер замовлення

25

order_date

INT

дата замовлення

26

return_date

INT

дата повернення

27

summ

VARCHAR

сума з ПДВ

28

parent_chain_hash

MD5

хеш ланцюжка

29

period

VARCHAR

крайня дата підпису документа

31

trans_id

VARCHAR

id транзакції

32

ttn

VARCHAR

номер накладної

33

doc_start_date

VARCHAR

початок терміну підписання документа

34

doc_end_date

VARCHAR

закінчення терміну підписання документа

35

delivery_note_number

VARCHAR

номер накладної

42

contract_gln

VARCHAR

GLN місце доставки при товарному узгодженні (Agreem-> Comdoc)

43

doc_date

INT

дата з документа

44

delivery_agreement_number

VARCHAR

кількість узгоджень

45

delivery_agreement_date

INT

дата узгодження

46

varn

VARCHAR

ЮЗД id документа

47

other_info

TEXT

додаткові дані

48

sub_doc_date

INT

дата підтипу документа

49

sub_doc_number

VARCHAR

номер підтипу документа

50

doc_error

TEXT

помилка при роботі з документом

51

doc_info

TEXT

коментар до документа

52

old_doc_id

INT

id документа

53

sub_status_date

INT

дата статусу документа (стан ланцюжка документів)

54

from_doc_id

INT

порядковий номер документа в ланцюжку

56

doc_num

VARCHAR

номер документа

57

sender

VARCHAR

GLN відправника

58

recipient

VARCHAR

GLN одержувача

59

file_name

VARCHAR

найменування прикладаємого (вкладення) файлу

60

xml_hash

VARCHAR

хеш змісту документа

61

answer_doc_id

INT

id COMDOC документа відправленного у відповідь

80

identifier

VARCHAR

ідентифікатор документа в системі клієнта

82

compound_number

VARCHAR

складовий номер

85

doc_process

TINYINT

87

users

VARCHAR

88

basis_doc_subtype

INT

підтип документа-підстави

89

basis_doc_number

INT

номер документа-підстави

90

basis_doc_date

INT

дата документа-підстави

Таблиця 9 - Опис DocType параметрів (объект XDocType)

Тип

Назва

Опис (найменування кирилицею)

0

all

всі

1

invoice

Рахунок

2

orders

Замовлення

3

recadv

Повідомлення про прийом

4

desadv

Повідомлення про відвантаження

5

ordrsp

Підтвердження замовлення

6

pricat

Прайс-лист

10

declar

Податкова накладна

11

insdes

Інструкція з доставки

13

slsrpt

Звіт про продажі

14

invrpt

Звіт про інвентаризацію

15

coacsu

Акт звірки взаєморозрахунків

16

actset

Акт взаємозаліку

17

iftmin

Інструкція про транспортування

18

retann

Повідомлення про повернення

19

iftmbf

Замовлення транспортування

21

mscons

Звіт про надані послуги

25

retins

Інструкція з повернення

28

comdoc

Комерційний документ

29

declarj12

Коригування до податкової накладної

30

condra

Не структурований документ

42

iftmbc

Підтвердження замовлення транспортування

59

documentinvoice

Товарна накладна

67

doccorinvoice

doccorinvoice

75

waybill

Товарно-транспортна накладна (ТТН)

79

addbill

addbill

98

quotes

Додаток до Повідомлення про відвантаження

*Тип* поля: M - mandatory (обов’язкове до заповнення), O - optional (опціональне)

RESPONSE

Таблиця 10 - Опис json-параметрів, які можуть передаватися в відповіді на метод API

Параметр

Формат

Опис

items

List<XDoc>

масив об’єктів; перелік документів

totalCount

int

кількість документів

Таблиця 11 - Опис параметрів об’єкта XDocStatus

Параметр

Формат

Опис

Об’єкт XDocStatus

детальніше

state

int

id статусу

title

String

статус

Таблиця 12 - Опис параметрів об’єкта XDoc

Параметр

Формат

Опис

Об’єкт XDoc

body

XDocBodyForms

об’єкт; тіла документів

attachments

List<XDocAttachment>

масив об’єктів; вкладення (може не використовуватися)

comments

XDocCommentsList

об’єкт (в якому масив об’єктів); список коментарів

doc_id

long

id документа

doc_uuid

UUID

унікальний ідентифікатор документа/квитанції

uuidSender

String

унікальний ідентифікатор відправника

uuidReceiver

String

унікальний ідентифікатор одержувача

docNumber

String

номер документа

dateCreated

long

дата створення документа (unix timestamp)

dateChanged

long

дата останньої зміни документа (unix timestamp)

dateRead

long

дата прочитання документа (unix timestamp)

docDate

long

дата документа, зазначена в документі

chain_id

long

id ланцюжка документів

chain_uuid

UUID

унікальний ідентифікатор ланцюжка документів

family

int

сімейство (EDI / UZD)

hash

String

хеш-значення, отримане в результаті обробки

type

XDocType

об’єкт; тип документа

status

XDocStatus

об’єкт; статус пари документів у відправника і одержувача

exchange_status

String

сабстатус документа

is_archive

boolean

відмітка; Архівний документ чи ні

signInfo

XDocSignInfo

об’єкт; дані про підписи

chain

XChain

объект; дані пов’язаних ланцюжків

extraFields

Map<String, String>

масив об’єктів; набір індексів (аналог індексних таблиць)

tags

List<XTag>

масив об’єктів; прикріплені теги

statuses

List<XStatus>

масив об’єктів; статуси обробки відправлених документів

multiExtraFields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

Таблиця 13 - Опис параметрів об’єкта XTag

Параметр

Формат

Опис

Об’єкт XTag

id

long

id тега

name

String

зміст тега

shortName

String

коротка назва тега

Таблиця 14 - Опис параметрів об’єкта XStatus

Параметр

Формат

Опис

Об’єкт XStatus

docId

long

id документа/квитанції

date

long

дата статусу; формат unix timestamp

type

int

тип статусу

text

String

зміст статусу

Таблиця 15 - Опис параметрів об’єкта XDocSignInfo

Параметр

Формат

Опис

Об’єкт XDocSignInfo

doc_id

long

id документа/квитанції

date

long

дата підписання; формат unix timestamp

count

short

кількість підписів

info

String

додаткова інформація

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 16 - Опис параметрів об’єкта XDocCommentsList

Параметр

Формат

Опис

Об’єкт XDocCommentsList

XDocCommentsList

List<XDocComment>

масив об’єктів; коментарі до документа

Таблиця 17 - Опис параметрів об’єкта XDocComment

Параметр

Формат

Опис

Об’єкт XDocComment

id

long

id коментаря

docUUID

UUID

унікальний ідентифікатор документа

createTimestamp

long

дата створення коментаря у форматі timestamp

authorLogin

String

автор коментаря

comment

String

зміст коментаря

Таблиця 18 - Опис параметрів об’єкта XDocAttachment

Параметр

Формат

Опис

Об’єкт XDocAttachment

id

long

id вкладення

docUUID

UUID

унікальний ідентифікатор документа

fileName

String

найменування файлу

createDate

long

дата створення вкладення; формат unix timestamp

type

String

тип вкладення

base64content

String

зміст вкладення в BASE64

content

byte[]

зміст вкладення в цілочисельному вигляді

Таблиця 19 - Опис параметрів об’єкта XDocBodyForms

Параметр

Формат

Опис

Об’єкт XDocBodyForms

forms

HashMap<String, XDocBody>

масив об’єктів; тіло документа

Таблиця 20 - Опис параметрів об’єкта XDocBody

Параметр

Формат

Опис

Об’єкт XDocBody

type

XDocBodyType

об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6

base64content

String

зміст тіла документа в BASE64

Таблиця 21 - Опис параметрів об’єкта XDocBodyType

Параметр

Формат

Опис

Об’єкт XDocBodyType

id

int

id типу тіла документа

name

String

назва типу тіла документа

Таблиця 22 - Опис DocStatus параметрів (об’єкт XDocStatus)

id статусу

статус

0

ALL - будь-який статус

1

OPEN - чернетка (відправник)

2

SENT - відправлений (відправник)

3

DELIVERED - прочитаний (відправник)

4

INBOX - доставлений / вхідний (одержувач)

5

READ - прочитаний (одержувач)

6

ERROR - помилка

7

DELETED - видалений

Приклади (json)

Отримати всі вхідні (отримані) документи на певний GLN без чернеток (масив statuses не містить «1»)
{
    "direction": {
        "sender": [],
        "receiver": [
            "9864232304302"
        ],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вхідні (відправлені) документи на певний GLN без чернеток (масив statuses не містить «1»)
{
    "direction": {
        "sender": [
            "9864232304302"
        ],
        "receiver": [],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вхідні (отримані) документи на певний GLN без чернеток (масив statuses не містить «1»), у яких номер містить підрядок «1001»
{
    "direction": {
        "sender": [],
        "receiver": [
            "9864232304302"
        ],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "number": "1001",
    "type": [
        {
            "type": "0"
        }
    ]
}
Отримати всі вихідні (відправлені) документи по GLN без чернеток (масив statuses не містить «1»), які створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp)
{
    "direction": {
        "sender": [
            "9864232304302"
        ],
        "receiver": [],
        "type": "IN"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": [
        "2",
        "3",
        "4",
        "5",
        "6",
        "7"
    ],
    "type": [
        {
            "type": "0"
        }
    ],
    "docDate": {
        "startTimestamp": "1556668800",
        "finishTimestamp": "1559347199"
    }
}

Приклад тіла відповіді (json):

{
    "items": [
        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 1017,
            "doc_uuid": "e18a05d5-983b-4ebc-95f3-c35eccc7d611",
            "uuidSender": "4820128010004",
            "uuidReceiver": "9864065702429",
            "docNumber": "8663c3f48bea4f96a281238e847b1639",
            "dateCreated": 1549961913,
            "dateChanged": 1549961913,
            "dateRead": 0,
            "docDate": 1547503200,
            "chain_id": 1006,
            "chain_uuid": "60e487d3-871f-4b3a-9254-1d3f0e7a032f",
            "family": 1,
            "hash": "30745386780343D0C2F4C65C7F06D60F",
            "type": {
                "type": 1,
                "title": "invoice",
                "description": "Счет"
            },
            "status": {
                "status": 4,
                "title": "inbox"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "order_date": "1551477600",
                "delivery_date": "1547503200",
                "ftpex_file_name": "highload_invoice_test.xml",
                "sender": "4820128010004",
                "buyer_uuid": "4820128010004",
                "doc_num": "8663c3f48bea4f96a281238e847b1639",
                "order_number": "747401",
                "doc_date": "1547503200",
                "recipient": "9864065702429",
                "ftpex_file_date": "1549961913",
                "supplier_uuid": "9864065702429",
                "delivery_place_uuid": "4820128019007"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        }
    ],
    "totalCount": 0
}
Отримання конкретного ланцюжка документів

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/eds/chain і заданих параметрів можливо отримати (вивантажити) необхідні дані конкретного ланцюжка документів.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/chain?gln=9864065702429&chain_uuid=9fe45d32-35c7-44d0-9131-7257fc0c0f39&load_docs=true&load_bodies=true&load_package=true&load_comments=true&load_tags=true&load_statuses=true

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

chain_uuid - рядок; ID ланцюжка

Опціональні url-параметри (boolean фільтри):

load_docs - чи завантажувати документи, що відносяться до ланцюжка

load_bodies - чи завантажувати тіла документів

load_package - чи завантажувати пакети

load_comments - чи завантажувати коментарі

load_tags - чи завантажувати теги до документів

load_statuses - чи завантажувати статуси до документів

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/eds/chain?gln=9864065702429&chain_uuid=9fe45d32-35c7-44d0-9131-7257fc0c0f39&load_docs=true&load_bodies=true&load_package=true&load_comments=true&load_tags=true&load_statuses=true“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API

Параметр

Формат

Опис

Об’єкт XChain

id

long

ID шарда

uuid

UUID

UUID ланцюжка документів

packageID

long

ID пакета

type

XDocType

об’єкт; тип документа

docsCount

int

кількість документів в ланцюжку

lastInDocID

long

id останнього вхідного документа в ланцюжку

lastOutDocID

long

id останнього вихідного документа в ланцюжку

partnerId

long

id роздрібної мережі

important

boolean

відмітка важливий документ

status

XChainStatus

об’єкт; статус пари документів у відправника і одержувача

visualStatus

int

номер іконки

archive

boolean

відмітка; Архівний документ чи ні

childs

List<XDoc>

масив об’єктів; дані документів/квитанцій

chainsInPackage

List<XChain>

масив об’єктів; дані пов’язаних ланцюжків

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 5 - Опис параметрів об’єкта XChainStatus

Параметр

Формат

Опис

Об’єкт XChainStatus

state

int

id статусу

title

String

статус

Таблиця 6 - Опис параметрів об’єкта XDocStatus

Параметр

Формат

Опис

Об’єкт XDocStatus

детальніше

state

int

id статусу

title

String

статус

Таблиця 7 - Опис параметрів об’єкта XDoc

Параметр

Формат

Опис

Об’єкт XDoc

body

XDocBodyForms

об’єкт; тіла документів

attachments

List<XDocAttachment>

масив об’єктів; вкладення (може не використовуватися)

comments

XDocCommentsList

об’єкт (в якому масив об’єктів); список коментарів

doc_id

long

id документа

doc_uuid

UUID

унікальний ідентифікатор документа/квитанції

uuidSender

String

унікальний ідентифікатор відправника

uuidReceiver

String

унікальний ідентифікатор одержувача

docNumber

String

номер документа

dateCreated

long

дата створення документа (unix timestamp)

dateChanged

long

дата останньої зміни документа (unix timestamp)

dateRead

long

дата прочитання документа (unix timestamp)

docDate

long

дата документа, зазначена в документі

chain_id

long

id ланцюжка документів

chain_uuid

UUID

унікальний ідентифікатор ланцюжка документів

family

int

сімейство (EDI / UZD)

hash

String

хеш-значення, отримане в результаті обробки

type

XDocType

об’єкт; тип документа

status

XDocStatus

об’єкт; статус пари документів у відправника і одержувача

exchange_status

String

сабстатус документа

is_archive

boolean

відмітка; Архівний документ чи ні

signInfo

XDocSignInfo

об’єкт; дані про підписи

chain

XChain

объект; дані пов’язаних ланцюжків

extraFields

Map<String, String>

масив об’єктів; набір індексів (аналог індексних таблиць)

tags

List<XTag>

масив об’єктів; прикріплені теги

statuses

List<XStatus>

масив об’єктів; статуси обробки відправлених документів

multiExtraFields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

Таблиця 8 - Опис параметрів об’єкта XTag

Параметр

Формат

Опис

Об’єкт XTag

id

long

id тега

name

String

зміст тега

shortName

String

коротка назва тега

Таблиця 9 - Опис параметрів об’єкта XStatus

Параметр

Формат

Опис

Об’єкт XStatus

docId

long

id документа/квитанції

date

long

дата статусу; формат unix timestamp

type

int

тип статусу

text

String

зміст статусу

Таблиця 10 - Опис параметрів об’єкта XDocSignInfo

Параметр

Формат

Опис

Об’єкт XDocSignInfo

doc_id

long

id документа/квитанції

date

long

дата підписання; формат unix timestamp

count

short

кількість підписів

info

String

додаткова інформація

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 11 - Опис параметрів об’єкта XDocCommentsList

Параметр

Формат

Опис

Об’єкт XDocCommentsList

XDocCommentsList

List<XDocComment>

масив об’єктів; коментарі до документа

Таблиця 12 - Опис параметрів об’єкта XDocComment

Параметр

Формат

Опис

Об’єкт XDocComment

id

long

id коментаря

docUUID

UUID

унікальний ідентифікатор документа

createTimestamp

long

дата створення коментаря у форматі timestamp

authorLogin

String

автор коментаря

comment

String

зміст коментаря

Таблиця 13 - Опис параметрів об’єкта XDocAttachment

Параметр

Формат

Опис

Об’єкт XDocAttachment

id

long

id вкладення

docUUID

UUID

унікальний ідентифікатор документа

fileName

String

найменування файлу

createDate

long

дата створення вкладення; формат unix timestamp

type

String

тип вкладення

base64content

String

зміст вкладення в BASE64

content

byte[]

зміст вкладення в цілочисельному вигляді

Таблиця 14 - Опис параметрів об’єкта XDocBodyForms

Параметр

Формат

Опис

Об’єкт XDocBodyForms

forms

HashMap<String, XDocBody>

масив об’єктів; тіло документа

Таблиця 15 - Опис параметрів об’єкта XDocBody

Параметр

Формат

Опис

Об’єкт XDocBody

type

XDocBodyType

об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6

base64content

String

зміст тіла документа в BASE64

Таблиця 16 - Опис параметрів об’єкта XDocBodyType

Параметр

Формат

Опис

Об’єкт XDocBodyType

id

int

id типу тіла документа

name

String

назва типу тіла документа

Таблиця 17 - Опис параметрів об’єкта XDocType

Параметр

Тип

Формат

Опис

Об’єкт XDocType

опис_параметрів

type

int

id типу документа/квитанції

title

String

назва документа/квитанции

description

String

опис документа/квитанції (найменування кирилицею)

Таблиця 18 - Опис DocStatus параметрів (об’єкт XDocStatus)

id статусу

статус

0

ALL - будь-який статус

1

OPEN - чернетка (відправник)

2

SENT - відправлений (відправник)

3

DELIVERED - прочитаний (відправник)

4

INBOX - доставлений / вхідний (одержувач)

5

READ - прочитаний (одержувач)

6

ERROR - помилка

7

DELETED - видалений

Таблиця 19 - Опис DocType параметрів (об’єкт XDocType)

Тип

Назва

Опис (найменування кирилицею)

0

all

всі

1

invoice

Рахунок

2

orders

Замовлення

3

recadv

Повідомлення про прийом

4

desadv

Повідомлення про відвантаження

5

ordrsp

Підтвердження замовлення

6

pricat

Прайс-лист

10

declar

Податкова накладна

11

insdes

Інструкція з доставки

13

slsrpt

Звіт про продажі

14

invrpt

Звіт про інвентаризацію

15

coacsu

Акт звірки взаєморозрахунків

16

actset

Акт взаємозаліку

17

iftmin

Інструкція про транспортування

18

retann

Повідомлення про повернення

19

iftmbf

Замовлення транспортування

21

mscons

Звіт про надані послуги

25

retins

Інструкція з повернення

28

comdoc

Комерційний документ

29

declarj12

Коригування до податкової накладної

30

condra

Не структурований документ

42

iftmbc

Підтвердження замовлення транспортування

59

documentinvoice

Товарна накладна

67

doccorinvoice

doccorinvoice

75

waybill

Товарно-транспортна накладна (ТТН)

79

addbill

addbill

98

quotes

Додаток до Повідомлення про відвантаження

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклади url-запитів:

Отримати перелік документів за визначеним ланцюжком без завантаження їхніх тіл, пакетів, коментарів, тегів і статусів
Отримати перелік документів за визначеним ланцюжком з завантаженням тіл і коментарів без завантаження їхніх пакетів, тегів і статусів
Отримати перелік документів за визначеним ланцюжком з завантаженням пакетів, тегів без завантаження їхніх тіл і коментарів і статусів
Отримати перелік документів за визначеним ланцюжком з завантаженням статусів без завантаження їхніх тіл, коментарів, пакетів, тегів

Приклад тіла відповіді (json):

{
    "id": 1,
    "uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
    "packageID": 0,
    "type": {
        "type": 5,
        "title": "ordrsp",
        "description": "Подтверждение заказа"
    },
    "docsCount": 13,
    "lastInDocID": 1,
    "lastOutDocID": 29,
    "partnerId": 0,
    "important": false,
    "status": {
        "status": 2,
        "title": "sent"
    },
    "visualStatus": 0,
    "archive": false,
    "childs": [
        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 1,
            "doc_uuid": "bf8dacb1-7b61-4c9c-ab36-ac37620db051",
            "uuidSender": "9864232304319",
            "uuidReceiver": "9864232304302",
            "docNumber": "1001",
            "dateCreated": 1555487166,
            "dateChanged": 1555487166,
            "dateRead": 1555497325,
            "docDate": 1555448400,
            "chain_id": 1,
            "chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
            "family": 1,
            "hash": "A1FF5B519289B936A09E99514277F429",
            "type": {
                "type": 2,
                "title": "orders",
                "description": "Заказ"
            },
            "status": {
                "status": 5,
                "title": "read"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "sub_doc_type_id": "2",
                "buyer_uuid": "9864232304319",
                "doc_num": "1001",
                "order_number": "1001",
                "ftpex_file_date": "1555487160",
                "supplier_uuid": "9864232304302",
                "delivery_place_uuid": "9864232304562",
                "order_date": "1555448400",
                "delivery_date": "1556485200",
                "ftpex_file_name": "order_20190417104600_475593380.xml",
                "contract_number": "Дог 1",
                "sender": "9864232304319",
                "doc_date": "1555448400",
                "recipient": "9864232304302",
                "action": "0"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        },

        ...

        {
            "body": {
                "forms": {}
            },
            "attachments": [],
            "comments": [],
            "doc_id": 29,
            "doc_uuid": "cb2f183f-ccbc-467b-9eb2-90b2c1ff8f5c",
            "uuidSender": "9864232304302",
            "uuidReceiver": "9864232304319",
            "docNumber": "АФ00-000001",
            "dateCreated": 1556115021,
            "dateChanged": 1556115022,
            "dateRead": 0,
            "docDate": 1556116482,
            "chain_id": 1,
            "chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
            "family": 1,
            "hash": "0F9CEEC0717992EB76A848F2E106D2D0",
            "type": {
                "type": 5,
                "title": "ordrsp",
                "description": "Подтверждение заказа"
            },
            "status": {
                "status": 2,
                "title": "sent"
            },
            "exchange_status": "000000000000000000000000",
            "is_archive": false,
            "extraFields": {
                "order_date": "1555448400",
                "delivery_date": "1556485200",
                "contract_number": "Дог 1",
                "sender": "9864232304319",
                "buyer_uuid": "9864232304319",
                "doc_num": "АФ00-000001",
                "order_number": "1001",
                "doc_date": "1556116482",
                "action": "4",
                "supplier_uuid": "9864232304302",
                "delivery_place_uuid": "9864232304562"
            },
            "tags": [],
            "statuses": [],
            "multiExtraFields": {}
        }
    ],
    "hash": "ABB416F3FF3B5027D212D62DD9F99E94"
}
Отримання контента документа

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою методу api/eds/doc/body можливо швидко отримати контент документа без підписів/печаток, а також тіло підпису, тіло печатки. У запиті повинен бути присутнім ідентифікатор авторизованого користувача (GLN), ID документа (doc_uuid), тип тіла документа.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/eds/doc/body?gln=9864065702429&doc_uuid=97c06d02-7c3c-4467-aaac-4a808078609f&body_type=JSON&response_type=base64

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні облікового запису doc_uuid - рядок; UUID документа

body_type - тип тіла документа; можливі значення: - CONTENT: base64 контенту без підписів/печаток - JSON: json документа - SIGN: base64 тіло підпису - STAMP: base64 тіло печатки - CRYPTED: шифровані вихідні дані

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/eds/doc/body?gln=9864065702429&doc_uuid=8c8a70e7-81c6-4382-8b58-7d60c3bc6ffd&body_type=JSON“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

В відповіді в json-тілі передається рядок значень в форматі Base64.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді (json):

У цьому методі в json-тілі відповіді передається рядок значень в форматі Base64.

Робота з квитанціями

Створення на сервері квитанції «Анулювання» (COMDOC_019)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою GET методу api/v2/eds/comdoc/repeal можливо створити COMDOC «Аннулювання».

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/comdoc/repeal?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

reason - text; текст причини відмови/анулювання

Опціональні url-параметри:

response_type - формат очікуваної відповіді; можливі варіанти: json (за замовчуванням), xml, json_base64, xml_base64

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/v2/eds/comdoc/repeal?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається тіло згенерованого COMDOC_019 в json форматі або форматі обраному в запиті (параметр response_type).

Приклади

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

Приклад тіла відповіді (json):

{
  "documentForRepeal": {
    "code": "006",
    "date": "2019-08-08",
    "number": "F24F5899EF846E147AAC",
    "type": "Видаткова накладна"
  },
  "parties": {
    "partners": [
      {
        "IBAN": "UA153510050000026007614396500",
        "code": "33133118",
        "gln": "9864232319962",
        "inn": "3313311833",
        "name": "Левицкий М.Г.",
        "status": "Відправник",
        "type": "Юридична"
      },
      {
        "code": "33133119",
        "gln": "9864232319979",
        "inn": "3313311834",
        "name": "Левицкий М.Г.",
        "status": "Отримувач",
        "type": "Юридична"
      }
    ]
  },
  "title": {
    "code": "19",
    "comments": [],
    "date": "2019-12-24",
    "number": "F24F5899EF846E147AAC",
    "reapealText": "чето как то надо бы аннулировать то ли",
    "repealDate": "2019-12-24",
    "type": "Анулювання"
  }
}

Приклад тіла відповіді (xml):

<?xml version="1.0" encoding="UTF-8"?>
<ЕлектроннийДокумент>
  <Заголовок>
    <НомерДокументу>2019-12-03-TEST-003</НомерДокументу>
    <ТипДокументу>Анулювання</ТипДокументу>
    <КодТипуДокументу>19</КодТипуДокументу>
    <ДатаДокументу>2020-01-03</ДатаДокументу>
    <ПричинаАнулювання>Какая то супер причина для аннулирования</ПричинаАнулювання>
    <ДатаАнулювання>2020-01-03</ДатаАнулювання>
  </Заголовок>
  <ДокументЩоАнулюється>
    <НомерДокументу>2019-12-03-TEST-003</НомерДокументу>
    <ТипДокументу>Видаткова накладна</ТипДокументу>
    <КодТипуДокументу>006</КодТипуДокументу>
    <ДатаДокументу>2019-12-03</ДатаДокументу>
  </ДокументЩоАнулюється>
  <Сторони>
    <Контрагент>
      <СтатусКонтрагента>Відправник</СтатусКонтрагента>
      <ВидОсоби>Юридична</ВидОсоби>
      <НазваКонтрагента>Левицкий М.Г.</НазваКонтрагента>
      <КодКонтрагента>33133118</КодКонтрагента>
      <ІПН>3313311833</ІПН>
      <IBAN>UA153510050000026007614396500</IBAN>
      <GLN>9864232319962</GLN>
    </Контрагент>
    <Контрагент>
      <СтатусКонтрагента>Отримувач</СтатусКонтрагента>
      <ВидОсоби>Юридична</ВидОсоби>
      <НазваКонтрагента>Левицкий М.Г.</НазваКонтрагента>
      <КодКонтрагента>33133119</КодКонтрагента>
      <ІПН>3313311834</ІПН>
      <GLN>9864232319979</GLN>
    </Контрагент>
  </Сторони>
</ЕлектроннийДокумент>

Приклад тіла відповіді (json_base64):

eyJ0aXRsZSI6eyJudW1iZXIiOiIyMDE5LTEyLTAzLVRFU1QtMDAzIiwidHlwZSI6ItCQ0L3Rg9C7
0Y7QstCw0L3QvdGPIiwiY29kZSI6IjE5IiwiZGF0ZSI6IjIwMjAtMDEtMDMiLCJyZWFwZWFsVGV4
dCI6ItCa0LDQutCw0Y8g0YLQviDRgdGD0L/QtdGAINC/0YDQuNGH0LjQvdCwINC00LvRjyDQsNC9
0L3Rg9C70LjRgNC+0LLQsNC90LjRjyIsInJlcGVhbERhdGUiOiIyMDIwLTAxLTAzIiwiY29tbWVu
dHMiOltdfSwiZG9jdW1lbnRGb3JSZXBlYWwiOnsibnVtYmVyIjoiMjAxOS0xMi0wMy1URVNULTAw
MyIsInR5cGUiOiLQktC40LTQsNGC0LrQvtCy0LAg0L3QsNC60LvQsNC00L3QsCIsImNvZGUiOiIw
MDYiLCJkYXRlIjoiMjAxOS0xMi0wMyJ9LCJwYXJ0aWVzIjp7InBhcnRuZXJzIjpbeyJzdGF0dXMi
OiLQktGW0LTQv9GA0LDQstC90LjQuiIsInR5cGUiOiLQrtGA0LjQtNC40YfQvdCwIiwibmFtZSI6
ItCb0LXQstC40YbQutC40Lkg0Jwu0JMuIiwiY29kZSI6IjMzMTMzMTE4IiwiaW5uIjoiMzMxMzMx
MTgzMyIsIklCQU4iOiJVQTE1MzUxMDA1MDAwMDAyNjAwNzYxNDM5NjUwMCIsImdsbiI6Ijk4NjQy
MzIzMTk5NjIifSx7InN0YXR1cyI6ItCe0YLRgNC40LzRg9Cy0LDRhyIsInR5cGUiOiLQrtGA0LjQ
tNC40YfQvdCwIiwibmFtZSI6ItCb0LXQstC40YbQutC40Lkg0Jwu0JMuIiwiY29kZSI6IjMzMTMz
MTE5IiwiaW5uIjoiMzMxMzMxMTgzNCIsImdsbiI6Ijk4NjQyMzIzMTk5NzkifV19fQ==

Приклад тіла відповіді (xml_base64):

PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4gCjzQldC70LXQutGC0YDQvtC9
0L3QuNC50JTQvtC60YPQvNC10L3Rgj4KICA80JfQsNCz0L7Qu9C+0LLQvtC6PgogICAgPNCd0L7Q
vNC10YDQlNC+0LrRg9C80LXQvdGC0YM+MjAxOS0xMi0wMy1URVNULTAwMzwv0J3QvtC80LXRgNCU
0L7QutGD0LzQtdC90YLRgz4KICAgIDzQotC40L/QlNC+0LrRg9C80LXQvdGC0YM+0JDQvdGD0LvR
jtCy0LDQvdC90Y88L9Ci0LjQv9CU0L7QutGD0LzQtdC90YLRgz4KICAgIDzQmtC+0LTQotC40L/R
g9CU0L7QutGD0LzQtdC90YLRgz4xOTwv0JrQvtC00KLQuNC/0YPQlNC+0LrRg9C80LXQvdGC0YM+
CiAgICA80JTQsNGC0LDQlNC+0LrRg9C80LXQvdGC0YM+MjAyMC0wMS0wMzwv0JTQsNGC0LDQlNC+
0LrRg9C80LXQvdGC0YM+CiAgICA80J/RgNC40YfQuNC90LDQkNC90YPQu9GO0LLQsNC90L3Rjz7Q
mtCw0LrQsNGPINGC0L4g0YHRg9C/0LXRgCDQv9GA0LjRh9C40L3QsCDQtNC70Y8g0LDQvdC90YPQ
u9C40YDQvtCy0LDQvdC40Y88L9Cf0YDQuNGH0LjQvdCw0JDQvdGD0LvRjtCy0LDQvdC90Y8+CiAg
ICA80JTQsNGC0LDQkNC90YPQu9GO0LLQsNC90L3Rjz4yMDIwLTAxLTAzPC/QlNCw0YLQsNCQ0L3R
g9C70Y7QstCw0L3QvdGPPgogIDwv0JfQsNCz0L7Qu9C+0LLQvtC6PgogIDzQlNC+0LrRg9C80LXQ
vdGC0KnQvtCQ0L3Rg9C70Y7RlNGC0YzRgdGPPgogICAgPNCd0L7QvNC10YDQlNC+0LrRg9C80LXQ
vdGC0YM+MjAxOS0xMi0wMy1URVNULTAwMzwv0J3QvtC80LXRgNCU0L7QutGD0LzQtdC90YLRgz4K
ICAgIDzQotC40L/QlNC+0LrRg9C80LXQvdGC0YM+0JLQuNC00LDRgtC60L7QstCwINC90LDQutC7
0LDQtNC90LA8L9Ci0LjQv9CU0L7QutGD0LzQtdC90YLRgz4KICAgIDzQmtC+0LTQotC40L/Rg9CU
0L7QutGD0LzQtdC90YLRgz4wMDY8L9Ca0L7QtNCi0LjQv9GD0JTQvtC60YPQvNC10L3RgtGDPgog
ICAgPNCU0LDRgtCw0JTQvtC60YPQvNC10L3RgtGDPjIwMTktMTItMDM8L9CU0LDRgtCw0JTQvtC6
0YPQvNC10L3RgtGDPgogIDwv0JTQvtC60YPQvNC10L3RgtCp0L7QkNC90YPQu9GO0ZTRgtGM0YHR
jz4KICA80KHRgtC+0YDQvtC90Lg+CiAgICA80JrQvtC90YLRgNCw0LPQtdC90YI+CiAgICAgIDzQ
odGC0LDRgtGD0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPtCS0ZbQtNC/0YDQsNCy0L3QuNC6PC/Q
odGC0LDRgtGD0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPgogICAgICA80JLQuNC00J7RgdC+0LHQ
uD7QrtGA0LjQtNC40YfQvdCwPC/QktC40LTQntGB0L7QsdC4PgogICAgICA80J3QsNC30LLQsNCa
0L7QvdGC0YDQsNCz0LXQvdGC0LA+0JvQtdCy0LjRhtC60LjQuSDQnC7Qky48L9Cd0LDQt9Cy0LDQ
mtC+0L3RgtGA0LDQs9C10L3RgtCwPgogICAgICA80JrQvtC00JrQvtC90YLRgNCw0LPQtdC90YLQ
sD4zMzEzMzExODwv0JrQvtC00JrQvtC90YLRgNCw0LPQtdC90YLQsD4KICAgICAgPNCG0J/QnT4z
MzEzMzExODMzPC/QhtCf0J0+CiAgICAgIDxJQkFOPlVBMTUzNTEwMDUwMDAwMDI2MDA3NjE0Mzk2
NTAwPC9JQkFOPgogICAgICA8R0xOPjk4NjQyMzIzMTk5NjI8L0dMTj4KICAgIDwv0JrQvtC90YLR
gNCw0LPQtdC90YI+CiAgICA80JrQvtC90YLRgNCw0LPQtdC90YI+CiAgICAgIDzQodGC0LDRgtGD
0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPtCe0YLRgNC40LzRg9Cy0LDRhzwv0KHRgtCw0YLRg9GB
0JrQvtC90YLRgNCw0LPQtdC90YLQsD4KICAgICAgPNCS0LjQtNCe0YHQvtCx0Lg+0K7RgNC40LTQ
uNGH0L3QsDwv0JLQuNC00J7RgdC+0LHQuD4KICAgICAgPNCd0LDQt9Cy0LDQmtC+0L3RgtGA0LDQ
s9C10L3RgtCwPtCb0LXQstC40YbQutC40Lkg0Jwu0JMuPC/QndCw0LfQstCw0JrQvtC90YLRgNCw
0LPQtdC90YLQsD4KICAgICAgPNCa0L7QtNCa0L7QvdGC0YDQsNCz0LXQvdGC0LA+MzMxMzMxMTk8
L9Ca0L7QtNCa0L7QvdGC0YDQsNCz0LXQvdGC0LA+CiAgICAgIDzQhtCf0J0+MzMxMzMxMTgzNDwv
0IbQn9CdPgogICAgICA8R0xOPjk4NjQyMzIzMTk5Nzk8L0dMTj4KICAgIDwv0JrQvtC90YLRgNCw
0LPQtdC90YI+CiAgPC/QodGC0L7RgNC+0L3QuD4KPC/QldC70LXQutGC0YDQvtC90L3QuNC50JTQ
vtC60YPQvNC10L3Rgj4=
Створення на сервері квитанції «Повідомлення про відмову від підписання документу» (COMDOC_021)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою GET методу api/v2/eds/comdoc/reject можливо створити документ COMDOC-відмову.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/comdoc/reject?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

reason - text; текст причини відмови/анулювання

Опціональні url-параметри:

response_type - формат очікуваної відповіді; можливі варіанти: json (за замовчуванням), xml, json_base64, xml_base64

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X GET „https://edo-v2.edi-n.com/api/v2/eds/comdoc/reject?gln=9864232319979&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986&reason=%D0%BF%D1%80%D0%BE%D1%81%D1%82“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається тіло згенерованого COMDOC_021 в json форматі або форматі обраному в запиті (параметр response_type).

Приклади

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

Приклад тіла відповіді (json):

{
  "documentForRepeal": {
    "code": "006",
    "date": "2019-08-08",
    "number": "F24F5899EF846E147AAC",
    "type": "Видаткова накладна"
  },
  "parties": {
    "partners": [
      {
        "IBAN": "UA153510050000026007614396500",
        "code": "33133118",
        "gln": "9864232319962",
        "inn": "3313311833",
        "name": "Левицкий М.Г.",
        "status": "Відправник",
        "type": "Юридична"
      },
      {
        "code": "33133119",
        "gln": "9864232319979",
        "inn": "3313311834",
        "name": "Левицкий М.Г.",
        "status": "Отримувач",
        "type": "Юридична"
      }
    ]
  },
  "title": {
    "code": "19",
    "comments": [],
    "date": "2019-12-24",
    "number": "F24F5899EF846E147AAC",
    "reapealText": "чето как то надо бы аннулировать то ли",
    "repealDate": "2019-12-24",
    "type": "Анулювання"
  }
}

Приклад тіла відповіді (xml):

<?xml version="1.0" encoding="UTF-8"?>
<ЕлектроннийДокумент>
  <Заголовок>
    <НомерДокументу>2019-12-03-TEST-003</НомерДокументу>
    <ТипДокументу>Анулювання</ТипДокументу>
    <КодТипуДокументу>19</КодТипуДокументу>
    <ДатаДокументу>2020-01-03</ДатаДокументу>
    <ПричинаАнулювання>Какая то супер причина для аннулирования</ПричинаАнулювання>
    <ДатаАнулювання>2020-01-03</ДатаАнулювання>
  </Заголовок>
  <ДокументЩоАнулюється>
    <НомерДокументу>2019-12-03-TEST-003</НомерДокументу>
    <ТипДокументу>Видаткова накладна</ТипДокументу>
    <КодТипуДокументу>006</КодТипуДокументу>
    <ДатаДокументу>2019-12-03</ДатаДокументу>
  </ДокументЩоАнулюється>
  <Сторони>
    <Контрагент>
      <СтатусКонтрагента>Відправник</СтатусКонтрагента>
      <ВидОсоби>Юридична</ВидОсоби>
      <НазваКонтрагента>Левицкий М.Г.</НазваКонтрагента>
      <КодКонтрагента>33133118</КодКонтрагента>
      <ІПН>3313311833</ІПН>
      <IBAN>UA153510050000026007614396500</IBAN>
      <GLN>9864232319962</GLN>
    </Контрагент>
    <Контрагент>
      <СтатусКонтрагента>Отримувач</СтатусКонтрагента>
      <ВидОсоби>Юридична</ВидОсоби>
      <НазваКонтрагента>Левицкий М.Г.</НазваКонтрагента>
      <КодКонтрагента>33133119</КодКонтрагента>
      <ІПН>3313311834</ІПН>
      <GLN>9864232319979</GLN>
    </Контрагент>
  </Сторони>
</ЕлектроннийДокумент>

Приклад тіла відповіді (json_base64):

eyJ0aXRsZSI6eyJudW1iZXIiOiIyMDE5LTEyLTAzLVRFU1QtMDAzIiwidHlwZSI6ItCQ0L3Rg9C7
0Y7QstCw0L3QvdGPIiwiY29kZSI6IjE5IiwiZGF0ZSI6IjIwMjAtMDEtMDMiLCJyZWFwZWFsVGV4
dCI6ItCa0LDQutCw0Y8g0YLQviDRgdGD0L/QtdGAINC/0YDQuNGH0LjQvdCwINC00LvRjyDQsNC9
0L3Rg9C70LjRgNC+0LLQsNC90LjRjyIsInJlcGVhbERhdGUiOiIyMDIwLTAxLTAzIiwiY29tbWVu
dHMiOltdfSwiZG9jdW1lbnRGb3JSZXBlYWwiOnsibnVtYmVyIjoiMjAxOS0xMi0wMy1URVNULTAw
MyIsInR5cGUiOiLQktC40LTQsNGC0LrQvtCy0LAg0L3QsNC60LvQsNC00L3QsCIsImNvZGUiOiIw
MDYiLCJkYXRlIjoiMjAxOS0xMi0wMyJ9LCJwYXJ0aWVzIjp7InBhcnRuZXJzIjpbeyJzdGF0dXMi
OiLQktGW0LTQv9GA0LDQstC90LjQuiIsInR5cGUiOiLQrtGA0LjQtNC40YfQvdCwIiwibmFtZSI6
ItCb0LXQstC40YbQutC40Lkg0Jwu0JMuIiwiY29kZSI6IjMzMTMzMTE4IiwiaW5uIjoiMzMxMzMx
MTgzMyIsIklCQU4iOiJVQTE1MzUxMDA1MDAwMDAyNjAwNzYxNDM5NjUwMCIsImdsbiI6Ijk4NjQy
MzIzMTk5NjIifSx7InN0YXR1cyI6ItCe0YLRgNC40LzRg9Cy0LDRhyIsInR5cGUiOiLQrtGA0LjQ
tNC40YfQvdCwIiwibmFtZSI6ItCb0LXQstC40YbQutC40Lkg0Jwu0JMuIiwiY29kZSI6IjMzMTMz
MTE5IiwiaW5uIjoiMzMxMzMxMTgzNCIsImdsbiI6Ijk4NjQyMzIzMTk5NzkifV19fQ==

Приклад тіла відповіді (xml_base64):

PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4gCjzQldC70LXQutGC0YDQvtC9
0L3QuNC50JTQvtC60YPQvNC10L3Rgj4KICA80JfQsNCz0L7Qu9C+0LLQvtC6PgogICAgPNCd0L7Q
vNC10YDQlNC+0LrRg9C80LXQvdGC0YM+MjAxOS0xMi0wMy1URVNULTAwMzwv0J3QvtC80LXRgNCU
0L7QutGD0LzQtdC90YLRgz4KICAgIDzQotC40L/QlNC+0LrRg9C80LXQvdGC0YM+0JDQvdGD0LvR
jtCy0LDQvdC90Y88L9Ci0LjQv9CU0L7QutGD0LzQtdC90YLRgz4KICAgIDzQmtC+0LTQotC40L/R
g9CU0L7QutGD0LzQtdC90YLRgz4xOTwv0JrQvtC00KLQuNC/0YPQlNC+0LrRg9C80LXQvdGC0YM+
CiAgICA80JTQsNGC0LDQlNC+0LrRg9C80LXQvdGC0YM+MjAyMC0wMS0wMzwv0JTQsNGC0LDQlNC+
0LrRg9C80LXQvdGC0YM+CiAgICA80J/RgNC40YfQuNC90LDQkNC90YPQu9GO0LLQsNC90L3Rjz7Q
mtCw0LrQsNGPINGC0L4g0YHRg9C/0LXRgCDQv9GA0LjRh9C40L3QsCDQtNC70Y8g0LDQvdC90YPQ
u9C40YDQvtCy0LDQvdC40Y88L9Cf0YDQuNGH0LjQvdCw0JDQvdGD0LvRjtCy0LDQvdC90Y8+CiAg
ICA80JTQsNGC0LDQkNC90YPQu9GO0LLQsNC90L3Rjz4yMDIwLTAxLTAzPC/QlNCw0YLQsNCQ0L3R
g9C70Y7QstCw0L3QvdGPPgogIDwv0JfQsNCz0L7Qu9C+0LLQvtC6PgogIDzQlNC+0LrRg9C80LXQ
vdGC0KnQvtCQ0L3Rg9C70Y7RlNGC0YzRgdGPPgogICAgPNCd0L7QvNC10YDQlNC+0LrRg9C80LXQ
vdGC0YM+MjAxOS0xMi0wMy1URVNULTAwMzwv0J3QvtC80LXRgNCU0L7QutGD0LzQtdC90YLRgz4K
ICAgIDzQotC40L/QlNC+0LrRg9C80LXQvdGC0YM+0JLQuNC00LDRgtC60L7QstCwINC90LDQutC7
0LDQtNC90LA8L9Ci0LjQv9CU0L7QutGD0LzQtdC90YLRgz4KICAgIDzQmtC+0LTQotC40L/Rg9CU
0L7QutGD0LzQtdC90YLRgz4wMDY8L9Ca0L7QtNCi0LjQv9GD0JTQvtC60YPQvNC10L3RgtGDPgog
ICAgPNCU0LDRgtCw0JTQvtC60YPQvNC10L3RgtGDPjIwMTktMTItMDM8L9CU0LDRgtCw0JTQvtC6
0YPQvNC10L3RgtGDPgogIDwv0JTQvtC60YPQvNC10L3RgtCp0L7QkNC90YPQu9GO0ZTRgtGM0YHR
jz4KICA80KHRgtC+0YDQvtC90Lg+CiAgICA80JrQvtC90YLRgNCw0LPQtdC90YI+CiAgICAgIDzQ
odGC0LDRgtGD0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPtCS0ZbQtNC/0YDQsNCy0L3QuNC6PC/Q
odGC0LDRgtGD0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPgogICAgICA80JLQuNC00J7RgdC+0LHQ
uD7QrtGA0LjQtNC40YfQvdCwPC/QktC40LTQntGB0L7QsdC4PgogICAgICA80J3QsNC30LLQsNCa
0L7QvdGC0YDQsNCz0LXQvdGC0LA+0JvQtdCy0LjRhtC60LjQuSDQnC7Qky48L9Cd0LDQt9Cy0LDQ
mtC+0L3RgtGA0LDQs9C10L3RgtCwPgogICAgICA80JrQvtC00JrQvtC90YLRgNCw0LPQtdC90YLQ
sD4zMzEzMzExODwv0JrQvtC00JrQvtC90YLRgNCw0LPQtdC90YLQsD4KICAgICAgPNCG0J/QnT4z
MzEzMzExODMzPC/QhtCf0J0+CiAgICAgIDxJQkFOPlVBMTUzNTEwMDUwMDAwMDI2MDA3NjE0Mzk2
NTAwPC9JQkFOPgogICAgICA8R0xOPjk4NjQyMzIzMTk5NjI8L0dMTj4KICAgIDwv0JrQvtC90YLR
gNCw0LPQtdC90YI+CiAgICA80JrQvtC90YLRgNCw0LPQtdC90YI+CiAgICAgIDzQodGC0LDRgtGD
0YHQmtC+0L3RgtGA0LDQs9C10L3RgtCwPtCe0YLRgNC40LzRg9Cy0LDRhzwv0KHRgtCw0YLRg9GB
0JrQvtC90YLRgNCw0LPQtdC90YLQsD4KICAgICAgPNCS0LjQtNCe0YHQvtCx0Lg+0K7RgNC40LTQ
uNGH0L3QsDwv0JLQuNC00J7RgdC+0LHQuD4KICAgICAgPNCd0LDQt9Cy0LDQmtC+0L3RgtGA0LDQ
s9C10L3RgtCwPtCb0LXQstC40YbQutC40Lkg0Jwu0JMuPC/QndCw0LfQstCw0JrQvtC90YLRgNCw
0LPQtdC90YLQsD4KICAgICAgPNCa0L7QtNCa0L7QvdGC0YDQsNCz0LXQvdGC0LA+MzMxMzMxMTk8
L9Ca0L7QtNCa0L7QvdGC0YDQsNCz0LXQvdGC0LA+CiAgICAgIDzQhtCf0J0+MzMxMzMxMTgzNDwv
0IbQn9CdPgogICAgICA8R0xOPjk4NjQyMzIzMTk5Nzk8L0dMTj4KICAgIDwv0JrQvtC90YLRgNCw
0LPQtdC90YI+CiAgPC/QodGC0L7RgNC+0L3QuD4KPC/QldC70LXQutGC0YDQvtC90L3QuNC50JTQ
vtC60YPQvNC10L3Rgj4=
Створення квитанції №2 (прийняття документа COMDOC)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою POST методу api/v2/eds/comdoc/accept можливо прийняти документ COMDOC.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/comdoc/accept?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/comdoc/accept?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються дані для здійснення операції прийняття:

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

signs

M

ArrayList<Signs>

Масив об’єктів; підписи

signInfo

M

SignInfo

Об’єкт; інформація про підписи

Таблиця 2 - Опис параметрів об’єкта Signs

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт Signs

sign

string

підписані дані

type

number

кількість sign в об’єкті Signs (число N )

Таблиця 3 - Опис параметрів об’єкта SignInfo

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт SignInfo

doc_id

number

id конкретного документа

date

any

дата підписання

count

number

кількість підписів

hash

string

хеш контента підпису

certData

{…}

об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту (json):

{
  "signInfo": {
    "certData": [
      {
        "EDRPOUCode": "",
        "isTimeStamp": true,
        "ownerName": "ЕДІН Тест ФОП",
        "serial": "1A15A67BC8E82F4C040000003AFA04000F890B00",
        "signDate": "08.08.2019 13:46 ",
        "subjOrg": "ЕДІН Тест ФОП",
        "subjTitle": "ЕДІН Тест ФОП"
      }
    ],
    "count": 1,
    "date": null,
    "hash": "3BC3AF062BCC00D51EC20EEDF6D4D7A7"
  },
  "signs": [
    {
      "sign": "MIIX0Q...Q5/XCjmk1pXR8mrASIx3U1zV0=",
      "type": 1
    }
  ]
}

У відповідь передається код сервера 200 (ok).

Створення квитанції №13 (відхилення документа COMDOC)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою POST методу api/v2/eds/comdoc/reject можливо відхилити документ COMDOC.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/comdoc/reject?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/comdoc/reject?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються дані для здійснення операції відхилення:

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

signs

M

ArrayList<Signs>

Масив об’єктів; підписи

signInfo

M

SignInfo

Об’єкт; інформація про підписи

Таблиця 2 - Опис параметрів об’єкта Signs

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт Signs

sign

string

підписані дані

type

number

кількість sign в об’єкті Signs (число N )

Таблиця 3 - Опис параметрів об’єкта SignInfo

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт SignInfo

doc_id

number

id конкретного документа

date

any

дата підписання

count

number

кількість підписів

hash

string

хеш контента підпису

certData

{…}

об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту (json):

{
  "signInfo": {
    "certData": [
      {
        "EDRPOUCode": "",
        "isTimeStamp": true,
        "ownerName": "ЕДІН Тест ФОП",
        "serial": "1A15A67BC8E82F4C040000003AFA04000F890B00",
        "signDate": "08.08.2019 13:46 ",
        "subjOrg": "ЕДІН Тест ФОП",
        "subjTitle": "ЕДІН Тест ФОП"
      }
    ],
    "count": 1,
    "date": null,
    "hash": "3BC3AF062BCC00D51EC20EEDF6D4D7A7"
  },
  "signs": [
    {
      "sign": "MIIX0Q...Q5/XCjmk1pXR8mrASIx3U1zV0=",
      "type": 1
    }
  ]
}

У відповідь передається код сервера 200 (ok).

Створення квитанції №1 (підпис чернетки)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою POST методу api/v2/eds/doc/ticket можливо пілписати чернетку документа (COMDOC, DECLAR, DECLARJ12, DOCUMENTINVOICE, KORINVOICE).

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/doc/ticket?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/doc/ticket?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються дані для здійснення операції підписання:

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

signs

M

ArrayList<Signs>

Масив об’єктів; підписи

signInfo

M

SignInfo

Об’єкт; інформація про підписи

Таблиця 2 - Опис параметрів об’єкта Signs

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт Signs

sign

string

підписані дані

type

number

кількість sign в об’єкті Signs (число N )

Таблиця 3 - Опис параметрів об’єкта SignInfo

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт SignInfo

doc_id

number

id конкретного документа

date

any

дата підписання

count

number

кількість підписів

hash

string

хеш контента підпису

certData

{…}

об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту (json):

{
  "signInfo": {
    "certData": [
      {
        "EDRPOUCode": "",
        "isTimeStamp": true,
        "ownerName": "ЕДІН Тест ФОП",
        "serial": "1A15A67BC8E82F4C040000003AFA04000F890B00",
        "signDate": "08.08.2019 13:46 ",
        "subjOrg": "ЕДІН Тест ФОП",
        "subjTitle": "ЕДІН Тест ФОП"
      }
    ],
    "count": 1,
    "date": null,
    "hash": "3BC3AF062BCC00D51EC20EEDF6D4D7A7"
  },
  "signs": [
    {
      "sign": "MIIX0Q...Q5/XCjmk1pXR8mrASIx3U1zV0=",
      "type": 1
    }
  ]
}

У відповідь передається код сервера 200 (ok).

Створення квитанції №12 (прийняття запиту на анулювання COMDOC)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою POST методу api/v2/eds/comdoc/repeal/accept можливо прийняти запит на анулювання документу COMDOC.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/comdoc/repeal/accept?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/comdoc/repeal/accept?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються дані для прийняття запиту на анулювання COMDOC:

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

signs

M

ArrayList<Signs>

Масив об’єктів; підписи

signInfo

M

SignInfo

Об’єкт; інформація про підписи

Таблиця 2 - Опис параметрів об’єкта Signs

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт Signs

sign

string

підписані дані

type

number

кількість sign в об’єкті Signs (число N )

Таблиця 3 - Опис параметрів об’єкта SignInfo

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт SignInfo

doc_id

number

id конкретного документа

date

any

дата підписання

count

number

кількість підписів

hash

string

хеш контента підпису

certData

{…}

об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту (json):

{
  "signInfo": {
    "certData": [
      {
        "EDRPOUCode": "",
        "isTimeStamp": true,
        "ownerName": "ЕДІН Тест ФОП",
        "serial": "1A15A67BC8E82F4C040000003AFA04000F890B00",
        "signDate": "08.08.2019 13:46 ",
        "subjOrg": "ЕДІН Тест ФОП",
        "subjTitle": "ЕДІН Тест ФОП"
      }
    ],
    "count": 1,
    "date": null,
    "hash": "3BC3AF062BCC00D51EC20EEDF6D4D7A7"
  },
  "signs": [
    {
      "sign": "MIIX0Q...Q5/XCjmk1pXR8mrASIx3U1zV0=",
      "type": 1
    }
  ]
}

У відповідь передається код сервера 200 (ok).

Створення квитанції №11 (запит на анулювання COMDOC)

Для роботи з цим методом користувач повинен бути авторизованим .

За допомогою POST методу api/v2/eds/comdoc/repeal можливо відправити запит на анулювання документу COMDOC.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/v2/eds/comdoc/repeal?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації

Обов’язкові url-параметри:

gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

doc_uuid - рядок; UUID документа COMDOC

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/v2/eds/comdoc/repeal?gln=9864065702429&doc_uuid=c1f6a1d0-5aaf-4a06-b78d-71c238f70986“ -d {json - тело документа} -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

У цьому методі в json-тілі запиту передаються дані для здійснення запит на анулювання COMDOC:

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

signs

M

ArrayList<Signs>

Масив об’єктів; підписи

signInfo

M

SignInfo

Об’єкт; інформація про підписи

Таблиця 2 - Опис параметрів об’єкта Signs

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт Signs

sign

string

підписані дані

type

number

кількість sign в об’єкті Signs (число N )

Таблиця 3 - Опис параметрів об’єкта SignInfo

Параметр

Mandatory/Optional

Формат

Опис

Об’єкт SignInfo

doc_id

number

id конкретного документа

date

any

дата підписання

count

number

кількість підписів

hash

string

хеш контента підпису

certData

{…}

об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту (json):

{
  "signInfo": {
    "certData": [
      {
        "EDRPOUCode": "",
        "isTimeStamp": true,
        "ownerName": "ЕДІН Тест ФОП",
        "serial": "1A15A67BC8E82F4C040000003AFA04000F890B00",
        "signDate": "08.08.2019 13:46 ",
        "subjOrg": "ЕДІН Тест ФОП",
        "subjTitle": "ЕДІН Тест ФОП"
      }
    ],
    "count": 1,
    "date": null,
    "hash": "3BC3AF062BCC00D51EC20EEDF6D4D7A7"
  },
  "signs": [
    {
      "sign": "MIIX0Q...Q5/XCjmk1pXR8mrASIx3U1zV0=",
      "type": 1
    }
  ]
}

У відповідь передається код сервера 200 (ok).

SOAP API

WSDL схема для роботи з FTPEX по SOAP: https://soap.edi-n.com/soap/service.wsdl

Отримання списку доступних файлів (getList)

Сигнатура (параметри які потрібно передати): логін і MD5 пароля (ті дані, які були видані користувачу при підключенні до платформи електронного документообігу) (MD5 генератор http://www.danstools.com/md5-hash-generator/).

У відповідь отримуємо список імен файлів, які на даний момент доступні користувачеві.

Приклад відповіді:

<result>
           <errorCode>0</errorCode>
           <list>status_20150924144604_4679904.xml</list>
           <list>status_20150924144604_7259532.xml</list>
           <list>status_20150924144604_4784911.xml</list>
   ...
   ...
   <list>status_20151005123023_686803070.xml</list>
           <list>order_20151005132435_707890630.xml</list>
 </result>

Можливі помилки:

  • errorCode 1 - помилка при авторизації,

  • errorCode 2 - інша помилка

«Масове» отримання документів (кількох шуканих документів) (getDocuments)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля і конкретні імена файлів (імена файлів повертає getList)

Що повертає: код відповіді сервера (0 - успішна обробка), а також закодований в base64 zip архів із затребуваними файлами.

Приклад запиту:

<soap:getDocumentsRequest>
   <!--Optional:-->
   <user>
      <!--Optional:-->
      <login>login</login>
      <!--Optional:-->
      <pass>parol</pass>
   </user>
   <!--Zero or more repetitions:-->
   <fileName>hello.xml</fileName>
  <fileName>musician.xml</fileName>
</soap:getDocumentsRequest>

Приклад відповіді:

<result>
   <errorCode>0</errorCode>
 <content>UEsDBBQACAgIAD...AAAA</content>
</result>

Можливі помилки:

  • errorCode 1 - помилка отримання документів (значення помилки повертається в <errorMessage/>)

Отримання конкретного файлу (getDoc)

Сигнатура (параметри, які потрібно передати): логін, MD5 пароля і конкретне ім’я файлу (імена файлів повертає getList)

У відповідь отримуємо конкретний файл у вигляді BASE-64 рядка.

Приклад відповіді:

<result>
          <errorCode>0</errorCode>
          <content>PFN0YXR1cz4KI...4KPC9TdGF0dXM+</content>
</result>

Вміст поля <content> перекладається в XML подання шляхом розшифровки BASE-64 (в результаті виходить тіло XML файлу).

Можливі помилки:

  • errorCode 1 - помилка при отриманні документа.

Передача конкретного файлу (sendDoc)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля, конкретне ім’я файлу і тіло файлу в вигляді BASE-64 рядка.

У відповідь отримуємо код відповіді сервера (0 - успішна передача).

Приклад відповіді:

<result>
           <errorCode>0</errorCode>
</result>

Можливі помилки:

  • errorCode 3 - помилка при відправленні документа

Архівування документа (видалення конкретного файлу з сервера) (archiveDoc)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля і конкретне ім’я файлу (імена файлів повертає getList)

Що повертає: код відповіді сервера (0 - успішна обробка).

Приклад відповіді:

<result>
           <errorCode>0</errorCode>
</result>

Можливі помилки:

  • errorCode 4 - помилка при архівуванні документа

«Масове» архівування документів (видалення файлів з сервера) (archiveDocuments)

Сигнатура (параметри які потрібно передати): логін, MD5 пароля і конкретне ім’я файлу (імена файлів повертає getList)

Що повертає: код відповіді сервера (0 - успішна обробка).

Приклад запиту:

<soap:archiveDocumentsRequest>
   <!--Optional:-->
   <user>
      <!--Optional:-->
      <login>login</login>
      <!--Optional:-->
      <pass>parol</pass>
   </user>
   <!--Zero or more repetitions:-->
       <fileName>hello.xml</fileName>
     <fileName>musician.xml</fileName>
</soap:archiveDocumentsRequest>

Приклад відповіді:

<result>
           <errorCode>0</errorCode>
</result>

Можливі помилки:

  • errorCode 4 - помилка при архівуванні документа (значення помилки повертається в<errorMessage/>)

FTP/FTPS

Структура сервера:

  • inbox/ - каталог з вхідними документами

  • cinbox/ - каталог з вхідними документами, зі спец. настройками

  • outbox/ - каталог для вихідних документів

  • coutbox/ - каталог для вихідних документів, зі спец. настройками

  • error/ - каталог з помилковими документами, які не оброблені системою

  • reports/ - каталог для вихідних спец. документів ДФС

  • transit/ - службовий каталог

Примітки щодо використання:

Адреса сервера обміну ftp://ftp.edi-n.com

Якщо ви використовуєте формат обміну даними EDIN, то робочими папками будуть /outbox/ і /inbox/, а якщо використовуєте інший, раніше обумовлений формат обміну даними, то робочими папками будуть: /coutbox/ і /cinbox/.

За замовчуванням файли, які ви відправляєте, будуть з’являтися в веб-інтерфейсі системи у вкладці «Чернетки», але не будуть відправлятися в роздрібну мережу. Для настройки автоматичної відправки потрібен письмовий запит від користувача на адресу integration@edi-n.com.

Важливо

Увага, в іменах файлів для завантаження повинні використовуватися тільки цифри, латинські літери і символи «&», «_», «-» чи «.».

Платформа EDIN також підтримує FTPS з’єднання: ftps://ftp.edi-n.com

Використовуючи такий тип з’єднання, порт буде: 990

FTPS (File Transfer Protocol + SSL, або FTP / SSL) - це розширення широко використовуваного протоколу передачі даних FTP, яке додає підтримку для криптографічних протоколів рівнів транспортної безпеки і захищених сокетів.

Інтеграція 1C

1C API

Інструкція розробника. Первинні налаштування

Скорочення:

ОС - облікова система

ЕЦП - електронно-цифровий підпис/печатка

GLN - (Global Location Number) глобальний номер місцезнаходження

НКІ - носій конфіденційної інформації

Перший запуск і налаштування модуля

Розроблений компанією EDIN інтеграційний модуль EDIN.API (в подальшому просто модуль) дозволяє працювати з обліковими системами 1С: Підприємство 8.Х на звичайних та керованих формах (надалі 1С) на базі операційної системи Windows.

Для роботи з модулем у користувача повинна бути підключена послуга для роботи з API. Для роботи з модулем користувачеві надаються логін, пароль і api_key:

  • email - логін користувача;

  • password - пароль користувача на платформі EDIN 2.0

  • api_key - пароль доступу до API

Для запуску модуля необхідно в обліковій системі 1С відкрити файл запуску модуля (передається користувачеві співробітниками EDIN):

_images/operator_instruction_01.jpg

Важливо

У користувача повинні бути повні права на каталог, в якому знаходиться файл модуля

Примітка

Для 1С на керованих формах не потрібні права на каталог, в якому знаходиться обробка

При підключенні модуля облікова система 1С може вимагати від користувача дозвіл на виконання операцій з боку модуля (захист від небезпечних дій).

_images/operator_instruction_02.jpg

При першому запуску (відсутній config.txt) автоматично відкривається розділ «Налаштування» для введення всіх необхідних даних (надалі при запуску відкривається розділ «Вхідні»). У каталозі, в якому розташований файл модуля, автоматично створюються: 1) файл основних налаштувань Config.txt; 2) каталог з назвою поточного користувача 1С, в якому створюється файл налаштувань користувача UserSettings.txt

Примітка

Налаштування для 1С на керованих формах зберігаються у типовому довіднику 1С «Файли». Загальні налаштування зберігаються у елементі довіднику з назвою «EDIN_config», налаштування користувача зберігаються у елементі довідника із назвою «EDIN_UserSettings_» + Назва користувача інформаційної бази. При першому запуску (відсутній елемент довіднику «Файли» з назвою «EDIN_config» ) автоматично відкривається розділ «Налаштування» для введення всіх необхідних даних (надалі при запуску відкривається розділ «Вхідні»).

«Налаштування»
_images/operator_instruction_03n.jpg

Розділ містить 4 вкладки:

  • Підключення

  • Об’єкти 1С

  • Користувач

  • ЕЦП

Підключення

Основний каталог - місце розташування файлу модуля.

Сервер обміну - адреса платформи електронного документообігу (на цю адресу надсилаються запити модуля)

У цій вкладці додаються (кнопка «Додати») користувачі, для кожного вказуються свої Логін (email) / Пароль / api_key. У цій вкладці також здійснюється вибір користувачів, від імені яких будуть здійснюватися подальші дії, наприклад, запити на відображення Вхідних / Вихідних документів.

_images/operator_instruction_04n.jpg

Налаштування користувачів зберігаються в файлі UserSettings, який розміщується в підкаталозі (найменування = <користувач 1С>) на одному рівні з файлом запуску модуля.

Примітка

Налаштування користувачів для 1С на керованих формах зберігаються у типовому довіднику 1С «Файли» у елементі довідника із назвою «EDIN_UserSettings_» + Назва користувача інформаційної бази.

Після того, як дані користувачів були введені можливо здійснити перевірку (кнопка «Перевірити підключення користувачів») введених даних (по користувачам, у рядках яких встановлено відмітки в колонці «Вибрати»). В результаті перевірки отриманий токен свідчить про коректно заповнені дані, пройдену авторизацію на платформі електронного документообігу.

Об’єкти 1С

Для подальшої роботи з електронним документообігом необхідно провести синхронізацію модуля і 1С, а також здійснити налаштування збереження даних довідників і документів.

_images/operator_instruction_05n.jpg

Вид конфігурації - поле заповнюється автоматично (модуль підставляє поточну версію конфігурації ОС 1С).

Важливо

Подивитися версію своєї 1С: Меню -> Довідка -> Про програму. У разі якщо облікова система 1С самописна або модифікована, то необхідно вибрати типову версію 1С, на підставі якої вона була написана/змінена. Неправильно обраний вид конфігурації може привести до проблем створення документів з 1С.

_images/operator_instruction_06.jpg

Кнопки: Мережі - відкриває вікно переліку всіх мереж, підключених до провайдера електронного документообігу. З цього переліку необхідно вибрати мережі (контрагентів) з якими користувач буде обмінюватися документами (вибір впливає на заповнення довідника Контрагенти).

Коди одиниць виміру - одиниці виміру, які повинні бути внесені в 1С (вказувати коди одиниць виміру необхідно в формі, яка відкривається при натисканні кнопки «Коди одиниць виміру»).

_images/operator_instruction_20n.jpg _images/operator_instruction_21n.jpg

Номенклатура контрагентів – кнопка відкриття об’єкту 1C, в якому зберігаються артикули і штрихкоди номенклатури контрагентів. В залежності від виду конфігурації назва колонки і відповідно об’єкт 1С можуть змінюватися. Для всіх конфігурацій на звичайних формах і для конфігурації «Бухгаглерія» на керованих формах використовується регістр відомостей «Номенклатура контрагентів». Для інших конфігурацій на керованих використовується довідник «Номенклатура постачальників».

Налаштування довідників

Важливо

Налаштування цього розділу рекомендовано виконувати володіючи знаннями досвідченного користувача або спільно з розробником 1С.

Для постачальників доступні 3 основні типи довідників (Організації, Контрагенти, Точки доставки), в які в ОС 1С будуть зберігатися власні дані користувача, дані контрагентів і їх точки доставки відповідно.

_images/operator_instruction_23.jpg

У цьому розділі для кожного довідника проводиться налаштування «місця розташування» зберігання даних (GLN (обов’язково), Формат НН, Ціни з бази 1С…) всередині облікової системи 1С. Можливо заповнити всі табличні налаштування розділу «Довідники» за замовчуванням (кнопка «Заповнити за замовчуванням») або зробити всі налаштування вручну.

Принципи заповнення: «По замовчуванню» і «Ручний»

При заповненні перевагу необхідно надавати принципу По замовчуванню. Виконується при натисканні кнопки «Заповнити по замовчуванню». При заповненні автоматично обираються типові довідники конфігурації і тільки необхідні налаштування. Вибір розташування обмежений двома варіантами: «Додаткові відомості» і «Реквізити довідника». В залежності від конфігурації, в якій використовується інтеграція, визначаються доступні варіанти. При доступності обох варіантів збереження перевага надається «Додатковим відомостям», оскільки вони не вносять зміни до вже існуючих довідників ОС користувача, а дозволяють зберігати дані окремо (незалежно від інших компонентів програми).

При ручному налаштуванні в колонці «Довідник 1С» відображаються списки доступних довідників, а в полях налаштувань (через double-click по необхідному полю) відкривається окрема форма заповнення налаштувань.

Важливо

У табличній частині налаштування «Довідник 1С» і «GLN» є обов’язковими до заповнення.

Приклад заповнення табличної частини налаштувань розділу «Довідники»:

_images/operator_instruction_08.jpg

При синхронізації з платформою електронного документообігу EDIN в ці довідники (Організації, Контрагенти, Точки доставки) автоматично підтягуються дані (перегляд/редагування через double-click). Організації наповнюються по користувацькому логіну (після успішної авторизації):

_images/operator_instruction_10n.jpg

В довіднику Контрагенти відображаються юридичні особи і точки доставки контрагентів, для яких можливо проставити додаткові налаштування:

_images/operator_instruction_11n.jpg

Довідник Точки доставки відрізняється від останнього наповненням колонок, відповідно до вимог EDI документообігу.

Налаштування документів

Важливо

Налаштування цього розділу рекомендовано виконувати володіючи знаннями досвідченного користувача або спільно з розробником 1С.

У цьому розділі для кожного типу документа проводиться налаштування «місця розташування» зберігання даних документів в УС 1С. Налаштування також можливо проводити По замовчуванню (кнопка «Заповнити за замовчуванням») та вручну через double-click. Принципи заповнення: «По замовчуванню» і «Ручний» табличної частини аналогічні налаштуванням довідників.

Створення документів в 1С залежить від виду конфігурації. 1С Бухгалтерія на звичайних і керованих формах дозволяє створювати «Рахунок на оплату покупця», «Реалізація товарів і послуг». Інші 1С (НЕ БУХГАЛТЕРІЯ) на звичайних формах дозволяють створити «Замовлення покупця», «Реалізація товарів і послуг». В 1С Управління невеликою фірмою і Управління середнім бізнесом на керованих формах можливо створити «Замовлення клієнта», «Видаткову накладну». Для 1С Управління торгівлею, Управління підприємством, Управління виробничим підприємством можливо створити «Замовлення клієнта» и «Реалізація товарів і послуг»:

_images/operator_instruction_09n.jpg
Користувач

Розділ в якому користувач може вибрати шлях локального сховища, в якому будуть зберігатися вхідні / вихідні ЮЗД документи, а також логи роботи модуля (аналіз документообігу). Поля Склад і Підрозділ також заповнюються для зручності користувача.

Проставлена відмітка в налаштуваннях «Тестовий режим» - додатково при відправці документу направляє його в «Чернетки» (розділ, що містить створені, але ще не відправлені документи).

Такі налаштування дозволяють співробітнику (наприклад недосвідченому чи без ЕЦП) створювати документи, а безпосередньою перевіркою/відправкою вже займається бухгалтер/керівник чи інший відповідальний співробітник.

_images/operator_instruction_13.jpg
ЕЦП

Розділ настройки електронно-цифрового підпису і печатки (ЕЦП), в якому зазначаються сертифікати ДФС (знаходяться у вільному доступі) і EDIN (надається співробітником компанії).

_images/operator_instruction_14n.jpg

У таблицю через кнопку «Додати» можливо вности або шляхи до ключів бухгалтера і печатки для організацій, по яким планується вивантаження юридично значимих документів або вказати токен (НКІ). Якщо вказано шлях до файлу (ключа) і токену, то пріоритет надається файлу. Налаштування для токену («Тип пристрою» та «Пристрій» (серійний номер часто вказується на фізичному носії)) можливо вибрати зі списку або скористатись автоматичним підбором налаштувань.

Важливо

Деякі оператори АЦСК розділяють розділяють ЕЦП на «ключ печатки» та «ключ печатки для шифрування». В такому випадку потрібно вносити в налаштування три ключа. «Ключ печатки для шифрування» використовується лише при відправці «Податкової накладної».

При вивантаженні юридично значимих документів паролі можна вносити або до таблиці, або обробка відобразить вікно для їх внесення перед початком підписання. Кнопка «Перевірити ЕЦП» дозволяє перевірити коректність введених даних ключів і паролів перед початком підписання.

Модуль дозволяє зберігати будь-яку кількість наборів ключів, але на момент підписання по одній організації і типу документу необхідно вибрати (встановити прапорець в колонці «Вибрати») тільки одну пару ключів.

При виявленні помилки при перевірці модуль попросить повторно ввести пароль:

_images/operator_instruction_15.jpg

При кожній перевірці ключа у вікні повідомлень відображається опис результату виконаної перевірки.

Інструкція користувача

Скорочення:

ОС - облікова система

ЕЦП - електронно-цифровий підпис/печатка

GLN - (Global Location Number) глобальний номер місцезнаходження

EDI - (Electronic Data Interchange) електронний обмін данними; тут мається на увазі не ЮЗ документообіг.

ЮЗД - юридично значимий документ/документообіг

Робота з модулем
1. Вступ

Дана інструкція описує роботу з інтеграційним модулем EDIN для облікової системи (далі ОС). Інтеграційний модуль являє собою зовнішню обробку для інтеграції електронного документообігу між обліковою системою користувача та платформою EDIN. Модуль інтеграції створено для типових конфігурацій ОС, але також є можливість налаштування під нестандартні конфігурації. Для роботи з документами меню інтеграційного модуля розділено на:

  • «Вхідні» - розділ для роботи з вхідними документами

  • «Відправлені» - розділ для роботи з вихідними документами

  • «Чернетки» - розділ для роботи зі створеними / підписаними, але ще не відправленими документами

Підказка

Розділ «Налаштування» описано в Інструкції оператора. Первинні налаштування

_images/user_instruction_01.jpg
2. «Вхідні»

Розділ вхідних документів (від контрагентів) при запуску модуля відкривається за замовчуванням. В журналі документів відображаються всі вхідні документи за датою їх отримання. Список документів можливо відфільтрувати за датою документа (поля «Дата з» / «по»), повним номером документа (поле номер). Також можливо налаштувати кількість документів, що будуть виводитись на одній сторінці журналу (пагінація) - це дозволяє пришвидшити завантаження сторінки та роботу з новими документами.

_images/user_instruction_02.jpg

Важливо

У «Вхідних»/»Відправлених» в списку журналу відображається документ, що є останнім в «ланцюжку документів» (документи, що логічно об’єднані між собою). В журналі документів для зручності проставляються позначки про наявність відповідних типів документів в ланцюжку.

_images/user_instruction_03.jpg

Через подвійний клік лівою кнопкою мишки по номеру/даті документу можливо відкрити друковану форму документу із коротким описом пов’язаних документів у ланцюжку. В цій формі можливо переглянути кожен пов’язаний документ.

_images/user_instruction_07.jpg

Документи в ланцюжку розташовані в хронологічному порядку; в цій формі можливо перейти на кожен документ в ланцюжку через подвійний клік. Через «Файл»->»Друк» можливо роздрукувати документ, а через «Файл»->»Зберегти як» зберегти документ на локальний носій в *.xml, *.odt, *.html, *.docx, *.txt та ін. форматах (типовий функціонал ОС).

У розділі присутні кнопки оновлення списку документів refresh (оновлення вхідних документів з платформи електронного документообігу та довантаження створених документів з ОС).

Важливо

Попередньо перед створенням документів необхідно обов’язково переконатися, що вказані відповідні GLN з довідниками ОС .

3. «Відправлені»

Розділ відправлених документів (до контрагентів) відображає в журналі документів всі відправлені документи за датою їх відправки. Аналогічно до розділу «Вхідних» документів «Відправлені» містить фільтри за датою документа (поля «Дата з» / «по»), повним номером документа (поле номер) і також дозволяє налаштувати кількість документів, що будуть виводитись на одній сторінці журналу (пагінація).

Важливо

У «Вхідних»/»Відправлених» в списку журналу відображається документ, що є останнім в «ланцюжку документів» (документи, що логічно об’єднані між собою). В журналі документів для зручності проставляються позначки про наявність відповідних типів документів в ланцюжку.

_images/user_instruction_03.jpg

Через подвійний клік лівою кнопкою мишки по номеру/даті документу можливо відкрити друковану форму документу із коротким описом пов’язаних документів у ланцюжку. В цій формі можливо переглянути кожен пов’язаний документ.

_images/user_instruction_07.jpg

Документи в ланцюжку розташовані в хронологічному порядку; в цій формі можливо перейти на кожен документ в ланцюжку через подвійний клік. Через «Файл»->»Друк» можливо роздрукувати документ, а через «Файл»->»Зберегти як» зберегти документ на локальний носій в *.xml, *.odt, *.html, *.docx, *.txt та ін. форматах (типовий функціонал ОС).

У розділі присутні кнопки оновлення списку документів refresh (оновлення вхідних документів з платформи електронного документообігу та довантаження створених документів з ОС).

Важливо

Попередньо перед створенням документів необхідно обов’язково переконатися, що вказані відповідні GLN з довідниками ОС .

4. «Чернетки»

«Чернетки» - це розділ, журнал якого містить створені, але ще не відправлені документи. Юридично значимі документи потрапляють до цього розділу вже підписаними. Документи потрапляють до цього розділу, якщо в налаштуваннях користувача проставлена відмітка «Тестовий режим».

Такі налаштування дозволяють співробітнику (наприклад недосвідченому чи без ЕЦП) створювати документи, а безпосередньою перевіркою/відправкою вже займається бухгалтер/керівник чи інший відповідальний співробітник.

5 Створення та відправка документів
5.1 EDI

Створювати EDI документи в ОС можна тільки на основі вхідного Замовлення. Для створення відповідного документа ОС необхідно Вибрати вхідний документ і вибрати тип відповідного документа під кнопкою Створити:

_images/user_instruction_05.jpg

Якщо модуль автоматично не розпізнав Контрагента/Організацію/Точку доставки - можливо через подвійний клік мишкою по об’єкту вручну вибрати з довідника ОС (налаштування).

При створенні документа в ОС модуль автоматично підтягує всі необхідні дані, проте якщо номенклатура була знайдена не вся - модуль відкриває вікно «Незнайдена номенклатура» для додавання і збереження артикула і штрих-кода контрагента у відповідному довіднику/регістрі відомостей ОС:

_images/user_instruction_06.jpg

Для відправки документа у відповідь необхідно вибрати документ в колонці «Документ ОС», зробити позначку навпроти вхідного документа (колонка «Вибрати») і натиснути «Відправити»:

_images/user_instruction_08.jpg _images/user_instruction_09.png

Важливо

Якщо одразу відправити «Замовлення» без створення документу в ОС, то «Замовлення» підтвердиться в повному обсязі.

Важливо

Якщо документ відправити повторно тойже документ, то система повідомить про це та запитає про необхідність повторної відправки документу чи документів.

_images/user_instruction_10.jpg

Всі EDI документи відправляються тільки на основі вхідних замовлень. В залежності від виду вивантаженого документу автоматично визначаються необхідні джерела заповнення даних:

  1. Підтвердження замовлення (ORDRSP) – якщо не створено жодного документу в ОС, тоді буде відправлено підтвердження у повному об’ємі вказаному в замовленні. Якщо відповідні документи ОС створені, тоді кількість заповнюється з них;

  2. Повідомлення про відвантаження (DESADV) – створюється тільки при наявності відповідного документу в ОС;

  3. Рахунок (INVOICE) – створюється тільки при наявності відповідного документу в ОС;

5.2 ЮЗД

Важливо

Для роботи з юридично значимими документами в модулі повинні бути `налаштовані ЕЦП <https://wiki.edi-n.com/uk/latest/integration_2_0/1C_integration_2_0/1C_API_integration_2_0/operator_instruction.html#etsp`__ для кожної організації.

Комерційні документи (COMDOC) надходять в розділ «Вхідні» вже підписаними зі сторони відправника. У відповідь користувачу доступно підтвердити документ (кнопка «Підписати») чи відмовити (кнопка «Відмова від підписання»). В випадку «Відмова від підписання», в Комерційному документі необхідно заповнити поле коментар, мотивуючий відмову від підписання.

_images/user_instruction_13.jpg

  1. Підписати – призначено для підписання вхідного комерційного документу;

  2. Видаткова накладна (ком. док) – призначено для вивантаження комерційного документу «Видаткова накладна», який використовується в схемах обміну деяких торгівельних мереж (створюється на основі «Реалізації товарів та послуг»);

  3. Відмова від підписання (ком.док) – призначено для відмови від підписання вхідного комерційного документу.

При будь-якій роботі з ключами (в тому числі і підписанні) системний модуль запитує пароль ключа для бухгалтера та печатки. Модуль запитує пароль 1 раз в сесію для кожної організації, вказаної в `налаштуваннях ЕЦП <https://wiki.edi-n.com/uk/latest/integration_2_0/1C_integration_2_0/1C_API_integration_2_0/operator_instruction.html#etsp`__.

_images/user_instruction_12.jpg

Документ «Податкова накладна» автоматично підтягується з ОС користувача. Для відправки «Податкової накладної» необхідно перейти в «Відправлені», вибрати документ (відмітка галочкою) та натиснути кнопку «Відправити» -> «Податкова накладна». Аналогічно відправляється і «Коригування на податкову накладну» (Додаток 2 до податкової накладної).

_images/user_instruction_11.jpg

Документи «Податкова накладна» і «Коригування податкових накладних», по яким не були відправлені електронні документи виділяються сірим кольором і відображаються у кінці списку відправлених документів. Не відправлені податкові документи відбираються по контрагентам, в яких вказано в налаштуваннях формат вивантаження податкових документів і організації, для яких вказано GLN.

_images/user_instruction_14.jpg

Кількість документів, яка вказується на закладці відправлених документів

_images/user_instruction_15.jpg

не впливає на відображення невідправлених податкових.

Інструкції

EDIN-Price

Інструкції для торгової мережі

Узгодження цін на web-платформі EDIN-Price. Інструкція для роздрібної мережі
Вивантаження товарного довідника для Постачальника. Схема роботи
_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_01.png

Роздрібна мережа зі своєї облікової системи вивантажує на FTP актуальний товарний довідник (контракт, специфікації) в форматі XML (PRODUCTLIST.XML). Після обробки даного файлу на платформі EDIN, у постачальника, в меню Сервіс - EDIN-Price, відобразиться перелік діючих контрактів з мережею. Постачальник на підставі узгодженого товарного довідника формує пропозицію щодо зміни цін і направляє його в торговельну мережу.

Торгова мережа проводить узгодження даної пропозиції, в разі успішного погодження, підписує зі свого боку комерційний документ і направляє його постачальнику. Постачальник зі свого боку підписує комерційний документ і відправляє Торгової мережі. Після отримання підписаного з обох сторін комерційного документа, на FTP Торгової мережі викладається новий узгоджений PRODUCTLIST.XML, на підставі якого оновлюються дані в обліковій системі. Після цих змін мережа повторно вивантажує вже оновлений товарний довідник (контракт, специфікацію) на FTP.

Примітка

В разі будь-яких змін, погоджених не через систему EDI, PRODUCTLIST.XML вивантажується повторно.

Обробка Товарного узгодження

Примітка! При наявності в бізнес процесі додаткових департаментів (керівник відділу закупівлі, служба безпеки, економічна безпека, фінансовий аналітик, логістика) статуси можуть змінюватися.

Нижче представлений список можливих статусів:

  1. На погодженні - отримано мережею, без внесення змін

  2. Підготовлено - оброблений категорійним менеджером мережі

Проміжні статуси обробки документів для регулювання бізнес процесів узгодження:

  • Підтверджений

  • Перевірений

  • Готовий до підписання

  • Узгоджений

  1. Підписано - оброблений фінальним підписантом і накладена ЕЦП з боку мережі

1 етап. Обробка товарного узгодження категорійним менеджером

Документ Товарне узгодження, відправлений Постачальником, знаходитися в розділі Вхідні. Відібрати документи для обробки можна за допомогою фільтра. Для цього необхідно вибрати тип документа «Товарне узгодження» і відповідний статус:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_02.png

Для швидкого доступу до документів, які потребують обробки, можна створити ярлик «Необхідно узгодження»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_03.png

Для відкриття вхідного документа натисніть на нього:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_04.png

У відкритому документі можна побачити основну інформацію, яка залежить від типу документа, а при натисканні на кнопку Показати повністю можна подивитися додатковий вміст документа. У документі на зміну регулярної / промо ціни Вам необхідно перевірити ціни в кожній з позицій і вказати статус - Прийнято / Не прийнято, по необхідності змінити період для нової ціни, а потім змінити загальний статус документа - На погодженні / Підготовлено.

Біля найменування товарної позиції розміщена ікона «інфо». Після її натискання, в додатковому вікні відкриваються піктограми Listex і Ucat. Натиснувши на них відбувається перехід на сайт каталогів. Якщо по товару постачальник завантажив сертифікат, то біля штрих-коду буде іконка «галочка», яка свідчить про те, що до штрих-коду прикріплений сертифікат. Після її натискання в додатковому вікні відобразиться основна інформація по сертифікату:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_05.png

За допомогою кнопок «Дія» можливо:

  • скачати сертифікат з усіма додатками (архів з файлами)

  • переглянути скан-копію сертифіката

  • отримати пряме посилання на скан-копію сертифіката

  • скачати основний бланк сертифіката (титульна сторінка)

Додатково, для перепогодження регулярної ціни, якщо зазначений період документа має спільні дати з раніше узгодженими промо цінами, то біля дати останньої зміни буде розміщена іконка «відсотки». Після її натискання, в додатковому вікні відкриється раніше узгоджена додаткова інформація по промо: період і ціна з ПДВ:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_06.png

Після зміни статусу, Вам необхідно підтвердити дію, для цього натисніть «Закінчити»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_07.png

У вікні «Зв’язок з продавцем» у Вас є можливість читати коментарі постачальника і залишати свої. Для цього введіть текст повідомлення в порожнє поле і натисніть кнопку Надіслати:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_08.png
2 етап. Обробка Товарного узгодження Керівником відділу закупівель

Документ Товарне узгодження, узгоджений Категорійним менеджером знаходиться в розділі Вхідні зі статусом Підготовлено. Аналогічно, як і для категорійного менеджера, можна скористатися фільтрами або перейти по ярлику «Необхідно узгодження» для відображення потрібного списку документів. Для відкриття вхідного документа натисніть на нього:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_09.png

У формі документа Вам необхідно перевірити ціни в кожній з позицій, вказати статус - Прийнято / Не прийнято, а потім змінити загальний статус документа - Готовий до підписання / Відхилено.

Також нижче в формі документа у Вас є можливість звернутися до відповідного постачальника і залишити йому коментар. Для цього введіть текст повідомлення в порожнє поле і натисніть кнопку Надіслати.

Після зміни статусу, Вам необхідно підтвердити дію, для цього натисніть «Закінчити»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_10.png
3 етап. Обробка і підписання Товарного узгодження Комерційним директором

Документ Товарне узгодження, узгоджений Керівником відділу закупівель знаходиться в розділі Вхідні зі статусом Готовий до підписання. Як і для попередніх ролей, документи можна відфільтрувати за статусом або перейти по ярлику «Необхідно узгодження».

Примітка! Є можливість масового підписання. Цей процес описаний в розділі Додаткові можливості і функції.

У разі одиничного підписання необхідно відкрити вхідний документ Товарне узгодження, натиснувши на нього:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_11.png

У формі документа Вам необхідно перевірити ціни в кожній з позицій, вказати статус - Прийнято / Не прийнято, потім змінити загальний статус документа - Погоджено / Відхилено. Після зміни статусу натисніть кнопку Підписати.

Після первинної настройки ЕЦП і введення ключів натисніть кнопку Зчитати ключі:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_13.png

Виберіть відповідні ключі для підписання і натисніть знову Зчитати ключі:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_14.png

Потім натисніть Підписати:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_15.png

Після успішного підписання, натисніть кнопку Надіслати:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_16.png
Створення Товарного узгодження
Перегляд актуального узгодженого довідника

Для перегляду і подальшої роботи з узгодженим довідником необхідно навести курсор миші на трикутник біля меню «Сервіс» і в випадаючому списку вибрати EDIN-Price:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_17.png

При цьому відкриється сторінка з актуальними товарними довідниками, згрупованими за назвою постачальника:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_18.png

Фільтр «пошук» шукає по найменуванню компанії, товарної позиції, ЄДРПОУ, номеру договору, номеру контракту, штрих-коду, артикулу. Для перегляду вмісту довідника необхідно зайти в відповідний документ шляхом натискання лівої кнопки миші. Буде відкрита детальна форма довідника.

Примітка

Всі дані, наведені на формі - фіктивні, використовуються тільки в якості прикладу

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_19.png
Створення пропозиції

Для ініціювання процесу перепогодження регулярної ціни необхідно створити документ «Товарне узгодження». Створення документа для перепогодження промо цін можливе в 2-х режимах - вручну та за допомогою завантаження Excel файла.

Створення Товарного узгодження для перепогодження промо ціни вручну

Для створення товарного узгодження зайдіть в необхідний узгоджений довідник. У формі що відкрилась виберіть позиції для перепогодження, і натисніть кнопку Перепогодити:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_20.png

У спливаючому вікні виберіть «Змінити промо ціну» і натисніть «ОК»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_21.png

У вікні встановіть нові ціни у відповідних колонках (Нова ціна без ПДВ / Нова ціна з ПДВ - за умовами договору з мережею). Потім вкажіть Дату початку і Дату закінчення дії нової ціни. Дата початку дії нової ціни повинна перевищувати узгоджену к-ть днів від дати створення документа Товарне узгодження.

При необхідності перелік позицій можна розширити або скоротити за допомогою кнопок «Додати позицію» і «Видалити позицію». Біля найменування товарної позиції розміщена іконка з назвою каталогу. Після її натискання, в додатковому вікні відкриваються піктограми Listex і Ucat. Натиснувши на них відбувається перехід на сайт відповідних каталогів.

Існує можливість додати обгрунтування зміни ціни або інші документи, які можуть прискорити узгодження. Для цього натисніть кнопку «Додати обгрунтування»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_22.png

У вікні що відкрилось можна додати необхідні файли:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_23.png

Для додавання файлів використовується кнопка «Додати файл», для видалення зайвих файлів - кнопка з хрестиком біля імені файлу.

Після того, як всі файли були додані - необхідно натиснути на кнопку «Створити обгрунтування», в результаті файли будуть збережені в окремий архів і довантажені до товарного узгодженням. Після натискання кнопки «Створити обгрунтування» зміна архіву буде неможлива. У разі якщо необхідно додати і / або видалити якісь файли - всю процедуру слід повторити спочатку. Після збереження внесених змін натисніть кнопку Відправити.

Зверніть увагу! Доступ до поля Кількість регулюється (заповнюється / не заповнюється). Дату початку дії нової ціни і дату закінчення дії нової ціни постачальник не змінює.

У розділі Відправлені знаходяться відправлені на перепогодження постачальнику документи:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_24.png

Жирним курсивом виділено ще не прочитаний Постачальником документ.

Товарне узгодження має кілька етапів узгодження документа на стороні постачальника, які у Вас відображаються у вигляді статусу документа:

  • На погодженні - отриманий постачальником

  • Відхилено - відхилений постачальником

  • Погоджено - узгоджений, але комерційний документ не підписаний

  • Підписано - накладена ЕЦП з боку постачальника

Для перегляду відправленого документа «Товарне узгодження» натисніть на нього. У відкритому документі можна побачити основну інформацію по документу. Для зв’язку з постачальником введіть текст повідомлення у вікно Зв’язок з продавцем і натисніть кнопку Надіслати:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_25.png
Створення Товарного узгодження для перепогодження промо ціни за допомогою завантаження з Excel

Виберіть розділ Узгоджений довідник, відкрийте необхідний запис товарного довідника і натисніть кнопку Завантажити шаблон:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_26.png

Після натискання на кнопку відкриється форма збереження шаблону. Збережіть файл на комп’ютер, відкрийте його для заповнення. У шаблоні заповніть поля по позиціях для перепогодження:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_27.png

Зверніть увагу!

Не міняйте розширення файлу шаблону. Воно повинно бути тільки xls. Не міняйте структуру файлу і послідовність колонок, не видаляйте верхні рядки.

Збережіть заповнений файл шаблону, а потім натисніть кнопку Завантажити Промо ціни XLS - для завантаження шаблону з заповненими промо цінами. Після натискання на кнопку завантаження відкриється стандартна форма для завантаження файлу.

Виберіть збережений вами шаблон. На підставі завантаженого файлу сформується документ Товарне узгодження. Перевірте правильність заповнення даних, вкажіть період початку і закінчення дії нової ціни, заповніть кількість, а потім натисніть кнопку Зберегти і після збереження документа кнопку Надіслати.

Важливо! У документ Товарне узгодження потрапляють тільки ті товарні позиції, які є в вибраній специфікації на платформі. Звірка проводиться по артикулу і по штрих-коду.

Додаткові можливості і функції
Інтерфейс

Для зручності визначення типу Товарного узгодження, документи різних типів виділені різними кольорами:

  • чорні - пропозиції щодо зміни регулярної ціни

  • помаранчеві - пропозиції щодо зміни промо ціни

  • зелені - пропозиція щодо виведення товару з асортименту та тимчасового призупинення постачання товару

Статус документа винесений останньої колонкою. Є лічильник позицій з підвищенням і зниженням регулярної ціни, червоним виводиться кількість позицій на підвищення ціни, а зеленим - зниження. За необхідності документ можна виділити як важливий, ставити мітки, а також прочитати всю історію листування не заходячи в документ.

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_28.png
Історія змін

При обробці товарного узгодження є можливість переглянути історію змін як по всьому документу, так і за окремими позиціями. Для перегляду історії змін по всьому документу в товарному узгодженні натисніть кнопку «Історія змін»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_29.png

Відкриється вікно з історією змін по документу.

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_30.png

Для перегляду історії змін по конкретній позиції необхідно натиснути на Найменування, Штрих-код або Артикул. В результаті буде відкрито вікно з історією змін по позиції.

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_31.png
Обгрунтування

У разі якщо постачальник додавав обгрунтування зміни ціни або приклав якісь інші файли, то в розділі Вхідні документи з обгрунтуванням будуть позначені скріпкою біля статусу:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_32.png

Завантажити та ознайомитися з вкладенням можна зайшовши в товарне узгодження і натиснувши на кнопку «Завантажити обгрунтування»:

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_33.png
Масове підписання

  1. У журналі оберіть чекбоксами документи готові до підписання і натисніть «Підписати»

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_34.png

  1. Відкриється вікно Підписання з кнопкою «Зчитати ключі». Натисніть на цю кнопку.

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_35.png

  1. При натисканні на «Зчитати ключі» відкривається вікно Зчитування ключів, в яке підтягніть ЕЦП, введіть пароль і натисніть «Зчитати ключ».

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_36.png

  1. Після успішного зчитування відкриється вікно Підписання. Натисніть на «Підписати». Всі вибрані документи успішно підпишуться і відправляться.

_images/pics_Soglasovanie_cen_Instrukcija_dlja_seti_37.png

У разі, якщо ключі вже підтягувалися раніше і дані про них були збережені в кеші браузера, то повторно підтягувати ЕЦП немає необхідності, тільки ввести пароль, активуйте чекбокс «Надіслати після підписання» і натисніть на кнопку «Зчитати ключ».

Інструкції для постачальника

Узгодження цін на платформі EDIN-Price. Інструкція для постачальника
Вступ

Інструкція визначає порядок узгодження ціни і підписання документа на стороні Постачальника на веб-платформі EDIN-Price. Описаний функціонал не передбачає введення нових товарних позицій!

Схема роботи
_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_01.png

Роздрібна мережа зі своєї облікової системи вивантажує на FTP товарний довідник (контракт, специфікацію) в форматі XML (PRODUCTLIST.XML), актуальний на даний момент. Після обробки даного файлу на платформі, у постачальника, в меню «Сервіс -> EDIN-Price», відобразиться перелік діючих контрактів з мережею. Постачальник на підставі узгодженого товарного довідника формує пропозицію щодо зміни цін і направляє його в торговельну мережу.

Торгова мережа проводить узгодження даної пропозиції. У разі успішного вирішення підписує зі свого боку комерційний документ і направляє його постачальнику. Постачальник зі свого боку підписує комерційний документ і відправляє Торгової мережі. Після отримання підписаного з обох сторін комерційного документа, на FTP Торгової мережі викладається новий узгоджений PRODUCTLIST.XML, на підставі якого оновлюються дані в обліковій системі. Після цих змін мережа повторно вивантажує вже оновлений товарний довідник (контракт, специфікацію) на FTP.

Примітка

У разі будь-яких змін даних, погоджених не через систему EDI, PRODUCTLIST.XML вивантажується повторно.

Обробка Товарного узгодження
Перегляд актуального узгодженого товарного довідника

Для перегляду і подальшої роботи з узгодженим довідником необхідно виконати вхід в систему за допомогою наданих логіна і пароля. Далі навести курсор мишки на трикутник біля меню «Сервіс» і в випадаючому списку вибрати EDIN-Price

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_02.png

При цьому відкриється сторінка з актуальними товарними довідниками, згрупованими за назвою торгової мережі:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_03.png

Для перегляду вмісту довідника необхідно перейти до вмісту відповідного документа клікнувши лівою кнопкою миші по документу. Буде відкрита детальна форма довідника.

Примітка

Всі дані, наведені на формі - фіктивні, використовуються тільки в якості прикладу

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_04.png
Створення пропозиції

Процес ініціації доступний тільки на WEB-платформі. Для ініціювання процесу перепогодження регулярної / промо ціни, виведення товару з асортименту, тимчасового призупинення постачання необхідно створити документ «Товарне узгодження». Створення документа для перепогодження регулярної та промо цін можливе в 2-х режимах - вручну та за допомогою завантаження Excel файла.

Створення Товарного узгодження для перепогодження регулярної / промо ціни вручну

Для створення товарного узгодження зайдіть в необхідний узгоджений довідник. У формі що відкрилась виберіть позиції для перепогодження, і натисніть кнопку Перепогодити:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_05.png

У спливаючому вікні Виберіть дію виберіть тип ціни для узгодження - Регулярна або Промо і натисніть «ОК»:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_06.png

У вікні, встановіть нові ціни у відповідних колонках (Нова ціна без ПДВ або Нова ціна з ПДВ - за умовами договору з мережею), а також код УКТ ЗЕД, якщо раніше він не був заповнений в Товарному довіднику. Потім вкажіть Дату початку дії і Дату закінчення дії нової ціни. Дата початку дії нової ціни повинна перевищувати узгоджену з мережею к-ть днів від дати створення документа Товарне узгодження. При необхідності перелік позицій можна розширити або скоротити за допомогою кнопок «Додати позицію» і «Видалити позицію».

Біля найменування товарної позиції розміщена ікона «інфо». Після її натискання, в додатковому вікні відкриються піктограми Listex і Ucat. Натиснувши на них відбувається перехід на сайт відповідних каталогів. Додатково для перепогодження регулярної ціни, якщо зазначений період документа має спільні дати до раніше узгоджених промо цін, то біля дати останнього зміни буде розміщена іконка «відсотки». Після її натискання, в додатковому вікні відкривається раніше узгоджена додаткова інформація по промо - період дії і ціна з ПДВ:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_07.png

Існує можливість додати обгрунтування зміни ціни або інші документи, які можуть прискорити погодження. Для цього натисніть кнопку «Додати обгрунтування»:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_08.png

У вікні що відкрилось можна додати необхідні файли:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_09.png

Для додавання файлів використовується кнопка «Додати файл», для видалення зайвих файлів - кнопка з хрестиком біля імені файлу. Після того, як всі файли були додані - необхідно натиснути на кнопку «Створити обгрунтування», в результаті файли будуть збережені в окремий архів і довантажені до товарного узгодженням. Після натискання кнопки «Створити обгрунтування» зміна архіву буде неможлива. У разі якщо необхідно додати і / або видалити якісь файли - всю процедуру слід повторити спочатку. Після збереження внесених змін з’являється кнопка «Прикріпити сертифікати». При натисканні на кнопку «Прикріпити сертифікат» біля кожного штрих-коду відобразиться іконка «галочка», яка свідчить про те, що до товару прикріплений сертифікат.

Примітка

Якщо сертифікати не були прив’язані до штрих-коду в сервісі EDIN-Certificate, в Товарному узгодженні іконка біля штрих-коду відображатися не буде. Для можливості передачі сертифікатів в документі Товарне узгодження необхідна наявність тарифного пакета сервісу EDIN-Certificate.

Натиснувши на іконку «галочка», в додатковому вікні з’явиться перелік всіх сертифікатів, які прив’язані до штрих-коду товару. Сертифікати, які потрібно передати, необхідно відзначити галочкою.

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_10.png

За допомогою кнопок «Дія» можливо:

  • завантажити сертифікат з усіма додатками (архів з файлами)

  • переглянути скан-копію сертифіката

  • отримати пряме посилання на скан-копію сертифіката

  • завантажити основний бланк сертифіката (титульна сторінка)

Для відправки документа необхідно натиснути на кнопку «Надіслати».

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_11.png

Все невідправлені документи знаходяться в розділі Чернетки.

Примітка

Зверніть увагу! Промо ціна змінюється тільки в окремому документі Товарне узгодження для промо ціни.

Важливо

Важливо! Мережа має право змінити запропоновані / зазначені Постачальником дати перед підписанням документа.

У розділі Відправлені знаходяться відправлені на переузгодження в Мережу документи:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_12.png

Жирним курсивом виділено ще не прочитаний Мережею документ. Товарне узгодження має кілька етапів узгодження документа на стороні мережі, які у Вас відображаються у вигляді статусу документа:

  1. На погодженні - отриманий мережею, без внесення змін

  2. Підготовлений - оброблений категорійним менеджером мережі.

Проміжні статуси обробки документів для регулювання бізнес процесів узгодження (керівник відділу закупівлі, служба безпеки, економічна безпека, фінансовий аналітик, логістика):

  • Підтверджений

  • Перевірений

  • Готовий до підписання

  • Погоджений

  1. Підписаний - оброблений фінальним підписантом і накладена ЕЦП з боку мережі. Для перегляду відправленого документа «Товарне узгодження» натисніть на нього. У відкритому документі можна побачити основну інформацію по документу.

Для зв’язку з Мережею введіть текст повідомлення у вікно Зв’язок з покупцем і натисніть кнопку Надіслати:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_13.png

Документ, що містить коментар, в списку буде відображатися з позначкою «коментар»:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_14.png

У документів на узгодження промо-ціни текст виділений помаранчевим.

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_15.png
Створення Товарного узгодження для перепогодження регулярної / промо ціни за допомогою завантаження з Excel

Виберіть розділ Узгоджений довідник, відкрийте необхідний запис товарного довідника і натисніть кнопку Завантажити шаблон:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_16.png

Після натискання на кнопку відкриється форма збереження шаблону. Збережіть файл на комп’ютер, відкрийте його для заповнення. У шаблоні заповніть поля по позиціях для перепогодження:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_17.png

Зверніть увагу!

Не міняйте розширення файлу шаблону. Воно повинно бути тільки xls. Не міняйте структуру файлу і послідовність колонок, не видаляйте верхні рядки.

Збережіть заповнений файл шаблону, а потім натисніть кнопку Завантажити Регулярні ціни XLS - для завантаження шаблону з заповненими регулярними цінами, Завантажити Промо ціни XLS - для завантаження шаблону з заповненими промо цінами. Після натискання на кнопку завантаження відкриється стандартна форма для завантаження файлу. Виберіть збережений вами шаблон.

На підставі завантаженого файлу буде сформований документ Товарне узгодження. Перевірте правильність заповнення даних, вкажіть період початку і закінчення дії нової ціни, потім натисніть кнопку Зберегти і після збереження документа кнопку Надіслати:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_18.png

Важливо

У документ Товарне узгодження потрапляють тільки ті товарні позиції, які є в вибраній специфікації на платформі. Звірка проводиться по артикулу і по штрих-коду.

Створення Товарного узгодження для виведення товару з асортименту / тимчасового призупинення постачання

У спливаючому вікні Виберіть дію - виберіть Вивести товар з асортименту або Тимчасово призупинити поставку:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_19.png

У вікні вкажіть причину виведення / призупинення постачання товару. Потім для припинення постачання товару вкажіть дату початку припинення постачання товару і дату закінчення припинення постачання, а для виведення товару з асортименту - дату виведення товару з асортименту. Дата початку припинення постачання / дата виведення товару з асортименту повинна перевищувати узгоджену з мережею к-ть днів від дати створення документа Товарне узгодження.

При необхідності перелік позицій можна розширити або скоротити за допомогою кнопок «Додати позицію» і «Видалити позицію». Існує можливість додати обґрунтування виведення / призупинення постачання товару або інші документи. Для цього натисніть кнопку «Додати обгрунтування». Збережіть внесені зміни, при необхідності прикріпіть сертифікати і відправте документ. Все невідправлені документи знаходяться в розділі Чернетки.

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_20.png

Примітка

Зверніть увагу! Вивід товару з асортименту погоджується лише в окремому документі Товарне узгодження.

Важливо

Важливо! Мережа має право змінити запропоновані / зазначені Постачальником дати перед підписанням документа.

Для перегляду відправленого документа «Товарне узгодження» натисніть на нього. У відкритому документі можна побачити основну інформацію по документу. У розділі Відправлені знаходяться відправлені на переузгодження в Мережу документи:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_21.png

Жирним курсивом виділено ще не прочитаний Мережею документ. Для зв’язку з Мережею введіть текст повідомлення у вікно Зв’язок з покупцем і натисніть кнопку Надіслати:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_22.png

Документ, що містить коментар, в списку буде відображатися з позначкою «коментар»:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_23.png

У документів на узгодження виведення товару з асортименту та тимчасового призупинення постачання товару, текст виділений зеленим.

Перегляд і обробка вхідного документа від Мережі (ініціація постачальника)

За затвердженими позиціями Ви отримаєте Комерційний документ, підписаний з боку мережі. Знаходиться він в розділі Вхідні. Для відкриття вхідного документа натисніть на нього:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_24.png

У відкритому документі можна побачити основну інформацію по документу (підписи від Мережі, перелік прийнятих позицій, коментарі від Мережі). Натисніть кнопку Підписати щоб підписати документ:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_25.png

Після первинного налаштування ЕЦП і введення ключів натисніть кнопку «Зчитати ключі»:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_26.png

Виберіть необхідні ключі для підписання і натисніть «Зчитати ключі»:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_27.png

Опісля натисніть на «Підписати».:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_28.png

Після успішного підписання, натисніть кнопку Надіслати:

_images/pics_Soglasovanie_cen_web_EDIN-Price_dlja_postavshhika_29.png

Підписаний і відправлений комерційний документ Товарна специфікація знаходяться в розділі Надіслані.

У разі відхилення частини запропонованих цін, Ви отримаєте Комерційний документ по прийнятим цінам (необхідно підписати ЕЦП) і документ Товарне узгодження зі списком не прийнятих позицій, які Ви можете переузгодити ще раз за допомогою відправки нового документа для узгодження.

Перегляд і обробка вхідного документа від Мережі (ініціація мережі)

Документ Товарне узгодження, відправлений Мережею для узгодження промо ціни, знаходиться в розділі Вхідні і виділений помаранчевим кольором.

Відібрати документи для обробки можна за допомогою фільтра. Для цього необхідно вибрати тип документа «Товарне узгодження» і статус «На погодженні». Усі не прочитані документи виділені жирним шрифтом. Для відкриття вхідного документа натисніть на нього. У відкритому документі необхідно ознайомитися з кількістю товару, промо цінами і періодом їх дії. Також є можливість зв’язатися з мережею, залишивши повідомлення в вікні Зв’язок з покупцем. Доступно дві кнопки - Відхилити і Підписати. Після натискання на Відхилити Вам необхідно підтвердити дію, натиснувши Закінчити, або відхилити, натиснувши Скасування.

Якщо підтвердити відхилення документа, то змінити рішення Ви не зможете і специфікація буде не узгодженою.

Натисніть кнопку Підписати для створення комерційного документа. Відкриється друкована форма документа. Необхідно виконати процедуру підписання і відправити документ в Мережу. У свою чергу Мережа підпише документ зі свого боку і комерційному документу буде присвоєно статус «Специфікація узгоджена».

Введення нових SKU (товарних позицій) на платформі
Вступ

Інструкція описує процес створення пропозиції щодо розширення товарного асортименту в діючих специфікаціях.

Для формування пропозиції необхідно:

1. Перевірити наявність товарної позиції в Товарному довіднику

1.1 Для цього в меню виберіть «Довідники» => «Товарний довідник»

_images/Vvod_novyh_SKU_na_platforme_01.png

1.2. Скористатися стандартним пошуком по штрих-коду, найменуванню або вн. № продукту.

_images/Vvod_novyh_SKU_na_platforme_02.png

Якщо позиція знайдена - необхідно перевірити коректність заповнення і доповнити відсутні параметри товару. Якщо позиція не знайдена - скориставшись кнопкою «+» створити картку нового товару, заповнивши всі необхідні параметри.

_images/Vvod_novyh_SKU_na_platforme_03.png
2. Сформувати пропозицію натиснувши кнопку Сформувати
_images/Vvod_novyh_SKU_na_platforme_04.png

Відкриється форма створення в якій необхідно вибрати торгову мережу, категорії, позиції для відправки на розгляд.

_images/Vvod_novyh_SKU_na_platforme_05.png

При додаванні товару в рядку «Найменування з товарного довідника» Ви можете скористатися пошуком по штрих-коду, артикулу покупця або найменуванням.

_images/Vvod_novyh_SKU_na_platforme_06.png

Після вибору товарної позиції, все поля заповняться автоматично. У разі, якщо частина полів виявилися порожніми - внесіть інформацію, якої бракує і натисніть кнопку Зберегти.

_images/Vvod_novyh_SKU_na_platforme_07.png
3. Створити документ Товарне узгодження натиснувши на «Сформувати»
_images/Vvod_novyh_SKU_na_platforme_08.png

Важливо

Обрані Вами товарні позиції будуть відправлені конкретному категорійного менеджеру, відповідальному за обрану Вами групу товарів. У разі некоректного присвоєння категорії або вибору позиції, що не відноситься до зазначеної Вами категорії - SKU можуть бути не розглянуті торговельною мережею.

Деякі мережі працюють з введенням нових SKU тільки при наявності розширених характеристик. Таким мережам не відправляться SKU, що не мають посилання на каталог Listex або uCat.

_images/Vvod_novyh_SKU_na_platforme_09.png

Якщо SKU занесені в Listex / uCat або ж мережа не вимагає характеристик, то документ сформується. При необхідності можна вказати дату початку дії нової ціни, дату закінчення дії нової ціни, Зберегти, Надіслати.

_images/Vvod_novyh_SKU_na_platforme_10.png

На стороні постачальника, товарне узгодження знаходиться в «Відправлених».

4. Залежно від бізнес процесів всередині Торгової мережі, далі відбувається відбір товару.

4.1. В буфер Облікової Системи мережі імпортуються всі запропоновані постачальником позиції з Товарного узгодження. Після підтвердження введення позицій в специфікацію, в ОС для кожного товару створюється картка товару, при цьому кожній позиції присвоюється номер договору і контракт.

4.2. Торгова мережа зі своєї ОС інтегровано вивантажує контракт з затвердженими товарними позиціями. В xml файлі, для таких позицій вказується <ACTION> 2 </ ACTION>. Також, відправляє постачальнику товарне узгодження на відхилені позиції. В xml файлі, для таких позицій вказується:

  • <PRICETYPE>addSKU</PRICETYPE> - підтип документа (дія)

  • <DOCACTION>1</DOCACTION> - ознака документа (1 - рахунок прийнятий, 3 - умовно прийнятий, 5 - тільки для інформації, 8 - не прийнятий)

5. На стороні Постачальника, контракти c новими SKU розміщуються на початку списку і виділяються позначкою «NEW!».
_images/Vvod_novyh_SKU_na_platforme_11.png

5.1. При відкритті контракту з позначкою «NEW!», нові позиції виділяються червоним кольором і розміщуються на початку списку. При наведенні курсора миші на такі позиції, спливає підказка «Необхідно підписання нових SKU!»

_images/Vvod_novyh_SKU_na_platforme_12.png

5.2. Для вибору необхідних позицій в контракті, встановіть «прапорець» навпроти нових або узгоджених SKU.

Важливо

Вибір позицій розмежований на можливість вибрати або тільки нові або тільки узгоджені позиції. При активації «прапорців» навпроти нових позиції - узгоджені будуть недоступні для вибору, і навпаки.

5.3. Масовий вибір позицій здійснюється за допомогою меню, що розвертається «Вибрати позиції».

_images/Vvod_novyh_SKU_na_platforme_13.png

5.3.1. Для вибору тільки узгоджених позицій, виберіть пункт меню «Узгоджені». При цьому «прапорцями» відзначаться тільки все раніше узгоджені позиції і стане доступною кнопка «Переузгодити».

_images/Vvod_novyh_SKU_na_platforme_14.png

5.3.2. Для вибору тільки нових позицій, виберіть пункт меню «Новинки». При цьому «прапорцями» відзначаться тільки нові позиції контракту і стане доступною кнопка «Підписати».

_images/Vvod_novyh_SKU_na_platforme_15.png

5.4. Підписання нових товарних позицій

При натисканні на кнопку «Підписати» формується комерційний документ «Товарна специфікація».

Введіть паролі і натисніть «Зчитати ключі»:

_images/Vvod_novyh_SKU_na_platforme_16.png

Далі натисніть «Підписати»:

_images/Vvod_novyh_SKU_na_platforme_17.png

Після зчитування ключів натисніть «Надіслати»

_images/Vvod_novyh_SKU_na_platforme_18.png

Після чого документ відправляється в торгову мережу. На стороні постачальника відобразиться в розділі «Відправлені».

5.5. Нові SKU, в контракті, можуть відображатися «бузковим» кольором в таких випадках:

_images/Vvod_novyh_SKU_na_platforme_19.png

  • Сформовано, але не підписаний, або підписаний, але не відправлений комерційний документ «Товарна специфікація» (наприклад, якщо випадково закрили вкладку) - такий документ переноситься в розділ «Чернетки».

    Продовжити процес підписання / відправки таких документів можливо з розділу «Чернетки» або знову відкривши контракт з цією товарною позицією (тепер вона виділена «бузковим» кольором) і клікнути на неї. При видаленні документа з «Чернеток», нові SKU будуть знову відображатися червоним кольором в Контракті.

  • Сформовано, підписаний, відправлений в торговельну мережу комерційний документ «Товарна специфікація». Очікується підписання з боку мережі. Клікнувши на таку позицію відкриється підписаний документ.

    При наведенні курсора миші на позиції бузкового кольору спливає підказка «Комерційний документ: No______ від __.__.__ До __.__.__»

6. На стороні торгової мережі, комерційний документ відображається в розділі «Вхідні» з поміткою «Документ вимагає підписання».
_images/Vvod_novyh_SKU_na_platforme_20.png

Мережа підписує зі свого боку Комерційний документ і відправляє постачальнику.

7. Процес введення нових товарних позицій вважається завершеним, коли комерційний документ «Товарна специфікація» підписаний з двох сторін.

При цьому, на стороні постачальника, біля контрактів, в яких підписані Нові SKU перестають відображатися піктограми «NEW!». Такі контракти не відображаються на початку списку. Товарні позиції в таких контрактах не відображаються червоним або фіолетовим кольорами.

Повторна відправка комерційного документа «Товарна специфікація» щодо введення нових SKU неможлива.

Служба Технічної Підтримки

EDIN-Distribution

Інструкції для дистриб’ютора

Створення замовлення по прайс-листу. Інструкція для дистриб’ютора
Вступ

Дана інструкція описує порядок формування документа «Замовлення по прайсу» (ORDERS) і обов’язкові для заповнення поля. Замовлення проводиться в бланку, основаному на цінових і логістичних даних для переліку товарних позицій, переданих постачальником в документі Прайс-лист. Крім того, постачальником можуть бути встановлені обмеження щодо максимальної ваги, максимального об’єму, максимальної кількості позицій і мінімальній сумі замовленої партії.

Створення Замовлення по прайсу

Натисніть на кнопку Замовлення по прайсу:

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_01.png

У вікні з’явиться бланк замовлення. Він складається з трьох блоків: Реквізити, Підсумок, Блок товарних позицій.

Заповнення блоку реквізитів

У вікні бланка Замовлення на основі прайсу, у верхній частині відображається блок реквізитів. Після заповнення обов’язкових полів його можна приховати кнопкою Приховати дод. інформацію.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_02.png

Обов’язкові поля:

  • Номер замовлення (заповнено). Замовлення на платформі нумеруються автоматично, якщо встановлена ​​галочка Автоматичний номер замовлення. Зняття галочки дозволяє вводити номера, що відповідають номерам замовлень у вашій обліковій системі.

  • Дата замовлення (заповнено). Дата створення документа Замовлення по прайсу.

  • Дата доставки. Планована дата поставки товару по даному замовленню.

  • Валюта (заповнено) - валюта замовлення.

  • Умови відвантаження (заповнено) - доступні до вибору варіанти Доставка транспортом постачальника і Самовивіз.

  • Тип замовлення (заповнено). За замовчуванням відображається Реалізація. Доступні до вибору варіанти: Склад відповідального зберігання (СОХ), Зняття з СОХ (Реалізація), Зняття з СОХ (Оптова торгівля), Оптова торгівля.

Галочка Ціни в прайсі з ПДВ впливає на те, як заповнюється колонка з сумою замовлення в блоці товарних позицій. За замовчуванням прапорець встановлений, і це дозволяє бачити суму замовлення по позиції, включаючи ПДВ. Якщо цю галочку зняти, колонка з сумою зміниться на Сума без ПДВ. На відображення підсумків по замовленню дана опція не впливає. Інші, які стосуються реквізитів замовлення, поля знаходяться на вкладці Додаткова інформація. Тут передбачена можливість передачі в замовленні постачальнику:

  • тип документа;

  • текстової інформації до замовлення;

  • кількість машин;

  • часу доставки;

  • номера договору поставки.

Поля заповнюються вручну.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_03.png
Заповнення блоку товарних позицій

Каталог продукції в бланку замовлення по прайс-листу групується в три рівня. Можна приховувати окремі групи товарів, натиснувши на назву групи. Повторне натискання на назву групи приводить до відображення вмісту групи. Для пошуку потрібної товарної позиції в бланку замовлення використовується Фільтр. Необхідно ввести в поле пошуку символи, і в списку продукції залишаться тільки ті позиції, у яких знайдені збіги з ними в найменуванні, або в номері артикулу постачальника, чи штрих-коду.

Якщо постачальник відправляє в Прайс-аркуші свої дані про залишки продукції, то ці значення відображаються в бланку в колонці Залишок. Встановлені постачальником обмеження на максимальний розмір одного замовлення відображаються біля підсумків Загальна вага, кг і Всього палет.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_04.png

Для зручного введення кількості товару в замовленні передбачені відкриті для редагування поля:

  • Товар з ціною в прайсі за штуку можна замовляти вводячи Кількість коробок. Якщо зручно, замовлення можна вводити в поле Кількість, штук, контролюючи кратність коробок.

  • Ваговий товар, для якого в прайс-листі ціна вказана за кілограм, можна замовити тільки внесенням кількості в кілограмах, в поле Загальна вага по позиції, кг.

Перегляд підсумків

Після введення замовляємої кількості по позиції, автоматично для неї розраховується кількість штук / коробок, палет, вага, сума з ПДВ і без, а також оновлюється блок Підсумок на замовлення. Приховати позиції, що не замовляються, для перевірки документа, можна натиснувши кнопку Показати замовлення.

Перед збереженням переконайтеся в тому, що не перевищено обмеження на розмір однієї партії в замовленні - в блоці Підсумки не повинно бути значень, виділених червоним кольором.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_05.png

Заповнення поля Знижка заблоковано, передача інформації про знижку виконується у вигляді індивідуальної реалізації для клієнта. Для цього зверніться до вашого менеджера АТС.

Збереження і відправка Замовлення по прайсу

Якщо ліміт по одному з встановлених обмежень перевищено, замовлення не зберігається, і видається повідомлення про перевищення. В такому випадку, зменшите кількість товару в замовленні до рівня, який дозволяє дотримуватись обмежень. Якщо у вас виникнуть питання щодо значень встановлених обмежень, зверніться безпосередньо до постачальника.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_06.png

При натисканні на кнопку Зберегти, документ зберігається в розділі Чернетки. Документ зберігається в цьому розділі до натискання кнопки Надіслати. У Чернетках можна знайти і відкрити раніше сформоване і не відправлене замовлення. При необхідності його можна відредагувати, зберігаючи кожен раз внесені зміни, або видалити.

Для процедур внутрішнього узгодження замовлення, в Чернетках передбачені такі можливості:

  • роздрукування чернетки замовлення (кнопка Друк);

  • вивантаження чернетки замовлення в Excel (кнопка Excel);

  • формування і вивантаження чернетки замовлення в форматі xml-файлу (кнопка XML);

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_07.png
Після відправки, Замовлення вже не доступно для редагування, його можна лише переглянути в розділі Відправлені.

Користувачі замовника, наприклад, співробітники бухгалтерії, зайшовши в відправлений документ, можуть додавати до нього свої Коментарі.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_08.png

Ім’я користувача, дата і час коментаря реєструються автоматично. Наявність коментаря до замовлення відображається в списку документів значком синього кольору.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_09.png
Перегляд Прайс-листа постачальника

Для перегляду переданої постачальником в прайсі логістичної і цінової інформації, а також терміну дії цін натисніть кнопку Прайс-лист. У вікні Прайс-листа можна вивантажити всю табличну інформацію в форматі Excel кнопкою Завантажити каталог.

У колонці Дії можна побачити для яких позицій постачальник додав інформацію, прикріпивши файли довільного формату, наприклад, фотографії або інструкції - для таких позицій відображається значок папки. При натисканні на піктограму відкривається вікно зі списком доданих файлів для перегляду і скачування.

_images/Sozdanie_zakaza_po_prajs_listu_Instrukcija_dlja_distributora_10.png
FAQ

Що робити, якщо Прайс-лист порожній?

Зверніться до служби технічної підтримки АТС, і ми подбаємо про його завантаження постачальником для вашої компанії. Також, звернувшись до постачальника, ви можете уточнити причину, по якій вам не надано Прайс-лист і узгодити надання.

Що робити, якщо ціни в прайсі не актуальні?

Всі дані, що містяться в Прайс-листі, отримуються безпосередньо від постачальника. В такому випадку необхідно звернутися до відповідного постачальника для узгодження цін і подальшої актуалізації Прайс-листа.

Як підключити Прайс-лист іншого Виробника?

Для вирішення даного питання зверніться до свого менеджера компанії АТС.

Чи можу я надсилати замовлення зі своєї облікової системи та як це зробити?

Для відправки замовлення з облікової системи потрібні додаткові налаштування. Як це зробити підкаже ваша відповідальна менеджер компанії АТС.

Інструції для виробника

Створення і відправлення прайс-листа. Інструкція для виробника
Вступ

Інструкція описує порядок формування документа Прайс-лист і його відправлення покупцю для використання у вигляді бланку замовлення.

Перегляд списку покупців

Натисніть на значок Налаштування, розміщений в правому верхньому куті. В списку доступних вам закладок, оберіть закладку Дистриб’ютори.

_images/012.png

У вкладці Мої дистриб’ютори можна переглянути список всіх покупців, яким ви можете відправляти прайс-листи, та групи, в які вони об’єднані.

Групування покупців по видам прайс-листів

Якщо для різних груп ваших покупців діють різні ціни чи відрізняється асортимент, ви можете спростити відбір дистриб’юторів для відправлення групових прайс-листів. Створюйте назви груп, які відповідають виду прайс-листа, діючому для кожної групи клієнтів.

Перейдіть на вкладку Групи. Для внесення нової назви групи призначена кнопка Створити групу. Для видалення якої-небудь з існуючих назв груп – кнопка видалення в колонці Видалити. При видаленні групи, дистриб’ютори, які входять до її складу, не видаляються.

_images/022.png

Після того, як ви створили всі необхідні назви груп, позначте покупців, яких необхідно включити туди. Натисніть на кожну назву групи, ви побачите список всіх своїх дистриб’юторів, в якому позначте приналежність до групи. Дані одразу ж будуть збережені, закрийте вікно заповненої групи та відкрийте наступну.

_images/037.png

Повернувшись на вкладку Мої дистриб’ютори, ви можете побачити в списку покупців додані їм групи. При необхідності, ви можете відкоригувати приналежність. Для цього натисніть на назву покупця, зніміть відмітку з назви групи, з якої його необхідно прибрати, і відмітьте групу, в яку додати.

_images/042.png
Створення прайс-листа

Оберіть пункт меню Прайс-лист.

_images/051.png

Завантажте файл з підказками по заповненню прайс-листа, натиснувши кнопку Зберегти - Шаблон прайс-листа.

_images/062.png

Додайте свій асортимент, ціни і логістичну інформацію для товарів в завантажену таблицю, видаливши дані приклади.

Збережіть у себе на диску цей Excel-файл (не змінюючи формат документу).

_images/072.png
Відправлення документу Прайс-лист і обмеження для замовлень по прайсу

Для відправлення прайсу на платформу EDIN-Distribution натисніть кнопку Завантажити - Прайс-лист.

_images/082.png

Заповніть у вікні Меню завантаження прайсу обов’язкову інформацію для відправлення прайс-листа:

  • Період дії: внесіть дату початку (не раніше поточної дати) і дату закінчення.

  • Номер прайс-листа: завантажені прайс-листи нумеруються на платформі автоматично. Якщо є потреба, введіть свій номер документа.

  • Список дистриб’юторів: вкажіть покупців, для яких відправляєте даний прайс-лист. Можна обрати всіх, вибрати раніше створену групу чи окремих покупців.

_images/092.png

Одночасно з відправленням Прайс-листа ви можете передати покупцям обмеження по об’єму, вазі, кількості позицій або сумі одного замовлення.

Для цього перейдіть у вкладку Налаштування обмежень, встановіть відмітки біля параметрів і введіть значення (максимальну кількість палет в замовленні, максимальну вагу замовлення в кілограмах, максимальну кількість товарних позицій або мінімальну суму замовлення з ПДВ). Обмеження будуть діяти обраним покупцям.

_images/1010.png

Щоб відправити Прайс-лист, поверніться на закладку Імпорт. Після натискання кнопки Завантажити файл з’явиться вікно, де ви вкажете шлях до документу і оберете створений раніше файл з Прайс-листом.

Натисніть кнопку Відкрити (Open), і Прайс-лист буде відправлений обраним покупцям.

_images/116.png

Документ буде знаходитись в папці Відправлені.

Перегляд і редагування прайс-листів

Для перегляду і редагування Прайс-листів передбачено Меню Прайс-лист.

_images/121.png

Обирайте покупця зі списку в полі Дистриб’ютор, і період, для якого хочете переглянути асортимент і ціни для нього.

Щоб побачити актуальний для покупця Прайс-лист, необхідно ввести дату для початку та для закінчення періоду та натиснути кнопку Застосувати фільтр для відображення.

_images/131.png

Якщо для обраного періоду не завантажений жоден прайс, буде виведено повідомлення.

_images/141.png

Інакше, за вибраний період відображатимуться всі товари.

В списку товару, в відповідних стовпчиках, ви можете побачити для кожної позиції дати початку і закінчення дії цін. Дистриб’ютор може замовити позицію за умовою, якщо дата завершення дії ціни не мешне за поточну дату.

_images/151.png

Прайс для обраного покупця, на вказаний період, вивантажується в форматі Excel кнопкою Зберегти - Прайс-лист.

_images/161.png

ВАЖЛИВО! Зміна дати на вашому ПК не змінить відтворення прайс-листів. Використовується час серверу.

Додавання Акційних цін

Для регулярних позицій прайс-листа можуть в певні періоди часу діяти акційні ціни. В такому випадку, для Акції можна сформувати прайс-лист в Excel, який містить тільки акційні позиції. Акційні позиції необхідно позначити в стовпці “Акція”. А при відправленні вказати Період дії відповідно умов Акції.

В такому випадку, коли регулярний Прайс-лист є на платформі EDIN-Distribution, то для деяких позицій, які входять до його складу, новим документом відправляється акційна ціна. А залишкові позиції зберігаються, які не входять у прайс, що відправляється. І якщо дата дії акційної ціни не перевищує дату дії регулярної, то по закінченню дії акційного прайс-листа, покупцям знову буде доступною початкова, регулярна ціна на позиції, які брали участь в акції.

Додавання Сезонних позицій

Для введення в прайс-лист сезонного асортименту, і для виведення по закінченні сезону, немає необхідності кожний раз формувати і відправляти повний список асортименту. Достатньо, у випадку діючого довготривалого прайсу, створити і відправити покупцям документ Прайс-лист, який містить тільки Сезонні позиції.

Для цього вкажіть в Меню завантаження прайсу період їх доступності до відвантажень. Позиції, які є в регулярному прайсі, залишаться без змін. Сезонний асортимент автоматично перестане відображатися покупцям, по закінченню періоду дії сезонного прайс-листа.

Додавання зображень і файлів до товарних позицій

До кожної позиції прайс-листа (після відправлення) можна прикріпити декілька файлів форматів jpg, png, doc, docx, xls, xlsx. Дистриб’ютор побачить ці файли, зможе переглянути і завантажити.

Натисніть на найменування позиції в прайсі, і у вікні редагування на кнопку Завантажити файл. З’явиться стандартне вікно відкриття файлу, де оберіть шлях і файл і натисніть (Open). Щоб прикріплені файли збереглись на платформі EDIN-Distribution, натисніть кнопку Зберегти.

_images/172.png
Виділення Новинок

Нові позиції в асортименті ви можете виділяти надписом “Новинка!”. Покупці побачать її в Прайс-листі і в бланку Замовлення по прайс-листу.

Якщо спочатку при імпорті прайс-листа з файлу, новинки НЕ були відмічені в відповідному стовпці, то їх можна відмітити (чи зняти відмітку) вручну, для кожного з покупців, відповідно в завантаженому прайс-листі.

Натисніть на найменування позиції, у вікні редагування встановіть відмітку Новинка. Натисніть кнопку Зберегти та поверніться в прайс-лист.

_images/181.png

Новинка буде позначена в прайс-листі.

_images/191.png
Виділення Акційних товарів

Акційні позиції в асортименті ви можете виділяти надписом “Акція!”. Покупці побачать її в Прайс-листі і в бланку Замовлення по прайс-листу.

Якщо спочатку при імпорті прайс-листа з файлу, акційні товари НЕ були відмічені в відповідному стовпці, то їх можна відмітити (чи зняти відмітку) вручну, для кожного з покупців, відповідно в завантаженому прайс-листі.

Натисніть на найменування позиції, у вікні редагування встановіть відмітку Акція. Натисніть кнопку Зберегти та поверніться в прайс-лист.

_images/202.png

Акція буде позначена в прайс-листі.

_images/211.png
Видалення прайсів

При видаленні прайс-листа проводиться очищення всієї історії асортименту і цін. Після видалення покупець не зможе користуватися бланком замовлення по прайсу.

Видалити прайс-лист для тільки одного з дистриб’юторів можна обравши його прайс для перегляду і натиснувши кнопку Очистити каталог.

_images/221.png

Якщо є потреба видалити прайс-лист для групи покупців, скористайтесь кнопкою Видалити прайси.

_images/231.png

У вікні Видалення прайсу можна обрати покупців, для яких будуть видалені всі дані, які були завантажені в прайс-лист. Після вибору натисніть кнопку Видалити.

_images/241.png
Внесення змін в обмеження для замовлень по прайсу

На закладці Існуючі обмеження в Меню завантаження прайс-листу (викликається кнопкою Завантажити - Прайс-лист) ви побачите список всіх покупців з встановленими на даний момент для їх замовлень обмеженнями.

_images/252.png

Для відправлення дистриб’юторам змін в значеннях обмежень необхідно виконати відправлення прайс-листів. Діючий для покупця прайс можно вивантажити, видалити два останні стовпця з датами дії цін, і зберегти. Далі виконати дії по відправленню прайсів і обмежень відповідно до розділу .

Додавання покупців

Щоб додати нового покупця, зверніться до вашого менеджера в компанії АТС.

У випадку ротації дистриб’юторів і покупців, звертайтесь до вашого менеджера в компанії АТС.

Відправлення прайс-листів дистриб’юторам з облікової системи

В компанії АТС розроблена специфікація XML. Щоб налаштувати відправлення прайсів безпосередньо з вашої облікової системи дистриб’юторам, зверніться до вашого менеджера в компанії АТС.

EDIN-Certificate

Інструкція по роботі з сервісом EDIN-Certificate на web-платформі EDIN

Вступ

Інструкція описує порядок завантаження і поширення сертифікатів якості та додаткових документів до них на Порталі Сертифікатів.

1. Початок роботи на Порталі Сертифікатів EDIN-Certificate

Перейдіть в розділ Сервіс і виберіть із меню «EDIN-Certificate»

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_01.png
2. Додавання документа на Портал Сертифікатів

Щоб додати сертифікат, натисніть на зелену кнопку «Додати сертифікат»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_02.png

У формі, що з’явилася необхідно заповнити обов’язкові поля відмічені червоною зірочкою (*)

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_03.png

  • Тип сертифіката - можна вибрати тип документа

  • Номер сертифіката - номер вказаний на сертифікаті

  • Дата видачі - дата видачі документа

  • Вид сертифіката - вибираємо по періоду дії документа або за номером партії

Далі, в залежності від виду сертифіката, заповнюються поля:

  • Дата початку та Дата закінчення або Номер партії, на який виписаний документ

  • Коментар - текстове поле для різних коментарів

  • Права перегляду - вказуємо права перегляду сертифіката

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_04.png

  • Не вибрано - статус, при якому не можна зберегти сертифікат, необхідно вибрати права перегляду

  • Доступний всім - доступний для перегляду всім користувачам

  • Обмежений доступ - доступ тільки обраним користувачам або мереж (після того, як ви вибрали «обмежений доступ», необхідно натиснути кнопку «Додати» і ввести або GLN-номер, або назву мережі, якою надається доступ). Якщо не додавати мережу або GLN, то сертифікат буде доступний для перегляду тільки вам.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_05.png

На екрані з’явиться вікно, в якому за допомогою пошуку можна знайти компанії, для яких сертифікат буде доступний для перегляду. Після того, як ви знайшли компанію за назвою або GLN, натисніть кнопку «Вибрати мережу»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_06.png

Натиснувши кнопку «Додати», можна додати ще компанії.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_07.png

Після заповнення всіх атрибутів Сертифікату натисніть кнопку «Зберегти»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_08.png

Після збереження з’явиться додаткове поле Категорія. Натиснувши на поле вводу і почавши вводити перші літери категорії, в випадаючому списку з’явиться категорія для вибору:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_09.png

Якщо в випадаючому списку не з’явилася необхідна категорія, то ви можете додати її, натиснувши кнопку «Додати нову категорію в довідник»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_10.png

Також в переліку Категория можна зробити множинну прив’язку сертифіката до категорій. Для цього необхідно, після вибору першої категорії, почати пошук знову, й вибрати наступну:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_11.png

2.1.Масове додавання документів

Щоб масово додати документ, потрібно попередньо підготувати необхідні файли, а саме заповнити шаблон і відсканувати необхідні документи в форматі PDF, JPG, JPEG, PNG, TIFF.

Для завантаження шаблону натисніть кнопку + і виберіть «Завантажити шаблон»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_12.png

Заповніть інформацію за документами в завантажений шаблон, попередньо видаливши дані зазначені для прикладу (окрім заголовків стовбців):

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_13.png

Тип сертифіката - в залежності від типу зазначеного в документі, необхідно вказати відповідний номер типу:

  1. Сертифікат відповідності / визнання

  2. Свідоцтво / сертифікат якості

  3. Декларація імпортера

  4. Висновок СЕС

  5. Декларація виробника

  6. Карантинний сертифікат

  7. Акт фітосанітарного контролю

  8. Фітосанітарний сертифікат

  9. Висновок фітосанітарної експертизи

  10. Протокол лабораторних випробувань

  11. Експертний висновок

  1. Сертифікат типу

  2. Сертифікат аналізу

  3. Дозвіл на випуск / реалізацію

  4. Висновок Держлікслужби

  5. Сертифікат на СУЯ (ISO9001)

  6. Паспорт якості

  • Номер сертифіката - номер вказаний на сертифікаті;

  • Дата видачі - дата видачі документа в форматі «ДД.ММ.ГГГГ»;

  • Вид сертифіката - для документа виданого на період дії вкажіть «1», для виданого на певну партію вкажіть «2»;

Далі, в залежності від виду сертифікату, заповнюються поля:

Дата початку дії і Дата закінчення дії або Номер партії, на який виписаний документ;

Зверніть увагу, для Віда сертифіката виданого на період - обов’язково вказувати дату закінчення, а для виданого на певну партію - Номер партії.

Артикул виробника - артикул вказаний виробником;
Номер ВМД, накладної - номер накладної до якої відноситься сертифікат;
Коментар - при необхідності можна додати додаткові відомості;
Назва файлу - в цьому полі необхідно вказати ім’я файлу для подальшого прикріплення до картки сертифіката. Зверніть увагу, що для одного документа допускається вказувати тільки одну назву файлу з розширенням. Наприклад «image (1) .jpg».

Після цього необхідно додати заповнений шаблон і всі підготовлені, відскановані файли в zip-архів.

Зверніть увагу, що формат комірок повинен бути текстовим.

Для масового створення документів натисніть кнопку + і виберіть «Масовий імпорт сертифікатів»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_14.png

У вікні, Ви можете встановити права перегляду сертифікатів.

Встановіть:

  • «Доступний всім» - якщо сертифікати будуть загальнодоступними;

  • «Обмежений доступ» - якщо сертифікати будуть доступні певним контрагентам;

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_15.png

Натисніть «Завантажити» і в формі вибору файлів виберіть необхідний zip-архів.

Після обробки zip-архіву відкриється форма зі звітом про результати імпорту. Успішно створені сертифікати будуть відображатися рядками білого кольору.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_16.png

У разі наявності помилок заповнення шаблону відповідний рядок буде виділено червоним кольором. При наведенні курсора миші в підказці буде відображено опис помилок. Для таких документів картки не будуть створені і при необхідності можна буде відредагувати відповідні рядки і знову імпортувати zip-архів. При цьому для раніше створених документів відобразиться помилка «Сертифікат вже існує» і нові карти не будуть створені.

Після натискання кнопки «Закрити» сторінка оновиться і в списку сертифікатів відобразяться нові створені документи.

Примітка

Якщо при масовому імпорті сертифікатів Ви встановили «Обмежений доступ» але не вказали контрагента або точку доставки - за замовчуванням такі сертифікати будуть з обмеженими правами перегляду (доступні тільки вам). Для зміни прав необхідно буде перейти в картку сертифікату натиснувши на Номер і змінити Права перегляду.

3. Завантаження файлів сертифіката

Після збереження атрибутів сертифіката стане доступний блок завантаження файлу:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_17.png

Підтримувані типи файлів: PDF, JPG, JPEG, PNG, TIFF.

Для завантаження файлу натисніть кнопку «Завантажити», вкажіть шлях до потрібного файлу і завантажте його.

Після того, як ви завантажили файл в систему, з’явиться можливість завантаження додаткових файлів, для додавання їх натисніть кнопку «Додати»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_18.png

Виберіть Тип додаткового файлу і натисніть «Завантажити», вкажіть шлях до файлу і завантажте його.

Максимальний розмір файлу для завантаження - 7,5 МБ. Після завантаження ви зможете подивитися розмір завантаженого файлу.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_19.png

Якщо розмір файлу більше, ніж 7,5 МБ, то його необхідно видалити і завантажити файл меншого розміру, після чого буде можливість підписати його ЕЦП.

Якщо необхідно завантажити додаткові файли, (зображення сертифіката знаходиться в декількох файлах), натисніть кнопку «Додати доп. файли». Після вибору файлу натисніть кнопку «Зберегти»

4. Підписання файлів сертифікатів

Після завантаження файлів сертифікатів, у Вас є можливість підписати ці документи ЕЦП, для цього під кожним файлом натисніть кнопку «Підписати»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_20.png

При переході на сторінку підписання документа необхідно натиснути кнопку «Зчитати ключі»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_21.png

У вікні з’явиться форма для вибору ключів:

Якщо ключі видані в АЦСК ІДД (ФСУ), то необхідно вибрати ключі (key-6.dat), вказати пароль і натиснути кнопку «Зчитати ключі»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_22.png

Після установки ключів, на сторінці відобразиться інформація про ЕЦП:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_23.png

Якщо використовуються для підписання ключі АЦСК «Україна», то ключі мають наступний вид:

  • Ключ директора: ЕДРПОУ_ІНН подпісанта_D1111111.ZS2

  • Ключ бухгалтера: ЄДРПОУ _ІНН подпісанта_B1111111.ZS2

  • Ключ друку: ЄДРПОУ _S1111111.ZS2 - Ключ шифрування: ЄДРПОУ _С1111111.ZS2

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_24.png

Кожна дія (підписання, установка ключів) буде супроводжуватися вікном:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_25.png

При новій сесії користувача, для підписання документа необхідно буде тільки ввести паролі і натиснути кнопку «Зчитати ключі».

Після підписання документа, на сторінці відобразиться інформація про ЕЦП:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_26.png
5. Прив’язка товару до сертифікату

На порталі сертифікатів у Вас є можливість прив’язати сертифікати до товару, на який вони виписані. Для цього натисніть кнопку «Додати»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_27.png

Заповнити один або кілька параметрів по продукції (Штрихкод, Артикул покупця, Артикул постачальника). Зверніть увагу якщо Вам необхідно додати багато штрихкодів, Ви можете скопіювати перелік штрихкодів з файлу Excel або написані через кому і вставити в перший рядок:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_28.png

Після заповнення даних по товару, натисніть кнопку «Зберегти»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_29.png

Як тільки Ви успішно виконали всі перераховані вище пункти, у Вас при формуванні Повідомлення про відвантаження в поле штрих-коду в позиції, на яку заведено сертифікат, з’явиться синя піктограма з галочкою:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_30.png

Якщо натиснути на піктограму, то у Вас відкриється детальна інформація про доданих документах:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_21.png
6. Перегляд доступних сертифікатів

У центральній частині Порталу Сертифікатів ви можете побачити всі доступні вам сертифікати а також можливі дії.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_32.png

  1. додати сертифікат;

  2. виконати пошук сертифіката по штрихкоду або номером Сертифіката;

  3. виконати розширений пошук сертифіката;

  4. відобразити сертифікати з +/- 30 днів від дати закінчення;

  5. відобразити сертифікати, які відкриті для вас;

  6. відобразити загальнодоступні сертифікати;

  7. настройка відображення стовпців.

У колонці Дії можна виконати швидкі операції з сертифікатами:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_32_2.png

Стан підпису сертифіката ЕЦП:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_32_3.png

6.1. Налаштування відображення стовпців

Для зручного перегляду даних про сертифікати, натисніть на кнопку «Налаштування відображення стовпців»

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_33.png

Активуйте необхідні стовпці і натисніть «Зберегти». Додані стовпці відобразяться після автоматичного оновлення сторінки.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_34.png

Примітка

Після виходу з особистого кабінету, активовані стовпці будуть скинуті на вибір за замовчуванням. Щоб змінити набір за замовчуванням активуйте «прапорець» біля «Запам’ятати параметри» і натисніть «Зберегти».

7. Звірка сертифіката з Реєстром державної системи сертифікації України.

Після того, як ви завантажили сертифікат і зберегли його, у вас є можливість отримати більш детальну інформацію з Реєстру сертифікації. Інформацію з Реєстру можна отримати тільки в тому випадку, якщо сертифікат зареєстрований в Реєстрі державної системи сертифікації України.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_35.png
8. Перегляд деталей сертифіката

У цьому полі можна подивитися дату створення, дату останньої зміни, статус сертифіката. Навівши курсор на статус А+, ви можете подивитися всі атрибути сертифіката.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_36.png

Статус має різні позначення і виділяється кольором, залежно від наявності атрибутів:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_36_2.png
9. Пошук сертифікатів за параметрами

Для пошуку сертифіката за певними параметрами, необхідно на Порталі Сертифікатів натиснути кнопку «Розширений пошук»:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_37.png

Відкриється форма для пошуку:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_38.png

Пошук можна проводити по одному або по декількох полях. Після того, як ви внесли умови пошуку, натисніть кнопку «Пошук».

10. Друк сертифіката з реквізитами ЕЦП

Для того, щоб роздрукувати підписаний сертифікат, необхідно натиснути кнопку «переглянути підписи», яка знаходиться в колонці «Дії» списку сертифікатів:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_39.png

Або у відкритому сертифікаті, в полі Файл:

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_40.png

Відкриється вікно із завантаженою скан-копію сертифіката, де можна додати реквізити ЕЦП. Натиснувши на кнопку «Друк», відкриється меню, з якого можна роздрукувати сертифікат з реквізитами ЕЦП.

_images/Instrukcija_po_rabote_s_servisom_EDIN_Certificate_41.png

API EDIN Certificate

Отримання атрибутів конкретного сертифіката по ID

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetCertByID

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

signInfo

M

number

ID конкретного сертификату

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**cert_data​**

{…}

об’єкт; інформація про сертифікат

cert_cat​

[{…}]

масив об’єктів; категорії, вказані власником

**cert_files**​

[{…}]

масив об’єктів; файли та скан-копії, прикріплені до сертифіката

​varMessage​

String

Повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertID​

int

ID сертификата

​varCreatedDate​

YYYY-MM-DD HH:MM:SS

дата сертифіката

​varNumber​

String

номер сертифіката

​varOriginalNum​

String

оригінальний номер сертифіката (в тому вигляді, в якому його передав користувач)

​varSystemNum​

String

внутрішній номер сертифіката (використовується для пошуку/відображення)

​intType​

int

тип сертифіката; 1 - Сертифікат відповідності / визнання; 2 - Свідоцтво якості; 3 - Декларація імпортера; 4 - Висновок СЕС; 5 - Декларація виробника; 6 - Карантинний сертифікат; 7 - Акт фітосанітарного контролю; 8 - Фітосанітарний сертифікат; 9 - Висновок фітосанітарної експертизи; 10 - Протокол лабораторних випробувань; 11 - Експертний висновок; 13 - Сертифікат типу; 14 - Сертифікат аналізу; 15 - Дозвіл на випуск / реалізацію; 16 - Висновок Держлікслужби

​intSubType​

int

вид сертифіката; 1 - період дії, 2 - номер партії

​intOwnerGlnID​

int

GLN користувача-власника сертифіката

​intSupplierGlnID​

int

GLN користувача-постачальника сертифіката

​intAccessType​

int

права перегляду; 0 - не вибрано; 1 - доступний усім; 2 - обмежений доступ

​varLotNumber​

String (50)

артикул виробника

​varDate​

YYYY-MM-DD HH:MM:SS

дата видачі сертифіката

​varText​

text

коментарі / найменування товару (якщо а полі є значення, то завантажуване (імпорт) значення дописується через кому)

​varStartDate​

YYYY-MM-DD HH:MM:SS

дата старту сертифіката

​varEndDate​

YYYY-MM-DD HH:MM:SS

дата закінчення сертифіката

​varPartNumber​

String (100)

номер партії

​intDssCertID​

int

номер dss сертифіката

​intDssCertStat​

int

статус сертифіката

​intDssCertDate​

int

дата звірки з dss

​isMadePDF​

загальний ідентифікатор статусу прикріплених скан-копій файлів; відображає статус сертифіката відносно загального pdf файлу, що мыстить файли сертифыката (основний та додатковий); 0 - файли не прикріплені до сертифіката користувачем; 1 - файли в черзі на конвертацію в загальний PDF без ЕПЦ; 2 - загальний PDF в процесі створення без ЕЦП; 3 - загальний PDF створений без ЕЦП; 4 - загальний PDF в черзі на створення PDF c візуалізацією ЕЦП; 5 - загальний PDF c візуалізацією ЕЦП в процесі створення; 6 - загальний PDF c візуалізацією ЕЦП створений; 7 - помилка при створенні загального PDF без ЕПЦ; 8 - помилка при створенні загального PDF з візуалізацією ЕПЦ

​varReviewDate​

YYYY-MM-DD HH:MM:SS

дата/час ревізії сертифіката (останні зміни)

​varSubTypeName​

String

назва виду сертифіката

​varAccessTypeName​

String

назва прав перегляду

​varTypeName​

String

назва типу сертифіката

​varDssCertStat​

String

назва статусу сертифіката

​intCertCatID​

int

id категорії, присвоєної власником

​varCertCatName​

String

назва категорії, присвоєної власником

​intFileID​

int

id файлу сертифіката

​intType​

int

тип файлу

​varFileName​

String

назва файлу сертифіката з розширенням

​intSignStatus​

int

статус підписання; 0 - ні, 1 - так

​varHashLink​

String

хеш посилання файлу

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ certID​ ": "​ 1234​ "
}

Приклад тіла відповіді в json форматі:

{
  "​cert_data​ ": {
    "​intCertID​ ": "​ 1493​ ",
    "​varCreatedDate​ ": "​ 2017-06-02 11:37:59​ ",
    "​varNumber​ ": "​ 1233​ ",
    "​varOriginalNum​ ": "​ 1233​ ",
    "​varSystemNum​ ": "​ 1233​ ",
    "​intType​ ": "​ 8 ​ ",
    "​intSubType​ ": "​ 1 ​ ",
    "​intOwnerGlnID​ ": "​ 133061​ ",
    "​intSupplierGlnID​ ": "​ 133061​ ",
    "​intAccessType​ ": "​ 2 ​ ",
    "​varLotNumber​ ": "",
    "​varDate​ ": "​ 2017-06-03 00:00:00​ ",
    "​varText​ ": "",
    "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
    "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
    "​varPartNumber​ ": "",
    "​intDssCertID​ ": "​ 123​ ",
    "​intDssCertStat​ ": "​ 1 ​ ",
    "​intDssCertDate​ ": "​ 2017-06-02 12:24:35​ ",
    "​isMadePDF​ ": "​ 6 ​ ",
    "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
    "​varSubTypeName​ ": "​ Период действия​ ",
    "​varAccessTypeName​ ": "​ Ограниченный доступ​ ",
    "​varTypeName​ ": "​ фітосанітарний сертифікат​ ",
    "​varDssCertStat​ ": "​ Данные корректны​ "
  },
  "​cert_cat​ ": [
    {
      "​intCertCatID​ ": "​ 7 ​ ",
      "​varCertCatName​ ": "​ Фрукты​"
    },
    {
      "​intCertCatID​ ": "​ 1 ​ ",
      "​varCertCatName​ ": "​ Зефир​"
    }
  ],
  "​cert_files​ ": [
    {
      "​intFileID​ ": "​ 2823​ ",
      "​intType​ ": "​ 0 ​ ",
      "​varFileName​ ": "​ mozilla.pdf​ ",
      "​intSignStatus​ ": "​ 0 ​ ",
      "​varHashLink​ ": "​ 38c95fcb3faec5f40267478abedd0338​ "
    },
    {
      "​intFileID​ ": "​ 2825​ ",
      "​intType​ ": "​ 2 ​ ",
      "​varFileName​ ": "​ 1233.pdf​ ",
      "​intSignStatus​ ": "​ 1 ​ ",
      "​varHashLink​ ": "​ 93607fa75358206fae30566ec99f8136​ "
    },
    {
      "​intFileID​ ": "​ 2827​ ",
      "​intType​ ": "​ 3 ​ ",
      "​varFileName​ ": "​ 1233_signed.pdf​ ",
      "​intSignStatus​ ": "​ 0 ​ ",
      "​varHashLink​ ": "​ f1eb7e602719270db93cc071bc63f77b​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Увага

Відповідь за запитом по сертифікату, що недоступний для поточного GLN:

{
  "varMessage": "no data found",
  "intCode": 404
}

Опис помилок роботи методу (для всього контроллера GetCert)

  1. У разі коли сертифікат не доступний авторизованому користувачеві, у відповідь отримуємо:

{
  "varMessage": "Нет доступа к запрашиваемой информации",
  "intCode": 403
}

  1. У разі якщо сертифікат не існує (в параметрах certID, num, barcode, gln, inn, edrpou, intFileID вказано неіснуюче значення), у відповідь отримуємо:

{
  "varMessage": "Запрашиваемая информация не найдена",
  "intCode": 404
}

  1. У разі коли значення certID, num, barcode, gln, inn, edrpou, intFileID не вказано в запиті, у відповідь отримуємо:

{
  "varMessage": "Ошибка в параметрах запроса",
  "intCode": 400
}

Отримання конкретного файла сертифіката в BASE64

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetFileByID

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

intFileID​

M

number

ID конкретного файлу сертифіката

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**cert_file_data​**

{…}

об’єкт; інформація про файл

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertFileID​

int

ID файлу сертификата

​intType​

int

тип файлу

​varFileName​

String

назва файлу з розширенням

​varBody​

[…]

масив; тіло файлу в base64 форматі

​varHashLink​

String

хеш посилання файлу

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ intFileID​ ": "​ 1234​ "
}

Приклад тіла відповіді в json форматі:

{
  "​cert_file_data​ ": {
    "​intCertFileID​ ": "​ 2823​ ",
    "​intType​ ": "​ 0 ​ ",
    "​varFileName​ ": "​ mozilla.pdf​ ",
    "​varHashLink​ ": "​ 38c95fcb3faec5f40267478abedd0338​ ",
    "​varBody​ ": [
      base64
    ]
  },
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​": 200
}

Отримання списку всіх доступних сертифікатів для конкретного ЕДРПОУ (за прив’язаними GLN номерами)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetCertsByEdrpouCode

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

edrpou​

M

number

код ЕДРПОУ

filter​

O

number

фільтр; owner​ - повернути тільки створен сертифіката юзера-власника; private - повернути тільки розшарені сертифікати юзера-власника; public - повернути тільки загальнодоступні сертифікати юзера-власника

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**​certs​​**

[{…}]

масив об’єктів; інформація про сертифікати

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertID​

int

ID сертификата

​varNumber​

String

номер сертифіката

​varStartDate​

YYYY-MM-DD HH:MM:SS

дата старту сертифіката

​varEndDate​

YYYY-MM-DD HH:MM:SS

дата закінчення сертифіката

​varReviewDate​

YYYY-MM-DD HH:MM:SS

дата/час ревізії сертифіката (останні зміни)

​intSupplierGlnID​

int

GLN користувача-постачальника сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ edrpou​ ": "​ 1234567890123​ ",
  "​ filter​ ": "​ owner​ "
}

Приклад тіла відповіді в json форматі:

{
  "​certs​": [
    {
      "​intCertID​ ": "​ 1493​ ",
      "​varNumber​ ": "​ 1233​ ",
      "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
      "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
      "​intSupplierGlnID​ ": "​ 133061​ "
    },
    {
      "​intCertID​ ": "​ 1495​ ",
      "​varNumber​ ": "​ 4567654​ ",
      "​varStartDate​ ": "​ 2017-06-03 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-07-07 00:00:00​ ",
      "​varReviewDate​ ": "null​",
      "​intSupplierGlnID​ ": "​ 133061​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Опис помилок роботи методу (для всього контроллера GetCert)

  1. У разі коли сертифікат не доступний авторизованому користувачеві, у відповідь отримуємо:

{
  "varMessage": "Нет доступа к запрашиваемой информации",
  "intCode": 403
}

  1. У разі якщо сертифікат не існує (в параметрах certID, num, barcode, gln, inn, edrpou, intFileID вказано неіснуюче значення), у відповідь отримуємо:

{
  "varMessage": "Запрашиваемая информация не найдена",
  "intCode": 404
}

  1. У разі коли значення certID, num, barcode, gln, inn, edrpou, intFileID не вказано в запиті, у відповідь отримуємо:

{
  "varMessage": "Ошибка в параметрах запроса",
  "intCode": 400
}

Отримання списку всіх доступних сертифікатів по штрих-коду товару

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetCertsByBarcode

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

barcode​

M

number

штрих-код товару, до якого прив’язаний сертифікат

filter​

O

number

фільтр; owner​ - повернути тільки створен сертифіката юзера-власника; private - повернути тільки розшарені сертифікати юзера-власника; public - повернути тільки загальнодоступні сертифікати юзера-власника

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**​certs​​**

[{…}]

масив об’єктів; інформація про сертифікати

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertID​

int

ID сертификата

​varNumber​

String

номер сертифіката

​varStartDate​

YYYY-MM-DD HH:MM:SS

дата старту сертифіката

​varEndDate​

YYYY-MM-DD HH:MM:SS

дата закінчення сертифіката

​varReviewDate​

YYYY-MM-DD HH:MM:SS

дата/час ревізії сертифіката (останні зміни)

​intSupplierGlnID​

int

GLN користувача-постачальника сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ barcode​ ": "​ 4820000000000​ ",
  "​ filter​ ": "​ owner​ "
}

Приклад тіла відповіді в json форматі:

{
  "​certs​": [
    {
      "​intCertID​ ": "​ 1493​ ",
      "​varNumber​ ": "​ 1233​ ",
      "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
      "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
      "​intSupplierGlnID​ ": "​ 133061​ "
    },
    {
      "​intCertID​ ": "​ 1495​ ",
      "​varNumber​ ": "​ 4567654​ ",
      "​varStartDate​ ": "​ 2017-06-03 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-07-07 00:00:00​ ",
      "​varReviewDate​ ": "null​",
      "​intSupplierGlnID​ ": "​ 133061​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Опис помилок роботи методу (для всього контроллера GetCert)

  1. У разі коли сертифікат не доступний авторизованому користувачеві, у відповідь отримуємо:

{
  "varMessage": "Нет доступа к запрашиваемой информации",
  "intCode": 403
}

  1. У разі якщо сертифікат не існує (в параметрах certID, num, barcode, gln, inn, edrpou, intFileID вказано неіснуюче значення), у відповідь отримуємо:

{
  "varMessage": "Запрашиваемая информация не найдена",
  "intCode": 404
}

  1. У разі коли значення certID, num, barcode, gln, inn, edrpou, intFileID не вказано в запиті, у відповідь отримуємо:

{
  "varMessage": "Ошибка в параметрах запроса",
  "intCode": 400
}

Отримання списку всіх доступних сертифікатів по номеру

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetCertsByNum

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

num​

M

number

номер сертифіката

filter​

O

number

фільтр; owner​ - повернути тільки створен сертифіката юзера-власника; private - повернути тільки розшарені сертифікати юзера-власника; public - повернути тільки загальнодоступні сертифікати юзера-власника

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**​certs​​**

[{…}]

масив об’єктів; інформація про сертифікати

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertID​

int

ID сертификата

​varNumber​

String

номер сертифіката

​varStartDate​

YYYY-MM-DD HH:MM:SS

дата старту сертифіката

​varEndDate​

YYYY-MM-DD HH:MM:SS

дата закінчення сертифіката

​varReviewDate​

YYYY-MM-DD HH:MM:SS

дата/час ревізії сертифіката (останні зміни)

​intSupplierGlnID​

int

GLN користувача-постачальника сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ num​ ": "​ 1234567890​ ",
  "​ filter​ ": "​ owner​ "
}

Приклад тіла відповіді в json форматі:

{
  "​certs​": [
    {
      "​intCertID​ ": "​ 1493​ ",
      "​varNumber​ ": "​ 1234567890​ ",
      "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
      "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
      "​intSupplierGlnID​ ": "​ 133061​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Опис помилок роботи методу (для всього контроллера GetCert)

  1. У разі коли сертифікат не доступний авторизованому користувачеві, у відповідь отримуємо:

{
  "varMessage": "Нет доступа к запрашиваемой информации",
  "intCode": 403
}

  1. У разі якщо сертифікат не існує (в параметрах certID, num, barcode, gln, inn, edrpou, intFileID вказано неіснуюче значення), у відповідь отримуємо:

{
  "varMessage": "Запрашиваемая информация не найдена",
  "intCode": 404
}

  1. У разі коли значення certID, num, barcode, gln, inn, edrpou, intFileID не вказано в запиті, у відповідь отримуємо:

{
  "varMessage": "Ошибка в параметрах запроса",
  "intCode": 400
}

Отримання списку всіх доступних сертифікатів для конкретного ІНН (за прив’язаними GLN номерами)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetCertsByBarcode

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

inn​

M

number

ІНН код

filter​

O

number

фільтр; owner​ - повернути тільки створен сертифіката юзера-власника; private - повернути тільки розшарені сертифікати юзера-власника; public - повернути тільки загальнодоступні сертифікати юзера-власника

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**​certs​​**

[{…}]

масив об’єктів; інформація про сертифікати

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertID​

int

ID сертификата

​varNumber​

String

номер сертифіката

​varStartDate​

YYYY-MM-DD HH:MM:SS

дата старту сертифіката

​varEndDate​

YYYY-MM-DD HH:MM:SS

дата закінчення сертифіката

​varReviewDate​

YYYY-MM-DD HH:MM:SS

дата/час ревізії сертифіката (останні зміни)

​intSupplierGlnID​

int

GLN користувача-постачальника сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ inn​ ": "​ 1234567890123​ ",
  "​ filter​ ": "​ owner​ "
}

Приклад тіла відповіді в json форматі:

{
  "​certs​": [
    {
      "​intCertID​ ": "​ 1493​ ",
      "​varNumber​ ": "​ 1233​ ",
      "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
      "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
      "​intSupplierGlnID​ ": "​ 133061​ "
    },
    {
      "​intCertID​ ": "​ 1495​ ",
      "​varNumber​ ": "​ 4567654​ ",
      "​varStartDate​ ": "​ 2017-06-03 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-07-07 00:00:00​ ",
      "​varReviewDate​ ": "null​",
      "​intSupplierGlnID​ ": "​ 133061​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Опис помилок роботи методу (для всього контроллера GetCert)

  1. У разі коли сертифікат не доступний авторизованому користувачеві, у відповідь отримуємо:

{
  "varMessage": "Нет доступа к запрашиваемой информации",
  "intCode": 403
}

  1. У разі якщо сертифікат не існує (в параметрах certID, num, barcode, gln, inn, edrpou, intFileID вказано неіснуюче значення), у відповідь отримуємо:

{
  "varMessage": "Запрашиваемая информация не найдена",
  "intCode": 404
}

  1. У разі коли значення certID, num, barcode, gln, inn, edrpou, intFileID не вказано в запиті, у відповідь отримуємо:

{
  "varMessage": "Ошибка в параметрах запроса",
  "intCode": 400
}

Отримання списку всіх доступних сертифікатів для конкретного GLN

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/GetCertUA/GetCertsByGLN

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

Токен, отриманий при авторизації

gln​

M

number

GLN

filter​

O

number

фільтр; owner​ - повернути тільки створен сертифіката юзера-власника; private - повернути тільки розшарені сертифікати юзера-власника; public - повернути тільки загальнодоступні сертифікати юзера-власника

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**​certs​​**

[{…}]

масив об’єктів; інформація про сертифікати

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

​intCertID​

int

ID сертификата

​varNumber​

String

номер сертифіката

​varStartDate​

YYYY-MM-DD HH:MM:SS

дата старту сертифіката

​varEndDate​

YYYY-MM-DD HH:MM:SS

дата закінчення сертифіката

​varReviewDate​

YYYY-MM-DD HH:MM:SS

дата/час ревізії сертифіката (останні зміни)

​intSupplierGlnID​

int

GLN користувача-постачальника сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ ",
  "​ gln​ ": "​ 1234567890123​ ",
  "​ filter​ ": "​ owner​ "
}

Приклад тіла відповіді в json форматі:

{
  "​certs​": [
    {
      "​intCertID​ ": "​ 1493​ ",
      "​varNumber​ ": "​ 1233​ ",
      "​varStartDate​ ": "​ 2017-06-01 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-06-30 00:00:00​ ",
      "​varReviewDate​ ": "​ 2017-06-02 11:37:59​ ",
      "​intSupplierGlnID​ ": "​ 133061​ "
    },
    {
      "​intCertID​ ": "​ 1495​ ",
      "​varNumber​ ": "​ 4567654​ ",
      "​varStartDate​ ": "​ 2017-06-03 00:00:00​ ",
      "​varEndDate​ ": "​ 2017-07-07 00:00:00​ ",
      "​varReviewDate​ ": "null​",
      "​intSupplierGlnID​ ": "​ 133061​ "
    }
  ],
  "​varMessage​ ": "​ Success!​ ",
  "​intCode​ ": 200
}

Опис помилок роботи методу (для всього контроллера GetCert)

  1. У разі коли сертифікат не доступний авторизованому користувачеві, у відповідь отримуємо:

{
  "varMessage": "Нет доступа к запрашиваемой информации",
  "intCode": 403
}

  1. У разі якщо сертифікат не існує (в параметрах certID, num, barcode, gln, inn, edrpou, intFileID вказано неіснуюче значення), у відповідь отримуємо:

{
  "varMessage": "Запрашиваемая информация не найдена",
  "intCode": 404
}

  1. У разі коли значення certID, num, barcode, gln, inn, edrpou, intFileID не вказано в запиті, у відповідь отримуємо:

{
  "varMessage": "Ошибка в параметрах запроса",
  "intCode": 400
}

Допоміжний метод. Показує доступні дії для надання доступу до сертифіката (по GLN користувача)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/ShowAccessActions

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту обов’язково передається лише токен varToken​, отриманий при авторизації

RESPONSE

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**certificate_access_actions**

[{…}]

масив об’єктів; дії, доступні для надання доступу до сертифіката

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

code

int

код дії; 1 - Розшарити доступ до сертифіката, 2 - Прибрати доступ до сертифікату

name

String

назва доступної дії

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ "
}

Приклад тіла відповіді в json форматі:

{
  "certificate_access_actions": [
    {
      "code": 1,
      "name ": "Расшарить доступ к сертификату"
    },
    {
      "code": 2,
      "name ": "Убрать доуступ к сертификату"
    }
  ],
  "varMessage": "Success!",
  "intCode": 200
}

Допоміжний метод. Показує доступні дії для надання прав доступу до сертифіката (властивість сертифіката)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/ShowAccessTypes

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту обов’язково передається лише токен varToken​, отриманий при авторизації

RESPONSE

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**certificate_access_types**

[{…}]

масив об’єктів; наданий доступ до сертифіката

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

code

int

код доступу; 1 - Доступний усім, 2 - Обмежений доступ

name

String

назва доступу

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ "
}

Приклад тіла відповіді в json форматі:

{
  "certificate_access_types": [
    {
      "code": 1,
      "name ": "Доступен всем"
    },
    {
      "code": 2,
      "name ": "Ограниченный доступ"
    }
  ],
  "varMessage": "Success!",
  "intCode": 200
}

Надання прав доступу до сертифіката (обмежений доступ для конкретних користувачів)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/SetAccess

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

токен, отриманий при авторизації

cert_id

M

int (11)

id сертифіката (intCertID)

access_type

M

int

тип доступу сертификата; 1 - доступний усім, 2 - обмежений доступ

access_action

O…M

int

дія по доступу до сертифікату; 1 - відкрити доступ до сертифікту, 2 - закрити доступ до сертифікату. Поле обов’язкове при access_type=2

amigos_info

O…M

[{…}]

масив об’єктів; дані контрагентів. Поле обов’язкове при access_type=2

gln

M

String

GLN користувача, для якого здійснюється налаштування доступу до сертифіката

isRetailer

O

boolean

відмітка, чи являється контрагент Торговою Мережею; false - открываем/ограничиваем доступ для GLN; true - відкрити/закрити доступ для мережі

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

Приклади

Приклад тіла запиту в json форматі:

{
  "varToken": "nohuola9h24tmj4jln3devi151",
  "cert_id": "2173",
  "access_type": "2",
  "access_action": "1",
  "amigos_info": [
    {
      "gln": "9864066822430",
      "isRetailer": false
    },
    {
      "gln": "9864064665428",
      "isRetailer": false
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад тіла відповіді в json форматі:

{
  "varMessage": "Success!",
  "intCode": 200
}

Опис помилок роботи методу для надання доступу до сертифіката

  1. У разі коли сертифікат ("cert_id":"21478457735367345") не належить користувачу, під яким пройдена авторизація:

{
  "varMessage": "Сертификат не найден",
  "intCode": 404
}

  1. Якщо в запиті був відсутній тип доступу ("access_type":"") або був переданий тип доступу, якого немає в довіднику:

{
  "varMessage": "Не заполнено обязательное поле \"access_type\"",
  "intCode": 400
}

  1. Якщо в запиті передано тип доступу «Обмежений доступ» та не заповнено поле «дії над доступом сертифіката» ("access_action":"") або це значення відсутнє в довіднику:

{
  "varMessage": "Не заполнено обязательное поле \"access_action\"",
  "intCode": 400
}

{
  "varMessage": "Недопустимый формат поля \"access_action\" 324",
  "intCode": 400
}

  1. Якщо в запиті не заповнений параметр amigos_info

Приклад запиту:

{
"varToken":"jl4k81iq15utvdqtihghk38kk1",
"cert_id":"2173",
"access_type":"2",
"access_action":"2"
}

Приклад відповіді:

{
  "varMessage": "Не заполнено обязательное поле \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті не заповнено поле gln в блоці amigos_info

Приклад запиту:

"amigos_info":[
    {
      "gln": "",
      "isRetailer": true
    },
    {
      "gln": "",
      "isRetailer": true
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]

Приклад відповіді:

{
  "varMessage": "Не заполнено обязательное поле \"gln\" в блоке \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті передано некорректний gln в блоці amigos_info

Приклад запиту:

"amigos_info":[
    {
      "gln": "dfghdfg",
      "isRetailer": true
    },
    {
      "gln": "dgfhdfg",
      "isRetailer": true
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Недопустимый формат поля \"gln\" dfghdfg в блоке \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті передано некорректний isRetailer в блоці amigos_info

Приклад запиту:

"amigos_info":[
    {
      "gln": "9864066822430",
      "isRetailer": "fdsa"
    },
    {
      "gln": "9864064665428",
      "isRetailer": false
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Недопустимый формат поля \"isRetailer\" fdsa в блоке \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті передано gln, якого немає в БД

Приклад запиту:

"amigos_info":[
    {
      "gln": "9008727091081",
      "isRetailer": false
    },
    {
      "gln": "9008727092026",
      "isRetailer": false
    },
    {
      "gln": "9008727092071",
      "isRetailer": false
    },
    {
      "gln": "9008727092033",
      "isRetailer": false
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Не найдены \"gln\" 9008727091081,9008727092026,9008727092071,9008727092033 в блоке \"amigos_info\"",
  "intCode": 404
}

  1. Якщо в запиті передано gln, що не відносяться до Торгової Мережі

Приклад запиту:

"amigos_info":[
    {
      "gln": "9864066822430",
      "isRetailer": true
    },
    {
      "gln": "9864064665428",
      "isRetailer": true
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Переданные данные в поле \"gln\" 9864066822430,9864064665428  блока \"amigos_info не принадлежат сети\"",
  "intCode": 404
}

Допоміжний метод. Показує доступні дії при «прив’язці» сертифіката до товарів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/ShowBindActions

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту обов’язково передається лише токен varToken​, отриманий при авторизації

RESPONSE

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**certificate_access_actions**

[{…}]

масив об’єктів; дії, доступні для «прив’язки» сертифіката до товарів

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

code

int

код дії; 1 - Додати прив’язку до товару, 2 - Видалити прив’язку до товару

name

String

назва доступної дії

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ "
}

Приклад тіла відповіді в json форматі:

{
  "certificate_access_actions": [{
    "code": 1,
    "name ": "Добавить привязки к товару"
  }, {
    "code": 2,
    "name ": "Удалить привязки к товару"
  }],
  "varMessage": "Success!",
  "intCode": 200
}

Додавання/видалення «прив’язки» сертифіката до товарів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/SetBind

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

токен, отриманий при авторизації

cert_id

M

int (11)

id сертифіката (intCertID)

bind_action

M

int

дія по прив’язкам сертифіката до товару; 1 - Додати прив’язку до товару, 2 - Видалити прив’язку до товару

product_binds

M

[{…}]

масив об’єктів; дані товарних позицій. Блок повинен містити хоча б один параметр

gtin

O

[{…}]

штрих-код товару

article_supplier

O

String(30)

артикул Поставщика

article_buyer

O

String(30)

артикул Покупця

uktved

O

String(4-10)

код УКТЗЕД

dkpp

O

String «ХХ.ХХ.XX-XX.XX»

код ДКПП

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

Приклади

Приклад тіла запиту в json форматі:

{
  "varToken": "jl4k81iq15utvdqtihghk38kk1",
  "cert_id": "2199",
  "bind_action": "1",
  "product_binds": [
    {
      "gtin": "4563456345",
      "article_supplier": "3458678967",
      "article_buyer": "67896789678",
      "uktved": "65756",
      "dkpp": "99.67.46-57.46"
    },
    {
      "article_supplier": "567856785",
      "article_buyer": "465345634574",
      "uktved": "567853",
      "dkpp": "11.67.46-57.46"
    },
    {
      "gtin": "875678567567"
    },
    {
      "gtin": "5678567453",
      "article_supplier": "5467456",
      "dkpp": "45.67.46-57.46"
    },
    {
      "gtin": "56785674353",
      "article_supplier": "567856711",
      "uktved": "3456",
      "dkpp": "78.67.46-57.41"
    },
    {
      "gtin": "5678354634",
      "article_supplier": "57856",
      "article_buyer": "3456435",
      "uktved": "47564",
      "dkpp": "98.67.46-57.46"
    }
  ]
}

Приклад тіла відповіді в json форматі:

{
  "varMessage": "Success!",
  "intCode": 200
}

Опис помилок роботи методу для надання доступу до сертифіката

  1. У разі коли сертифікат ("cert_id":"21478457735367345") не належить користувачу, під яким пройдена авторизація:

{
  "varMessage": "Сертификат не найден",
  "intCode": 404
}

  1. Якщо в запиті був відсутній тип доступу ("access_type":"") або був переданий тип доступу, якого немає в довіднику:

{
  "varMessage": "Не заполнено обязательное поле \"access_type\"",
  "intCode": 400
}

  1. Якщо в запиті передано тип доступу «Обмежений доступ» та не заповнено поле «дії над доступом сертифіката» ("access_action":"") або це значення відсутнє в довіднику:

{
  "varMessage": "Не заполнено обязательное поле \"access_action\"",
  "intCode": 400
}

{
  "varMessage": "Недопустимый формат поля \"access_action\" 324",
  "intCode": 400
}

  1. Якщо в запиті не заповнений параметр amigos_info

Приклад запиту:

{
"varToken":"jl4k81iq15utvdqtihghk38kk1",
"cert_id":"2173",
"access_type":"2",
"access_action":"2"
}

Приклад відповіді:

{
  "varMessage": "Не заполнено обязательное поле \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті не заповнено поле gln в блоці amigos_info

Приклад запиту:

"amigos_info":[
    {
      "gln": "",
      "isRetailer": true
    },
    {
      "gln": "",
      "isRetailer": true
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]

Приклад відповіді:

{
  "varMessage": "Не заполнено обязательное поле \"gln\" в блоке \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті передано некорректний gln в блоці amigos_info

Приклад запиту:

"amigos_info":[
    {
      "gln": "dfghdfg",
      "isRetailer": true
    },
    {
      "gln": "dgfhdfg",
      "isRetailer": true
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Недопустимый формат поля \"gln\" dfghdfg в блоке \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті передано некорректний isRetailer в блоці amigos_info

Приклад запиту:

"amigos_info":[
    {
      "gln": "9864066822430",
      "isRetailer": "fdsa"
    },
    {
      "gln": "9864064665428",
      "isRetailer": false
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Недопустимый формат поля \"isRetailer\" fdsa в блоке \"amigos_info\"",
  "intCode": 400
}

  1. Якщо в запиті передано gln, якого немає в БД

Приклад запиту:

"amigos_info":[
    {
      "gln": "9008727091081",
      "isRetailer": false
    },
    {
      "gln": "9008727092026",
      "isRetailer": false
    },
    {
      "gln": "9008727092071",
      "isRetailer": false
    },
    {
      "gln": "9008727092033",
      "isRetailer": false
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Не найдены \"gln\" 9008727091081,9008727092026,9008727092071,9008727092033 в блоке \"amigos_info\"",
  "intCode": 404
}

  1. Якщо в запиті передано gln, що не відносяться до Торгової Мережі

Приклад запиту:

"amigos_info":[
    {
      "gln": "9864066822430",
      "isRetailer": true
    },
    {
      "gln": "9864064665428",
      "isRetailer": true
    },
    {
      "gln": "4829900023799",
      "isRetailer": true
    }
  ]
}

Приклад відповіді:

{
  "varMessage": "Переданные данные в поле \"gln\" 9864066822430,9864064665428  блока \"amigos_info не принадлежат сети\"",
  "intCode": 404
}

Додавання до сертифіката скан-копії (в будь-якому форматі)

Для роботи з цим методом користувач повинен бути авторизованим .

Підказка

Метод використовується для сертифікатів (без прикріпленого файлу), власником якогоє GLN, до якого підв’язаний авторизований користувач.

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/AttachScan

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

токен, отриманий при авторизації

cert_id

M

int (11)

id сертифіката (intCertID)

file_body

M

String

тіло файлу (завантаженної скан-копії) в форматі base64

file_name

M

String

назва файлу

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

file_id

String

id доданої скан-копії

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

Приклади

Приклад тіла запиту в json форматі:

{
    "cert_id": "2199",
    "file_body": "JVBERi0xLjQK...NTcKJSVFT0Y=",
    "varToken": "jl4k81iq15utvdqtihghk38kk1",
    "file_name":"test2"
}

Приклад тіла відповіді в json форматі:

{
"file_id": "5071",
"varMessage": "Success!",
"intCode": 200
}

Опис помилок роботи методу для додавання скан-копій до сертифіката

  1. У разі коли сертифікат ("cert_id":"21478457735367345") не належить користувачу, під яким пройдена авторизація:

{
  "varMessage": "Сертификат не найден",
  "intCode": 404
}

  1. Якщо в запиті не був заповнений параметр "file_body":"":

{
  "varMessage": "Не заполнено обязательное поле \"file_body\"",
  "intCode": 400
}

  1. Якщо в запиті не був заповнений параметр "file_name":"":

{
  "varMessage": "Не заполнено обязательное поле \"file_name\"",
  "intCode": 400
}

Допоміжний метод. Отримання довідника типів сертифікатів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/ShowTypes

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту обов’язково передається лише токен varToken​, отриманий при авторизації

RESPONSE

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**certificate_types**

[{…}]

масив об’єктів; типи сертифікатів

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

code

int

код типу сертифіката; 1 - сертифікат відповідності/визнання, 2 - посвідчення якості, 3 - декларація імпортера, 4 - висновок СЄС, 5 - декларація виробника, 6 - карантинний сертифікат, 7 - акт фітосанітарного контролю, 8 - фітосанітарний сертифікат, 9 - висновок фітосанітарної експертизи, 10 - протокол лабораторних досліджень, 11 - Експертний висновок, 12 - Приложение к файлу, 13 - Сертификат типа, 14 - Сертифікат аналізу, 15 - Дозвіл на випуск /реалізацію, 16 - Висновок Держлікслужби

name

String

назва типу сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ "
}

Приклад тіла відповіді в json форматі:

{
  "certificate_types": [{
    "code": 1,
    "name": "сертифікат відповідності\/визнання"
  }, {
    "code": 2,
    "name": "посвідчення якості"
  }, {
    "code": 3,
    "name": "декларація імпортера"
  }, {
    "code": 4,
    "name": "висновок СЄС"
  }, {
    "code": 5,
    "name": "декларація виробника"
  }, {
    "code": 6,
    "name": "карантинний сертифікат"
  }, {
    "code": 7,
    "name": "акт фітосанітарного контролю"
  }, {
    "code": 8,
    "name": "фітосанітарний сертифікат"
  }, {
    "code": 9,
    "name": "висновок фітосанітарної експертизи"
  }, {
    "code": 10,
    "name": "протокол лабораторних досліджень"
  }, {
    "code": 11,
    "name": "Експертний висновок"
  }, {
    "code": 12,
    "name": "Приложение к файлу"
  }, {
    "code": 13,
    "name": "Сертификат типа"
  }, {
    "code": 14,
    "name": "Сертифікат аналізу"
  }, {
    "code": 15,
    "name": "Дозвіл на випуск \/реалізацію"
  }, {
    "code": 16,
    "name": "Висновок Держлікслужби"
  }],
  "varMessage": "Success!",
  "intCode": 200
}

Допоміжний метод. Отримання довідника видів сертифікатів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/ShowSubTypes

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту обов’язково передається лише токен varToken​, отриманий при авторизації

RESPONSE

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**certificate_sub_types**

[{…}]

масив об’єктів; види сертифікатів

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

code

int

код виду сертифіката; 1 - Період дії, 2 - Номер партії

name

String

назва виду сертифіката

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ "
}

Приклад тіла відповіді в json форматі:

{
  "certificate_sub_types": [{
    "code": 1,
    "name ": "Период действия"
  }, {
    "code": 2,
    "name ": "Номер партии"
  }],
  "varMessage": "Success!",
  "intCode": 200
}

Створення картки сертифіката

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/Create

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

токен, отриманий при авторизації

cert_number

M

String(100)

номер сертифіката

cert_date

M

String «DD.MM.YYYY»

дата видачі сертифіката

cert_sub_type

M

String

вид сертифіката (код із довідника)

cert_type

M

String

тип сертифіката (код із довідника)

cert_start_date

M

String «DD.MM.YYYY»

дата початку дії сертифіката

cert_end_date

M…O

String «DD.MM.YYYY»

дата закінчення дії сертифіката. Поле обов’язкове лише за cert_sub_type=1

cert_part_number

M…O

String(100)

номер партії. Поле обов’язкове лише за cert_sub_type=2

cert_gln_creator

M

String

GLN власника сертифіката (GLN авторизованого користувача)

cert_lot_number

O

String(50)

артикул виробника

cert_gtd

O

String(100)

номер ГТД

Примітка

При створенні картки виконуються наступні перевірки:

  • Перевірка на наявність сертифікату з таким номером в сервісі, де власник є GLN, який передає поле «cert_gln_creator», якщо є - повертається помилка (детальніше в Описі помилок)

  • GLN в полі «cert_gln_creator» повинен бути підв’язаний під авторизованого користувача, якщо не підв’язаний - повертається помилка (детальніше в Описі помилок)

  • Дата початку дії (cert_start_date) не повинна бути більшою, ніж дата закінчення дії (cert_end_date), якщо більше - повертається помилка (детальніше в Описі помилок)

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

certificate_id

int

id створеного сертифіката

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

Приклади

Приклад тіла запиту в json форматі:

{
"varToken":"nohuola9h24tmj4jln3devi151",
"cert_number":"Test_api_4",
"cert_date":"05.06.2018",
"cert_sub_type":"1",
"cert_type":"8",
"cert_start_date":"30.06.2018",
"cert_end_date":"29.07.2018",
"cert_part_number":"part_numb_api_1",
"cert_gln_creator":"9864066822454",
"cert_lot_number":"lot_numb_api_1",
"cert_gtd":"gtd_api_1"
}

Приклад тіла відповіді в json форматі:

{
  "certificate_id": "2121",
  "varMessage": "Success!",
  "intCode": 200
}

Опис помилок роботи методу створення картки сертифіката

  1. Якщо в запиті не заповнено одне з обов’язкових полей (cert_number / cert_date / cert_sub_type / cert_type / cert_start_date / cert_end_date / cert_part_number / cert_gln_creator):

{
  "varMessage": "Не заполнено обязательное поле "cert_number",
  "intCode": 400
}

  1. Якщо в запиті в полях cert_number / cert_part_number / cert_lot_number / cert_gtd передана кількість символів більша допустимого (таблиця 1), наприклад, "поле":"r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5":

{
  "varMessage": "Недопустимый формат поля "поле" r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5r5hgjj4h70it9eieg4356ojop5, максимальное количество символов N",
  "intCode": 400
}

  1. Якщо в запиті в полі cert_gln_creator передано значення неправильного формату ("cert_gln_creator":"sdfgsdfsfdgsdf"):

{
  "varMessage": "Недопустимый формат поля \"cert_gln_creator\" sdfgsdfsfdgsdf",
  "intCode": 400
}

  1. Якщо в запиті в полі cert_sub_type передано некорректне значення ключа ("cert_sub_type":"fsew"):

{
  "varMessage": "Недопустимый формат поля \"cert_sub_type\" fsew, вид сертификата не найден",
  "intCode": 400
}

  1. Якщо в запиті в полі cert_type передано некорректне значення ключа ("cert_type":"fsew"):

{
  "varMessage": "Недопустимый формат поля \"cert_type\" fsew, тип сертификата не найден",
  "intCode": 400
}

  1. Якщо в запиті в «полі_дати» ( cert_date / cert_start_date / cert_end_date ) передано некорректне значення ключа (відмінне від DD.MM.YYYY), наприклад, "поле_дата":"wetryert":

{
  "varMessage": "Недопустимый формат поля \"поле_дата\" wetryert, формат даты DD.MM.YYYY",
  "intCode": 400
}

  1. Якщо в запиті передано номер сертифіката (cert_number), котрий вже є під GLN користувача (дублювання):

{
  "varMessage": "Сертификат с номером Test_api_20 уже создан",
  "intCode": 404
}

  1. Якщо в запиті передано GLN ("cert_gln_creator":"4607164999995"), котрий не підв’язаний під користувачем:

{
  "varMessage": "Gln 4607164999995 не найден",
  "intCode": 404
}

  1. Якщо дата початку (cert_start_date) більша за дату закінчення (cert_end_date):

{
  "varMessage": "Дата начала 30.06.2018 не может быть больше даты окончания 12.05.2018",
  "intCode": 400
}

Допоміжний метод. Отримання довідника типів помилок

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/ShowErrorTypes

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту обов’язково передається лише токен varToken​, отриманий при авторизації

RESPONSE

Таблиця 1 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​**certificate_error_types**

[{…}]

масив об’єктів; типи помилок при роботі з сертифікатами

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

code

int

код типу помилки; 1 - Відсутність файлу скан-копії, 2 - Відсутність прив’язки до товару, 3 - Некоректні дані картки, 4 - Некоректний файл скан-копії, 5 - Некоректні прив’язки до категорії товарів

name

String

назва типу помилки

Приклади

Приклад тіла запиту в json форматі:

{
  "​ varToken​ ": "​ 8q0hu05o59vmmrpo4t5slfedj2​ "
}

Приклад тіла відповіді в json форматі:

{
  "certificate_error_types": [
    {
      "code": 1,
      "name": "Отсутствие файла скан-копии"
    },
    {
      "code": 2,
      "name": "Отсутствие привязки к товару"
    },
    {
      "code": 3,
      "name": "Некорректные данные карточки"
    },
    {
      "code": 4,
      "name": "Некорректный файл скан-копии"
    },
    {
      "code": 5,
      "name": "Некорректные привязки к категории товаров"
    }
  ],
  "varMessage": "Success!",
  "intCode": 200
}

Відправка скарг по сертифікатам

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло HTTP запиту/відповіді в json форматі)

URL запиту

https://edo.edi-n.com/Api/V1/Certificate/NotifyError

Параметри, що передаються в URL (разом з адресою методу)

-//-

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту

Параметр

Mandatory/Optional

Формат

Опис

varToken​

M

String

токен, отриманий при авторизації

cert_id

M

int (11)

id сертифіката (intCertID)

type_error

M

int

код типу помилки; 1 - Відсутність файлу скан-копії, 2 - Відсутність прив’язки до товару, 3 - Некоректні дані картки, 4 - Некоректний файл скан-копії, 5 - Некоректні прив’язки до категорії товарів

text

O…M

text

текст скарги

RESPONSE

Таблиця 2 - Опис json-параметрів відповіді метода API

Параметр

Mandatory/Optional

Формат

Опис

​varMessage​

String

повідомлення сервера

​intCode​

int

код відповіді сервера

Приклади

Приклад тіла запиту в json форматі:

{
"varToken":"jl4k81iq15utvdqtihghk38kk1",
"cert_id":"3001",
"type_error":"2",
"text":"Тест тест тест"
}

Приклад тіла відповіді в json форматі:

{
  "varMessage": "Success!",
  "intCode": 200
}

Опис помилок роботи методу для відправки скарг на сертифікати

  1. У разі коли сертифікат ("cert_id":"21478457735367345") не належить користувачу, під яким пройдена авторизація:

{
  "varMessage": "Сертификат не найден",
  "intCode": 404
}

  1. Якщо в запиті був переданий неіснуючий тип помилки ("type_error":"100"):

{
  "varMessage": "Недопустимый формат поля ",
  "type_error": "100",
  "intCode": 400
}

  1. Якщо в запиті передано опис помилки довжиною більше 500 символів ("text":"jl4k...8kk1"):

{
"varMessage": "Недопустимый формат поля "text" Тест тест jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4kjl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk181iq15utvdqtihghk38kk1jl4k81iq15utvdqtihghk38kk1, максимальное количество символов 500",
"intCode": 400
}

  1. Якщо помилка була відправлена раніше:

{
  "varMessage": "Уведомление об ошибке было отправлено ранее",
  "intCode": 400
}

Інструкції

Інструкція з авторизації

Дана інструкція описує порядок реєстрації та авторизації на web-платформі EDIN-DOCflow, процедуру відновлення та зміни пароля, порядок зміни Email.

1 Реєстрація користувача

Для реєстрації в сервісі перейдіть за посиланням http://doc.edi-n.com. У формі авторизації натисніть «Зареєструватися»:

_images/2_instruktsia_avtorizatsia_01.png

Далі заповніть форму реєстрації, що містить наступні поля:

  • Email – обов’язкове для заповнення поле. На вказану адресу буде надіслано листа для підтвердження реєстрації. Вказаний Email в подальшому буде використовуватись як логін користувача. Якщо дане поле не заповнене, система повідомить про помилку.

  • ПІБ (Прізвище, Ім’я, По-батькові) – обов’язкове для заповнення поле. Внесена інформація зберігається в особистому профілі користувача.

  • Номер телефону* – обов’язкове для заповнення поле. Внесена інформація зберігається в особистому профілі користувача. Номер телефону користувача заповнюється у форматі +380 (00) 000-00-00.

Наступним кроком проставте відмітку у чекбоксі «Погоджуюся на обробку персональних даних та з умовами договору-оферти». Відповідно до Закону України «Про захист персональних даних» від 01.06.2010 No2297-VI, встановлення даної відмітки є обов’язковою передумовою для старту роботи на платформі.

Ви можете ознайотися з текстом Угоди перейшовши за посиланням в тексті «Погоджуюся на обробку персональних даних»:

Після заповнення форми реєстрації натисніть «Реєстрація»:

_images/instruktsia_avtorizatsia_17_2.png

Система повідомить про відправку реєстраційного листа на вказану в полі Email адресу:

_images/instruktsia_avtorizatsia_3.png

Для підтвердження реєстрації перейдіть за посиланням у реєстраційному листі. Відправник листа - noreply@edi-n.com, тема – «EDIN-DOCFLOW Підтвердження реєстрації».

_images/instruktsia_avtorizatsia_4.png

У формі продовження реєстрації, у полі ПІБ, вкажіть ім’я користувача (обов’язково), введіть і підтвердіть пароль. Для створення безпечного пароля дотримуйтесь наступних рекомендацій:

  • мінімальна кількість символів – шість

  • уникайте повторення того ж самого символу (для прикладу – аааааа, 11111)

  • уникайте послідовностей літер або цифр (для прикладу 123456)

  • не використовуйте особисту інформацію (для прикладу – ім’я, прізвище, рік народження)

  • не використовуйте паролі до інших інтернет-сервісів.

У разі введення вже зареєстрованого Email система повідомить про помилку.

Після підтвердження пароля на формі активуються кнопки «Реєстрація» та «Реєстрація з ЕЦП»:

_images/instruktsia_avtorizatsia_18.png

При натисканні на кнопку «Реєстрація» відбувається стандартний процес реєстрації, після чого користувач потрапляє на форму авторизації (п.2 даної інструкції). Кнопка «Реєстрація з ЕЦП/КЕП» дозволяє виконати всі налаштування, необхідні для старту роботи у сервісі (рекомендовано за наявності ЕЦП на момент реєстрації).

При натисканні на кнопку «Реєстрація з ЕЦП/КЕП» відкривається форма вибору ключа. Оберіть потрібний файл підпису в каталозі на жорсткому диску ПК чи на іншому носії та введіть пароль від нього. Зазвичай ключ - це файл у форматі dat (Key-6.dat), zs2, sk, jks, pk8, pfx:

_images/instruktsia_avtorizatsia_19.png

Обраний ключ відобразиться на формі реєстрації. Водночас з’явиться можливість змінити ключ, натиснувши на відповідну кнопку. Наступним кроком проставте відмітку у чекбоксі «Погоджуюсь на умови «договору-оферти» і натисніть «Зчитати ключ»:

_images/instruktsia_avtorizatsia_20.png

У разі успішного зчитування в окремому вікні відобразиться інформація про ключ:

_images/instruktsia_avtorizatsia_21.png

Для закінчення реєстрації натисніть «Підтвердити». Перевагою вибору реєстрації з ЕЦП/КЕП буде автоматичне створення компанії і погодження з умовами договору-оферти, що є передумовою швидкого старту роботи у сервісі.

2 Авторизація

Для авторизації на платформі перейдіть за посиланням http://doc.edi-n.com/auth, введіть свій логін = Email та натисніть «Далі»:

_images/instruktsia_avtorizatsia_5.png

Наступним кроком встановіть відмітку «Я не робот», вкажіть пароль та натисніть кнопку «Увійти»:

_images/instruktsia_avtorizatsia_6.png

Якщо логін або пароль вказаний невірно, система повідомить про помилку.

У сервісі також реалізована можливість встановити інший строк блокування користувача (мінімальне значення – 3 хвилини, максимальне – 24 години) у межах налаштування параметрів парольної політики. Детальніше про налаштування парольної політики в «Інструкції адміністратора користувачів».

3 Відновлення пароля

Для відновлення пароля натисніть на сторінці авторизації «Нагадати пароль»:

_images/instruktsia_avtorizatsia_7.png

Далі вкажіть Email (логін користувача), встановіть відмітку «Я не робот» і натисніть «Відновити»:

_images/instruktsia_avtorizatsia_8.png

Система повідомить про успішну відправку листа на вказану адресу Email.

У разі використання незареєстрованого Email система повідомить про помилку.

Наступним кроком перейдіть за посиланням у листі, отриманому на вказану адресу. Відправник листа - noreply@edi-n.com, тема – «EDIN-DOCFLOW Відновлення пароля».

_images/instruktsia_avtorizatsia_9.png

Система відобразить вікно створення пароля. На формі двічі вкажіть новий пароль і натисніть «Зберегти»:

_images/instruktsia_avtorizatsia_10.png

4 Зміна пароля

Для зміни пароля натисніть на логін користувача у верхньому правому куті інтерфейсу та натисніть кнопку «Скинути пароль»:

_images/instruktsia_avtorizatsia_11.png

Система повідомить про успішне скасування пароля та відправить листа для генерації нового пароля на Email користувача.

Для зміни пароля перейдіть за посиланням у листі та вкажіть новий пароль (двічі):

_images/instruktsia_avtorizatsia_12.png

Відправник: - noreply@edi-n.com. Тема листа: «EDIN-DOCFLOW Відновлення пароля».

У разі введення пароля, що був використаний раніше, система повідомить про помилку.

5 Зміна Email

Для зміни Email перейдіть на форму редагування облікового запису користувача (меню «Налаштування узгодження» - «Користувачі») і натисніть «Редагувати».

_images/instruktsia_avtorizatsia_13.png

У формі, що відкриється, вкажіть новий Email у полі «Email» та натисніть «Зберегти». Система повідомить про успішне збереження нових даних.

_images/instruktsia_avtorizatsia_14.png

На нову адресу надійде лист з посиланням для підтвердження зміни Email та генерації пароля.

_images/instruktsia_avtorizatsia_15.png

Для завершення процедури зміни Email перейдіть за посиланням у листі та вкажіть новий пароль у формі генерації пароля.

_images/instruktsia_avtorizatsia_16.png

На стару адресу Email надійде інформаційне повідомлення про зміну електронної адреси. Відправник: - noreply@edi-n.com, тема листа: «EDIN-DOCFLOW. Відновлення пароля».

Служба Технічної Підтримки

Інструкція з налаштування ЕЦП/КЕП

Дана інструкція описує порядок завантаження та налаштування електронного цифрового підпису.

1 Терміни та визначення

Електронний цифровий підпис (ЕЦП/КЕП) — електронний цифровий підпис уповноважених осіб та окремий електронний цифровий підпис, що виконує функцію печатки (у разі наявності), з посиленим сертифікатом ключа, наданим акредитованими центрами сертифікації ключів (далі – АЦСК).

2 Авторизація в системі

Для авторизації на платформі перейдіть за посиланням https://doc.edi-n.com/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Налаштування підпису

Для підписання та шифрування документів необхідно, щоб у системі користувача були зчитані (завантажені) ключі підписів.

3.1 Зчитування ключа

Для зчитування ключа перейдіть до розділу «Налаштування ЕЦП/КЕП»:

_images/instruktsia_nastroyka_ecp_1.png

У формі налаштування ключів натисніть іконку иконка-плюсик «Зчитати ключі» для зчитування електронного цифрового підпису:

_images/instruktsia_nastroyka_ecp_2.png

Наступним кроком виберіть файл підпису в каталозі на жорсткому диску ПК (чи на іншому носії) та натисніть «Відкрити»:

_images/instruktsia_nastroyka_ecp_3.png

Система відобразить форму для вибору АЦСК (видавця електронного цифрового підпису) та вводу пароля (до ЕЦП).

До поля «Автовизначення АЦСК» підключений системний довідник з усіма існуючими АЦСК:

_images/instruktsia_nastroyka_ecp_4.png

Поряд із вибором акредитованого центру вручну, для спрощення робочого процесу реалізована можливість автоматичного визначення АЦСК.

Після вибору АЦСК та вводу пароля натисніть «Зчитати». У разі успішного зчитування ЕЦП/КЕП з’явиться відповідне повідомлення:

_images/instruktsia_nastroyka_ecp_5.png

Зчитування підписів виконується по черзі, кожен файл підпису зчитується окремо:

_images/instruktsia_nastroyka_ecp_6.png

Згідно з політикою безпеки, паролі до ЕЦП/КЕП зберігаються лише упродовж сеансу роботи з браузером.

3.2 Активація ЕЦП/КЕП для нової сесії

При повторному сеансі необхідно активувати ЕЦП/КЕП, вказавши пароль до ключа. Неактивовані ключі на формі налаштування ЕЦП/КЕП виділені сірим кольором та містять іконку иконка-ключик ключа біля назви.

_images/instruktsia_nastroyka_ecp_7.png

Для активації ключа натисніть на іконку иконка-ключик. У формі зчитування ключа поле для вибору АЦСК буде автоматично заповнене значенням, вибраним при зчитуванні ЕЦП/КЕП. Для активації ключа введіть пароль у відповідне поле та натисніть «Зчитати»:

_images/instruktsia_nastroyka_ecp_8.png

3.3 Скидання пароля та видалення ключа

Підписи зберігаються у локальному сховищі браузера. Для скидання пароля зчитаного та активованого ключа завершіть сеанс роботи в браузері або натисніть на іконку иконка-ведерко біля необхідного ключа чи на кнопку иконка-сброс «Скинути всі ключі».

_images/instruktsia_nastroyka_ecp_9.png

Для остаточного видалення ключів натисніть на іконку иконка-ведерко або на кнопку «Скинути всі ключі» для неактивного ключа(ів).

При скиданні ключів необхідно підтвердити дію у відповідному запиті системи.

4 Налаштування MobileID

Для зчитування ключа з допомогою технології MobileID перейдіть до розділу «Налаштування ЕЦП/КЕП». У формі налаштування ключів натисніть на іконку иконка-мобилка «Зчитати MobileID»:

_images/instruktsia_nastroyka_ecp_10.png

Наступним кроком вкажіть номер телефону у форматі 380 00 000 00 00 та натисніть на кнопку «Зчитати».

_images/instruktsia_nastroyka_ecp_11.png

На вказаний номер надійде sms-запит для підтвердження зчитування ключа. Введіть код підтвердження (видається оператором).

Після введення коду система відобразить список сертифікатів ЕЦП/КЕП, прив’язаних до номера телефону. Оберіть зі списку потрібний електронний підпис, встановивши відмітку навпроти нього, та натисніть «Зчитати»:

_images/instruktsia_nastroyka_ecp_12.png

У разі успішного зчитування у формі налаштування ЕЦП/КЕП з’явиться детальна інформація про підпис:

_images/instruktsia_nastroyka_ecp_13.png

5 Налаштування Апаратного ключа (Токен)

В сервісі DOCflow реалізована можливість підписання документів використовуючи зовнішній Електронний USB-ключ, токен від виробника ТОВ “Автор” сумісні з АЦСК “Україна”: «Алмаз-1К» та «SecureToken-337М».

Токен – це носій інформації у формі флешки із захистом від несанкціонованого доступу при генерації секретних ключів, зберіганні цифрового підпису та підписанні електронних документів.

При підписанні документа, є можливість вибрати яким Електронним ключем підписати документ - за допомогою налаштованого КЕП/ЕЦП, чи USB-ключем.

Для використання токена, необхідно вставити Електронний USB-ключ у ваш ПК, потім у документі що потребує підписання, натиснути Підписати, потім вибрати Робота з захищеним носієм (Token).

Виберіть підпис із списку що відобразиться та натисніть ОК.

З використанням апаратного ключа не потрібно проводити жодних налаштувань КЕП/ЕЦП!

_images/instruktsia_nastroyka_ecp_14.png

Якщо для роботи із зовнішнім токеном, вам необхідно буде здійснити налаштування й встановити необхідне програмне забезпечення, зявиться підказка:

  • Web розширення для браузера, для роботи криптобібліотеки

  • Необхідне програмне забезпечення для ПК

  • Інструкція по роботі з крипто бібліотеками і захищеним носієм (Тоken)

Усі пункти є робочими посиланнями з необхідною інформацією. Натиснувши Необхідне програмне забезпечення для ПК почнеться автоматичне завантаження програми для ПК. Подальші дії детально описані у «Інструкція по роботі з крипто бібліотеками і захищеним носієм».

Служба Технічної Підтримки

Інструкція користування пошуком та фільтрами

Дана інструкція описує порядок дій користувачів для здійснення пошуку або користування фільтрами на платформі. У кожного розділу, де наявні фільтри та пошук, є свої ообливості та правила, яких потрібно притримуватися для коректного пошуку та фільтрації.

Пошук у розділі Зовнішні комплекти документів

Для здійснення пошуку файлу за назвою, необхідно у полі Пошук файлу ввести назву файлу. Для пошуку необхідно ввести мінімум 4 символа. При пошуку не повинно бути зайвих пробілів до чи після запиту!

Назва файлу - це назва прикладеного документу, назва відображається при Завантаженні файлів документів, також можна переглянути назву файлу всередині комплекту у вікні Документи.

Для розширеного пошуку за іншими параметрами, використовуйте функціонал Фільтр.

_images/pics_іnstrukcіya-koristuvannya-poshukom_001.png

У формі Фільтр шукайте конкретний комплект у правильному вибраному розділі. Тобто, у розділі Вхідні пошук можливий лише серед вхідних комплектів документів, відповідно у розділі Вихідні пошук можливий лише серед відправлених вихідних комплектів.

_images/pics_іnstrukcіya-koristuvannya-poshukom_02.png

Доступні наступні поля для фільтрації:

  • Номер комплекту документів

  • Статус (Надіслано, Прийнято, Додано документ)

  • Обрати тег

  • Відправник

  • Типи комплектів документів Відправника (комплекти налаштовані для компаніх у меню Налаштування комплектів документів, поле доступно лише якщо вибрано Відправника)

  • Отримувач та

  • Типи комплектів документів Отримувача (поле доступно лише якщо вибрано Отримувача)

  • Довiдник ( якщо у довідника є Значення, потрібно заповнити значення)

  • Користувацькi поля

  • Дата

Будьте уважні! Залежно від напрямку (Вхідні чи Вихідні) Відправник та Отримувач відображається по різному - у розділі Вхідні для поля Відправник вибирається контрагент, а у розділі Вихідні - Відправником виступають ваші власні компанії.

Для пошуку за тегами необхідно вибрати з випадаючого списку тег за яким ви шукаете комплект. Головна умова - тег повинен бути створений раніше, а також доданий до комплекту документів або до контракту з партнером.

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Пошук. Пошук здійсниться лише по заповненим параметрам - тобто, якщо заповнити лише поле Відправник, відобразиться вся вибірка типів комплектів цього Відправника.

Якщо ви бачите повідомлення «Комплекти документів відсутні», це означає що за заданими параметрами пошуку немає вхідних чи вихідних комплектів (залежно від того в якому розділі ви знаходитеся). Спробуйте перевірити введені дані та ,можливо, змінити деякі параметри пошуку.

Коли фільтр активний, кнопка Фільтр відображається у синьому кольорі та на сторінці відображенно лише дані за вибіркою.

_images/pics_іnstrukcіya-koristuvannya-poshukom_03_2.png

Для відображення усіх комплектів обов’язково натисніть у фільтрах кнопку Скинути.

У розділах Вхідні, Вихідні та Чернетки можливо створити ярлик, тобто постійний пошуковий запит за допомогою кнопки Додати ярлик та заповнивши поля фільтру для ярлика.

_images/pics_іnstrukcіya-koristuvannya-poshukom_03.png

Обов’язкові поля для збереження ярлика:

  • Створити назву

  • Вибрати Тип періоду (поточний місяць, попередній місяць, фіксована дата або поточна дата мінус N-днів - вказується кількість днів).

Опціональні поля для ярлика:

  • Номер комплекту документів

  • Статус

  • Тег

  • Відправник та Типи комплектів документів Відправника (доступно лише якщо вибрано відправника)

  • Отримувач та Типи комплектів документів Отримувача (доступно лише якщо вибрано отримувача)

  • Довiдник та Значення

  • Користувацькi поля

Створення та додавання тегів

Налаштуйте зручний пошук комплектів за індивідуальними тегами. Ви можете додати тег до комплекту документів у будь-якому статусі - теги видимі лише вам.

Для початку створіть унікальні теги у меню Налаштування компанії - Керування тегами. Для цього натисніть Створити тег та придумайте назву, унікальний код тегу сформується автоматично.

_images/pics_іnstrukcіya-koristuvannya-poshukom_03_3.png _images/pics_іnstrukcіya-koristuvannya-poshukom_03_4.png

Додавайте теги при створенні або редагуванні комплекту або присвойте контракту при створенні або редагуванні.

Пошук за тегами можливий лише у Фільтрі у розділі Зовнішні комплекти документів, якщо тег додано або до контракту або до комплекту.

Мої завдання

Якщо ви входите до групи виконавців узгодження комплектів або внутрішніх документів, знайти конкретне завдання серед списку вам допоможуть Фільтри завдань.

_images/pics_іnstrukcіya-koristuvannya-poshukom_04.png

Пошук можливий за такими ,полями:

  • Тип завдання - Узгодження; Підписання; Повідомлення;

  • Статус завдання - До виконання, Виконано, Відхилено, Прострочена;

  • Компанія відправник

  • Компанія отримувач

  • Тип документа - можливо вибрати серед тих типів, які є серед доданих до завдань;

  • Дата створення завдання

  • Строк виконання

  • Напрямок - Вхідні або Вихідні завдання

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Пошук.

Для відображення усіх завдань обов’язково натисніть у фільтрах кнопку Скинути.

Взаємодія з Партнерами - Контракти

Контракт - спеціальний договір, форма зв’язку між партнерами, згідно з якою відбувається обмін комплектами документів. У контракті визначається перелік вхідних та вихідних (по відношенню до власника контракту) типів комплектів та довідники. Власник контракту – ініціатор процесу обміну комплектами та є відправником контракту.

_images/pics_іnstrukcіya-koristuvannya-poshukom_005.png

Пошук контракту, спеціального договору з партнером, можна знайти за такими полями:

  • Назва контракту - відображається у стовбці Назва контракту, та у контракті в блоці Дані

  • Номер - номер контракту, що відображається у контракті в блоці Дані

  • Клієнт - той хто отримав контракт, пошук за компанією, для розділів Вхідні та Вихідні відображаються різні компанії;

  • Ініціатор - той хто надіслав контракт; власник контракту;

  • Статус - Новий; Прийнятий; Відхилений; Розірваний; Очікує підписання;

  • Термін дії

У розділах Вхідні та Вихідні контракти поля Клієнт та Ініціатор відрізняються - відображаються або внутрішні компанії або партнери, так як у вихідних контрактах власником-ініціатором є наші внутрішні компанії (що відображаються у меню Мої компанії).

Якщо ви бачите повідомлення «Контракти не знайдені», це означає що за заданими параметрами пошуку немає вхідних чи вихідних контрактів (залежно від того в якому розділі ви знаходитеся). Спробуйте перевірити введені дані та можливо змінити деякі параметри пошуку. Перевірте введені дані на наявність зайвих пробілів.

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Застосувати.

Для відображення усіх контрактів обов’язково натисніть у фільтрах кнопку Скинути.

Особистий кабінет - Рахунки та Журнал подій

У розділі Рахунки у вигляді таблиці відображені всі рахунки та акти по компаніях акаунта із виведенням такої інформації як Номер рахунку, Дата здійснення рахунку, Сума рахунку та Період оплати.

Для пошуку конкретного рахунку, або віведення рахунків лише за певний період часу скористайтеся фільтрами.

_images/pics_іnstrukcіya-koristuvannya-poshukom_006.png

Фільтр Рахунки дозволяє пошук за такими полями:

  • Номер

  • Статус (оплачений / неоплачений)

  • Дата рахунку

  • Дата оплати

  • Дата акту

  • Наявність акту (акт сформовано/ не сформовано)

У поле Номер введіть точну та повну назву рахунку, відображену в стовбці Номер рахунку. Перевірте введені дані на наявність зайвих пробілів.

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Пошук.

Для відображення усіх контрактів обов’язково натисніть у фільтрах кнопку Скинути.

Журнал подій містить інформацію щодо змін і коментарів до документів та комплектів

_images/pics_іnstrukcіya-koristuvannya-poshukom_007.png

Фільтр у Журналі подій

  • Пошук

  • Дія

  • Об’єкт

  • Користувач

  • Дата

Для пошуку за вибраними фільтрами обов’язково натисніть кнопку Застосувати.

Для відображення усіх завдань обов’язково натисніть у фільтрах кнопку Скинути.

Інструкція бізнес-адміністратора

Дана інструкція описує порядок дій користувача, що виконує роль бізнес-адміністратора, на платформі DOCflow для виконання налаштувань, які є передумовою обміну комплектами документів.

1 Терміни та визначення

  • Компанія – юридична чи фізична особа, яка використовує систему для виконання своїх процесів. До одного акаунта можливо прив’язати декілька компаній. Документи, довідники, типи комплектів, контракти, маршрути, налаштування узгодження створюються в межах компанії і закріплюються за нею.

  • Контракт – форма налаштування зв’язку між партнерами, у відповідності до якої відбувається обмін комплектами документів.

  • Власник (ініціатор) контракту – організація, яка виступає ініціатором процесу обміну комплектами та відправником контракту.

  • Клієнт – організація-контрагент, яка виступає отримувачем контракту.

  • Тип комплекта – налаштування та параметри комплекта документів для обміну (являє собою перелік обов’язкових та необов’язкових типів документів для обміну в рамках комплекта, визначає необхідність шифрування, кількість підписів власника та клієнта).

  • Маршрут – операція визначення працівників отримувача, які будуть отримувати та обробляти комплекти документів. Маршрут будується на основі переліку контрактів та типів комплектів, до яких буде надано доступ користувачеві.

  • Довідник – прикладний об’єкт системи, який дозволяє зберігати дані, що мають однакову структуру та обліковий характер. Довідниками можуть бути, наприклад, типи операцій, регіони, види бізнесу тощо.

  • Тип документа – спеціальний системний довідник, що містить дані за типами документів, якими виконуватиметься обмін між сторонами.

2 Авторизація

Для авторизації на платформі перейдіть за посиланням https://doc.edi-n.com/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Створення / редагування компанії

Для створення чи редагування даних компанії перейдіть до розділу «Налаштування компанії» - «Мої компанії». В списку будуть відображені вже існуючі компанії.

3.1 Створення компанії

Для створення компанії натисніть кнопку «Створити компанію» (якщо жодна компанія ще не створена):

_images/foto0.png

або «Створити» (якщо потрібно додати нову компанію до переліку раніше створених):

_images/foto110.png

Після цього відкриється форма вибору типу створення компанії. «Звичайний» тип створення передбачає заповнення користувачем реєстраційних даних компанії вручну. Тип створення «З ЕЦП/КЕП» виконує автоматичне заповнення основних реєстраційних даних компанії із зчитаного електронного цифрового підпису компанії:

_images/foto210.png

Оберіть потрібний тип створення і натисніть «Створити». Після цього відкриється форма налаштування компанії:

_images/biznes-administratora_foto3_1.png

У разі вибору «Звичайного» типу створення заповніть поля, що виділені червоним (обов’язкові параметри). При заповненні поля «ЄДРПОУ» слід дотримуватись наступних правил:

  1. Для фізичних осіб в поле «ЄДРПОУ» вводиться ІПН (10 цифр)

  2. Для юридичних осіб в поле «ЄДРПОУ» вводиться 8 цифр

  3. Для нерезидентів в поле «ЄДРПОУ» можливо ввести 10 символів

Після внесення необхідних даних натисніть «Зберегти».

Для створення компанії «З ЕЦП/КЕП» попередньо завантажте і налаштуйте електронний цифровий підпис (детальніше в «Інструкції з налаштування ЕЦП»). Далі оберіть ЕЦП/КЕП з переліку зчитаних і натисніть «Створити»:

_images/foto41.png

При цьому відкриється форма налаштування компанії, заповнена даними з ЕЦП/КЕП. Зі зчитаного ключа береться наступна інформація: форма власності компанії, назва компанії, код ЄДРПОУ.

Зверніть увагу!

Інформація з ЕЦП/КЕП підтягується автоматично і не підлягає редагуванню.

3.2 Підтвердження даних компанії з ЕЦП/КЕП

Якщо на момент створення компанії у користувача були відсутні ЕЦП/КЕП і компанія була створена звичайним способом, система дозволяє підтвердити внесені дані з ЕЦП/КЕП (автоматично оновити дані, внесені в форму, реєстраційними даними компанії, що містяться в електронному цифровому підписі).

Для підтвердження даних із ЕЦП/КЕП перейдіть в розділ меню «Налаштування компанії» – «Мої компанії» навігаційної панелі сервісу та оберіть потрібну компанію зі списку, натиснувши на її назву. Далі перейдіть до вкладки «Основна інформація» та натисніть кнопку «Підтвердити з ЕЦП/КЕП»:

_images/foto51.png

У формі вибору ЕЦП/КЕП, що відкриється, оберіть потрібний електронний цифровий підпис і натисніть «Створити».

Зверніть увагу!

Код ЄДРПОУ підпису повинен відповідати коду ЄДРПОУ, вказаному у формі редагування компанії.

У разі успішного виконання підтвердження користувачеві буде відображене відповідне інформаційне повідомлення: «Компанія підтверджена успішно».

Зверніть увагу!

Кнопка «Підтвердити з ЕЦП/КЕП» наявна лише для компаній, створених звичайним способом.

3.3 Редагування та блокування компанії

Для редагування даних компанії перейдіть у розділ меню «Налаштування компанії» – «Мої компанії» та оберіть потрібну компанію зі списку, натиснувши на її назву. У формі, що відкриється, натисніть «Редагувати». Після чого дані за компанією будуть доступні для редагування. Для блокування компанії натисніть кнопку «Деактивувати» та підтвердіть дію у відповідному запиті системи:

_images/foto61.png _images/foto71.png

Для активації компанії натисніть кнопку «Активувати» та підтвердіть дію у відповідному запиті системи.

3.4 Надання компанії статусу «Акаунт»

Акаунтом є головна компанія із групи компаній облікового запису, по якій здійснюватимуться платежі. У випадку, якщо жодну з компаній не обрано акаунтом, система автоматично призначить акаунтом компанію, що створена з ЕЦП, за умови підписаного договору з компанією-провайдером.

Для надання компанії статусу «акаунт» перейдіть в розділ меню «Особистий кабінет» (раніше «Адміністрування акаунта») – «Акаунт» – «Основна інформація», оберіть компанію з переліку у полі «Компанія» і натисніть «Зберегти».

Зверніть увагу!

У переліку будуть відображені лише компанії з типом створення «З ЕЦП/КЕП» та підписаним договором.

_images/foto111.png

Форма «Акаунт» складається з декількох блоків даних. Поля, заповнені з ЕЦП («Назва», «ЄДРПОУ», т.д) не підлягають редагуванню.

  • Реєстраційні дані – заповнюється автоматично даними компанії, що обрана акаунтом

  • Адреса

  • Банківські реквізити – заповнюється автоматично даними компанії, що обрана акаунтом

  • Контакті дані

Зверніть увагу!

Заблокувати чи змінити компанію-акаунт після збереження данних неможливо. У переліку компаній (меню «Налаштування компанії» – «Мої компанії») напроти компанії із статусом «Акаунт» відсутній перемикач «активувати – деактивувати».

_images/foto121.png

4 Налаштування довідників компанії

Для керування довідниками оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії». У формі редагування компанії перейдіть до вкладки «Довідники», де у формі списку будуть відображені довідники, вже закріплені за компанією. Для пошуку необхідного довідника введіть у поле пошуку 3 чи більше символів. Пошук виконується за назвою та кодом довідника.

_images/foto131.png

4.1 Створення нового довідника

Для створення нового довідника натисніть кнопку «Додати». У формі створення довідника вкажіть назву та код довідника (може бути використаний для інтеграції з іншими системами). Для збереження внесених даних натисніть «Зберегти»:

_images/foto141.png

Після цього можна буде вводити значення довідника. Для додання нових значень натисніть «Додати» і заповніть поля форми, що відкриється:

_images/foto97_1.png

Зверніть увагу!

Код значення має бути унікальним у межах довідника. При введенні неунікального значення система повідомить про помилку: «Код значення довідника вже використовується».

Для збереження значення довідника натисніть Enter чи кнопку «Зберегти».

4.2 Редагування довідника

Для редагування довідника виберіть зі списку довідників потрібний і натисніть на його назву. Для редагування назви чи коду довідника натисніть «Редагувати».

Для редагування назви значення довідника натисніть на назву значення і введіть нове значення.

В меню «Довідники» є можливість створювати ієрархічні довідники у формі деревовидного списку 1.

_images/foto94.png

Натиснувши кнопку Додати у значеннях довідника, є можливість додавати «дочірні» значення в довідник; кількість рівнів підлеглих значень у довіднику необмежена.

Для блокування чи розблокування значення довідника переведіть у відповідне положення перемикач блокування:

_images/foto161.png

При блокуванні / активації материнського значення - блокуються активуються всі його дочірні значення.

4.2.1 Завантаження / вивантаження в Excel значень довідників

Для спрощення процесу введення значень довідника передбачена можливість завантажити / вивантажити значення довідника з таблиці Excel:

_images/foto98.png

Завантаження / вивантаження доступно для кожного рівня ієрархічного довідника окремо. Для експорту значень довідника (на платформу) натисніть «Вивантажити» та оберіть каталог на жорсткому диску ПК або змінному носії для вибору файлу. Для імпорту значень довідника скористайтеся кнопкою «Завантажити».

5 Налаштування типів документів

Для налаштування доступні документи для зовнішнього (договір, акт, рахунок), та для внутрішнього(заява на відпустку, тощо) документообігу.

5.1 Налаштування типів документів компанії для зовнішнього документообігу

Для налаштування типів документів оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії» перейдіть у вибрану компанію і перейдіть до вкладки «Документи». На вкладці у вигляді списку будуть відображені вже існуючі типи документів, що закріплені за компанією. Для пошуку необхідного документа введіть у поле пошуку 3 чи більше символів. Пошук виконується за назвою та кодом типу документа:

_images/biznes_administratora_foto18_2.png

5.1.1 Створення типу документа

Для створення нового типу документа натисніть «Додати». У формі створення документа вкажіть назву,код і оберіть тип документа (неструктурований, якщо не задано інакше). Код типу документа може бути використаний для інтеграції з іншими системами. Для збереження внесених даних натисніть «Зберегти»:

_images/foto191.png

5.1.2 Завантаження / вивантаження типів документів в Excel

Для спрощення процесу налаштування типів документів у сервісі реалізована можливість завантаження та вивантаження їх переліку в форматі Excel:

_images/foto201.png

Для вивантаження переліку типів документів натисніть «В Excel» та оберіть каталог на жорсткому диску ПК чи змінному носії для збереження файлу.

Для завантаження переліку типів документів з таблиці Excel натисніть «З Excel» та оберіть підготовлений файл.

Зверніть увагу!

Для успішного завантаження у файлі має бути щонайменше дві колонки (назва типу документа та код типу документа), файл не повинен містити формули, формат клітинок – загальний, перший рядок використовується як заголовок.

5.1.3 Редагування типу документа

Для редагування типу документа оберіть потрібний тип документа, натиснувши на його назву. Внесіть потрібні правки у формі редагування і натисніть «Зберегти».

Для блокування чи активації типу документа в списку типів документів переведіть перемикач у відповідне положення:

_images/foto211.png

Для присвоєння користувацьких полів натисніть на кнопку «Поля документа»:

_images/foto221.png

У формі, що відкриється, будуть відображені вже присвоєні поля. Для додання поля із списку виберіть потрібне поле і натисніть «Додати поле». Для видалення зв’язку з полем натисніть «Кошик»:

_images/foto231.png

5.1.4 Налаштування зв’язку типу документа з довідником

За допомогою кнопки «Додати зв’язок з довідником» в меню «Документи» створюється зв’язок довідника з документом.

_images/foto92.png

При натисканні на кнопку з’явиться форма зі списком доступних довідників для компанії. Після вібору довідника натисніть кнопку Зберегти.

_images/foto93.png

До одного типу документа можна прив’язати один довідник; 1 довідник можна прив’язати до декількох документів; прив’язка здійснюється тільки до активних довідників.

Можливо редагувати довідники, прив’язані до типу документа, в комплекті. Довідники доступні до редагування тільки на стороні відправника комплекта і тільки до відправки комплекта (в статусі «Чернетка»).

5.2 Налаштування типів документів компанії для внутрішнього документообігу

Внутрішній документообіг компанії необхідний для узгодження внутрішніх документів у рамках однієї компанії - наприклад, коли потрібно узгодити зміну тарифу чи розмір знижки для контрагента, або коли заява на відпустку потребує узгодження.

Для налаштування типів документів оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії», перейдіть у вибрану компанію і перейдіть до вкладки «Внутрішні документи компанії».

_images/biznes_administratora_foto23_4.png

Для створення нового типу документа натисніть «Додати». У формі створення документа вкажіть назву, код і оберіть тип документа (неструктурований, або структурований). Форма аналогічна формі створення типу зовнішнього документа.

_images/foto191.png

Для збереження внесених даних натисніть «Зберегти».

Для спрощення процесу налаштування типів документів у сервісі реалізована можливість завантаження та вивантаження їх переліку в форматі Excel.

Для вивантаження переліку типів документів натисніть «В Excel» та оберіть каталог на жорсткому диску ПК чи змінному носії для збереження файлу.

Для завантаження переліку типів документів з таблиці Excel натисніть «З Excel» та оберіть підготовлений файл.

5.3 Налаштування доступу для провайдера

Для відображення інформації про підпис у документі PDF при скачуванні архіва, необхідно відкрити доступ провайдеру до документа. Щоб відкрити доступ провайдеру до зовнішнього або внутрішнього документа, натисніть відповідну кнопку навпроти документу - Відображати штамп ЕЦП.

_images/biznes_administratora_foto23_5.png

Підтвердіть дозвіл на доступ до вмісту:

_images/biznes_administratora_foto23_3.png

Аналогічні дії проведіть у розділі «Внутрішні документи компанії».

У документах з відкритим доступом та у форматі PDF відтепер буде відображено візуалізацію ЕЦП у листі підписання при скачуванні архіва.

Зверніть увагу!

Відмінити надання доступу до документу неможливо.

6 Налаштування користувацьких полів

Для налаштування користувацьких полів оберіть компанію зі списку в розділі «Налаштування компанії» - «Мої компанії». На формі редагування перейдіть до вкладки «Користувацькі поля», де будуть відображені вже існуючі поля. Для пошуку необхідного поля введіть у поле пошуку 3 чи більше символів. Пошук виконується за назвою та описом поля:

_images/foto241.png

6.1 Створення користувацького поля

Для створення нового поля натисніть «Додати». На формі створення вкажіть назву поля, оберіть формат введення даних та введіть опис поля. Всі поля обов’язкові до заповнення. Для збереження внесених даних натисніть «Зберегти»:

_images/foto251.png

6.2 Редагування користувацького поля

Для редагування поля оберіть потрібне поле в списку полів і натисніть на його назву. Внесіть необхідні правки у формі редагування і натисніть «Зберегти».

Для блокування чи активації поля переведіть перемикач у відповідне положення:

_images/foto261.png

7 Налаштування маршруту

Маршрут визначає перелік контрактів і комплектів, до яких буде надано доступ користувачеві. Маршрут є прикріпленим до компанії.

Для налаштування маршруту перейдіть у розділ «Налаштування узгодження» – «Маршрути». У розділі відображаються всі створені маршрути. Для зручності реалізовано фільтр пошуку маршруту за компанією, до якої прикріплений маршрут, за статусом (активний / заблокований), за назвою маршруту:

_images/foto271.png

Зверніть увагу!

Для користувача без ознаки «Власник акаунта» налаштування маршруту є обов’язковою передумовою початку роботи.

7.1 Створення маршруту

Для створення нового маршруту натисніть «Створити». У формі створення вкажіть назву і код маршруту (обов’язкові поля), оберіть зі списку компанію, до якої буде прикріплений даний маршрут, і визначте його напрямок (вхідний або вихідний) відносно типу комплекта. Для збереження внесених даних натисніть «Зберегти»:

_images/foto281.png

Після збереження даних з’явиться можливість працювати з вкладками «Користувачі», «Контракти» та «комплекти» для остаточного налаштування маршруту:

_images/foto291.png

7.1.1 Налаштування зв’язку з користувачем

Для створення зв’язку маршрут — користувач перейдіть до вкладки «Користувачі» форми редагування маршруту, оберіть користувача з випадаючого списку і натисніть «Додати користувача». Кількість користувачів не обмежується:

_images/foto301.png

Для розірвання зв’язку маршрут — користувач натисніть кнопку «Кошик».

7.1.2 Налаштування доступу до контракту

Для додання контракту в маршрут користувача перейдіть до вкладки «Контракти» форми редагування маршруту і натисніть «Додати»:

_images/foto311.png

У формі, що відкриється, оберіть потрібний контракт із списку і натисніть «Підтвердити». У полі вибору контракту реалізовано пошук за назвою контракту:

_images/foto32.png

Для зручності реалізована можливість обрати всі контракти. Для цього встановіть відмітку «Всі контракти» та підтвердіть дію у відповідному запиті системи:

_images/foto33.png

Користувачеві буде надано доступ до всіх контрактів, наявних на момент налаштування маршруту, та всіх нових контрактів по мірі їх укладення.

Для обмеження доступу користувача до контракту встановіть відмітку напроти потрібного контракту і натисніть «Видалити».

Для обмеження доступу до всіх контрактів зніміть відмітку «Всі контракти» та підтвердіть дію у відповідному запиті системи.

7.1.3 Налаштування доступу до типів комплектів

Для додання типів комплектів у маршрут користувача перейдіть до вкладки «Типи комплектів» на формі редагування маршруту і натисніть «Додати»:

_images/foto34.png

У вікні, що відкриється, оберіть у відповідному полі компанію з випадаючого списку:

_images/foto35.png

Після вибору компанії стане доступним поле для вибору типу комплекта за обраною компанією та активується кнопка «Додати».

Також для зручності реалізована можливість відкрити користувачеві доступ до всіх типів комплектів, встановивши відмітку «Всі комплекти»:

_images/foto36.png

Підтвердіть дію у відповідному запиті системи, натиснувши «Так». Користувачеві буде надано доступ до всіх типів комплектів.

Для обмеження доступу користувача до типу комплекта відмітьте потрібний тип у списку і натисніть «Видалити».

Для видалення доступу до всіх типів комплектів зніміть відмітку «Всі типи комплектів» і підтвердіть дію у відповідному запиті системи:

_images/foto37.png

7.2 Блокування маршруту

Для блокування маршруту переведіть перемикач у відповідну позицію напроти потрібного маршруту в списку «Налаштування узгодження» – «Маршрути». Маршруту буде надано статус «Заблокований»:

_images/foto38.png

8 Налаштування типу комплекта

Для налаштування типу комплекта перейдіть до розділу «Налаштування компанії» - «Налаштування комплектів документів». У розділі будуть відображені вже існуючі типи комплектів (комплектів). Система фільтрів дозволяє здійснювати пошук типу комплекта за його назвою, за компанією, до якої прикріплений комплект, за статусом типу комплекта:

_images/foto100.png

8.1 Створення типу комплекта

Для створення типу комплекта натисніть «Створити». У формі створення введіть назву та код типу комплекта, а також оберіть компанію, до якої буде прикріплений тип комплекта. Всі поля є обов’язковими для заповнення. Чекбокс Автообробка комплекта - під «автообробкою» мається на увазі автоматичне прийняття або відхилення комплекта, якщо всі документи в ньому з відповідним статусом (Прийнято/Відхилено).

Для збереження внесених даних натисніть «Зберегти»:

_images/foto40.png

Після цього з’явиться можливість налаштувати для типу комплекта документи, довідники і користувацькі поля у відповідних вкладках:

_images/foto411.png

Після збереження типу комплекта буде надано статусу «Чернетка».

Зверніть увагу!

Типи комплекта у статусі «Чернетка» не відображаються у списку доступних при створенні комплекта. Для того, щоб тип комплекта став доступним для вибору, його потрібно активувати.

Зверніть увагу!

Активувати можна лише той тип комплекта, що містить хоча б один доданий тип документа (вкладка «Документи»).

8.2 Редагування типу комплекта

Для редагування типу комплекта оберіть потрібний комплект у списку і натисніть на його назву. Далі натисніть кнопку «Редагувати» і внесіть необхідні зміни. При редагуванні є можливість змінити назву та код типу комплекта, додати чи видалити зв’язки с типами документів, довідниками, користувацькими полями.

Для збереження внесених даних натисніть «Зберегти».

При редагуванні автоматично створюється нова версія типу комплекта в статусі «Чернетка». Для активації нової відредагованої версії натисніть «Активувати»:

_images/foto42.png

При цьому попередня активна версія типу комплекта набуде статусу «Архів».

Для перегляду всіх версій типу комплекта натисніть кнопку «Показати всі версії» у формі редагування / перегляду типу комплекта:

_images/foto44.png

Відкриється перелік усіх версій типу комплекта:

_images/foto45.png

Для блокування чи активації типу комплекта в списку переведіть перемикач у відповідне положення.

8.3 Керування зв’язком із довідниками

Для керування зв’язком із довідниками перейдіть до вкладки «Довідники» на формі редагування типу комплекта. На вкладці будуть відображені вже прикріплені довідники із вказаними параметрами:

_images/foto46.png

Для редагування даних натисніть кнопку «Олівець». У формі, що відкриється, є можливість вибрати новий довідник, змінити тип заповнення та встановити чи зняти ознаку обов’язковості. Для збереження внесених змін натисніть «Зберегти».

Зверніть увагу!

Зміна назви довідника при редагуванні призведе до створення нового зв’язку.

Для розірвання зв’язку з довідником натисніть кнопку «Кошик».

Для створення нового зв’язку натисніть «Додати зв’язок». На формі редагування виберіть довідник зі списку, вкажіть тип заповнення («Заповнює клієнт», «Заповнює ініціатор», «Заповнюють обидва») та визначте ознаку обов’язковості:

_images/foto47.png

8.4 Керування зв’язком з типами документів

Для керування зв’язком комплекта з типами документів перейдіть до вкладки «Документи» на формі редагування типу комплекта. На вкладці будуть відображені вже прикріплені типи документів з вказаними параметрами:

_images/foto48.png

Для створення нового зв’язку натисніть кнопку «Додати зв’язок». На формі редагування виберіть тип документа, визначте кількість необхідних ЕЦП з боку ініціатора та клієнта, встановіть ознаки обов’язковості та шифрування, за необхідності встановіть відмітку «Довкладення отримувача» та вкажіть допустиму кількість файлів (максимальне значення 10).

Зверніть увагу!

Якщо «Довкладення отримувача» позначене як обов’язкове, документ має бути завантажений на стороні отримувача комплекта. Також неможливо буде відмітити ознаку «Документ дозволений для редагування партнером» (і навпаки, при дозволі редагування неможливо використовувати довкладення).

_images/foto49_2.png

Документ можна позначити як такий, що дозволено редагувати партнером, якщо вибраний у налаштуваннях документ зовнішній, структурований і не стоїть відмітка «Довкладення отримувача». Детальніше про редагування документів партнером у розділі Копіювання комплекту с документами, позначеними для редагування. Налаштування правил роботи з документом збережуться до скопійованого комплекту.

Ви можете вказати термін підписання документа отримувачем у днях - якщо контрагент не обробить документ до закінчення терміну, підписати документ та комплект стане неможливо!

При відміченні документа як дозволеного для редагування, налаштування правил роботи, у тому числі термін підписання зберігається!

Для редагування даних натисніть кнопку «Олівець» напроти потрібного типу документа та внесіть необхідні зміни на формі редагування.

Зверніть увагу!

Зміна назви документа при редагуванні призведе до створення нового зв’язку.

Для збереження внесених даних натисніть «Зберегти».

Для розірвання зв’язку з типом документа натисніть кнопку «Кошик».

8.5 Керування зв’язком з користувацьким полем

Для керування зв’язком з користувацькими полями перейдіть до вкладки «Поля» на формі редагування типу комплекта. На формі будуть відображені вже прикріплені поля з вказаними параметрами:

_images/foto50.png

Для створення нового зв’язку натисніть «Додати зв’язок». На формі редагування виберіть поле, визначте тип заповнення поля («Заповнює ініціатор», «Заповнює клієнт», «Заповнюють обидва»), встановіть ознаку обов’язковості. Для збереження внесених даних натисніть «Зберегти».

Для редагування даних натисніть кнопку «Олівець» напроти потрібного поля у списку. У формі, що відкриється, внесіть необхідні зміни і натисніть «Зберегти».

Зверніть увагу!

Зміна назви поля при редагуванні призведе до створення нового зв’язку.

Для розірвання зв’язку з полем натисніть кнопку «Кошик».

9 Налаштування зв’язку з партнерами (контракт)

  • Контракт – форма зв’язку між партнерами, у відповідності до якої відбувається обмін комплектами документів

  • Власник контракту – організація (юридична особа), що ініціює процес обміну комплектами та є відправником контракту

  • Клієнт – організація-контрагент, що є отримувачем контракту

  • Тип комплекта – налаштування та параметри комплекта документів для обміну (перелік обов’язкових та необов’язкових типів документів у рамках комплекта, ознака шифрування, кількість підписів відправника комплекта та отримувача).

На рівні контракту визначається перелік вхідних та вихідних (по відношенню до власника контракту) типів комплектів. Контракти зберігаються у розділі «Взаємодія з Партнерами» - «Контракти» меню навігаційної панелі сервісу. Розділ складається з папок:

  • Вхідні з переліком отриманих від контрагентів контрактів

  • Вихідні з переліком відправлених контрагентам контрактів

  • Чернетки з переліком створених контрактів на етапі їх заповнення / налаштування (до моменту відправки)

Для швидкого пошуку необхідного контракту у розділі реалізовано фільтр.

_images/foto511.png

Пошук виконується за наступними атрибутами:

  • Назва та номер (для пошуку вкажіть хоча б один символ із назви / номера контракту)

  • Клієнт (пошук можливий за кодом ЄДРПОУ і назвою)

  • Ініціатор (пошук можливий за кодом ЄДРПОУ і назвою)

  • Статус (поле містить системний перелік статусів у відповідності до обраної папки)

  • Термін дії із можливістю вибрати дату дії контракту:

_images/foto52.png

Для одночасного видалення всіх внесених в налаштування фільтра значень скористайтеся кнопкою «Скинути».

9.1 Налаштування шаблона контракту

Для налаштування шаблона контракту перейдіть до розділу «Взаємодія з Партнерами» - «Шаблони контрактів» навігаційної панелі сервісу. У розділі будуть відображені всі створені шаблони. Система фільтрів дозволяє виконувати пошук за назвою шаблона та назвою компанії-власника контракту (у вигляді випадаючого списку):

_images/foto53.png

Для видалення шаблона поставте відмітку напроти потрібного шаблона і натисніть кнопку «Кошик». Також реалізована можливість масового видалення шаблонів. Для масового видалення необхідно відмітити потрібний шаблон та натиснути кнопку «Видалити».

Для створення нового шаблона натисніть «Створити»:

_images/foto54.png

У формі, що відкриється, заповніть поля і натисніть «Створити»:

_images/foto55.png

Порядок заповнення полів:

  • Назва – обов’язкове поле, допускається внесення літер, цифр та спеціальних символів; призначене для заповнення назви шаблона; якщо не задано інакше, внесене значення використовуватиметься як назва контракту, створеного на основі даного шаблона

  • Номер – поле, призначене для внесення номеру шаблона, допускається внесення літер, цифр та спеціальних символів; якщо не задано інакше, внесене значення використовуватиметься як номер контракту

  • Дата укладання - поле, що містить дату підписання контракту

  • Дата закінчення дії – поле, що містить дату закінчення дії контракту

  • Ініціатор – поле містить випадаючий список компаній, доступних користувачеві відповідно до налаштувань ролі

  • Дод. інформація – поле, не обов’язкове до заповнення.

Форма налаштування шаблона відкривається з автоматично заповненими полями «Назва», «Номер», «Дата укладання» та «Дата закінчення» контракту із додатковими вкладками для налаштування зв’язку з довідниками і типами комплектів.

У разі необхідності змінити автоматично заповнені дані натисніть «Редагувати», внесіть потрібні правки і натисніть «Зберегти».

Для налаштування зв’язку з довідниками перейдіть до вкладки «Довідники», де зберігається перелік прикріплених до шаблона довідників та їх значень.

Для видалення зв’язку встановіть відмітку напроти потрібного запису і натисніть кнопку «Кошик».

Для формування нового зв’язку натисніть «Додати»:

_images/foto56.png

При цьому відкриється форма із переліком доступних активних довідників, що пов’язані з компанією-власником контракту (перелік довідників заповнюється у розділі «Налаштування компанії» – «Мої компанії» – «Довідники»).

Після вибору довідника виберіть значення довідника і натисніть «Зберегти» для збереження внесених даних.

Для зміни значення необхідно спочатку видалити зв’язок з довідником, а потім додати новий із новим значенням.

Для пошуку довідника чи значення довідника введіть декілька початкових символів у пошукове поле.

Для налаштування переліку вхідних та вихідних (по відношенню до власника) типів комплектів перейдіть до вкладки «Типи комплектів». Вкладка містить два розділи:

  • Вихідні із переліком типів комплектів, доступних для відправлення власнику (ініціатору) контракту

  • Вхідні із переліком типів комплектів, доступних для відправлення клієнту

Для видалення типу комплекта з переліку натисніть кнопку «Кошик».

Для додання типу комплекта до переліку доступних (вхідних або вихідних) натисніть «Додати». При цьому відкриється форма зі списком доступних типів комплектів, що прикріплені до компанії-власника контракту (перелік типів комплектів налаштовується у розділі «Налаштування компанії» – «Типи комплектів»):

_images/foto57.png

Після вибору типу комплекта для збереження внесених даних натисніть «Зберегти».

Для зручності реалізована можливість додати в шаблон всі типи комплектів, прикріплені до компанії-власника контракту, шляхом встановлення відмітки «Всі комплекти». Після встановлення відмітки «Всі комплекти» в обраному розділі («Вхідні» або «Вихідні») підтвердіть дію у відповідному запиті системи.

9.2 Створення та відправка контракту

Для створення контракту перейдіть до розділу «Взаємодія з Партнерами» - «Контракти» та натисніть кнопку «Створити»:

_images/foto58.png

При цьому відкриється форма створення / редагування контракту з переліком обов’язкових для заповнення полів:

  • Назва та номер (допускається внесення літер, цифр та спеціальних символів)

  • Дата укладання та дата закінчення дії (поля містять календар для зручності внесення дат)

  • Контрагент (поле для вибору компанії-контрагента, якій буде відправлено контракт на розгляд). В межах поля реалізований пошук за кодом ЄДРПОУ та назвою (для старту пошуку введіть будь-який символ)

  • Мої компанії (поле для вибору однієї з компаній користувача, від імені якої буде відправлений контракт). В межах поля реалізований пошук за кодом ЄДРПОУ та назвою (для старту пошуку введіть будь-який символ)

_images/foto59.png

Після заповнення обов’язкових полів натисніть «Створити». Контракт буде збережений у статусі «Чернетка» і відкриються додаткові вкладки («Довідники», «Типи комплектів») для остаточного налаштування контракту:

_images/foto60.png

9.2.1 Налаштування зв’язку з довідниками

Для налаштування зв’язку з довідниками перейдіть до вкладки «Довідники», де зберігається перелік прикріплених до контракту довідників та їх значень. Всі закріплені за контрактом значення довідників будуть автоматично перенесені до комплекта документів, створеного на основі даного контракту. У комплекті значення відображатимуться у розділі «Довідники» і будуть доступні тільки для перегляду.

Для розірвання зв’язку контракт-довідник оберіть потрібні записи, встановивши відмітки напроти, і натисніть «Видалити», або на кнопку «Кошик» для одиничного видалення. Для додання зв’язку натисніть «Додати»:

_images/foto611.png

При цьому буде відкрито поле зі списком доступних активних довідників, що пов’язані з компанією-власником контракту (перелік довідників заповнюється у розділі «Адміністрування» – «Мої компанії» – «Довідники»):

_images/foto62.png

Після вибору довідника з’явиться можливість вибрати значення довідника. Для збереження даних необхідно натиснути кнопку «Зберегти».

Для зміни значення необхідно спочатку видалити зв’язок з довідником, а потім додати новий з новим значенням.

Можливість видалити або додати нове значення довідника доступна на всіх етапах обробки контракту (від створення до розірвання).

Для пошуку довідника чи значення довідника в списку введіть початкові символи назви в пошуковий рядок.

9.2.2 Налаштування переліку доступних типів комплектів

Для налаштування вхідних та вихідних (відносно власника контракту) типів комплектів перейдіть до вкладки «Типи комплектів». Вкладка містить два розділи:

  • Вихідні із переліком типів комплектів, доступних для відправлення власнику (ініціатору) контракту

  • Вхідні із переліком типів комплектів, доступних для відправлення клієнту:

_images/foto63.png

Для видалення типу комплекта з переліку натисніть кнопку «Кошик».

Для додання типу комплекта до переліку доступних (вхідних або вихідних) натисніть «Додати». У формі, що відкриється, оберіть потрібний тип комплекта зі списку. У списку будуть відображені всі доступні типи комплектів, прикріплені до компанії-власника контракту (перелік типів комплектів налаштовується у розділі «Налаштування компанії» – «Типи комплектів»):

_images/foto64.png

Після вибору типу комплекта для збереження внесених даних натисніть «Зберегти».

Для зручності реалізована можливість додати у контракт всі типи комплектів, прикріплені до компанії-власника контракту, шляхом встановлення відмітки «Всі комплекти»:

_images/foto65.png

Після встановлення відмітки «Всі комплекти» в обраному розділі («Вхідні» або «Вихідні») підтвердіть дію у відповідному запиті системи.

9.2.3 Відправлення контракту (шаблона контракту)

Для відправлення контракту перейдіть до папки «Чернетки» розділу «Контракти», оберіть потрібний контракт зі списку, натиснувши на його назву, і натисніть «Надіслати» у формі редагування контракту:

_images/foto66.png

Для масової відправки контрактів встановіть відмітки напроти потрібних контрактів і натисніть «Надіслати»:

_images/foto67.png

Для відправки шаблону контракту перейдіть до меню «Взаємодія з Партнерами» - «Шаблони контрактів», оберіть потрібний шаблон та натисніть кнопку «Надіслати»:

_images/foto68.png

Наступним кроком необхідно обрати контрагентів-отримувачів та натиснути кнопку «Надіслати»:

_images/foto69.png

Після обробки контракту контрагентом йому буде надано статусу «Прийнятий» чи «Відхилений». Прийнятий контракт можливо розірвати за допомогою відповідної кнопки:

_images/foto70.png

9.3 Мої контрагенти

Контрагент - організація (юридична особа), одна зі сторін у процесі обміну контрактами (власник або клієнт) та комплектами (відправник або отримувач).

Розділ «Мої контрагенти» містить перелік контрагентів користувача і призначений для відправлення запрошень до співпраці новим контрагентам.

Система фільтрів дозволяє здійснювати пошук контрагента за назвою та кодом ЄДРПОУ. Для старту пошуку достатньо ввести у пошукове поле початкові символи назви чи коду. В окремому полі реалізована можливість відфільтрувати контрагентів за ознакою реєстрації на платформі: всі /зареєстровані / незареєстровані. Перевірка реєстрації здійснюється за кодом ЄДРПОУ.

_images/foto86.png

Інформація щодо контрагентів відображається на стартовій сторінці розділу у вигляді таблиці із наступними колонками:

  • Код ЄДРПОУ

  • Назва компанії

  • ПІБ контактної особи

  • Email контактної особи

  • Номер телефону

  • Ознака реєстрації на платформі — візуалізація у вигляді іконок

  • Статус — поле містить інформацію щодо контрагента («Новий» при доданні контрагента вручну кнопкою «Додати контрагента») і дату відправлення запрошення

  • Статус запрошення — відображає статус запрошення після обробки контрагентом, можливі значення: «Прийнято», «Розірвано», «Відхилено»

_images/foto87.png

Для додання контрагента до переліку робочих контактів натисніть «Додати контрагента»:

_images/foto88.png

У формі, що відкриється, заповніть поля «Код ЄДРПОУ», «Назва компанії», «ПІБ контактної особи», «Email контактної особи», «Номер телефону», «Коментар» і натисніть «Зберегти».

Зверніть увагу!

Кнопка «Зберегти» активується тільки після заповнення обов’язкових полів (виділені червоним).

Для прискорення процесу внесення нових контрагентів реалізована можливість завантажити список контрагентів з Excel (кнопка «Завантажити з Excel»). Для зручності заповнення реалізовано шаблон (кнопка «Завантажити шаблон»).

_images/foto89.png

Для відправлення запрошення оберіть потрібного контрагента зі списку, поставивши відмітку у чекбоксі, і натисніть на кнопку «Відправити запрошення»:

_images/foto90.png

Відкриється форма, що містить перелік підготовлених шаблонів (налаштовуються і зберігаються у розділі «Взаємодія з Партнерами» - «Шаблони контрактів»).

_images/foto91.png

Для вибору шаблона введіть початкові символи назви шаблона у поле пошуку і оберіть потрібний варіант. Для відправлення натисніть «Відправити запрошення».

Зверніть увагу!

За один раз можна відправити лише одне запрошення (багатьом контрагентам). Для масової відправки шаблонів контрагенту(-там) перейдіть у розділ «Взаємодія з Партнерами» - «Шаблони контрактів».

Після натискання кнопки «Відправити запрошення» на підставі обраного шаблона будуть створені контракти і відправлені усім вибраним контрагентам. При цьому у колонці «Статус» на стартовій сторінці розділу «Мої контрагенти» з’явиться відповідне повідомлення.

Якщо контрагент не зареєстрований на платформі EDIN-DOCflow, у разі відправлення запрошення йому на пошту надійде лист із посиланням для реєстрації. Відправник листа - noreply@edi-n.com, тема – «До уваги партнерів компанії N». В цьому випадку контрагентові необхідно перейти за посиланням для реєстрації на платформі, використовуючи свій ЕЦП/КЕП. При цьому, в рамках політики безпеки виконується перевірка ідентичності коду ЄДРПОУ компанії із запрошення та коду ЄДРПОУ ключа. Після успішної реєстрації, на основі даних з ЕЦП/КЕП контрагента буде створена компанія, а запрошення автоматично набуде статусу «Прийнято».

10 Обробка вхідних контрактів

Під обробкою мається на увазі надання контракту статусу «Прийнятий» або «Відхилений». Для обробки контракту, що надійшов від контрагента, перейдіть до розділу «Взаємодія з Партнерами» - «Контракти» та зайдіть у папку «Вхідні». В папці списком будуть відображені всі контракти, надіслані партнерами. Необроблені контракти будуть відображені зі статусом «Новий».

Для пошуку необхідного контракту у розділі реалізовано фільтр із можливістю пошуку за назвою і номером контракту, за назвою і кодом ЄДРПОУ компанії-ініціатора і клієнта, за статусом і терміном дії контракту:

_images/foto711.png

Для обробки обраного контракту натисніть на його назву, після чого відкриється форма обробки:

_images/foto72.png

На вкладці «Типи комплектів» відображається перелік вихідних та вхідних (підпапки «Вихідні» та «Вхідні» відповідно) типів комплектів, налаштованих власником (ініціатором) контракту для обміну в межах даного контракту:

_images/foto73.png

Натиснувши на назву типу комплекта, можна переглянути правила роботи с документами для даного типу комплекта:

_images/foto74.png

Відображення розділу «Типи комплектів» у випадку, якщо власник встановив відмітку «Всі комплекти»:

_images/foto75.png

При обробці нового контракту реалізована можливість налаштувати зв’язок з довідниками. Для цього перейдіть на вкладку «Довідники» і натисніть «Додати». У формі, що відкриється, оберіть з випадаючого списку довідник і значення і натисніть «Зберегти». У списку для вибору будуть доступні довідники, додані в розділі «Налаштування компанії» - «Мої компанії» - «Довідники».

Зверніть увагу!

На відміну від довідників, що закріплюються за типом комплекта, довідники у контракті відображаються лише для того користувача, який їх додав.

11 Білінг

Для перегляду інформації по транзакціях, що відбулися за компаніями акаунта, перейдіть до розділу «Особистий кабінет» - «Білінг»:

_images/foto76.png

Транзакції відображаються списком із виведенням наступної інформації:

  • Відправник — назва і код ЄДРПОУ компанії-відправника

  • Отримувач — назва і код ЄДРПОУ компанії-отримувача

  • Дата транзакції

  • Тип транзакції — відправлення документа чи довкладення отримувача

  • Напрямок — вхідна / вихідна

  • Ознака тарифікації

  • Номер комплекта — у вигляді посилання із можливістю перейти до перегляду комплекта

Система фільтрів дозволяє здійснювати пошук транзакцій за наступними параметрами:

  • Компанія — вибір із випадаючого списку, де відображені всі компанії акаунта

  • Тип транзакції — відправлення документа чи довкладення отримувача

  • Період — обирається помісячно

Також реалізована можливість відфільтрувати транзакції за ознакою вхідна / вихідна / тарифікована. До тарифікованих транзакцій належать відправлення документа і довкладення отримувача. Тарифікація транзакцій відбувається згідно обраного тарифного плану (налаштування в розділі «Особистий кабінет» - «Рахунки»).

12 Рахунки

Для перегляду інформації по рахунках перейдіть до розділу «Особистий кабінет» - «Рахунки». У розділі у вигляді таблиці будуть відображені всі рахунки та акти по компаніях акаунта із виведенням наступної інформації:

  • Номер рахунку

  • Дата здійснення рахунку

  • Сума рахунку

  • Період оплати

При цьому несплачені рахунки будуть розміщені на початку списку і підсвічені червоним, сплачені підсвічуватимуться зеленим.

У таблиці напроти рахунку реалізована можливість скачати рахунок і акт (за наявності).

Можливо скачати рахунок або акт як PDF файл, при натисканні на відповідні іконки «Завантажити рахунок» і «Завантажити акт». При наведені курсора на іконку з’явиться спливна підказка.

_images/foto76_02.png

Система фільтрів дозволяє здійснювати пошук за наступними атрибутами:

  • Номер рахунку

  • Статус (сплачений / несплачений)

  • Дата рахунку

  • Дата оплати

  • Дата акту

  • Наявність акту

  • Узгодження

13 Групи

Групи користувачів необхідні для налаштування процесу узгодження. Інформація за групами користувачів доступна в розділі «Налаштування узгодження» - «Погодження групою», де відображаються всі створені групи із можливістю фільтрації за компанією.

Для створення нової групи натисніть «Створити»:

_images/foto83.png

У формі, що відкриється, введіть назву групи, оберіть з випадаючого списку компанію, у межах якої створено групу, за потреби додайте коментар:

_images/foto84.png

Для збереження внесених даних натисніть «Зберегти».

Після збереження даних з’явиться можливість додати в групу користувачів. Для додання користувача у групу натисніть «Додати», оберіть зі списку потрібний контакт і знов натисніть «Додати»:

_images/foto85.png

У списку для вибору будуть доступні всі користувачі, що закріплені за компанією. Для видалення користувача із групи натисніть кнопку «Кошик».

Для редагування даних групи оберіть потрібну групу в переліку відображених у розділі і натисніть на її назву. У формі, що відкриється, натисніть «Редагувати», внесіть необхідні зміни і натисніть «Зберегти».

Для видалення групи натисніть кнопку «Кошик».

14 Узгодження

Застосовується до документів у вихідних комплектах. Для кожного типу документа процес узгодження налаштовується окремо.

Для налаштування правил і послідовності процесу узгодження перейдіть до розділу «Налаштування узгодження» - «Узгодження». В розділі у вигляді списку будуть відображені вже створені процеси узгодження по всіх компаніях, доступних користувачеві за маршрутом і роллю.

Для додання нового процесу узгодження натисніть «Створити».

_images/foto77.png

У формі, що відкриється, введіть назву процесу узгодження і оберіть компанію, в межах якої налаштовується узгодження. Після збереження даних (кнопка «Зберегти») для роботи стануть доступні вкладки «Крок» і «Тип документа»:

_images/foto78.png

Для створення кроку узгодження натисніть «Додати крок узгодження» і заповніть форму налаштувань.

Для редагування існуючого кроку узгодження натисніть кнопку «Олівець», внесіть необхідні зміни у форму налаштувань і натисніть «Зберегти». Для видалення кроку натисніть кнопку «Кошик».

Для додання типів документів до процесу узгодження перейдіть до вкладки «Тип документа». На вкладці у вигляді списку будуть відображені типи документів для узгодження за обраною компанією.

Для додання типів документів до процесу узгодження натисніть «Додати».

_images/foto80.png

Відкриється форма з автоматично заповненим полем «Компанія» (відповідно до назви компанії, вказаної при створенні узгодження) і можливістю вибрати тип документа.

При додаванні типу документа на формі редагування налаштування узгодження, якщо до типу документа прив’язаний довідник - відобразиться поле для вибору значення цього довідника; Якщо довідник не містить значеннь - поле не відображається.

_images/foto95.png

При виборі значення, яке містить «дочірні» значення, поля для вибору дочірніх значень виводяться аж до фінального «підлеглого» значення. Інформація по обраних значеннях довідника по типу документа відображається в списку прив’язаних до налаштування узгодження документів.

Довідники обов’язково заповнювати до фінального дочірнього значення. Довідники доступні до редагування тільки на стороні відправника комплекта.

Зверніть увагу!

У списку будуть відображені всі типи документів, закріплені за обраною компанією.

_images/foto81.png

На етапі відправлення комплекта із документами, що потребують узгодження, замість кнопки «Відправити» відображатиметься кнопка «Відправити на узгодження»:

_images/foto82.png

Відправити комплект із документами, для яких процес узгодження не завершено, неможливо.

15 Аналітика

Розділ у якому можливо створити звіт про документообіг, відображається тільки користувачам з ввімкненими ролями на даний розділ (меню «Налаштування узгодження» → «Ролі» → «Розділи»). Розділ дозволяє «Створити звіт» по зовнішньому документообігу за обраний період часу по одній з «своїх» компаній (також можливо вибрати контрагента). В меню відображається: Період звіту, Мої компанії, Контрагенти, Дата і час створення звіту, кнопка «Завантажити» або статусний значок «звіт створюється», що означає «Звіт створюється, очікуйте повідомлення на електронну пошту».

_images/biznes-administratora_foto103.png

Період часу вказується з календаря (мінімальне значення 1 день, максимальне - 31 день), «Компанія» вибирається з усіх (активних і заблокованих) компаній аккаунта, а «Контрагент» зі списку власників та клієнтів з контрактів. Вибірка формується за датою відправлення документу (а не створення), тобто для документів зі статусом відмінним від статусу Чернетка.

За фактом створення звіту буде надіслано повідомлення на Email адресу поточного користувача, також з’явиться кнопка для скачування навпроти відповідного запису з періодом звіту. Посилання на скачування звіту доступне 31 день, для скачування необхідно пройти авторизацію. Звіт доступний для скачування в форматі Excel (* .xls).

1

Ієрархічні деревовидні довідники — це багаторівневий деревовидний список з головними - материнськими, та підлеглими - дочірніми значеннями, що розкриваються послідовно.

Служба Технічної Підтримки

Інструкція адміністратора користувачів

Дана інструкція описує порядок дій адміністратора користувачів зі створення, редагування ролей та облікових записів користувачів.

1 Терміни та визначення

  • Компанія – юридична чи фізична особа, яка використовує систему для виконання своїх процесів. До одного акаунта можливо прив’язати декілька компаній. Документи, довідники, типи комплектів і контракти створюються в межах компанії і закріплюються за нею.

  • Роль користувача – визначає обмеження доступу до розділів системи.

  • Користувач – працівник, який буде створювати, редагувати, підписувати чи обробляти комплект документів. Для користувачів, що оброблятимуть комплект документів, налаштовуються маршрути.

  • Адміністратор Компанії та модуля Cryptex (АК) – користувач, який відповідає за налаштування Компанії, модуля Cryptex, налаштовує роботу з сертифікатами та ключами шифрування. АК має доступ до розділів «Журнал подій» (перегляд), «Шифрування» в карточці компанії та «Сертифікати» (редагування).

  • Адміністратор користувачів (АП) – користувач, відповідальний за створення, редагування облікових записів користувачів, присвоєння ролей користувачам. Для АП доступний розділ «Користувачі».

  • Адміністратор ролей (АР) – користувач, що відповідає за створення та редагування ролей, налаштування маршруту (присвоєння довідників та їх значень). Для АР доступний розділ «Ролі».

  • Бізнес-адміністратор (БА) – користувач, відповідальний за налаштування та введення довідників, обробку контрактів, налаштування компанії, налаштування та керування комплектами та типами документів. БА доступні розділи «Мої компанії», «Контракти», «Налаштування комплектів».

2 Авторизація

Для авторизації на платформі перейдіть за посиланням https://doc.edi-n.com/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Створення облікового запису користувача

Для створення облікового запису нового користувача перейдіть до розділу меню «Налаштування узгодження» - «Користувачі». В розділі відображається перелік вже існуючих облікових записів користувачів. Список можливо відфільтрувати за статусом або скористатися пошуком за ПІБ чи email.

Для створення облікового запису користувача натисніть «Створити»:

_images/foto1.png

Форма створення / редагування облікового запису користувача містить наступні вкладки:

  • Основна інформація – містить базову інформацію з налаштувань користувача, дозволяє задати рівень складності пароля, дає можливість скинути пароль для користувача

  • Білий список – використовується для налаштування білого списку доступних ІР-адрес, з яких буде можливо заходити на платформу

  • Ролі – вкладка для призначення ролей користувачам

  • Шифрування – вкладка для встановлення параметрів розшифрування документів

  • Маршрути – містить перелік контрактів і типів комплектів, до яких має доступ користувач.

3.1 Основна інформація

Для створення облікового запису користувача заповніть обов’язкові поля (виділені червоним і позначені «зірочкою») форми «Основна інформація». Значення, внесене в поле Email, буде використовуватися системою як логін. Процедура зміни Email описана в «Інструкції з авторизації».

Поле ПІБ призначене для внесення прізвища, імені та по-батькові користувача, мінімальна кількість знаків для внесення – п’ять. Поле «Парольна політика» містить випадаючий список рівнів парольної політики, які налаштовуються в меню «Особистий кабінет» - «Акаунт» – «Парольна політика»:

_images/foto2.png

За відсутності інших налаштувань до користувача, для якого не встановлений рівень парольної політики, застосовуються наступні правила:

  • Обов’язкове використання капчі;

  • Час блокування користувача – 5 хвилин

  • Кількість попередніх паролів (кількість раніше використаних паролів,збережених у системі для блокування їх повторного використання) – 1

  • Мінімальна довжина пароля - 6 знаків

  • Обов’язкова наявність цифр у паролі.

Зверніть увагу!

Значення поля Email (логін користувача) повинно бути унікальним. У разі введення даних вже зареєстрованого користувача система повідомить про помилку.

3.2 Білий список

Для внесення обмежень за IP-адресою користувача натисніть «Редагувати», перейдіть до вкладки Білий список» і натисніть «Додати обмеження»:

_images/foto3.png

Якщо не задано інакше, доступ дозволено з будь-якої IP-адреси:

_images/foto4.png

Для додання IP-адреси до переліку необхідно ввести значення у відповідне поле та натиснути «Зберегти». Для зручності реалізована можливість вказати лише начальні цифри IP-адреси, замінивши останні цифри «зірочками» — * :

_images/foto5.png

Після додання усіх необхідних IP-адрес натисніть кнопку «Зберегти». Система повідомить про успішне збереження даних. Обмеження за кількістю доступних IP-адрес у білому списку відсутнє. Для видалення IP-адреси з переліку натисніть «Видалити»:

_images/foto6.png

3.3 Призначення ролі

Оскільки роль визначає перелік розділів, доступних користувачеві, призначення ролі є необхідною передумовою початку його роботи. Обмеження не стосується користувачів, які є власниками акаунта.

Для призначення ролі користувачеві натисніть «Редагувати», перейдіть до вкладки «Ролі» і натисніть «Додати»:

_images/foto7.png

Наступним кроком виберіть роль для користувача з випадаючого списку і натисніть «Додати». У списку будуть відображені всі ролі, створені в розділі «Керування доступом» - «Ролі»:

_images/foto8.png

Одному користувачеві можливо призначити декілька ролей.

Для видалення ролі зі списку призначених користувачеві натисніть «Видалити»:

_images/foto9.png

3.4 Шифрування

Для визначення порядку розшифрування документів для користувача перейдіть до вкладки «Шифрування» і оберіть потрібний варіант:

_images/foto10.png

При виборі «Розшифрувати документи за допомогою Cryptex» необхідно вказати IP-адресу і порт сервера (комп’ютера), де встановлений модуль.

Для збереження внесених данних натисніть «Зберегти».

3.5 Маршрут

Маршрут використовується для визначення контрактів і типів комплектів, доступних користувачеві для роботи. Список маршрутів налаштовується у розділі «Керування доступом» - «Маршрути». Для додання маршруту до облікового запису користувача перейдіть до вкладки «Маршрути», де у вигляді списку будуть відображені всі маршрути, призначені даному користувачеві. Для додання маршруту натисніть «Додати»:

_images/foto11.png

У формі, що відкриється, виберіть із випадаючого списку типи комплектів. У списку для вибору будуть доступні всі типи комплектів за активними контрактами, що укладені з компаніями, які доступні користувачеві відповідно до налаштувань ролі.

_images/foto12.png

3.6 Налаштування облікового запису користувача при інтеграції

За відсутності інших налаштувань капча застосовується для всіх користувачів при доступі на WEB-платформу. Для користувачів із інтеграційним підключенням для обробки комплектів капча не застосовується.

Для вимкнення капчі перейдіть до розділу «Особистий кабінет» – «Акаунт» – «Парольна політика» і створіть або відредагуйте парольну політику без застосування капчі. Для цього зніміть відмітку у відповідному чекері:

_images/foto13.png

Детальніше про порядок налаштування парольної політики в пункті 4.3 даної інструкції.

В цілях безпеки для користувачів із вимкненою капчею рекомендовано налаштовувати білий список.

3.7 Блокування користувача

З метою обмеження доступу користувачів на плафторму реалізована можливість їх блокування. Для цього натисніть «Редагувати» у формі налаштувань облікового запису користувача. У формі, що відкриється, натисніть «Заблокувати»:

_images/foto14.png

Для розблокування поверніться до форми налаштувань користувача («Керування доступом» – «Користувачі» - «Редагувати») та натисніть «Розблокувати»:

_images/foto15.png

4 Налаштування акаунта

Для спрощення процедури створення облікових записів користувачів реалізована можливість встановлення налаштувань білого списку, шифрування та парольної політики на рівні акаунта.

4.1 Налаштування парольної політики

Для налаштування парольної політики перейдіть до розділу меню «Особистий кабінет» – «Акаунт», вкладка «Парольна політика». На вкладці відображений перелік всіх створених рівнів парольної політики із можливістю редагування та видалення.

Для створення нового рівня натисніть «Створити»:

_images/foto19.png

У формі створення рівня парольної політики заповніть наступні поля:

  • Назва — назва рівня парольної політики (обов’язкове для заповнення поле)

  • Довжина пароля — мінімальна кількість символів 4, максимальна - 50 (обов’язкове для заповнення поле)

  • Складність пароля — зумовлює необхідність використання у паролі наступних символів: великих літер, малих літер, спец. символів; наявність цифр обов’язкова (відмітка проставлена автоматично)

  • Кількість попередніх паролів — вказується кількість раніше використаних паролів, збережених у системі для блокування їх повторного використання; поле не обов’язкове для заповнення

  • Період дії пароля — вказується період часу, через який користувачеві необхідно змінити пароль. Якщо поле не заповнене, змінювати пароль не потрібно

  • Час блокування — мінімальне значення 3 (хвилини) , максимальне 1440 (= 24 години).

На формі також є можливість увімкнути / вимкнути капчу, встановивши відмітку у відповідному чекері:

_images/foto20.png

Після заповнення форми налаштувань натисніть «Зберегти».

4.2 Налаштування білого списку на рівні акаунта

Для налаштування обмежень за IP-адресами перейдіть до розділу «Особистий кабінет» – «Акаунт», вкладка «Білий список IP адрес».

Якщо не задано інакше, доступ дозволено з будь-якої IP-адреси:

_images/foto16.png

Для додання обмеження необхідно натиснути Додати обмеження, ввести IP-адресу, з якої користувачеві буде дозволений доступ до платформи, та натиснути «Додати»:

_images/foto17.png

При створенні облікового запису нового користувача вказані у даному розділі IP-адреси будуть автоматично завантажені до налаштувань користувача у меню «Керування доступом» - «Користувачі».

4.3 Налаштування шифрування на рівні акаунта

Для визначення порядку розшифрування документів на рівні акаунта перейдіть до розділу «Особистий кабінет» – «Акаунт» – «Шифрування»:

_images/foto18.png

Серед доступних методів розшифрування Web або Cryptex оберіть потрібний варіант і натисніть «Зберегти». При створенні облікового запису нового користувача вказані у даному розділі налаштування будуть автоматично завантажені на вкладку «Шифрування» у формі налаштувань користувача меню «Керування доступом» - «Користувачі».

5 Створення ролі

Для створення ролі перейдіть до розділу «Керування доступом» – «Ролі». У розділі списком відображатимуться всі ролі, створені у межах компаній облікового запису. Натисніть «Створити»:

_images/foto21.png

У формі, що відкриється, заповніть поля «Назва ролі», «Код ролі», «Компанія». Всі поля є обов’язковими для заповнення. Значення для поля «Компанія» необхідно вибрати з системного переліку. Значення, введене в поле «Код ролі», повинно бути унікальним у межах компанії.

Після внесення даних натисніть «Створити». Система повідомить про успішне створення ролі і відкриє форму налаштувань.

На вкладці «Користувачі» оберіть користувачів, котрим буде призначена роль. Для цього натисніть «Додати користувача» і оберіть із переліку:

_images/foto22.png _images/foto23.png

Одну роль можливо призначити декільком користувачам (кількість користувачів необмежена). Для визначення прав доступу для ролі перейдіть до вкладки «Розділи»:

_images/foto24.png

Розділ передбачає наступні варіанти доступу:

  • Немає доступу – розділ не відображається для користувача

  • Перегляд – розділ доступний для перегляду без можливості редагування

  • Редагування і перегляд – повний доступ до всіх опцій розділу.

До початку налаштувань всі розділи є закритими для ролі (автоматично проставлена відмітка «немає доступу»). Для надання доступу встановіть відмітку напроти певного розділу та натисніть «Зберегти».

Розділи в ролі відповідають наступним розділам платформи:

  • Комплекти – «Зовнішні комплекти документів»

  • Компанії - «Налаштування компанії» - «Мої компанії»

  • Контракти - «Взаємодія з Партнерами» - «Контракти»

  • Типи комплектів - «Налаштування компанії» - «Налаштування комплектів документів»

  • Доступ -

  • Безпека - «Особистий кабінет» - «Сертифікати»

  • Акаунт – «Особистий кабінет» - «Акаунт»

  • Журнал подій - «Особистий кабінет» - «Журнал подій»

  • Маршрути - «Керування доступом» - «Маршрути»

  • Налаштування контрактів - «Взаємодія з Партнерами» - «Шаблони контрактів»

  • Рахунки - «Особистий кабінет» - «Рахунки»

  • Групи - «Керування доступом» - «Групи»

  • Узгодження - «Керування доступом» - «Налаштування етапів узгодження документів»

  • Мої завдання - «Мої завдання»

  • Контрагенти - «Взаємодія з Партнерами» - «Мої контрагенти»

  • Внутрішній документообіг

5.1 Рекомендації щодо налаштування спеціальних ролей

5.1.1 Бізнес-адміністратор

Для налаштування ролі бізнес-адміністратора надайте доступ до редагування наступних розділів:

_images/foto25.png

5.1.2 Адміністратор

Налаштування ролі адміністратора передбачає доступ до наступних розділів:

_images/foto26.png

5.1.3 Адміністратор доступу

Налаштування ролі адміністратора доступу передбачає доступ до наступних розділів:

_images/foto27.png

5.1.4 Користувач

Налаштування ролі користувача передбачає доступ до наступних розділів:

_images/foto28.png

5.2 Автоматичне створення ролей

Для зручності ролі бізнес-адміністратора, адміністратора системи та користувача створюються автоматично при доданні нової компанії («Налаштування компанії» – «Мої компанії»- «Створити»). Роль адміністратора системи об’єднує в собі ролі адміністратора доступу та адміністратора.

Зверніть увагу!

У разі створення компанії користувачем, який не є власником акаунта, система автоматично надасть йому роль бізнес–адміністратора.

Відредагувати автоматично надану роль можливо у меню «Керування доступом» – «Ролі» або «Керування доступом» – «Користувачі» – «Редагувати» – «Роль».

5.3 Блокування – розблокування ролі

Для блокування / розблокування ролі переведіть перемикач у відповідне положення:

_images/foto29.png

6 Керування розсилкою повідомлень

Для керування розсилкою повідомлень перейдіть до розділу меню «Налаштування компанії» - «Мої компанії» і виберіть зі списку потрібну компанію, натиснувши на її назву. У формі редагування, що відкриється, перейдіть до вкладки «Повідомлення»:

_images/foto30.png

Вкладка містить наступні поля:

  • Ел. адреса для нових контрактів - поле для введення електронних адрес, на які надходитимуть повідомлення щодо отримання нових контрактів

  • Ел. адреса для змінених контрактів – поле для введення електронних адрес, на які надходитимуть повідомлення щодо зміни статусу контракту (прийняття або відхилення на стороні отримувача контракту)

  • Ел. адреса для нових комплектів – поле для введення електронних адрес, на які надходитимуть повідомлення про отримання нових комплектів

  • Ел. адреса для змінених комплектів – поле для введення електронних адрес, на які надходитимуть повідомлення при зміну статусу комплекта отримувачем (надання статусу«прийнятий», «відхилений», «відмова», «уточнення»).

Для кожного поля доступні варіанти:

  • Відключити – розсилка не надходитиме

  • За користувачем – розсилка надходитиме на Email користувача з відповідними правами доступу. Повідомлення про надходження нових вхідних контрактів або зміну статусу вихідних надходитимуть лише тим користувачам, що мають доступ на перегляд та редагування розділу «Контракти», а також доступ до компанії відповідно до ролі. Повідомлення про надходження нових комплектів або зміну статусу комплекта отримувачем будуть надходити лише тим користувачам, що мають доступ на перегляд та редагування розділу «Зовнішні комплекти документів», а також доступ до комплекта відповідно до ролі та маршруту. Всі повідомлення також будуть надходити власнику акаунта.

  • Вказані адреси – розсилка надходитиме на вказані адреси:

_images/foto31.png

Після заповнення полів та вибору варіанту розсилки натисніть «Зберегти».

Інструкція користувача з обміну комплектами

Дана інструкція описує порядок дій користувача на платформі DOCflow з підготовки до обміну комплектами, створення та відправлення комплекта документів.

1 Терміни та визначення

  • Компанія – юридична чи фізична особа, яка використовує систему для виконання своїх процесів. До одного акаунта можливо прив’язати декілька компаній. Документи, довідники, типи комплектів, контракти, маршрути, налаштування узгодження створюються в межах компанії і закріплюються за нею.

  • Тип документа – спеціальний системний довідник, що містить дані за типами документів, якими виконуватиметься обмін між сторонами.

  • Тип комплекта – налаштування та параметри комплекта документів для обміну.

  • Контракт – форма налаштування зв’язку між контрагентами, у відповідності до якої відбувається обмін комплектами документів.

  • Маршрут – операція визначення працівників отримувача, які будуть отримувати та обробляти комплекти документів. Маршрут будується на основі переліку доступних користувачеві контрактів і типів комплекта.

  • Електронний цифровий підпис (ЕЦП/КЕП) — електронний цифровий підпис уповноважених осіб та окремий електронний цифровий підпис, що виконує функцію печатки (у разі наявності), з посиленим сертифікатом ключа, наданим акредитованими центрами сертифікації ключів (далі – АЦСК).

2 Авторизація

Для авторизації на платформі перейдіть за посиланням https://doc.edi-n.com/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

3 Передумови обміну комплектами

Налаштування, які є передумовами обміну комплектами, детально викладені в «Інструкції бізнес-адміністратора», «Інструкції з налаштування ЕЦП/КЕП», «Інструкції з налаштування шифрування». Деталі процедури створення та налаштування облікових записів користувачів та їх ролей описані в «Інструкції адміністратора користувачів».

Для пришвидшення та полегшення налаштування аккаунту на платформі, скористайтеся Майстром налаштувань, що з’явиться при першому відвідуванні платформи після авторизації.

За допомогою майстра ви зможете створити картку вашої компанії, створите перші типи документів, якими плануєте обмінюватися зі своїми контрагентами, та налаштуєте правила обробки документів. Слідуйте підсказкам та підготуйте усі умови для зручного та швидкого обміну комплектами документів.

В майстрі налаштовуємо тільки неструктуровані документи (наприклад, документи типу pdf). Для налаштування структурованих документів необхідно скористатися розширеними налаштуваннями платформи.

Якщо не хочете знову бачити майстер налаштувань, відмітьте позначку Не показувати майстер при повторному вході.

_images/instruktsia_korystuvacha_obminy_paketami_1_1.png

4 Створення та відправка комплекта

Для створення комплекта перейдіть до розділу меню «комплекти» і натисніть «Створити комплект»:

_images/instruktsia_korystuvacha_obminy_paketami_1.png

У формі створення комплекта виберіть компанію, яка відправлятиме комплект документів, із випадаючого списку:

_images/instruktsia_korystuvacha_obminy_paketami_2.png

Після вибору компанії стане доступним поле для вибору контракту. Поле містить перелік активних (діючих) контрактів за обраною компанією, що відображаються випадаючим списком.

Після вибору контракту система відобразить перелік доступних комплектів за обраним контрактом:

_images/instruktsia_korystuvacha_obminy_paketami_3.png

Для вибору типу комплекта натисніть на його назву. Після цього автоматично відкриється форма для заповнення обраного типу комплекта.

Зверніть увагу!

Якщо у формі контракту не налаштований перелік типів комплектів, система повідомить про їх відсутність.

У такому випадку слід виконати налаштування переліку вихідних типів комплектів відповідно до пункту 5.1.2 даної інструкції (для вихідних контрактів) або узгодити відповідні налаштування на стороні контрагента (для вхідних контрактів).

4.1 Заповнення комплекта

При створенні чи редагуванні комплекта відкриється форма обробки комплекта, що містить наступні вкладки:

  • Основна інформація – містить загальну інформацію про комплект (дані про Відправника та Отримувача, дані про контракт, дані про комплект, статус комплекта)

  • Документи – основний розділ для обробки документів.

  • Довідники – використовується для керування довідниками, що пов’язані з комплектом.

  • Користувацькі поля – використовується для керування користувацькими полями, що пов’язані з комплектом.

  • Журнал – містить інформацію щодо змін і коментарів до документів та комплекта.

_images/instruktsia_korystuvacha_obminy_paketami_4.png

4.1.1 Введення довідників

Вкладка «Довідники» містить перелік довідників, які потребують заповнення відповідно до налаштувань типу комплекта. Для заповнення довідника виберіть значення з випадаючого списку (обов’язкові для заповнення поля виділені червоним):

_images/instruktsia_korystuvacha_obminy_paketami_5.png

Після введення значень відбувається автоматичне збереження внесених даних і з’являється відповідне повідомлення.

4.1.2 Введення користувацьких полів

Вкладка «Поля» містить перелік користувацьких полів, які потребують заповнення. Для заповнення поля введіть у нього необхідні дані. Обов’язкові для заповнення поля виділені червоним.

Для отримання підказки щодо заповнення користувацького поля наведіть курсор миші на іконку «Інформація»:

_images/instruktsia_korystuvacha_obminy_paketami_6.png

Після введення значень натисніть «Зберегти». У разі успішного збереження з’явиться відповідне повідомлення.

4.1.3 Введення документів

Вкладка «Документи» містить перелік обов’язкових та не обов’язкових документів для даного комплекта. Обов’язкові для конкретного комплекта документи позначаються відміткою иконка-звезда. Документи, що потребують шифрування, позначаються відміткою иконка-щит.

Для завантаження документа натисніть «Додати»:

_images/instruktsia_korystuvacha_obminy_paketami_7.png

Після цього з’явиться можливість завантажити файли документів. Для завантаження файлу або файлів натисніть кнопку «Завантажити» та виберіть необхідні файли (обмеження до 10МБ для одного файлу).

_images/instruktsia_korystuvacha_obminy_paketami_8.png

Якщо для даного типу документа встановлено обмеження кількості документів, система повідомить про помилку (обмеження кількості документів встановлюється у налаштуваннях типу комплекта):

_images/instruktsia_korystuvacha_obminy_paketami_9.png

Якщо для документа встановлено ознаку шифрування, перед початком завантаження файлу необхідно вибрати ЕЦП/КЕП, який буде використано для шифрування. При цьому сертифікати для шифрування повинні бути завантажені як на стороні відправника, так і отримувача.

_images/instruktsia_korystuvacha_obminy_paketami_10.png

Після завантаження файлу з’явиться можливість ввести обов’язкові та необов’язкові поля для документа. Для цього необхідно натиснути на кнопку «Додаткова інформація по документу»:

_images/instruktsia_korystuvacha_obminy_paketami_11.png

У формі, що відкриється, потрібно натиснути кнопку «Редагувати»:

_images/instruktsia_korystuvacha_obminy_paketami_12.png

Після чого відкриється форма для редагування:

_images/instruktsia_korystuvacha_obminy_paketami_13.png

Зверніть увагу!

Для документів, які відповідно до налаштувань типу комплекта повинні бути завантажені на стороні контрагента (довкладення), відсутня кнопка «Додати».

При додаванні документа з привязаним довідником, необхідно заповнити усі значення довідника до фінального дочірнього значення. Ви можете також редагувати довідники, які привязані до типу докумена у комплекті.

Для цього необхідно перейти в «Чернетки», вибрати комплект що потребує редагування, та внести зміни. Довідники доступні до редагування тільки на стороні відправника комплекта.

_images/foto99.png

Документ у якому потрібно редагувати довідник, показує підсказку «Потрібно додати значення». Натисніть кнопку «Редагувати значення», для того щоб вибрати усі небхідні значення довідника, потім натисніть «Зберегти».

4.1.4 Додання раніше підписаного документа

Якщо завантажений документ був підписаний раніше із використанням зовнішнього підписання (тобто накладення підпису), необхідно завантажити файли підписів. Для цього натисніть кнопку «Завантажити підписи» та виберіть файли підписів.

_images/instruktsia_korystuvacha_obminy_paketami_14.png

Якщо для документа встановлено ознаку шифрування, перед завантаженням файлів підписів документ необхідно розшифрувати. Для цього на формі виберіть ключ для розшифрування:

_images/instruktsia_korystuvacha_obminy_paketami_15.png

Після цього натисніть «Завантажити». При завантаженні система перевіряє валідність підпису. Файли підписів, що пройшли перевірку, можливо зберегти. У разі помилки верифікації підпису з’явиться відповідне повідомлення. Завантажені підписи додаються до загальної кількості підписів на документі.

4.1.5 Підписання документа(ів)

Для підписання одиничного документа натисніть на кнопку підпису иконка-ручка в необхідному рядку:

_images/instruktsia_korystuvacha_obminy_paketami_16.png

Якщо для документа встановлено ознаку шифрування, перед підписанням його необхідно розшифрувати. Для цього виберіть ЕЦП/КЕП для розшифрування. Успішно розшифрований документ можливо буде підписати. У разі виникнення помилки розшифрування з’явиться відповідне повідомлення, і подальше підписання буде неможливим:

_images/instruktsia_korystuvacha_obminy_paketami_17.png _images/instruktsia_korystuvacha_obminy_paketami_18.png

У разі використання MobileID користувачеві буде надіслано sms-запит на номер телефону, зв’язаний із ЕЦП/КЕП. Для підтвердження підписання введіть код підтвердження.

Для масового підписання виберіть у списку потрібні документи та натисніть кнопку «Підписання виділених». При цьому відкриється форма підписання з переліком вибраних файлів. Якщо серед вибраних документів є такі, що потребують шифрування, їх потрібно розшифрувати.

Зверніть увагу!

Підписати документ тим самим підписом декілька разів неможливо.

4.1.6 Видалення документа

Для видалення документа натисніть відповідну кнопку иконка-ведерко. Підтвердження дії призведе до видалення контенту та підписів, що були накладені чи завантажені окремо:

_images/instruktsia_korystuvacha_obminy_paketami_19.png

4.1.7 Перегляд детальної інформації

Для отримання детальної інформації за документом та накладеними на нього підписами або для переходу до редагування даних документа натисніть на іконку иконка-информация «Додаткова інформація за документом»:

_images/instruktsia_korystuvacha_obminy_paketami_20.png

На формі, що відкриється, будуть відображені наступні дані: назва типу документа, ім’я файлу, № та дата документа, коментар, дата/час відправки, кількість підписів, а також детальна інформація щодо накладених підписів з позначкою часу, додаткові користувацькі поля, посилання для скачування документу, тощо.

_images/instruktsia_korystuvacha_obminy_paketami_21.png

Для редагування даних документа натисніть «Редагувати» і внесіть необхідні зміни. Для збереження внесених даних натисніть «Зберегти документ».

4.2 Відправлення комплекта

Для відправки комплекта натисніть кнопку «Відправити» на формі комплекта:

_images/instruktsia_korystuvacha_obminy_paketami_22.png

У разі, якщо в комплекті не заповнені обов’язкові довідники чи користувацькі поля, обов’язкові документи не містять файлів або не дотримано вимоги щодо мінімальної кількісті ЕЦП/КЕП, кнопка «Відправити» буде заблокована. Для отримання повідомлення-підказки наведіть курсор на неактивну кнопку:

_images/instruktsia_korystuvacha_obminy_paketami_23.png

У разі, якщо до складу комплекта входять документи, що потребують узгодження, замість кнопки «Відправити» відображатиметься кнопка «Надіслати на узгодження»:

_images/instruktsia_korystuvacha_obminy_paketami_24.png

Відправити контрагенту комплект із документами, для яких процес узгодження не завершено, неможливо. Для запуску процедури узгодження натисніть кнопку «Надіслати на узгодження». Документу буде надано статус «На узгодженні».

Для перегляду статусу узгодження документа натисніть на іконку иконка-информация «Додаткова інформація по документу»:

_images/instruktsia_korystuvacha_obminy_paketami_25.png

У блоці «Журнал узгодження» міститься інформація щодо статусів узгодження, дати та часу виконання завдання (погодити, підписати або переглянути документ), коментар у разі відхилення документа в процесі узгодження:

_images/instruktsia_korystuvacha_obminy_paketami_26.png

Після надання документу фінального статусу узгодження активується кнопка «Відправити»:

_images/instruktsia_korystuvacha_obminy_paketami_27.png

Для масової відправки / видалення комплектів із папки «Чернетки» виділіть необхідні комплекти і натисніть кнопку «Надіслати» / «Видалити»:

_images/instruktsia_korystuvacha_obminy_paketami_28.png

Незаповнені комплекти не підлягають відправці і позначаються іконкою иконка-значок. При масовій відправці такі комплекти не будуть відправлені.

5 Редагування комплекта та відстеження статусу

Для роботи з комплектами перейдіть до розділу «комплекти» (Зовнішні комплекти документів) на навігаційній панелі. Розділ містить наступні папки:

  • Вхідні – для отриманих комплектів документів

  • Вихідні – для відправлених комплектів

  • Чернетки – для зберігання комплектів на стадії обробки

  • Архів – для відображення отриманих та відправлених комплектів, які були оброблені і переведені в архів

  • Уточнення – для комплектів, що потребують уточнення.

Для кожної папки відображається список комплектів.

_images/instruktsia_korystuvacha_obminy_paketami_29_2.png

Необроблені та нерозглянуті на стороні контрагента комплекти відображаються зі статусом «Прийнятий» («Надісланий») та виділяються жирним шрифтом. комплекти відображаються за датою / часом зміни у порядку зменшення.

Для редагування комплекта натисніть на рядок із потрібним комплектом, після чого відкриється форма редагування.

5.1 Контроль статусу комплекта

Статус комплекта відображається у списку комплектів у вигляді відповідної іконки, а також на формі редагування комплекта у вкладці «Загальна інформація»:

_images/instruktsia_korystuvacha_obminy_paketami_30.png

Статуси комплекта: иконка-получен Отриманий; иконка-отправлен Надісланий; иконка-отказ Відмова; иконка-отклонен Відхилений; иконка-черновик Оброблений / Чернетка; иконка-уточнение Запит на уточнення Для перегляду інформації щодо зміни статусів документів, комплектів та коментарів за даними змінами (причини відхилення документа / комплекта, коментар до уточнення) перейдіть до розділу «Журнал» форми обробки комплекта.

Статуси документів відображаються напроти кожного конкретного документа безпосередньо у формі обробки комплекта:

_images/instruktsia_korystuvacha_obminy_paketami_31.png

Історія зміни статусів зберігається у розділі «Журнал» форми обробки:

_images/instruktsia_korystuvacha_obminy_paketami_32.png

5.2 Фільтр (пошук комплекта)

Для пошуку потрібного комплекта натисніть «Фільтр»:

_images/instruktsia_korystuvacha_obminy_paketami_33.png

Пошук виконується за наступними атрибутами:

  • Номер (для пошуку вкажіть три або більше символів номера комплекта)

  • Статус (поле містить системний перелік статусів у відповідності до обраного розділу)

  • Відправник (ЄДРПОУ, назва)

  • Отримувач (ЄДРПОУ, назва)

  • Тип комплекта (для фільтрування за типом комплекта необхідно обрати отримувача у відповідному полі фільтра)

  • Дата (вказується в діапазоні від _ до)

_images/instruktsia_korystuvacha_obminy_paketami_34_2.png

Для одночасного видалення внесених у налаштування фільтра значень натисніть «Скинути».

5.3 Шаблони фільтрів

Для спрощення фільтрації комплектів у розділах, реалізована можливість зберегти потрібні параметри фільтра. Для цього натисніть кнопку «Додати ярлик» (є у кожному розділі), заповніть необхідні атрибути і натисніть кнопку «Зберегти»:

_images/instruktsia_korystuvacha_obminy_paketami_29_3.png

Створиться новий фільтр-підпапка, де буде відображено лише документи які відповідають заданим у фільтрі параметрам. Фільтр можливо редагувати або видалити за допомогою відповідних кнопок.

5.4 Уточнення до комплекта з боку відправника

До комплекта в статусі «Відправлено» чи «Уточнення» можливо довкласти (додати, завантажити) файли на стороні відправника.

комплекти в статусі «Уточнення» відображаються в папці «Уточнення». Також для таких комплектів у журналі відображені коментарі, зроблені власником контракту (отримувачем).

Для додання файлу зайдіть в комплект, натисніть кнопку «Редагувати» та додайте файл. Підпишіть додані файли (якщо вони потребують підпису) та відправте комплект з новими файлами.

6 Обробка вхідних комплектів документів

Для обробки комплектів, що надійшли від контрагентів, перейдіть до розділу «комплекти» на навігаційній панелі меню, папка «Вхідні», та натисніть на рядок із потрібним комплектом.

6.1 Керування довідниками

Для перегляду чи редагування довідника, прикріпленого до комплекта, перейдіть на вкладку «Довідники». На вкладці відображені довідники комплекта з заповненими значеннями, що вказав відправник при формуванні комплекта:

_images/instruktsia_korystuvacha_obminy_paketami_38.png

Для редагування довідника на стороні отримувача натисніть «Редагувати». При цьому будуть відображені лише ті довідники, які дозволено редагувати користувачеві. Після введення значень виконується їх автоматичне збереження.

6.2 Фільтр та пошук документа у комплекті

Для пошуку документа за назвою у формі обробки введіть три або більше символів у відповідне поле на панелі пошуку:

_images/instruktsia_korystuvacha_obminy_paketami_39.png

Для фільтрування документів за ознаками «обов’язковий» / «необов’язковий» виберіть відповідне значення на панелі пошуку:

_images/instruktsia_korystuvacha_obminy_paketami_40.png

Для фільтрування типів документів за ознаками «з документами» / «без документів» виберіть відповідне значення на панелі пошуку:

_images/instruktsia_korystuvacha_obminy_paketami_41.png

6.3 Обробка документів у комплекті

Для обробки надісланих контрагентами документів перейдіть до вкладки «Документи» у формі обробки комплекта. На вкладці буде відображений список типів документів з завантаженими файлами, панель для пошуку та фільтрації списку, інформація щодо кількості вкладених файлів.

Обов’язкові для конкретного комплекта документи позначаються відміткою иконка-звезда. Зашифровані документи позначаються відміткою иконка-щит. У списку документів відображається назва файлу та кількість накладених підписів.

Для отримання детальної інформації за документом та накладеними на нього підписами натисніть на іконку иконка-информация «Додаткова інформація про документ»:

_images/instruktsia_korystuvacha_obminy_paketami_42.png

Форма детальної інформації містить наступні дані: назва типу документа, ім’я файлу, посилання для скачування документа, № та дата документа, коментар, дата/час відправки, кількість підписів та інформація про них із позначкою часу, тощо.

Під обробкою документа слід розуміти надання статусу «Прийнято» чи «Відхилено». Для цього натисніть на відповідну кнопку навпроти кожного документа:

_images/instruktsia_korystuvacha_obminy_paketami_43.png

При відхиленні документа необхідно вказати причину відхилення у відповідному вікні:

_images/instruktsia_korystuvacha_obminy_paketami_44.png

Встановлення статусу записується в журнал дії за комплектом.

6.4 Підписання документа отримувачем

Документ можна підписувати як зовнішнім так і внутрішнім Електронним цифровим підписом. Внутрішній ЕЦП додається в тіло документу, зовнішній - створюється в окремому файлі.

Для підписання документа внутрішнім підписом натисніть на іконку підпису иконка-ручка:

_images/instruktsia_korystuvacha_obminy_paketami_45.png

Якщо для документа встановлено ознаку шифрування, перед підписанням його необхідно розшифрувати. Для цього виберіть ЕЦП/КЕП для розшифрування. Успішно розшифрований документ можливо буде підписати. У разі виникнення помилки розшифрування з’явиться відповідне повідомлення, і подальше підписання буде неможливим.

_images/instruktsia_korystuvacha_obminy_paketami_46.png

Після розшифрування виберіть потрібні ЕЦП/КЕП з переліку зчитаних, якими буде виконане підписання документа, і натисніть «Підписати». Кількість накладених ЕЦП/КЕП буде відображена в списку документів:

_images/instruktsia_korystuvacha_obminy_paketami_47.png

Для масового підписання виберіть у списку потрібні документи та натисніть кнопку «Підписати виділені». При цьому відкриється форма підписання з переліком вибраних файлів. Якщо серед вибраних документів є такі, що потребують шифрування, їх потрібно розшифрувати. Слід мати на увазі, що підписати документ тим самим підписом декілька разів неможливо.

Для накладення зовнішнього підпису натисніть відповідну іконку:

_images/instruktsia_korystuvacha_obminy_paketami_48.png

Зверніть увагу!

Підписаний отримувачем документ автоматично набуває статусу «Прийнятий».

6.5 Скачування документа та архіву

Для перегляду (ознайомлення) з документом натисніть на його назву або на іконку «Скачати архів» навпроти документу, а для скачування всіх документів у комплекті натисніть «Завантажити архів»:

_images/instruktsia_korystuvacha_obminy_paketami_48_1.png

В залежності від налаштувань методу розшифрування будуть завантажені відповідні дані у .zip архіві або окремим файлом.

Зверніть увагу!

Параметри скачування (каталог для зберігання, відображення після скачування тощо) залежать від налаштувань браузера.

_images/instruktsia_korystuvacha_obminy_paketami_49.png

6.5.1 Незашифрований документ або розшифрування на WEB

Якщо для типу документа, який скачується, вказано «Нешифрований», або в налаштуваннях шифрування для користувача, який скачує, вказано «Розшифрування на WEB», то при натисканні на ім’я файлу буде скачаний оригінальний файл, а при натисканні на кнопку «Скачати архів» — оригінальний файл та архів підписів. В архіві підписів містяться файли ЕЦП/КЕП, що були накладені, та файл із візуалізацією ЕЦП/КЕП у форматі PDF.

Якщо для типу документа встановлено ознаку шифрування, перед скачуванням файлу необхідно вибрати ЕЦП/КЕП з переліку зчитаних, за допомогою якого буде виконуватись розшифрування контенту.

У разі помилки розшифрування з’явиться відповідне повідомлення і скачування файлу не відбудеться.

6.5.2 Cryptex

Якщо в налаштуваннях розшифрування користувача вказано «Розшифрування Cryptex», то при натисканні на назву файлу чи на кнопку «Скачати архів» буде скачаний архів документів, який містить оригінальний файл, файли підписів, якими підписано документ, файл з візуалізацією ЕЦП/КЕП та друкований макет з «водяними знаками» (тільки якщо оригінальний файл у форматі PDF).

6.6 Довкладення документа в комплект

Під довкладенням мається на увазі можливість додати (завантажити) документ на стороні отримувача комплекта. Довкладення можливе лише для документа з ознакою «Довкладення отримувача» (встановлюється в налаштуваннях типу комплекта, детальніше про порядок налаштування в «Інструкції бізнес-адміністратора»).

Для завантаження документа перейдіть у форму обробки комплекта, вкладка «Документи», і натисніть «Додати»:

_images/instruktsia_korystuvacha_obminy_paketami_50.png

Після цього з’явиться можливість завантажити файли документів. Для завантаження файлу натисніть на кнопку «Завантажити»:

_images/instruktsia_korystuvacha_obminy_paketami_51.png

Якщо для документа встановлено ознаку шифрування, перед початком завантаження файлу необхідно вибрати ЕЦП/КЕП, який буде використано для шифрування. При цьому сертифікати для шифрування повинні бути завантажені як на стороні відправника, так і на стороні отримувача:

_images/instruktsia_korystuvacha_obminy_paketami_52.png

Завантажені файли будуть відображені у списку зі статусом «Новий»:

_images/instruktsia_korystuvacha_obminy_paketami_53.png

Для передачі довкладення на розгляд відправникові комплекта натисніть кнопку «Уточнення». У вікні, що відкриється, зазначте причину відхилення (коментар щодо довкладення). Поле є обов’язковим для заповнення:

_images/instruktsia_korystuvacha_obminy_paketami_54.png

Після внесення коментаря, для передачі даних відправникові комплекта натисніть «Так». Довкладенню буде наданий статус «Надісланий», комплект набуде статусу «Запит на уточнення», і відповідно буде перенесений до папки «Уточнення», підпапка «Вхідні». У свою чергу, відправник комплекта отримає можливість перегляду та обробки довкладення у папці «Уточнення», підпапка «Вихідні».

6.7 Обробка комплекта

Під обробкою комплекту слід розуміти надання комплекту відповідного статусу. Статус комплекту можливо встановити лише за умови, що всі документи в комплекті оброблені. Для встановлення потрібного статусу натисніть відповідну кнопку: «Прийняти», «Відхилити», «Уточнення»:

_images/instruktsia_korystuvacha_obminy_paketami_55.png

При встановленні статусу «Відмова», «Відхилено» або «Уточнення» необхідно вказати причину відхилення / уточнення у відповідному вікні.

комплекти у статусі «Оброблено», «Відмова», «Відхилено» відображатимуться в папці «Архів». комплекти в статусі «Уточнення» відображатимуться в папці «Уточнення».

6.7.1 Керування користувацькими полями

Для перегляду чи редагування користувацького поля перейдіть до вкладки «Поля». В розділі відображаються користувацькі поля з заповненими значеннями, що вказав відправник при формуванні комплекта.

Для редагування поля на стороні обробника (отримувача) натисніть «Редагувати». При цьому будуть відображені лише ті поля, які може редагувати користувач:

_images/instruktsia_korystuvacha_obminy_paketami_56.png

Після внесення змін натисніть «Зберегти».

_images/instruktsia_korystuvacha_obminy_paketami_57.png

6.8 Журнал

Для перегляду інформації про зміну статусів документів чи комплекта та коментарів по даних змінах (причини відхилення документа / комплекта, коментар до уточнення) перейдіть до розділу «Журнал»:

_images/instruktsia_korystuvacha_obminy_paketami_58.png

Записи в журналі відображаються в зворотному хронологічному порядку.

7 Мої завдання

Для документів, що входять у комплект, може бути налаштований процес узгодження (детальніше в «Інструкції бізнес-адміністратора», п. 13). У такому випадку користувачеві, який входить до групи виконавців, необхідно виконати потрібну дію за документом.

Для перегляду завдань для виконання перейдіть до розділу «Мої завдання» навігаційної панелі сервісу, де у вигляді таблиці будуть відображені всі завдання користувача:

_images/instruktsia_korystuvacha_obminy_paketami_59_2.png

Таблиця складається з наступних колонок:

  • Компанія одержувач – назва та код ЄДРПОУ компанії, у межах якої виконується узгодження

  • Компанія відправник – назва та код ЄДРПОУ компанії, у межах якої виконується узгодження

  • Напрямок – напрямок руху документа, вхідний чи вихідний

  • Тип завдання - узгодження, підписання, повідомлення

  • Дата створення завдання – дата і час створення завдання

  • Термін виконання – кінцева дата і час виконання

  • Тип документа – тип документа, що підлягає узгодженню

  • Завантажити / Переглянути документ – містить посилання на скачування чи форму перегляду документу, що підлягає узгодженню

  • Статус завдання - статус виконяння завдання: Виконано, Відхилено, Прострочено;

Статус завдання – містить наступні значення: «до виконання» - надається новому завданню; «виконано» - надається завданню, за яким виконана потрібна дія; «відхилено» - фінальний статус, при наданні якого документ вибуває з процесу узгодження, а завдання автоматично анулюється; статуси відображаються за допомогою іконок, при наведенні курсору на які спливає підказка.

Під виконанням завдання мається на увазі надання документу відповідного статусу за допомогою кнопок: узгодження - «Погодити» або «Відхилити», підписання - «Підписати» та «Завантажити підпис», повідомлення - «Переглянути». Кнопки відображаються в залежності від типу завдання, зазначеного в налаштуваннях. Для типу завдання підписання необхідно підписати документ, вибравши з переліку зчитаних потрібний ЕЦП/КЕП.

Для перегляду форми задачі натисніть на назву компанії (перша колонка в таблиці):

_images/instruktsia_korystuvacha_obminy_paketami_60.png

Форма містить загальні дані щодо завдання, а також інформацію по документу із можливістю виконати потрібну дію або переглянути додаткову інформацію чи структуру документу,та можливість перейти в комплект (у вигляді посилання),:

_images/instruktsia_korystuvacha_obminy_paketami_61.png

При переході за посиланням відкривається форма перегляду комплекта, що містить документ:

_images/instruktsia_korystuvacha_obminy_paketami_62.png

Дії узгодження за документом відображаються у «Журналі узгодження» на формі перегляду додаткової інформації про документ (розділ «комплекти», форма редагування, вкладка «Документи»):

_images/instruktsia_korystuvacha_obminy_paketami_63.png

8 Внутрішній документообіг компанії

Внутрішній документообіг необхідний для узгодження внутрішніх документів у межах однієї компанії - наприклад, коли потрібно узгодити зміну тарифу чи розмір знижки для контрагента, або коли заява на відпустку потребує узгодження. Для створення внутрішніх документів перейдіть до розділу «Внутрішній документообіг».

Розділ Внутрішній документообіг складається з розділів «Мої Чернетки» та «Мої Відправлені документи».

_images/instruktsia_korystuvacha_obminy_paketami_101.png

В меню Внутрішній документообіг можливо створити документ для відправки на узгодження за допомогою кнопки «Створити документ», або вибрати й відмітити вже створений документ із списку у вкладці Мої Чернетки.

_images/instruktsia_korystuvacha_obminy_paketami_102_2.png

Таблична частина розділу «Мої Чернетки» складається з стовбців з інформацією по документу й відображають наступну інформацію:

  • «Відправник» -назва і код ЕДРПОУ/ІНН компанії

  • «Тип документу» - структурований або неструктурований

  • «Завантажити/Переглянути» - скачування або перегляд документу чи архіву з документом та підписом

  • «Додаткова Інформація» - інформація про документ та підписи

_images/instruktsia_korystuvacha_obminy_paketami_102_3.png

Таблична частина розділу «Мої Відправлені документи» відображає ті ж стовпці що в Чернетках, але додатково ще:

  • «Дата відправлення» - дата та час відправки

  • «Статус документу» - Потребує узгодження; Погоджений; Не погоджений

8.1 Відправка документів на внутрішнє узгодження в рамках компанії

За допомогою кнопки «Створити документ» можливо створити новий структурований або неструктурований документ з наступними елементами:

_images/instruktsia_korystuvacha_obminy_paketami_113.png

  • Поле «Компанія» зі списком компаній, доступних відповідно до ролі;

  • Поле «Доступні внутрішні документи компанії» з списком активних типів документів з ознакою «Внутрішній документ» і зв’язкою з налаштуванням узгодження, за компанією обраною в полі «Компанія»;

  • Поле «Коментар» (зберігається в стовбці «Дод. Інформація по документу»)

  • Кнопка «Завантажити» (тільки якщо обраний неструктурований тип документа);

При створенні документа на узгодження обовязково потрібно вибрати компанію із списку, вибрати тип документу із доступних і завантажити сам документ (якщо вибрано неструктурований документ). У списку будуть відображені всі типи документів, закріплені за обраною компанією.

Тільки після заповнення усіх полів на формі з’явиться кнопка Створити документ.

Якщо обраний структурований тип документа, після збереження з’явиться форма для заповнення полей структурованого документу.

_images/instruktsia_korystuvacha_obminy_paketami_104.png

Створений документ відобразиться у вкладці «Мої Чернетки».

Зверніть увагу!

Якщо у списку немає необхідного типу документу, зверніться до бізнес-адміністратора вибраної компанії та попросіть створити тип у «Мої компанії -> Внутрішні документи компанії». Якщо при створенні явилася помилка «Не налаштоване правило узгодження документа» - потрібно налаштувати документ у розділі «Налаштування узгодження -> Узгодження».

Документ у розділі можна відмітити й Підписати (за необхідності), Надіслати, або Видалити за допомогою відповідних кнопок. Також можливо скачати/переглянути документ, або переглянути додаткову інформацію про документ та підписи сторін.

_images/instruktsia_korystuvacha_obminy_paketami_105.png

Відправлений документ відобразиться у вкладці «Мої відправлені документи» з актуальним статусом.

Відправлений документ з’явиться у розділі «Мої завдання» у людини яка вказана у Узгоджені типу документу, з напрямком Внутрішній документ.

Для кожного типу документа процес узгодження налаштовується окремо. Для налаштування правил і послідовності процесу узгодження перейдіть до розділу «Налаштування узгодження» - «Узгодження». В розділі списком будуть відображені вже створені процеси узгодження по всіх компаніях, доступних користувачеві за маршрутом і роллю.

9 Візуалізація ЕЦП

У підписаних документах без шифрування та у форматі PDF відображається візуалізація ЕЦП у листі підписання при скачуванні архіва.

Обовязкова умова - увімкнути ознаку «Відображати штамп ЕЦП» для документу, детальніше - у пункті Налаштування доступу для провайдера.

Внизу сторінки листа підпису буде відображено штамп «Документ підписаний…» та вказано id документа.

_images/instruktsia_korystuvacha_obminy_paketami_114.png

У листі підписання з архіву,у тому числі відображається основна інформація по документу, а також про підписантів, та загальна інформація про електронний документ з Електроннім цифровим підписом.

_images/instruktsia_korystuvacha_obminy_paketami_list_114.png

Також, у структурованому документі, в формі перегляду редагування структурованого документа (внизу форми) відображається інформація про підпис, а саме поле «Власник», поле «ЄДРПОУ» та поле «Посада».

Підпис в структурованому документі відображається:

  • в комплекті

  • в розділі «Внутрішній документообіг»

  • в задачі на узгодження

10 Багатоступеневе узгодження за допомогою ієрархічних довідників

Використання ієрархічних довідників полегшує узгодження документів в комплекті. Ієрархічні (або древовидні) довідники дозволяють застосовувати до одного типу документа різні маршрути узгодження. Різні типи документів мають різних узгоджувачів - наприклад, бухгалтера, менеджера напрямку, директора. Один раз налаштувавши маршрути, документи завжди будуть надходити до правильного Узгоджувача.

Налаштування на стороні одержувача комплекта

Налаштування маршруту узгодження проводиться на стороні отримувача комплекта. Для цього необхідно:

  1. Створити ієрархічний довідник. Меню «Налаштування компанії» → «Мої компанії» → відкрити форму редагування компанії (кліком по назві) → вкладка «Довідники» → кнопка «Створити». Додайте необхідні значення.

_images/instruktsia_korystuvacha_obminy_paketami_115.png

  1. Зв’язати довідник з типом документа. Перейти у вкладку «Документи» → натиснути на іконку «Зв’язок з довідником» (у виді ланцюжка) і вибрати потрібний довідник зі списку.

_images/instruktsia_korystuvacha_obminy_paketami_116.png

  1. Додати документ в налаштування узгодження, вказавши фінальні значення довідника. Меню «Управління доступом» → «Налаштування етапів узгодження» → вкладка «Типи документа». Виберіть тип документа й значення. Детальніше про налаштування узгодження в інструкції «Узгодження».

_images/instruktsia_korystuvacha_obminy_paketami_117.png

Налаштування на стороні відправника комплекта (контрагент)

При відпраці комплекта, контрагентам більше не потрібно шукати та вказувати відповідних узгоджувачів для різних документів, а просто вибрати потрібні значення при відпраці комплекта. Для цього:

  1. У комплекті по кожному файлу документа заповнити значення довідників до «фінальних» і відправити комплект.

_images/instruktsia_korystuvacha_obminy_paketami_118.png

11 Копіювання комплекту с документами, позначеними для редагування

У Налаштування - Налаштування комплектів документів, при додаванні звязку комплекта з типами документів можливо налаштувати правила роботи з документом.

Для зручності користувачів на платформі, та простішого обміну структурованими документами, реалізована можливість копіювання і редагування документів отриманих від контрагента.

Якщо обрано структурований документ та без відмітки «Довкладення отримувача», можливо встановити відмітку «Документ дозволений для редагування партнером».

_images/instruktsia_korystuvacha_obminy_paketami_119_1.png

Даний функціонал дозволяє вашому партнеру редагувати отриманий документ. Дозволяючи вам, тим самим, відправити структурованний документ партнеру для довнесення інформації.

Це зручно якщо ви хочете отримувати документи лише певного вигляду та структури, а також зручно для партнерів тим, що можна просто скопіювати документи й заповнити необхідні поля, без необхідності налаштовувати структуру.

Усі документи з відміткою «Документ дозволений для редагування партнером» буде позначено у комплекті спеціальною іконкою зі спливаючою підказкою, а також додано примітку у блоці Додаткова інформація.

_images/instruktsia_korystuvacha_obminy_paketami_119.png

Отримувач вхідного комплекта з такими документами може створити копію комплекту документів за допомогою відповідної кнопки Створити у відповідь копію. Новий створений комплект буде збережено у Чернетках.

У новому комплекті у вкладці «Документи» відображаються тільки документи з ознакою «Дозволений для редагування партнером» в статусі «Новий» - отримувач може редагувати структуровані документи, тобто заповнити їх інформацією.

До скопійованих типів документів застосовуються усі налаштування правил роботи з документом з комплекта-основи. Наприклад необхідна кількість підписів ініціатора і клієнта, допустима кількість файлів та термін підписання. Партнер не зможе редагувати налаштування. Номер комплекта-основи зберігається у вкладці «Основна інформація» при опрацюванні комплекту.

Зверніть увагу!

У скопійованих документах зберігається налаштування Терміну підписання документа отримувачем. Після закінчення терміну, партнер не зможе підписати документ, але зможе скопіювати, та надіслати у відповідь з ідентичним терміном підписання.

У вкладках «Довідники» й «Користувацькі поля» зберігаються налаштування комплекту-основи. Журнал комплекту-основи не зберігається. Неможливо прикріпити довкладення.

Служба Технічної Підтримки

Інструкція з налаштування шифрування

Дана інструкція описує порядок налаштування сертифікатів для шифрування.

1 Авторизація в системі

Для авторизації на платформі перейдіть за посиланням http://doc.edi-n.com/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

2 Завантаження сертифіката

Для завантаження сертифіката перейдіть до розділу меню «Особистий кабінет» – «Сертифікати» та натисніть «Завантажити сертифікат»:

_images/foto1-3.png

Система повідомить про успішне завантаження, після чого сертифікат з’явиться у переліку завантажених сертифікатів. За сертифікатом відображатиметься серійний номер, код ЄДРПОУ організації, назва та дата закінчення дії. Завантаження сертифікатів після закінчення строку їх дії блокується системою.

_images/foto2-3.png

Для перегляду детальнішої інформації за сертифікатом натисніть на його серійний номер:

_images/foto3-3.png

Для повернення з форми деталізації до переліку сертифікатів натисніть на кнопку «Назад»:

_images/foto4-3.png

2.1 Налаштування зв’язку з сертифікатом

Для налаштування зв’язку сертифіката з конкретною компанією виберіть на навігаційній панелі меню «Налаштування компанії» – «Мої компанії», відкрийте форму обробки компанії, натиснувши на її назву, та перейдіть до розділу «Сертифікати». Наступним кроком натисніть «Додати зв’язок» та «Прив’язати», обравши сертифікат з переліку доступних, що відображені системою:

_images/foto5-3.1.png _images/foto6-3.1png

Опція завантажити сертифікат присутня також безпосередньо у формі налаштування зв’язку. Для завантаження сертифіката натисніть «Завантажити сертифікат» або «Завантажити новий».

2.2 Видалення сертифіката

Для видалення сертифіката натисніть на кнопку «Кошик» напроти обраного сертифіката:

_images/foto7-3.2.png

Для одночасного видалення декількох сертифікатів відмітьте обрані для видалення сертифікати та натисніть кнопку «Видалити виділені»:

_images/foto8-3.2.png

Опція видалення доступна також безпосередньо у формі детальної інформації за сертифікатом:

_images/foto9-3.2.png
Служба Технічної Підтримки

Інструкція з налаштування структурованого документа

Дана інструкція описує налаштування та порядок роботи з структурованим документом.

1 Авторизація в системі

Для авторизації на платформі перейдіть за посиланням https://doc.edi-n.com/auth та введіть свої логін = email і пароль на формі авторизації. Детальна інформація з авторизації міститься в «Інструкції з авторизації».

2 Налаштування структурованого документа

У межах документообігу EDIN-DOCflow, поряд із неструктурованими (звичайними) документами, реалізована можливість передачі структурованих (XML) документів у комплекті. Визначення типу документа як структурованого відбувається на етапі налаштування типів документів у межах компанії.

Для налаштування структурованого документа перейдіть в меню «Налаштування компанії» – «Мої компанії» та оберіть потрібну компанію зі списку, натиснувши на її назву. У формі редагування, що відкриється, перейдіть до вкладки «Документи». Вкладка містить вже закріплені за компанією типи документів. Для додання нового документа з ознакою «Структурований» натисніть на кнопку «Додати»:

_images/instr_struct_doc_1.png

У формі додання типу документа заповніть обов’язкові поля:

  • Назва – поле призначене для введення літер, цифр або спеціальних символів, мінімальна кількість знаків – три

  • Код - поле призначене для введення літер, цифр або спеціальних символів, мінімальна кількість знаків – один. Значення, введене в поле «Код», має бути унікальним у межах компанії. У разі введення значення, що вже використовується, система відобразить відповідне повідомлення.

Наступним кроком встановіть відмітку напроти типу документа, а саме «Структурований», і натисніть «Зберегти»:

_images/instr_struct_doc_2.png

Документ буде збережено та відображено в переліку типів документів з позначкою «Структурований» иконка-кубик:

_images/instr_struct_doc_3_02.png

Для редагування назви або коду типу документа натисніть на його назву у загальному переліку, внесіть потрібні зміни та натисніть «Зберегти».

2.1 Опис (налаштування) структури документа

Для опису і зберігання структури документа використовується текстовий формат JSON. Параметри, що прописуються у налаштуваннях структури, визначають порядок відображення на web-формі елементів структури документа і правила їх заповнення.

При описі структурованого документа використовуються певні типи даних, кожен з яких є окремим типом елемента і описується у вигляді окремої структури зі своїм переліком параметрів, наприклад:

_images/json.png

Основні параметри, що використовуються при описі структурованого документа:

  • 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:

Функції:

  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": []
  }
}]

  1. arithmeticOperate - виконує математичні операції по вже введених інших полях. Шаблон: $arithmeticOperate(resultPath: string, sourcePath1: string, operationType: string, sourcePath2: string)$, де

  • resultPath - шлях до елементу структурованого документа в який потрібно записати результат;

  • sourcePath1 - шлях до елементу структурованого документа в якому міститься перший аргумент для арифметичної операції;

  • operationType - вид операції, можливі значення «+», «-«, «/», «*»;

  • sourcePath2 - шлях до елементу структурованого документа в якому міститься другий аргумент для арифметичної операції (sourcePath2 може бути відсутнім);

Зверніть увагу!

Важливо! У разі, якщо схема документа створена з використанням типу даних enum, для відображення значень довідника в структурованому документі необхідно вказати «type»: {«enum»: []}}.

Для завантаження (внесення) опису структури документа натисніть на іконку «Структурований»:

_images/instr_struct_doc_4.png

У формі, що відкриється, натисніть на кнопку «Додати»:

_images/instr_struct_doc_5.png

Наступним кроком введіть опис структури документа у форматі JSON, оберіть кодування xml для документа і натисніть «Зберегти»:

_images/instr_struct_doc_6.png

Система повідомить про успішне збереження відповідним повідомленням. Під час збереження опису структури відбувається перевірка валідності внесених даних на відповідність формату JSON та перевірка на дублі.

Перевірка елементів структурованого документа при збереженні:

_images/instr_struct_doc_validation2.png

У разі внесення не коректних даних кнопка «Зберегти» не активується. При внесенні дублюючого опису користувачеві буде відображене відповідне повідомлення. Перевірка на дублі виконується у межах компанії.

Збереження опису структури відбувається по версіях створення. Номер версії присвоюється автоматично. Система також фіксує дату та час модифікації кожної версії.

Під версією мається на увазі збереження певної модифікації опису структури. Система передбачає можливість роботи з різними модифікаціями одного типу документа за рахунок активації тієї чи іншої версії структури даних. Не активована схема зберігається у статусі «Чернетка».

_images/instr_struct_doc_7.png

Схема у статусі «Чернетка» доступна для редагування. Для переходу у режим редагування натисніть на номер версії иконка-дата або на кнопку «Редагувати». Для активації певної версії структури натисніть «Активувати» у формі редагування опису даних:

_images/instr_struct_doc_8.png

Для зручності у формі додання версій реалізований пошук за номером і датою. Для старту пошуку введіть початкові символи у пошукове поле:

_images/instr_struct_doc_9.png

Зверніть увагу!

У статусі «Активний» і «Чернетка» може бути лише одна версія структури.

3 Налаштування зв’язку структурованого документа з типом комплекта

Налаштування виконується на загальних підставах. Детальний опис процедури в пункті 8 «Інструкції бізнес-адміністратора».

4 Заповнення структурованого документа

Форма заповнення структури відкривається при доданні документа з ознакою «структурований» до комплекта. Для цього перейдіть в меню «Зовнішні комплекти документів», у вкладці Чернетки виберіть комплект та в ньому перейдіть до вкладки «Документи», і натисніть «Додати»:

_images/instr_struct_doc_10.png

Після цього відкриється форма для заповнення структурованого документа, складена відповідно до опису його структури.

Елементи структури документа відображаються послідовно, у порядку, заданому в налаштуваннях структури. При цьому типи елемента (секції) відображаються у вигляді окремих структур, складові компоненти яких розташовуються горизонтально по три в ряд. Назва структури (типу елемента) виділяється жирним шрифтом:

_images/instr_struct_doc_11.png

Заповніть поля документа і натисніть кнопку «Зберегти». Для повторного перегляду збереженого структурованого документа в комплекті натисніть на іконку иконка-кубик напроти документа:

_images/instr_struct_doc_12.png

5 Блокування типу документа

Для блокування типу документа оберіть потрібний тип з переліку закріплених за компанією, меню «Налаштування компанії» – «Мої компанії» – «Документи», та переведіть перемикач у положення «Заблокувати»:

_images/instr_struct_doc_13.png

Тип документа буде переведений у статус «Заблокований». Даний статус блокує використання типу документа у будь-яких операціях з моменту призначення статусу.

Служба Технічної Підтримки

API

Видалення тега з контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_tag?contract_id=2445&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Видалення тега з комплекту документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json; (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/tag?package_id=7511&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

Видалення тегу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

text/plain; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tag?tag_id=447

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

tagId - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі у тіло запиту відсутнє (дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

Отримання данних сертифікату компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/bdoc/certificate?certificate_id=18

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

certificate_id - ID сертифікату

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Отримання списку сертифікатів компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/certificates

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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
  }
]

Отримання списку всіх ярликів фільтрів

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній filterId, то запис з зазначеним filterId підлягає редагуванню.

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/filters

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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
  }
]

Підписання документа за допомогою MobileID

Увага

Підписання з допомогою MobileID відбувається в два кроки:

  1. Користувачу необхідно відправити запит що містить документ на підпис. В відповідь на запит приходить ID транзакції.

  2. Користувачу необхідно відправити ID з пункта 1, й отримати тіло підпису , використовуючи метод {url сервера}/bdoc/mobile_sign.

Крок 1. Отримання ID транзакції

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/form-data (бінарні данні в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/mobile_sign

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Параметри в тілі HTTP запиту/відповіді

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. Отримання тіла підпису

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/octet-stream (бінарні данні в тілі HTTP відповіді)

URL запиту

https://doc.edi-n.com/bdoc/mobile_sign?msisdn=380667901456&=16

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

msisdn - номер телефону

trans_id - ID транзакції
JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається набір байт .p7s файл тіла підпису.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається набір байт .p7s файл тіла підпису.

Отримання списку тегів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tags

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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"
  }
]

Закінчення сессії користувача

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/logout

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

RESPONSE

При використанні методу json-тіло відповіді відсутнє, в результаті сесія активного користувача завершена

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

При використанні методу json-тіло відповіді відсутнє, в результаті сесія активного користувача завершена

Створення / редагування ярлика фільтра

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній filterId, то запис з зазначеним filterId підлягає редагуванню.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/filter

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

filterName; periodType; dateFrom; dateTo;

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Зміна статусу документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

multipart/form-data (тіло запиту в form-data в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/document/status

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Отримання списку всіх документів своєї компанії та компанії контрагента

Для роботи з цим методом користувач повинен бути авторизованим .

Метод використовується для отримання списку документів при налаштуванні процесу узгодження.

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

В тілі відповіді передається список документів з ID процесу узгодження для компанії-власника процесу узгодження (тої, що визначається параметром agreement_company_id)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

В тілі відповіді передається список документів з ID процесу узгодження для компанії-власника процесу узгодження (тої, що визначається параметром agreement_company_id)

Отримання списку користувачів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/users?status=0&limit=30

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Опціональні url-параметри (фільтр)

search_pattern - пошук по ПІБ та email

limit - ліміт вибірки (за замовчуванням=20)

offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0)

status - статус користувача (0-всі; 1-активний; 2-заблокований)

JSON-параметри в тілі HTTP запиту/відповіді

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": {}
  }
]

Отримання списку ролей

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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
  }
]

Отримання списку сертифікатів MobileID

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/mobile_certs?msisdn=380667901456

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

msisdn - номер телефону

JSON-параметри в тілі HTTP запиту/відповіді

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"
    ]
  }
]

Отримання типу комплекта документів по контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Викликати цей метод можуть лише одна з компаній контракту (клієнт или власник).

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/extra/contract/package_type?contract_id=111&package_id=58

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

package_id - ID комплекту документів

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
]

Отримання тіла документа

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається документ в вигляді набору байт.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається документ в вигляді набору байт.

Отримання тіла підпису

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається .p7s файл тіла підпису.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається .p7s файл тіла підпису.

Авторизація

Для роботи з API користувачу для авторизації потрібні логін (email) та пароль. Авторизація API відбувається за допомогою передачі цих ключових параметрів в двох HTTP 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)

Метод запиту

HTTP POST

Content-Type

multipart/form-data (елементи запиту передаются в інтерфейсі form-data)

URL запиту

https://doc.edi-n.com/bdoc/auth_uuid

Параметри, що передаються в URL (разом з адресою методу)

-//-

При авторизації і тілі запиту обов’язково передається наступний параметр:

email=[електронна пошта користувача]

При успішній авторизації отримуємо у відповідь «токен авторизації», необхідний для подальшої роботи:

{
  "isCaptcha": false,
  "token": "1ebe6825-0d1f-4577-a8d7-472650ce86b0"
}

isCaptcha - ознака відображення капчі для користувача

token - токен авторизації

Авторизація (крок 2)

Метод запиту

HTTP POST

Content-Type

multipart/form-data (елементи запиту передаются в інтерфейсі form-data)

URL запиту

https://doc.edi-n.com/bdoc/auth

Параметри, що передаються в URL (разом з адресою методу)

-//-

В тілі запиту обов’язково передаються наступні параметри:

token=[токен авторизації]
password=[пароль користувача]

При успішній авторизації отримуємо у відповідь на запит: код відповіді сервера 200 (ok)

Створення/редагування структурованого документа

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/document

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Створення/редагування групи користувачів узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній groupId, то група з зазначеним Id підлягає редагуванню. Відсутність параметра groupId веде до створення нової групи.

Увага

Додавання / видалення користувачів виконується шляхом перезатирання - залишаються тільки ті користувачі (передаються списком), userId котрих були передані в останньому запиті!

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/agreement_group

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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": "Юридический отдел"
}

Отримання конкретної группи узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/agreement_group?agreement_group_id=301

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

agreement_group_id - ID групи узгодження (groupId)

JSON-параметри в тілі HTTP запиту/відповіді

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": "Юридический отдел "
}

Отримання списка групп користувачів для узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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": "Бухгалтерия"
  }
]

Отримання списку процесів узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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
  },
]

Отримання списку довідників компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionaries?company_id=1313

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_id - ID компанії

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
]

Отримання довідника компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionary?dictionary_id=719

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

dictionary_id - ID довідника

JSON-параметри в тілі HTTP запиту/відповіді

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 файлу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionary/xlsx?dictionary_id=719

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

dictionary_id - ID довідника

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається згенерований по шаблону .xlsx файл з інформацією довідника.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається згенерований по шаблону .xlsx файл з інформацією довідника.

Отримання списку всіх документів на рівні компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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": []
    }
]

Отримання файлу договору-оферти

Для роботи з цим методом користувач повинен бути авторизованим .

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається файл договору-оферти.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У цьому методі у відповідь передається файл договору-оферти.

Отримання даних користувача по ID

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/user?user_id=683

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

user_id - ID користувача

JSON-параметри в тілі HTTP запиту/відповіді

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": {}
}

Зміна статусу процесу узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Блокування / активація користувача

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/user?user_id=697&status=1

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

user_id - ID користувача

status - статус (активація = 1, блокування = 2)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Завантаження значень довідника в .xlsx файл

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionary_values/xls?dictionary_id=117

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

dictionary_id - ID довідника

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

RESPONSE

У відповідь передається згенерований по шаблону .xlsx файл зі значеннями довідника

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається згенерований по шаблону .xlsx файл зі значеннями довідника

Створення компанії з КЕП/ЕЦП

Для роботи з цим методом користувач повинен бути авторизованим .

Увага

Створення компанії з КЕП/ЕЦП відбувається в два кроки:

  1. Користувачу необхідно отримати унікальний UUID (метод {url сервера}/bdoc/sign_auth_uuid). Далі отриманий UUID необхідно підписати ЕЦП - зовнішнє підписання, в результаті якого користувач отримує .bin-файл.

  2. Користувачу необхідно відправити отриманий .bin-файл (пункт 1), використовуючи метод {url сервера}/bdoc/company_from_sign.

Отримання UUID (крок 1)

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/sign_auth_uuid

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

В результаті успішного запиту отримуємо у відповідь «UUID» у вигляді рядка. UUID необхідно підписати ЕЦП, в результаті підписання якого користувач отримує .bin-файл.

Створення компанії (крок 2)

Метод запиту

HTTP POST

Content-Type

application/binary/json (тіло запиту передається в бінарному вигляді, тіло відповіді в json форматі)

URL запиту

https://doc.edi-n.com/bdoc/company_from_sign

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Параметри HTTP запиту/відповіді

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)

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/sign_auth_uuid

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

В результаті успішного запиту отримуємо у відповідь «UUID» у вигляді рядка. UUID необхідно підписати ЕЦП, в результаті підписання якого користувач отримує .bin-файл.

Оновлення компанії (крок 2)

Метод запиту

HTTP POST

Content-Type

application/binary/json (тіло запиту передається в бінарному вигляді, тіло відповіді в json форматі)

URL запиту

https://doc.edi-n.com/bdoc/company/approve

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_id - ID компанії
Параметри HTTP запиту/відповіді

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": []
    }
  ]
}

Створення/редагування компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/company

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

type, name, code

JSON-параметри в тілі HTTP запиту/відповіді

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": []
    }
  ]
}

Створення ролі

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/role

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

companyId, name, code

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Додавання (прив’язка) контракту до маршруту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/route/contracts?route_id=251

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

route_id - ID маршруту

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В json-тілі запиту передається масив id контрактів.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

[
  5087,
  2109,
  2110
]

У відповідь передається код сервера 200 (ok)

Додавання (прив’язка) типу комплекта документів до маршруту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/package_route/package_type?company_id=989&route_id=251

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_id - ID компанії

route_id - ID маршруту

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В json-тілі запиту передається масив id типів комплектів документів.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

[
  5087,
  2109,
  2110
]

У відповідь передається код сервера 200 (ok)

Видалення прив’язки контракту до маршруту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/route/contracts?route_id=251

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

route_id - ID маршруту

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В json-тілі запиту передається масив id контрактів.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

[
  5087,
  2109,
  2110
]

У відповідь передається код сервера 200 (ok)

Видалення прив’язки типу комплекта документів до маршруту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com//bdoc/package_route/package_type?route_id=251

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

route_id - ID маршруту

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В json-тілі запиту передається масив id типів комплектів документів.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

[
  5087,
  2109,
  2110
]

У відповідь передається код сервера 200 (ok)

Редагування прив’язки між маршрутом та користувачем

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/route/users

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

routeId, isOwner, userId

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Створення/редагування довідника

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній dictionaryId, то довідник з зазначеним Id підлягає редагуванню. Відсутність параметра dictionaryId веде до створення нового довідника.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionary

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Створення комплекта документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

contractId, packageId наприклад: {«contract»:{«contractId»:55},»packageType»:{«packageId»:59}}

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Створення запиту на формування Аналітичного звіту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/report

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

reportType (визначає тип звіту), reportName, companyId, reportStartDate, reportEndDate

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
}

Отримання документу (в вигляді архіву)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/document/arch

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

body_id - ID тіла документу

package_id - ID комплекта документів

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається архів, який містить указаний в запиті оригінальний документ, а також підпис і лист підписання (за наявності підпису).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У цьому методі у відповідь передається архів, який містить указаний в запиті документ.

Отримання комплекту документів (пакету)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекта

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Отримання списку партнерів-контрагентів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/partners

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Опціональні url-параметри (фільтр)

search_pattern - код ЕДРПОУ або назва компанії

limit - ліміт вибірки (за замовчанням=20)

offset - зміщення відносно верхньої межі вибірки (за замовчанням=0)

is_registered - відмітка про те, що контрагент зареєстрований на платформі DOCflow; 1 - так, 0 - ні

JSON-параметри в тілі HTTP запиту/відповіді

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
  },
]

Отримання файлу-звіту Аналітики

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/report_file

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

report_id - ID звіту

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь повертається файл звіту в форматі Excel (* .xls)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь повертається файл звіту в форматі Excel (* .xls)

Отримання списку запитів на формування Аналітичного звіту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/reports

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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": []
    }
  }
]

Додавання (прив’язка) довідника до типу документа

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

Створення / редагування аккаунту

Для роботи з цим методом користувач повинен бути авторизованим .

Примітка

Редагування тільки якщо adminAccountId НЕ = 0. При adminAccountId = 0 створюється новий акаунт.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/account

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Важливо

При кожному виконанні запиту виконується «перезапис» всіх параметрів аккаунту доступних до редагування. Значення наведених нище параметрів, якщо не будуть передані при запиті в цьому методі - видаляються!!!

  • companyId, whiteList, decryptType, cryptexServer, mfo, paymentAccount, fullName, phone, email, addInfo, dirPosition, activityBase

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт 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 категорії аккаунта (для уточнення в випадку дублів)

RESPONSE

У відповідь передаються дані аккаунта (об’єкт Account).

Приклади

Приклад тіла запиту в 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": []
}

Приклад тіла відповіді в 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": []
}

Додавання / редагування партнера-контрагента

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/partner

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

code, name, contactEmail

JSON-параметри в тілі HTTP запиту/відповіді

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 файлу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/partners

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в тілі запиту передається .xls/.xlsx файл у вигляді масиву байт. Файл повинен відповідати шаблону:

Завантажити шаблон

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

В цьому методі в тілі запиту передається .xls/.xlsx файл у вигляді масиву байт. Файл повинен відповідати шаблону:

Завантажити шаблон

У відповідь передається код сервера 200 (ok)

Створення / редагування тегів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tag

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Важливо

Редагування тегу відбувається аналогічним запитом за допомогою перезапису даних, обов’язково при цьому вказувати tagId!

JSON-параметри в тілі HTTP запиту/відповіді

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 файлу на платформу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

text/plain; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tag/xls

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі у тіло запиту передається згенерований по шаблону .xlsx файл зі значеннями тегів.

Файл повинен відповідати шаблону:

Завантажити шаблон

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

Завантаження сертифікату безпеки

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

multipart/form-data (тіло запиту в form-data в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/certificate

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В тілі запиту в form-data передається файл з бінарними данними сертифікату.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

В тілі запиту в form-data передається файл з бінарними данними сертифікату.

У відповідь передається код сервера 200 (ok)

Додавання (прив’язка) тега до контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_tag?contract_id=2445&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Додавання тега до комплекту документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/tag?package_id=7511&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

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"
  }
]

1. Створення / редагування тегів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tag

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Важливо

Редагування тегу відбувається аналогічним запитом за допомогою перезапису даних, обов’язково при цьому вказувати tagId!

JSON-параметри в тілі HTTP запиту/відповіді

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"
}

2. Отримання списку тегів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tags

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані тегу (об’єкт Tag).

Таблиця 2 - Опис параметрів об’єкта Tag

Параметр

Формат

Опис

tagId

long

ID тегу

name

String

назва тегу

code

long

унікальний код, якщо не передано створиться автоматично

Приклади

При використанні методу 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"
  }
]

3. Експорт тегів з .xlsx файлу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

text/plain; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tag/xls

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі у тіло запиту передається згенерований по шаблону .xlsx файл зі значеннями тегів.

Файл повинен відповідати шаблону:

Завантажити шаблон

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

В цьому методі у тіло запиту передається згенерований по шаблону .xlsx файл зі значеннями тегів.

У відповідь передається код сервера 200 (ok)

4. Додавання (прив’язка) тега до контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_tag?contract_id=2445&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

5. Додавання (прив’язка) тега до комплекту документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

text/json; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/tag?package_id=7511&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані прив’язаних тегів (об’єкт Tag).

Таблиця 2 - Опис параметрів об’єкта Tag

Параметр

Формат

Опис

tagId

long

ID тегу

name

String

назва тегу

code

long

унікальний код, якщо не передано створиться автоматично

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі

[
  {
    "tagId": 293,
    "name": "Ривермол 1",
    "code": "43274dec45704dbe9340831896a557fd"
  },
  {
    "tagId": 409,
    "name": "Альбатрос",
    "code": "6418c44baec34df7bc17a66a1989fa1a"
  }
]

6. Видалення тегу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

text/plain; charset=UTF-8 (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/tag?tag_id=447

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

tagId - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі у тіло запиту відсутнє (дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

7. Видалення тега з контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json, text/plain (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_tag?contract_id=2445&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

8. Видалення тега з комплекту документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json; (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/tag?package_id=7511&tag_id=409

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекту

tag_id - ID тегу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

Редагування профілю користувача

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/user-profile

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

notShowWizard, language

Важливо

У цьому методі при запиті змінюються лише 2 обов’язкові параметри - notShowWizard, language, інші параметри, навіть якщо передати інші значення, ніяк не змінюються!

JSON-параметри в тілі HTTP запиту/відповіді

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)

Додавання документа в комплект документів (в пакет)

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Логіка виконання методу може мінятися: якщо «Header» відсутній, у відповідь на успішний запит прийдуть дані по всьому комплекту документів (пакету) - об’єкт Package; якщо ж в «Header» запиту вибрати (передати) один з response-object-type, то:

  • uuid - GUID документа; у відповідь на успішний запит прийде тільки GUID документа (documentUuid);

  • document - дані документів; у відповідь на успішний запит прийде тільки об’єкт з даними документа (DocumentStore)

Метод запиту

HTTP PUT

Content-Type

application/form-data/json (тіло HTTP запиту в form-data /тіло відповіді в json форматі)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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"
}

Додавання підпису до документу по GUID документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/form-data/json (тіло HTTP запиту в form-data/тіло відповіді в json форматі)

URL запиту

https://doc.edi-n.com/bdoc/store/package/document/upload_sign_by_uuid

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_uuid - GUID документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в form-data запиту передається файл тіла підпису до документа (один або кілька файлів).

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok)

Додавання підпису до документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/form-data/json (тіло HTTP запиту в form-data /тіло відповіді в json форматі)

URL запиту

https://doc.edi-n.com/bdoc/store/package/document/sign

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

body_id - ID тіла документу

package_id - ID комплекта документов (пакета)

JSON-параметри в тілі HTTP запиту/відповіді

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"
}

Зміна статусу контрагента-партнера (статус: відправлено запрошення)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/partner/status

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

partnerId

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В тілі запиту передається масив мінімум з одним параметром id контрагента-партнера (partnerId)

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

Приклад тіла запиту (json):

[
  561651651,
  849494984,
  9849848
]

У відповідь передається код сервера 200 (ok)

Додавання (прив’язка) типу комплекта документів до документу

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Для активації комплекта документів достатньо додати документ - це є обов’язковою умовою, без документа користувач отримує повідомлення про помилку з проханням додати документ.

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/package_document

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

packageId, documentId

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
}

Відправка запрошення контрагенту-партнеру

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/form-data (тіло запиту/відповіді в форматі form-data в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/partner/invitation

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (form-data)

partner_id - id контрагента партнера

contract_template_id - id шаблону контракту АБО owner_company_id - id компанії від якої відправляється запрошення

Примітка

Для інтегрованих користувачів можливо відправити запрошення без шаблону контракту. Для цього необхідно передати id компанії, від якої Запрошення буде надіслано. Контрагенту в такому випадку приходить тільки запрошення на реєстрацію від зазначеної компанії з посиланням для реєстрації.

JSON-параметри в тілі HTTP запиту/відповіді

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).

Отримання даних аккаунту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/account

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Масова реєстрація аккаунтів

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

У кожного аккаунта повинна бути хоча б одна компанія і один користувач. На підставі отриманих даних в системі будуть створені аккаунти, компанії і користувачі. Всі користувачі, будуть відзначені, як власники аккаунта, компанії не підтверджені ЕЦП.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc_admin/register_account_list

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

accName, companies, users, edrpou, inn, name, ownType, email, fio

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API

Параметр

Mandatory/Optional

Формат

Опис

accName

M

long

назва компанії

companies

M

List<Company>

масив об’єктів з даними компанії

users

M

List<User>

масив об’єктів з даними користувача

Таблиця 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_>

масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 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_>

масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

RESPONSE

Таблиця 3 - Опис json-параметрів відповіді метода API

Параметр

Формат

Опис

accName

long

назва компанії

companies

List<Company>

масив об’єктів з даними компанії

users

List<User>

масив об’єктів з даними користувача

handleResult

повідомлення щодо дії запиту;

created - «1» створено / «0» - не створено

error - опис помилки, якщо created = «0»

додається в кожний json елемент компанії

Приклади

Приклад тіла запиту (json):

{
[
  {
    "accName": "Летюд ТОВ",
    "companies": [
      {
        "edrpou": "1212",
        "inn": "1243546556",
        "name": "Летюд",
        "ownType": "ТОВ"
      },
      {
        "edrpou": "435465",
        "inn": "124354653454556",
        "name": "Летюдewewe",
        "ownType": "ТОВ"
      }
    ],
    "users": [
      {
        "email": "test@test",
        "fio": "Иванов Иван"
      },
      {
        "email": "test2@test2",
        "fio": "Иванов2 Иван2"
      }
    ]
  },
  {
    "accName": "ФОП Сокол О.В.",
    "companies": [
      {
        "edrpou": "343434",
        "inn": "3435467",
        "name": "Сокол О.В.",
        "ownType": "ФОП"
      }
    ],
    "users": [
      {
        "email": "sokolov@test",
        "fio": "Иванов Иван"
      }
    ]
  }
]
}

Приклад тіла відповіді (json):

{
[
    {
        "accName": "Летюд ТОВ",
        "companies": [
            {
                "edrpou": "1212",
                "inn": "1243546556",
                "name": "Летюд",
                "ownType": "ТОВ"
            },
            {
                "edrpou": "435465",
                "inn": "124354653454556",
                "name": "Летюдewewe",
                "ownType": "ТОВ"
            }
        ],
        "handleResult": {
            "created": 1
        },
        "users": [
            {
                "email": "test@test",
                "fio": "Иванов Иван",
                "handleResult": {
                    "created": 1
                }
            },
            {
                "email": "test2@test2",
                "fio": "Иванов2 Иван2",
                "handleResult": {
                    "created": 1
                }
            }
        ]
    },
    {
        "accName": "ФОП Сокол О.В.",
        "companies": [
            {
                "edrpou": "343434",
                "handleResult": {
                    "created": 0,
                    "error": "compnay allready exisrts"
                },
                "inn": "3435467",
                "name": "Сокол О.В.",
                "ownType": "ФОП"
            }
        ],
        "handleResult": {
            "created": 1
        },
        "users": [
            {
                "email": "sokolov@test",
                "fio": "Иванов Иван",
                "handleResult": {
                    "created": 1
                }
            }
        ]
    }
]
}

Зміна налаштувань підписання в аккаунті

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc_admin/account/sign_settings

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Примітка

1 довідник можна прив’язати до декількох документів. До 1 документу можна прив’язати тільки 1 довідник.

JSON-параметри в тілі HTTP запиту/відповіді

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)

Відкрити доступ провайдеру до документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/document_type/provider_access

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

access - доступ (завжди=1); 1 - так, 0 - ні

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Отримання списку типів комплектів документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/extra/package_types

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_id - ID компанії

Опціональні url-параметри

status - ID статусу комплекта документів («1 - Активний; 2 - Заблокований; 3 - Чернетка»)

search_pattern - пошук по признаку типу комплекта документів (фільтр)

JSON-параметри в тілі HTTP запиту/відповіді

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 форматі

додати приклад

Отримання списку типів документів у вигляді .xlsx файлу

Для роботи з цим методом користувач повинен бути авторизованим .

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається згенерований по шаблону .xlsx файл зі списком документів

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається згенерований по шаблону .xlsx файл зі списком документів

Вивантаження списку типів документів з .xlsx файлу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/document_types

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

Опціональні url-параметри:

use_type - тип документообігу („1 - external use (зовнішній), 2 - internal use (внутрішній)“)

JSON-параметри в тілі HTTP запиту/відповіді

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
  }
]

Отримати внутрішній документ в вигляді архіву

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-documents/arch

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається файл-архів (масив байтів).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається файл-архів (масив байтів).

Збереження підпису внутрішнього документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-document/sign

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

JSON-параметри в тілі HTTP запиту/відповіді

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)

Отримання тіла внутрішнього документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-documents/body

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь на запит передається файл в *.xml (структурований документ) чи іншому форматі, в якому був відправлений НЕструктурований документ.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь на запит передається *.xml файл.

Отримання інформації по документу в задачі на узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/task/doc-info

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

task_id - ID задачі

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Отримання інформації по внутрішньому документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-document/info

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Отримання структури внутрішнього документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-document/structure

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Отримання списку внутрішніх документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-documents

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

folder - вибір каталога користувача (1- draft (чернетки), 2-sent (відправлені документи))

JSON-параметри в тілі HTTP запиту/відповіді

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
  }
]

Створення внутрішнього структурованого/НЕструктурованого документу

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/form-data (тіло запиту/відповіді в форматі form-data в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/internal-document

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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).

Активувати / Заблокувати значення довідника

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Метод дозволяє заблокувати чи активувати значення довідника в залежності від значення параметра is_active=0 / is_active=1

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

Заблокувати значення довідника

https://doc.edi-n.com/bdoc/dictionary_value?dictionary_id=445&value_id=755&is_active=0

Активувати значення довідника

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Активувати / Заблокувати довідник

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Метод дозволяє заблокувати чи активувати довідник в залежності від значення параметра is_active=0 / is_active=1

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

Заблокувати довідник

https://doc.edi-n.com/bdoc/dictionary?dictionary_id=443&is_active=0

Активувати довідник

https://doc.edi-n.com/bdoc/dictionary?dictionary_id=443&is_active=1

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

dictionary_id - ID довідника

is_active - статус довідника; 1 - активний, 0 - заблокований

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Активувати / Заблокувати документ

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Метод дозволяє заблокувати чи активувати значення довідника в залежності від значення параметра is_active=0 / is_active=1

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

Заблокувати документ

https://doc.edi-n.com/bdoc/document_type?document_id=2393&is_active=0

Активувати документ

https://doc.edi-n.com/bdoc/document_type?document_id=2393&is_active=1

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документа

is_active - статус документа; 1 - активний, 0 - заблокований

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Додавання значень довідника

Для роботи з цим методом користувач повинен бути авторизованим .

Підказка

Метод дозволяє додавати «материнські» значення до довідника та прив’язувати до них «дочірні» значення

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionary_value

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Видалити тип документа з узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Додати тип документа до узгодження * без прив’язаного довідника - в url параметр dict_val_id = 0

  • з прив’язаним до нього довідником - в url параметр dict_val_id = «наприклад323»

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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
}

Створення / редагування користувача

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній userId, то користувач з зазначеним Id підлягає редагуванню. Відсутність параметра userId веде до створення нового користувача.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/user

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

fio, email (повинен бути валідний з доменною частиною), passPolicyId

JSON-параметри в тілі HTTP запиту/відповіді

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": {}
}

Видалення групи користувачів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/agreement_group?agreement_group_id=185

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

agreement_group_id - ID групи користувачів

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Створення/редагування типу комплекта документів (структурованого чи НЕструктурованого)

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній documentId, то документ з зазначеним Id підлягає редагуванню. Відсутність параметра documentId веде до створення нового документу.

Увага

Вибір типу документу визначається параметром type:

type=1 - НЕструктурований документ

type=2 - структурований документ

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/document_type

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

documentId (для редагування документу), isActive, companyId, name, code, type

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Додавання структури в структурований документ

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/document_type/structure

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

encoding, id, structure (будь-яка кількість регламентованих полей)

JSON-параметри в тілі HTTP запиту/відповіді

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"
}

Отримання списку версій типу комплекту документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/packages_by_chain?package_chain_id=242

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_chain_id - ID комплекту документів

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
]

Активувати тип комплекту документів (змінити статус комплекту документів)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/package_type/status?package_id=1455&status=1

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекту документів

status - статус комплекту документів (1 - Активний; 2 - Заблокоаний; 3 - Чернетка)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Створення/редагування типу комплекта документів

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній packageId, то тип комлекту документів з зазначеним Id підлягає редагуванню. Відсутність параметра packageId веде до створення нового типу комлекту документів.

Увага

За замовчуванням комплект документів створюється зі статусом «Чорновик» і для подальшої корректної роботи його необхідно активувати !!!

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/package

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

packageId (для редагування типу комплекта документів), name, code, type, companyId

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
}

Видалення кроку узгодження

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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»

Метод запиту

HTTP PUT

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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 веде до створення нового кроку узгодження.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/agreement_proc

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

agreementProcId (для редагування), name, companyId

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Відправка контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract/send

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передається масив ідентифікаторів контрактів (contractId), які необхідно відправити.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

[
  2181
]

У відповідь передається код сервера 200 (ok)

Зміна статусу контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract?contract_id=2169&status=2

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

status - новий статус контракту ( 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Отримання конкретного контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Редагування (додавання / видалення) зв’язків користувачів з роллю(-ями)

Увага

Додавання / видалення зв’язків виконується шляхом перезатирання - залишаються тільки ті зв’язки (передаються списком), котрі були передані в останньому запиті!

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/user/roles

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

user_id - ідентифікатор користувача

JSON-параметри в тілі HTTP запиту/відповіді

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
  }
]

Видалення контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract/delete

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передається масив ідентифікаторів контрактів (contractId), які необхідно видалити.

RESPONSE

У відповідь передається код сервера 200 (ok)

Приклади

[
  2181
]

У відповідь передається код сервера 200 (ok)

Додавання (прив’язка) типу комплекта документів до довідника

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/package_dictionary

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

packageId, dictionaryId

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
}

Додавання (прив’язка) поля користувача до типу комплекта документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP OPTIONS

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/package/extra_field

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

packageId, required, fieldId, fillType

JSON-параметри в тілі HTTP запиту/відповіді

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": []
  }
}

Видалення прив’язки типу комплекта документів до контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_packages

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

package_chain_id - ID типу комплекта документів

sender_type - тип відправника: 1 - клієнт, 2 - власник

JSON-параметри в тілі HTTP запиту/відповіді

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-параметри в тілі HTTP запиту/відповіді

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": []
    }
  ]
}

Видалення (прив’язки) довідника до контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_dictionary

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

dictionary_id - ID довідника

dictionary_value_id - ID значення довідника

JSON-параметри в тілі HTTP запиту/відповіді

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": []
    }
  ]
}

Додавання (прив’язка) довідника до контракту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PUT

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract_dictionary

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

contract_id - ID контракту

dictionary_id - ID довідника

dictionary_value_id - ID значення довідника

JSON-параметри в тілі HTTP запиту/відповіді

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 веде до створення нового контракту.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/contract

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

contractId (для редагування контракту), clientCompany, companyId, contractName, ownerCompany, number

JSON-параметри в тілі HTTP запиту/відповіді

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": []
}

Отримання списку транзакцій

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/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-параметри в тілі HTTP запиту/відповіді

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 рахунку / акту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/payment/invoice - PDF рахунку

https://doc.edi-n.com/bdoc/payment/act - PDF акту

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

payment_id - ID розрахункового документу

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається посилання на скачування печатного макету в форматі pdf відповідного документа.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад url-запиту:

/bdoc/payment/invoice?payment_id=1272

У цьому методі у відповідь передається посилання на скачування печатного макету в форматі pdf відповідного документа

Відправка коментаря до комплекта документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/comment?package_id=5261

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекта документів, до якого необхідно відправити документ

JSON-параметри в тілі HTTP запиту/відповіді

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
        }
      ]
    ]

Отримання списку комплекта документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/packages

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Опціональні url-параметри:

limit - ліміт вибірки (за умовчуванням 30; максимальне значення вибірки 50)

offset - зміщення відносно верхньої межі вибірки (за умовчуванням 0)

JSON-параметри в тілі HTTP запиту/відповіді

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
  }
]

Отримання комплекту документів (в вигляді архіву)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/arch

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекта документів

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається архів, який містить указаний в запиті комплект документів.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У цьому методі у відповідь передається архів, який містить указаний в запиті комплект документів.

Отримання журналу комплекту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту в form-data в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/comments?package_id=2137

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекту

JSON-параметри в тілі HTTP запиту/відповіді

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 веде до створення нового кроку узгодження.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/agreement_step

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

agreementStepId (для редагування контракту), agreementExecType, agreementTaskType, agreementStepId, agreementProcId, agreementGroups

JSON-параметри в тілі HTTP запиту/відповіді

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
    }

Відправка комплекта документів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/send

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

package_id - ID комплекта документів

JSON-параметри в тілі HTTP запиту/відповіді

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"
    }

Зміна статусу комплекту

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json/form-data (тіло запиту в form-data в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/status

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

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
}

Отримання листа підписання (в вигляді архіву)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/store/package/document/sign-list

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

document_id - ID документу

body_id - ID тіла документу

package_id - ID комплекта документів

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається архів, який містить лист підписання указанного в запиті документу, і підпис (за наявності підпису).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У цьому методі у відповідь передається архів, який містить лист підписання указанного в запиті документу.

Інструкції

Терміни та поняття (згідно Правил перевезення вантажів автомобільним транспортом в Україні)

  • Е-ТТН – товарно-транспортна накладна в електронній формі

  • Перевізник – фізична або юридична особа – суб’єкт господарювання, що надає послуги з перевезень вантажів чи здійснює за власний кошт перевезення вантажів автомобільними транспортними засобами

  • Водій (експедитор транспортний) – працівник, який забезпечує виконання комплексу операцій транспортно-експедиторського обслуговування під час перевезення вантажів

  • Замовник – вантажовідправник або вантажоодержувач, який уклав з перевізником договір про перевезення вантажів

  • Вантажовідправник – будь-яка фізична або юридична особа, яка подає перевізнику вантаж для перевезення

  • Вантажоодержувач – будь-яка фізична або юридична особа, яка здійснює приймання вантажів, оформлення товарно-транспортних документів та розвантаження транспортних засобів у встановленому порядку

Робота з сервісом EDIN-ETTN

Вхід

Для роботи з WEB сервісом Ви можете використовувати будь-який браузер (рекомендованим є Google Chrome останньої версії). Для входу до сервісу платформи необхідно перейти за посиланням ВЖЕ ВІДОМА ПРОД АДРЕСА?????? https://edo-v2.edi-n.com/auth .

При переході за вказаним посиланням відкриється вікно авторизації. Необхідно ввести Ваш логін і пароль користувача і натиснути «Вхід», як це зазначено на зображенні нижче:

_images/Work_with_ETTN_01.png

Загальний вигляд сервісу ETTN

Після успішної авторизації відкриється основне меню для вибору сервісу платформи EDIN: «EDI», «ETTN», «АТС», «Виробник», «Дистриб’ютор», «Сертифікати», «Е-Специфікація», «Товари», «DOCflow», «Tender», «Wiki».

_images/Work_with_ETTN_02n.png

Для переходу до сервісу EDIN ETTN Вам потрібно в розділі Документообіг натиснути Відкрити під іконкою ETTN.

Відкриється основне вікно сервісу EDIN ETTN. При первинному вході на платформу буде виконаний вхід в каталог документів - «Вхідні».

_images/Work_with_ETTN_03.png

Основне вікно сервісу EDIN ETTN складається з:

  1. Кнопка «Створити» - відкриває вікно для вибору та створення нового документа;

  2. Меню папок - дозволяє вибрати каталог з відповідними документами, що будуть відображатись в журналі документів;

    • «Вхідні» - всі вхідні документи для організації від контрагентів;

    • «Вихідні» - всі відправлені документи для організації до контрагентів;

    • «Важливі» - всі зазначені документи як важливі;

    • «Чернетки» - всі документи які були створені, але не відправлені;

    • «Архів» - всі оброблені і архівні документи (перенесені в архів);

  3. Збережений пошук - дозволяє задати та зберегти критерії пошуку документів (детальніше в розділі Пошук );

  4. Журнал документів (детальніше описаний в розділі «Журнал документів» );

  5. Рядок пошуку документів за різними критеріями (детальніше в розділі «Пошук» );

  6. Навігація на платформі;

  7. Функціонал з керування: дані про компанію (вибір GLN організації)(1), кнопки переходу в меню сервісів (2), вибору мови (3), виходу з платформи (4)

_images/Work_with_ETTN_06.png
Журнал документів

В журналі відображаються документи, що потрапили до вибраного каталогу. Вхідні «непрочитані» документи відображаються товстим чорним текстом (прочитані блакитним):

_images/Work_with_ETTN_05.png

фільтр - фільтр, що дозволяє відсортувати ЕТТН документи, що потребують підтвердження для логічного завершення документообігу.

Примітка

Для каталогу «Вхідні» для «Перевізника» доступна кнопка фільтр - фільтр, що дозволяє відсортувати ЕТТН документи, що потребують підтвердження по яким можливо створити «Акт перевантаження» / «Акт виконаних робіт» ( детальніше )

В лівій частині по кожному документу відображаються символи:

  • звезда / звезда2 - регульована відмітка користувача, «важливий»/»звичайний» документ. Відмічені документи відображаються в каталозі «Важливі».

  • прапорець - дозволяє відмітити документ одним із символів набор

Архівування документів, видалення чернеток

Будь-який ланцюжок документів з папок «Вхідні» / «Надіслані» / «Важливі» можливо вибірково чи масово (чекер в верхній частині журналу) відправити до архіву (кнопка «Архівувати»):

_images/Work_with_ETTN_25.png

Цей процес зворотній: ланцюжки, що потрапили до архіву можливо розархівувати в такий же спосіб через кнопку «Розархівувати»:

_images/Work_with_ETTN_26.png

Документи з «Чернеток» не були відправлені іншим контрагентам; ці документи можливо вибірково чи масово (чекер в верхній частині журналу) «Видалити»:

_images/Work_with_ETTN_27.png

Сценарії взаємодії з контрагентами

В сервісі ETTN передбачені 3 основні ролі учасників документообігу: «Вантажовідправник», «Перевізник», «Вантажоотримувач», а також реалізовано кілька можливих сценаріїв взаємодії учасників документообігу ЕТТН.

1 Пряма схема документообігу ЕТТН

«Вантажовідправник» -> «Перевізник» -> «Вантажоотримувач»

Ініціатором документообігу виступає «Вантажовідправник» - створює, підписує, відправляє ЕТТН (детально в інструкції для вантажовідправника ). Далі «Перевізник» приймає вхідний документ, підписує та відправляє (детально в інструкції для перевізника ). Завершальним підписантом в цій схемі є компанія-«Вантажоотримувач» (детально в інструкції для вантажоодержувача )

2 Документообіг ЕТТН між розподільчими центрами (всередині однієї компанії)

РЦ-«Вантажовідправник» -> «Перевізник» -> РЦ-«Вантажоотримувач»

Алгоритм взаємодії ідентичний до прямої схеми за виключенням того, що в якості «Вантажовідправника» та «Вантажоотримувача» виступає одна компанія.

3 Обернена схема документообігу ЕТТН

  1. «Вантажоотримувач» -> «Вантажовідправник» -> «Перевізник» -> «Вантажоотримувач»

  2. «Перевізник» -> «Вантажовідправник» -> «Перевізник» -> «Вантажоотримувач»

Обидва варіанти оберненої схеми документообігу ЕТТН відрізняються від «прямої» схеми тим, що ініціатором документообігу виступає «Вантажоотримувач» (1) або «Перевізник» (2). Алгоритм детально описаний в інструкції створення документів перевізником/вантажоодержувачем )

Повідомлення контрагентів, водіїв

На кожному єтапі в вище зазначених схемах (новий документ чи зміна статусу) контрагенти отримують повідомлення на e-mail про документ, до якого вони причасні в форматі:

_images/Work_with_ETTN_23.png

  1. Статус документу: «У процесі» / «Підписано Вантажовідправником» / «Підтверджено водієм» / «Відхилено Вантажовідправником» / «Підписано Перевізником» / «Відхилено Перевізником» / «Підписано Вантажоотримувачем» / «Підтверджено Приймальником»

  2. Тип документа: «ЕТТН» / «Заявка на трпнспортування» / «Акт перевантаження» / «Акт виконаних робіт»

  3. Блок даних контрагентів

  4. Посилання на документ

Загальний вигляд форми документа

Функціонал форми документа дещо відрізняється в залежності від ролі користувача та етапу/статусу документообігу (детальніше у інструкціях, присвяченим цим ролям).

_images/Work_with_ETTN_16.png

Розглянемо основні елементи форми:

  1. Кнопки «Підтвердити» / «Підписати» / «Відхилити» / «Змінити» / «Зберегти» / «Створити» / «Відправити» відображаються лише там, де цей функціонал є логічним (згідно сценаріїв взаємодії з контагентами ). Кнопки «Друк», «Завантажити», «Клонувати» - є загальним функціоналом для всіх ролей та документів:

    • Друк - «Друк» - відкриває друковану форму документа, яку можливо зберегти в *.pdf форматі;

    • Завантажити - «Завантажити» - дозволяє завантажити архів формату ettn_DocUuid.zip, що містить json, xml документа, а також p7s, якщо документ вже підписаний.

    • Клонувати - «Клонувати» - функціонал, що дозволяє клонувати заповнений документ і всі його вкладення для подальшого редагування/підписання/відправки контрагентам (детальніше в Клонування документа ).

  2. Сам документ разом з табличною частиною («Відомості про вантаж»).

  3. Список документів у ланцюжку, в якому також відображається їх статус.

  4. Кнопка, що згортає додаткову інформацію про ланцюжок документів, підписантів та супровідні документи (вкладення).

  5. Інформація про підписантів зі статусами про підписання.

  6. Супровідні документи про вантаж, що додав користувач при створенні документа (вкладення).

  7. Функціонал, що дозволяє долучити до документа додаткові коментарі (відображаються лише для користувача, що їх залишив).

Клонування документа

Функціонал, що дозволяє копіювати заповнений документ і всі його вкладення для подальшого редагування/підписання/відправки контрагентам.

Примітка

Клонувати можливо лише такі типи документів, які доступні для створення для даної ролі користувача («Вантажовідправник», «Перевізник», «Вантажоотримувач»).

Для створення копії потрібно натиснути на кнопку Клонувати «Клонувати»:

_images/Work_with_ETTN_17.png

В клонованому документі можливо внести правки, після яких перед «Підписанням» обов’язково потрібно «Зберегти» документ:

_images/Work_with_ETTN_21.png

Підписаний документ можливо відправити контрагенту:

_images/Work_with_ETTN_22.png
Створення актів на підставі ЕТТН

можливо є ризон зробити окрему статтю-сторінку

Створення, підписання, відправлення та відхилення е-ТТН вантажовідправником

Створення документа

Важливо

Ініціатор документообігу повинен бути присутнім серед учасників документообігу!

Для створення е-ТТН на платформі необхідно натиснути на кнопку «Створити».

_images/Creation_signing_ending_rejection_ETTN_shipper_01n.png

Після цього необхідно вибрати тип створюваного документа в модальному вікні:

_images/Creation_signing_ending_rejection_ETTN_shipper_02n.png

Далі необхідно заповнити форму е-ТТН (кнопка «Зберегти» активується лише для заповненої форми):

_images/Creation_signing_ending_rejection_ETTN_shipper_03n.png

Важливо

Вибір компаній, водія, адрес навантаження/розвантаження доступний лише з випадаючого списку!

  • Номер та дату (за замовчуванням вказується поточна дата);

  • Марку/модель, тип, реєстраційний номер автомобілю;

  • Марку/модель, тип, реєстраційний номер причіпу/напівпричіпу (необов’язково);

  • Вид перевезень (покілометровий тариф, погодинний тариф, відрядний тариф, централізоване перевезення, внутрішньоміське, приміське, міжміське, міжнародне перевезення);

  • Перевізник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. перевізника, після цього обрати його з випадаючого списку);

  • Водій (рядок стає активним тільки після вибору перевізника) – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

Якщо водій відсутній в списку його можливо додати через кнопку «Новий водій»:

_images/Creation_signing_ending_rejection_ETTN_shipper_25n.png

Після чого в модальному вікні потрібно буде заповнити дані про водія («Серія, номер посвідчення водія» заповнюється в форматі «3 заголовні латинські літери + 6 цифр», наприклад «DGJ123456»). Доданий водій прив»язується в системі до вказаного «Перевізника».

_images/Creation_signing_ending_rejection_ETTN_shipper_26n.png

  • Серія, номер посвідчення водія буде додано автоматично після вибору водія;

  • Вантажовідправник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. вантажовідправника, після цього обрати його з випадаючого списку), місцезнаходження/місце проживання буде додано автоматично;

  • Вантажоодержувач – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. вантажоодержувача, після цього обрати його з випадаючого списку), місцезнаходження/місце проживання буде додано автоматично;

  • Пункт навантаження – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

  • Пункт розвантаження – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

Якщо адреси у вказаному списку немає, то її можливо додати вручну через кнопку «Нова адреса»:

_images/Creation_signing_ending_rejection_ETTN_shipper_27n.png

Після чого в модальному вікні потрібно буде додати населений пункт, адресу та вибрати КОАТУУ (в цьому рядку можливо здійснювати пошук по назві чи коду). Код КОАТУУ вказується автоматично. Додана адреса навантаження прив’язується в системі до вказаного «Вантажовідправника», а адреса розвантаження - до «Вантажоодержувача».

_images/Creation_signing_ending_rejection_ETTN_shipper_28n.png _images/Creation_signing_ending_rejection_ETTN_shipper_29n.png

  • Натиснути на кнопку «Додати» для заповненя вартісно-кількісних показників та табличної частини.

_images/Creation_signing_ending_rejection_ETTN_shipper_04n.png

Після натискання на кнопку «Додати» відкриється модальне вікно, де необхідно заповнити рядки (найменування вантажу, кількість місць, одиниця виміру, ціна без ПДВ, вид пакування (необов’язково), маса брутто, кількість або назва документів з вантажем) та натиснути на кнопку «Додати».

_images/Creation_signing_ending_rejection_ETTN_shipper_05n.png

Також для додавання табличних даних (вантаж) є можливість скористатись шаблоном. Для цього над таблицею необхідно натиснути «Зберегти шаблон Excel» (1).

_images/Creation_signing_ending_rejection_ETTN_shipper_06n.png

На Ваш комп’ютер буде завантажено файл з назвою ettn_products_sample.xlsx. Відкривши його, необхідно внести інформацію про вантаж.

Обов’язкові для заповнення поля (поля відмічені червоним кольором):

  • Найменування

  • Кількість

  • Одиниці виміру

  • Ціна

  • Маса брутто, кг

  • Документи

Важливо

Ні в якому разі не змінювати формат шаблону, не видаляти або додавати нові стовпці. Також не допускається зміна формату комірок.

Після збереження заповненої інформації завантажуємо файл на веб-портал, скориставшись кнопкою «Завантажити позиції з Excel» (2).

За необхідністю є можливість додавати ще вантаж(і), для цього необхідно натиснути на кнопку «Додати» та заповнити інформацію в модальному вікні.

Для редагування інформації щодо вантажу необхідно навести курсор на рядок цього вантажу та натиснути «Змінити», для видалення – «Видалити».

_images/Creation_signing_ending_rejection_ETTN_shipper_07n.png

Порада

Для повторного вибору перевізника, водія, вантажовідправника, вантажоодержувача, пунктів навантаження/розвантаження необхідно натиснути на кнопку «Обрати».

Для збереження е-ТТН необхідно натиснути кнопку «Зберегти», документ потрапить у папку «Чернетки».

За необхідністю є можливість додати супровідні документи на вантаж. Для цього необхідно натиснути на кнопку «Додати файл» (назва файлу повина бути унікальною).

_images/Creation_signing_ending_rejection_ETTN_shipper_08n.png

Для того щоб видалити доданий файл необхідно натиснути на іконку корзини. Для того щоб зберегти доданий файл необхідно натиснути на його назву.

_images/Creation_signing_ending_rejection_ETTN_shipper_09n.png

Для підписання е-ТТН необхідно натинути на кнопку «Підписати».

_images/Creation_signing_ending_rejection_ETTN_shipper_10n.png

Підписання та відправка документа

Після ініціалізації бібліотеки підписання, система надасть можливість додати ключ для підписання. При першому підписанні необхідно додати файловий ключ. Для цього у модальному вікні потрібно обрати файл (2) і ввести пароль (1):

_images/Creation_signing_ending_rejection_ETTN_shipper_11n.png

Після чого натиснути кнопку «Додати»:

_images/Creation_signing_ending_rejection_ETTN_shipper_12n.png

При успішному додаванні ключа автоматично відобразиться вибрана особа, від імені якої буде здійснено підписання (кнопка «Підписати»):

_images/Creation_signing_ending_rejection_ETTN_shipper_13n.png

При подальшій роботі з раніше доданим ключем/-ами потрібно вводити лише пароль для обраного ключа:

_images/Creation_signing_ending_rejection_ETTN_shipper_14n.png

Після підписання е-ТТН інформація щодо підписанта відображається в блоці «Підписанти». Для відправки е-ТТН необхідно натинути на кнопку «Надіслати».

_images/Creation_signing_ending_rejection_ETTN_shipper_15n.png _images/Creation_signing_ending_rejection_ETTN_shipper_16n.png

Після відправки документа контрагенту він відображається в журналі вихідних документів. Для відправленної вантажовідправником е-ТТН присвоєно статус «У процесі»:

_images/Creation_signing_ending_rejection_ETTN_shipper_17n.png

Відправлена е-ТТН має наступний вигляд:

_images/Creation_signing_ending_rejection_ETTN_shipper_18n.png

На формі е-ТТН у лівій верхній частині відображаються QR-код та унікальний ідентифікатор документа.

Користувач може скористатись функціоналом для «Друку», «Завантаження» чи «Клонування» (1); також у разі виявлення помилки в документі у «Вантажовідправника» є можливість відхилити відправлену е-ТТН до підписання «Перевізником». Для цього потрібно натиснути на кнопку «Відхилити» (2).

Відхилення документа

Для того, щоб відхилити документ (доступно до підписання «Перевізником») потрібно натиснути «Відхилити». Після чого в модульному вікні обов’язково потрібно заповнити причину відміни документа:

_images/Creation_signing_ending_rejection_ETTN_shipper_30n.png _images/Creation_signing_ending_rejection_ETTN_shipper_19n.png

На платформі відображається повідомлення та змінюється статус документа в ланцюжку («Відхилено»).

_images/Creation_signing_ending_rejection_ETTN_shipper_20n.png

Створення документа на підставі чернетки Перевізника чи Вантажоотримувача

Існують схеми документообігу, в яких ініціатором виступає не «Вантажовідправник», а «Перевізник» чи «Вантажоотримувач». В такому випадку ініціатор створює та відправляє документ-чернетку, яку не потрібно підписувати.

Далі згідно оберненої схеми документообігу контрагент з роллю «Вантажовідправник» отримує документ-чернетку:

_images/Creation_signing_ending_rejection_ETTN_shipper_21n.png

Для ролі «Вантажовідправника» вхідний документ-чернетка відображається з інформативною підказкою і дозволяє «Створити» на основі вхідної чернетки документ, що потребує підписання:

_images/Creation_signing_ending_rejection_ETTN_shipper_22n.png

В створений такий чином документ копіюється вся інформація та вкладення з чернетки. Документ може бути відредагований, після чого його потрібно «Зберегти» (1) та «Підписати» (2) (детальніше про підписання в наступному розділі).

_images/Creation_signing_ending_rejection_ETTN_shipper_23n.png

Особливістю такого документообігу є те, що в ланцюжку документів присутня чернетка, як документ-ініціатор документообігу:

_images/Creation_signing_ending_rejection_ETTN_shipper_24n.png

Створення та відправлення е-ТТН перевізником та вантажоотримувачем

Існують схеми документообігу, в яких ініціатором виступає не «Вантажовідправник», а «Перевізник» чи «Вантажоотримувач». В такому випадку ініціатор створює та відправляє документ-чернетку, яку не потрібно підписувати.

Створення чернетки документа

Важливо

Ініціатор документообігу повинен бути присутнім серед учасників документообігу!

Для створення е-ТТН на платформі користувачем з роллю «Перевізник» чи «Вантажоотримувач» необхідно натиснути на кнопку «Створити»:

_images/Creation_sending_ETTN_carrier_consignee_01.png

Після цього необхідно вибрати тип створюваного документа в модальному вікні:

_images/Creation_sending_ETTN_carrier_consignee_02.png

Далі необхідно заповнити форму е-ТТН (кнопка «Зберегти» активується лише для заповненої форми):

_images/Creation_sending_ETTN_carrier_consignee_03.png

Важливо

Вибір компаній, водія, адрес навантаження/розвантаження доступний лише з випадаючого списку!

  • Номер та дату (за замовчуванням вказується поточна дата);

  • Марку/модель, тип, реєстраційний номер автомобілю;

  • Марку/модель, тип, реєстраційний номер причіпу/напівпричіпу (необов’язково);

  • Вид перевезень (покілометровий тариф, погодинний тариф, відрядний тариф, централізоване перевезення, внутрішньоміське, приміське, міжміське, міжнародне перевезення);

  • Перевізник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. перевізника, після цього обрати його з випадаючого списку);

  • Водій (рядок стає активним тільки після вибору перевізника) – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

Якщо водій відсутній в списку його можливо додати через кнопку «Новий водій»:

_images/Creation_sending_ETTN_carrier_consignee_16.png

Після чого в модальному вікні потрібно буде заповнити дані про водія («Серія, номер посвідчення водія» заповнюється в форматі «3 заголовні латинські літери + 6 цифр», наприклад «DGJ123456»). Доданий водій прив»язується в системі до вказаного «Перевізника».

_images/Creation_sending_ETTN_carrier_consignee_17.png

  • Серія, номер посвідчення водія буде додано автоматично після вибору водія;

  • Вантажовідправник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. вантажовідправника, після цього обрати його з випадаючого списку), місцезнаходження/місце проживання буде додано автоматично;

  • Вантажоодержувач – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. вантажоодержувача, після цього обрати його з випадаючого списку), місцезнаходження/місце проживання буде додано автоматично;

  • Пункт навантаження – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

  • Пункт розвантаження – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

Якщо адреси у вказаному списку немає, то її можливо додати вручну через кнопку «Нова адреса»:

_images/Creation_sending_ETTN_carrier_consignee_18.png

Після чого в модальному вікні потрібно буде додати населений пункт, адресу та вибрати КОАТУУ (в цьому рядку можливо здійснювати пошук по назві чи коду). Код КОАТУУ вказується автоматично. Додана адреса навантаження прив’язується в системі до вказаного «Вантажовідправника», а адреса розвантаження - до «Вантажоодержувача».

_images/Creation_sending_ETTN_carrier_consignee_19.png _images/Creation_sending_ETTN_carrier_consignee_20.png

  • Натиснути на кнопку «Додати» для заповненя вартісно-кількісних показників та табличної частини.

_images/Creation_sending_ETTN_carrier_consignee_04.png

Після натискання на кнопку «Додати» відкриється модальне вікно, де необхідно заповнити рядки (найменування вантажу, кількість місць, одиниця виміру, ціна без ПДВ, вид пакування (необов’язково), маса брутто, кількість або назва документів з вантажем) та натиснути на кнопку «Додати».

_images/Creation_sending_ETTN_carrier_consignee_05.png

Також для додавання табличних даних (вантаж) є можливість скористатись шаблоном. Для цього над таблицею необхідно натиснути «Зберегти шаблон Excel» (1).

_images/Creation_sending_ETTN_carrier_consignee_06.png

На Ваш комп’ютер буде завантажено файл з назвою ettn_products_sample.xlsx. Відкривши його, необхідно внести інформацію про вантаж.

Обов’язкові для заповнення поля (поля відмічені червоним кольором):

  • Найменування

  • Кількість

  • Одиниці виміру

  • Ціна

  • Маса брутто, кг

  • Документи

Важливо

Ні в якому разі не змінювати формат шаблону, не видаляти або додавати нові стовпці. Також не допускається зміна формату комірок.

Після збереження заповненої інформації завантажуємо файл на веб-портал, скориставшись кнопкою «Завантажити позиції з Excel» (2).

За необхідністю є можливість додавати ще вантаж(і), для цього необхідно натиснути на кнопку «Додати» та заповнити інформацію в модальному вікні.

Для редагування інформації щодо вантажу необхідно навести курсор на рядок цього вантажу та натиснути «Змінити», для видалення – «Видалити».

_images/Creation_sending_ETTN_carrier_consignee_07.png

Порада

Для повторного вибору перевізника, водія, вантажовідправника, вантажоодержувача, пунктів навантаження/розвантаження необхідно натиснути на кнопку «Обрати».

Для збереження е-ТТН необхідно натиснути кнопку «Зберегти», документ потрапить у папку «Чернетки».

Підказка

Над створеним документом відображається інформативна підказка:

_images/Creation_sending_ETTN_carrier_consignee_08.png

За необхідністю є можливість додати супровідні документи на вантаж. Для цього необхідно натиснути на кнопку «Додати файл» (назва файлу повина бути унікальною).

_images/Creation_sending_ETTN_carrier_consignee_09.png

Для того щоб видалити доданий файл необхідно натиснути на іконку корзини. Для того щоб зберегти доданий файл необхідно натиснути на його назву.

_images/Creation_sending_ETTN_carrier_consignee_10.png

Після останнього редагування документу його потрібно «Зберегти» (1) та «Надіслати» (2) без підписання.

Після відправки документа контрагенту він відображається в журналі вихідних документів. Для відправленної «Перевізником» чи «Вантажоотримувачем» е-ТТН присвоюється статус «Чернетка»:

_images/Creation_sending_ETTN_carrier_consignee_11.png

Далі згідно оберненої схеми документообігу контрагент з роллю «Вантажовідправник» отримує документ-чернетку:

_images/Creation_sending_ETTN_carrier_consignee_12.png

Для ролі «Вантажовідправника» вхідний документ-чернетка відображається з інформативною підказкою і дозволяє «Створити» на основі вхідної чернетки документ, що потребує підписання:

_images/Creation_sending_ETTN_carrier_consignee_13.png

В створений такий чином документ копіюється вся інформація та вкладення з чернетки. Документ може бути відредагований, після чого його потрібно «Зберегти» (1) та «Підписати» (2) (детальніше про підписання в інструкції для вантажовідправника ).

_images/Creation_sending_ETTN_carrier_consignee_14.png

Особливостю такого документообігу є те, що в ланцюжку документів присутня чернетка, як документ-ініціатор документообігу:

_images/Creation_sending_ETTN_carrier_consignee_15.png

Заявка на транспортування (Створення, підписання, відправлення та відхилення)

При формуванні документообігу «Заявки на транспортування» ініціатором документа виступає користувач з роллю «Вантажовідправник» (в сервісі ETTN передбачені 3 основні ролі учасників документообігу: «Вантажовідправник», «Перевізник», «Вантажоотримувач»). Обмін документом здійснюється між «Вантажовідправником» та «Перевізником»:

«Вантажовідправник» -> «Перевізник» -> «Вантажовідправник»

Створення «Заявки на транспортування» «Вантажовідправником»

Для створення «Заявки на транспортування» на платформі «Вантажовідправнику» необхідно натиснути на кнопку «Створити».

_images/Creation_signing_ending_rejection_Proposal_01.png

Після цього необхідно вибрати тип створюваного документа в модальному вікні:

_images/Creation_signing_ending_rejection_Proposal_02.png

Далі необхідно заповнити форму «Заявки на транспортування» (кнопка «Зберегти» активується лише для заповненої форми):

_images/Creation_signing_ending_rejection_Proposal_03.png

Важливо

Вибір компаній, водія, адрес навантаження/розвантаження доступний лише з випадаючого списку!

  • За замовчуванням формується номер та вказується поточна дата;

  • Вид перевезень (покілометровий тариф, погодинний тариф, відрядний тариф, централізоване перевезення, внутрішньоміське, приміське, міжміське, міжнародне перевезення);

  • Перевізник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. перевізника, після цього обрати його з випадаючого списку);

  • Замовник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. перевізника, після цього обрати його з випадаючого списку);

  • Вантажовідправник – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. вантажовідправника, після цього обрати його з випадаючого списку), місцезнаходження/місце проживання буде додано автоматично;

  • Вантажоодержувач – необхідно обрати з випадаючого списку (для цього в рядку необхідно ввести мінімум 3 символи найменування/П.І.Б. вантажоодержувача, після цього обрати його з випадаючого списку), місцезнаходження/місце проживання буде додано автоматично;

  • Пункт навантаження – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

  • Пункт розвантаження – необхідно поставити курсор в рядок та обрати його з випадаючого списку;

Якщо адреси у вказаному списку немає, то її можливо додати вручну через кнопку «Нова адреса»:

_images/Creation_signing_ending_rejection_Proposal_04.png

Після чого в модальному вікні потрібно буде додати населений пункт, адресу та вибрати КОАТУУ (в цьому рядку можливо здійснювати пошук по назві чи коду). Код КОАТУУ вказується автоматично. Додана адреса навантаження прив’язується в системі до вказаного «Вантажовідправника», а адреса розвантаження - до «Вантажоодержувача».

_images/Creation_signing_ending_rejection_Proposal_05.png _images/Creation_signing_ending_rejection_Proposal_06.png

  • Вид транспорту / Кількість місць / Температурні вимоги / Масою брутто / Вартість перевезення – в цих полях «Вантажовідправником» заповнюються вимоги до транспорту

Порада

Для повторного вибору перевізника, водія, вантажовідправника, вантажоодержувача, пунктів навантаження/розвантаження необхідно натиснути на кнопку «Обрати».

Для збереження «Заявки на транспортування» необхідно натиснути кнопку «Зберегти», документ потрапить у папку «Чернетки».

За необхідністю є можливість додати супровідні документи. Для цього необхідно натиснути на кнопку «Додати файл» (назва файлу повинна бути унікальною).

_images/Creation_signing_ending_rejection_Proposal_07.png

Для того щоб видалити доданий файл необхідно натиснути на іконку корзини. Для того щоб зберегти доданий файл необхідно натиснути на його назву.

_images/Creation_signing_ending_rejection_Proposal_08.png

Після усіх проведених змін документ необхідно «Зберегти» (1) та «Підписати» (2).

Підписання та відправка «Заявки на транспортування» «Вантажовідправником»

Після ініціалізації бібліотеки підписання, система надасть можливість додати ключ для підписання. При першому підписанні необхідно додати файловий ключ. Для цього у модальному вікні потрібно обрати файл (2) і ввести пароль (1):

_images/Creation_signing_ending_rejection_Proposal_09.png

Після чого натиснути кнопку «Додати»:

_images/Creation_signing_ending_rejection_Proposal_10.png

При успішному додаванні ключа автоматично відобразиться вибрана особа, від імені якої буде здійснено підписання (кнопка «Підписати»):

_images/Creation_signing_ending_rejection_Proposal_11.png

При подальшій роботі з раніше доданим ключем/-ами потрібно вводити лише пароль для обраного ключа:

_images/Creation_signing_ending_rejection_Proposal_12.png

Після підписання «Заявки на транспортування» інформація щодо підписанта відображається в блоці «Підписанти». Для відправки «Заявки на транспортування» необхідно натинути на кнопку «Надіслати».

_images/Creation_signing_ending_rejection_Proposal_13.png

Після відправки документа контрагенту він відображається в журналі вихідних документів. Для відправленної «Вантажовідправником» «Заявки на транспортування» присвоюється статус «У процесі»:

_images/Creation_signing_ending_rejection_Proposal_14.png

Відправлена «Заявка на транспортування» має наступний вигляд:

_images/Creation_signing_ending_rejection_Proposal_15.png

На формі «Заявки на транспортування» у лівій верхній частині відображаються QR-код та унікальний ідентифікатор документа.

Користувач може скористатись функціоналом для «Друку», «Завантаження» чи «Клонування»; також у разі виявлення помилки в документі у «Вантажовідправника» є можливість відхилити відправлену «Заявку на транспортування» до підписання «Перевізником». Для цього потрібно натиснути на кнопку «Відхилити».

Відхилення «Заявки на транспортування» «Вантажовідправником»

Для того, щоб відхилити документ (доступно до підписання «Перевізником») потрібно натиснути «Відхилити». Після чого в модульному вікні обов’язково потрібно заповнити причину відміни документа:

_images/Creation_signing_ending_rejection_Proposal_25.png _images/Creation_signing_ending_rejection_Proposal_16.png

На платформі відображається повідомлення та змінюється статус документа в ланцюжку («Відхилено»).

Підтвердження «Заявки на транспортування» та відправка «Підтвердження транспортування» «Перевізником»

Відправлена з боку «Вантажовідправника» «Заявка на транспортування» відображається в папці «Вхідні».

_images/Creation_signing_ending_rejection_Proposal_17.png

Вхідний підписаний документ дозволяє «Підтвердити» та «Відхилити» документ.

_images/Creation_signing_ending_rejection_Proposal_18.png

Після того, як водій чи «Перевізник» «підтверджує» документ, відкривається форма «Підтвердження транспортування», в якій необхідно заповнити відомості про водія та натиснути «Зберегти»:

_images/Creation_signing_ending_rejection_Proposal_19.png

За необхідністю до «Підтвердження транспортування» також є можливість додати супровідні документи. Для цього необхідно натиснути на кнопку «Додати файл» (назва файлу повинна бути унікальною).

_images/Creation_signing_ending_rejection_Proposal_20.png

Для того щоб видалити доданий файл необхідно натиснути на іконку корзини. Для того щоб зберегти доданий файл необхідно натиснути на його назву.

_images/Creation_signing_ending_rejection_Proposal_21.png

Після усіх проведених змін документ необхідно «Зберегти» (1) та «Підписати» (2).

Підказка

Процес підписання «Перевізником» не відрізняється від підписання «Вантажовідправником» та описаний в розділі вище .

Після підписання в «Підтвердження транспортування» додається інформація щодо підписантів документа. Документ можливо «Надіслати» контрагенту («Вантажовідправнику»):

_images/Creation_signing_ending_rejection_Proposal_22.png

Підписаний документ відображається в журналі надісланих документів зі статусом «У процесі»:

_images/Creation_signing_ending_rejection_Proposal_23.png

Відхилення «Заявки на транспортування» «Перевізником»

У «Перевізника» є можливість відхилити «Заявку на транспортування» до її підтвердження. Для цього потрібно натиснути на кнопку «Відхилити». Після чого в модульному вікні обов’язково потрібно заповнити причину відміни документа:

_images/Creation_signing_ending_rejection_Proposal_25.png _images/Creation_signing_ending_rejection_Proposal_24.png

Для відхиленної перевізником «Заявки на транспортування» присвоєно статус «Відхилено». Документ з цим статусом відображається у «Вхідних» «Перевізника».

Підписання «Підтвердження транспортування» «Вантажовідправником»

Відправлене з боку «Перевізника» «Підтвердження транспортування» відображається в папці «Вхідні».

_images/Creation_signing_ending_rejection_Proposal_26.png

Вхідний відкритий підписаний документ доступно «Підписати» та «Відхилити».

_images/Creation_signing_ending_rejection_Proposal_27.png

Підказка

Процес підписання «Перевізником» не відрізняється від підписання «Вантажовідправником» та описаний в розділі вище .

Відхилення «Підтвердження транспортування» «Вантажовідправником»

Для того, щоб відхилити документ потрібно натиснути «Відхилити». Після чого в модульному вікні обов’язково потрібно заповнити причину відміни документа:

_images/Creation_signing_ending_rejection_Proposal_25.png _images/Creation_signing_ending_rejection_Proposal_29.png

На платформі відображається повідомлення та змінюється статус документа в ланцюжку («Відхилено»).

Підписання або відхилення е-ТТН перевізником

Відправлена з боку вантажовідправника е-ТТН відображається в папці «Вхідні».

_images/Signing_rejection_ETTN_carrier_01n.png

Вхідний підписаний документ дозволяє «Підтвердити» / «Підписати» / «Відхилити» документ.

_images/Signing_rejection_ETTN_carrier_02n.png

Важливо

В залежності від внутрішньої схеми «Перевізника» документ перед «Підписанням» може бути «Підтверджений» водієм, (кнопка «Підтвердити») і відповідно цей документ у вхідних змінить свій статус на «Підтверджений водієм», підказка в документі:

_images/Signing_rejection_ETTN_carrier_03n.png

Підписання документа

Для підписання е-ТТН «Перевізнику» необхідно її відкрити та натиснути на кнопку «Підписати».

Після ініціалізації бібліотеки підписання, система надасть можливість додати ключ для підписання. При першому підписанні необхідно додати файловий ключ. Для цього у модальному вікні потрібно обрати файл (2) і ввести пароль (1):

_images/Signing_rejection_ETTN_carrier_04n.png

Після чого натиснути кнопку «Додати»:

_images/Signing_rejection_ETTN_carrier_05n.png

При успішному додаванні ключа автоматично відобразиться вибрана особа, від імені якої буде здійснено підписання (кнопка «Підписати»):

_images/Signing_rejection_ETTN_carrier_06n.png

При подальшій роботі з раніше доданим ключем/-ами потрібно вводити лише пароль для обраного ключа:

_images/Signing_rejection_ETTN_carrier_07n.png

Після підписання е-ТТН додається інформація щодо підписантів документа.

_images/Signing_rejection_ETTN_carrier_08n.png

Підписаний документ відображається в журналі вхідних документів зі статусом «Підписано перевізником»:

_images/Signing_rejection_ETTN_carrier_09n.png

Відхилення документа

У «Перевізника» є можливість відхилити е-ТТН до підписання. Для цього потрібно натиснути на кнопку «Відхилити». Після чого в модульному вікні обов’язково потрібно заповнити причину відміни документа:

_images/Signing_rejection_ETTN_carrier_12n.png _images/Signing_rejection_ETTN_carrier_10n.png

Для відхиленної перевізником е-ТТН присвоєно статус «Відхилено». Документ з цим статусом відображається у «Вхідних» «Перевізника».

_images/Signing_rejection_ETTN_carrier_11n.png

Підписання е-ТТН вантажоодержувачем

Підписана з боку перевізника е-ТТН відображається в папці «Вхідні».

_images/Signing_rejection_ETTN_consignee_01n.png

Важливо

Підписання е-ТТН вантажоодержувачем можливе тільки після підписання перевізником (статус документу – «Підтверджено Перевізником»).

Важливо

В залежності від внутрішньої схеми «Вантажоодержувача» документ перед «Підписанням» може бути «Підтверджений» приймальником, (кнопка «Підтвердити») і відповідно цей документ у вхідних змінить свій статус на «Підтверджено приймальником»:

_images/Signing_rejection_ETTN_consignee_02n.png _images/Signing_rejection_ETTN_consignee_03n.png _images/Signing_rejection_ETTN_consignee_04n.png

Для підписання е-ТТН «Вантажоодержувачу» потрібно відкрити документ та натиснути на кнопку «Підписати».

_images/Signing_rejection_ETTN_consignee_05n.png

Після ініціалізації бібліотеки підписання, система надасть можливість додати ключ для підписання. При першому підписанні необхідно додати файловий ключ. Для цього у модальному вікні потрібно обрати файл (2) і ввести пароль (1):

_images/Signing_rejection_ETTN_consignee_06n.png

Після чого натиснути кнопку «Додати»:

_images/Signing_rejection_ETTN_consignee_07n.png

При успішному додаванні ключа автоматично відобразиться вибрана особа, від імені якої буде здійснено підписання (кнопка «Підписати»):

_images/Signing_rejection_ETTN_consignee_08n.png

При подальшій роботі з раніше доданим ключем/-ами потрібно вводити лише пароль для обраного ключа:

_images/Signing_rejection_ETTN_consignee_09n.png

Після підписання е-ТТН інформація щодо підписантів відображається в документі ТТН у списку документів у ланцюжку.

_images/Signing_rejection_ETTN_consignee_10n.png

Після підписання перевізником е-ТТН присвоєно статус «Підписано».

_images/Signing_rejection_ETTN_consignee_11n.png

Служба Технічної Підтримки

API

Підказка

Всі запити нижче перерахованих API методів сервісу «ЕТТН» направляються на адресу: https://ettn-demo.edi-n.com

Авторизація

Після підключення послуги для роботи з API, користувач отримує логін, пароль і api_key для авторизації. Авторизація API відбувається за допомогою передачі цих ключових параметрів в HTTP POST запиті:

  • email - рядок; логін користувача;

  • password - рядок, пароль користувача на платформі EDIN 2.0

  • api_key - рядок, пароль доступу до API

Після авторизації відбувається передача унікального cookie токена «SID». HTTP-заголовок відповіді сервера в вигляді «Set-Cookie» використовується для подальшої відправки файлів «Cookie». В кожному наступному запиті (виклику методу) повинен бути присутнім HTTP-заголовок (Header) «Cookie», який для коректного виконання запитів повинен містити токен «SID» зі значенням, отриманим при авторизації.

В сучасних популярних браузерах і Rest клієнтах відбувається автоматичне збереження і передача токена на сервер під час сесії, однак при використанні деяких інтеграційних рішень, самописних REST-клієнтів цей обов’язковий параметр може не передаватись - його необхідно примусово передавати в заголовку (Header) «Cookie». Після авторизації час життя сесії при бездіяльності користувача становить 10 хвилин.

Метод запиту

HTTP GET

Content-Type

application/json (тіло HTTP запиту / відповіді в json форматі)

URL запиту

https://edo-v2.edi-n.com/api/oas/authorization

Параметри, що передаються в URL (разом з адресою методу)

Обов’язкові параметри:

email - рядок; логін користувача;

password - рядок, пароль користувача на платформі EDIN 2.0

api_key - рядок, пароль доступу до API

При авторизації json-тіло запиту відсутнє (інші дані передавати не потрібно). При успішній авторизації отримуємо у відповідь «токен» (наприклад,``“SID=65daca25-74ba-4c85-8183-71b404a348c0“`` ), необхідний для подальшої роботи.

Підказка

Також можливо виконати запит у вигляді curl-рядка:

curl -X POST „https://edo-v2.edi-n.com/api/oas/authorization“ -d „email=uaEDSsender&password=111&api_key=66B4814DEC28B4CA17DE56338A52D7DB“

Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

Перевірки

Доступні методи для перевірки активності сесії та сервера:

Перевірка активності сервера (метод не потребує проходження авторизації):

Метод запиту

HTTP GET

URL запиту

https://edo-v2.edi-n.com/ping

Підказка

Також можливо виконати запит у вигляді curl-рядка: curl -X GET „https://edo-v2.edi-n.com/ping“

Перевірка активності сесії:

Метод запиту

HTTP GET

URL запиту

https://edo-v2.edi-n.com/api/auth_check

Параметри, що передаються в URL (разом з адресою методу)

У рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен отриманий при авторизації

Підказка

Також можливо виконати запит у вигляді curl-рядка: curl -X GET „https://edo-v2.edi-n.com/api/auth_check“ -b „SID=65daca25-74ba-4c85-8183-71b404a348c0;“

Створення вкладення до документа

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/attachment

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

file_name - назва файлу-вкладення

file_type - тип файлу-вкладення; може бути переданий будь-який MIME тип

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В запиті методу передається файл-вкладення в вигляді набору байтів

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

В запиті методу передається файл-вкладення в вигляді набору байтів

У відповідь передається код сервера 200 (ok).

Створення/редагування документу ЕТТН

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в url запиту присутній ідентифікатор документа (параметр doc_uuid), то документ ЕТТН з зазначеним Id підлягає редагуванню. Відсутність в запиті параметра doc_uuid веде до створення нового документу.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

Опціональні url-параметри:

doc_uuid - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (ETTN )

RESPONSE

У відповідь в текстовому форматі передається «ідентифікатор документа».

Приклади

Приклад тіла запиту в json форматі:

{
  приклад тимчасово відсутній
}

Приклад тіла відповіді в текстовому форматі:

приклад тимчасово відсутній

Створення/редагування документу «Акт перевантаження товарів»

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в url запиту присутній ідентифікатор документа (параметр doc_uuid), то документ «Акт перевантаження товарів» з зазначеним Id підлягає редагуванню. Відсутність в запиті параметра doc_uuid веде до створення нового документу.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/transhipment

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

Опціональні url-параметри:

doc_uuid - ідентифікатор документа (передається для редагування (оновлення) даних раніше створеного документа)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт TRANSHIPMENT )

RESPONSE

У відповідь в текстовому форматі передається «ідентифікатор документа».

Приклади

Приклад тіла запиту в json форматі:

{
  приклад тимчасово відсутній
}

Приклад тіла відповіді в текстовому форматі:

приклад тимчасово відсутній

Видалення вкладення документа сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP DELETE

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/attachment

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

attach_id - ідентифікатор вкладення

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

У відповідь передається код сервера 200 (ok).

Видалення документів сервісу «ЕТТН» з «Чернеток»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/docs

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передається масив ідентифікаторів документів (doc_uuid) сервісу «ЕТТН».

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається код сервера 200 (ok).

Створити копію документа сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/clone

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається ідентифікатор створеної копії документа сервісу «ЕТТН» в текстовому вигляді.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в текстовому форматі:

{
  приклад тимчасово відсутній
}

Підтвердити документ сервісу «ЕТТН»

Важливо

Метод може бути виконаний тільки у відповідь на вхідний документ зі сторони вантажоодержувача або перевізника!

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/confirm

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

У відповідь передається код сервера 200 (ok).

Відмовити в підписанні документа сервісу «ЕТТН»

Важливо

Метод може бути виконаний тільки у відповідь на вхідний документ зі сторони вантажовідправника або перевізника!

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/reject

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

У відповідь передається код сервера 200 (ok).

Відправка документа сервісу «ЕТТН» з Чернеток

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/send

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

У відповідь передається код сервера 200 (ok).

Отримання ланцюжка документів сервісу «ЕТТН» по id ланцюжка чи id документа

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/chain

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

chain_uuid або doc_uuid - ідентифікатор ланцюжка або ідентифікатор документа відповідно

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані ланцюжка документів (об’єкт XChain).

Таблиця 1 - Опис параметрів об’єкта XChain

Параметр

Формат

Опис

Об’єкт XChain

id

long

ID шарда

uuid

UUID

UUID ланцюжка документів

packageID

long

ID пакета

type

XDocType_

об’єкт; тип документа

docsCount

int

кількість документів в ланцюжку

lastInDocID

long

id останнього вхідного документа в ланцюжку

lastOutDocID

long

id останнього вихідного документа в ланцюжку

partnerId

long

id роздрібної мережі

important

boolean

відмітка важливий документ

status

XChainStatus

об’єкт; статус пари документів у відправника і одержувача

visualStatus

int

номер іконки

archive

boolean

відмітка; Архівний документ чи ні

childs

List< XDoc >

масив об’єктів; дані документів/квитанцій

chainsInPackage

List<XChain>

масив об’єктів; дані пов’язаних ланцюжків

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 2 - Опис параметрів об’єкта XChainStatus

Параметр

Формат

Опис

Об’єкт XChainStatus

state

int

id статусу

title

String

статус

Таблиця 3 - Опис параметрів об’єкта XDoc

Параметр

Формат

Опис

Об’єкт XDoc

body

XDocBodyForms_

об’єкт; тіла документів

attachments

List<XDocAttachment_>

масив об’єктів; вкладення (може не використовуватися)

comments

XDocCommentsList_

об’єкт (в якому масив об’єктів); список коментарів

doc_id

long

id документа

doc_uuid

UUID

унікальний ідентифікатор документа/квитанції

uuidSender

String

унікальний ідентифікатор відправника

uuidReceiver

String

унікальний ідентифікатор одержувача

docNumber

String

номер документа

dateCreated

long

дата створення документа (unix timestamp)

dateChanged

long

дата останньої зміни документа (unix timestamp)

dateRead

long

дата прочитання документа (unix timestamp)

docDate

long

дата документа, зазначена в документі

chain_id

long

id ланцюжка документів

chain_uuid

UUID

унікальний ідентифікатор ланцюжка документів

family

int

сімейство (EDI / UZD)

hash

String

хеш-значення, отримане в результаті обробки

type

XDocType_

об’єкт; тип документа

status

XDocStatus_

об’єкт; статус пари документів у відправника і одержувача

exchange_status

String

сабстатус документа

is_archive

boolean

відмітка; Архівний документ чи ні

signInfo

XDocSignInfo_

об’єкт; дані про підписи

chain

XChain

объект; дані пов’язаних ланцюжків

extraFields

Map<String, String>

масив об’єктів; набір індексів (аналог індексних таблиць)

tags

List<XTag_>

масив об’єктів; прикріплені теги

statuses

List<XStatus_>

масив об’єктів; статуси обробки відправлених документів

multiExtraFields

Map<String, List<String>>

масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання списку ланцюжків документів сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/chains/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передаються дані для фільтрації (об’єкт StorageQuery)

Таблиця 2 - Опис json-параметрів (фільтр) запиту методу API

Параметр

Обов’язкове / необов’язкове поле

Формат

Опис

Об’єкт StorageQuery

extraParams

List<ExtraQueryParameters>

масив об’єктів;

multiExtraParams

List<ExtraQueryParameters>

масив об’єктів;

type

О

List<XDocType>

масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа

statuses

О

List<Integer>

масив; список статусів (станів) документів, за якими буде відбуватися відбір: 0 - все 1 - open 2 - sent 3 - delivered 4 - inbox 5 - read 6 - error 7 - deleted

tags

List<Long>

масив; тег

exchangeStatus

Н

List<Integer>

масив; статус документообігу

docs

List<Long>

масив; документи

direction

О

Direction

об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів

limit

Н

Limitation

объект; фільтр відбору (налаштування виводу даних)

number

Н

String

номер документа

family

Н

int

сімейство (EDI / UZD); можливі значення: 1 - edi

partnerId

Long

id роздрібної мережі

chainHash

String

хеш-значення, отримане в результаті обробки ланцюжка

docHash

String

хеш-значення, отримане в результаті обробки документа

docDate

Н

DateTimeRange

об’єкт; дата зазначена в документі (в форматі UNIX-timestamp) з / по

docCreate

Н

DateTimeRange

об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по

docRead

Н

DateTimeRange

об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по

docChanged

Н

DateTimeRange

об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по

archive

Boolean

відмітка наявності архівної ознаки документа

important

boolean

відмітка важливий документ

visible

boolean

відмітка видимості

loadBody

boolean

відмітка наявності тіла документа

loadComments

boolean

відмітка наявності коментарів до документа

loadStatuses

boolean

відмітка наявності статусів документа

loadTags

boolean

відмітка наявності тегів документа

loadChain

boolean

відмітка наявності ланцюжка документів

Таблиця 3 - Опис параметрів об’єкта ExtraQueryParameters

Параметр

Обов’язкове / необов’язкове поле

Формат

Опис

Об’єкт ExtraQueryParameters

operator

enum (AND, OR)

type

О

enum (EQUALS, EQUALS_UUID, EQUALS_MD5, LIKE, MORE, MORE_EQ, LESS, LESS_EQ, IN)

fieldName

String

найменування параметру

value

String

id параметра

Таблиця 4 - Опис параметрів об’єкта Direction

Параметр

Обов’язкове / необов’язкове поле

Формат

Опис

Об’єкт Direction

type

enum (EQ, OR, IN)

тип вибірки; можливі значення: » EQ » / » OR » / » IN » * EQ - відбираються тільки документи в яких збігаються зазначені і sender, і receiver; * OR - відбираються документи в яких збігаються АБО sender, АБО receiver; * IN - відбираються документи в яких sender або receiver один з тих, які вказані в масивах sender і receiver

sender

О/Н

List<String>

масив; відправники; GLN відправників - обов’язковий, але може бути порожнім якщо зазначений масив GLN одержувачів (receiver)

receiver

О/Н

List<String>

масив; одержувачі; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначений масив GLN відправників (sender)

Таблиця 5 - Опис параметрів об’єкта Limitation

Параметр

Обов’язкове / необов’язкове поле

Формат

Опис

Об’єкт Limitation

offset

Н

int

зміщення першого елемента списку щодо верхньої межі вибірки (за замовчуванням 0)

count

Н

int

ліміт вибірки (кількість)

Таблиця 6 - Опис параметрів об’єкта DateTimeRange

Параметр

Обов’язкове / необов’язкове поле

Формат

Опис

Об’єкт DateTimeRange

startTimestamp

long

початок часового діапазону

finishTimestamp

long

закінчення часового діапазону

Таблиця 7 - Опис параметрів об’єкта XDocType

Параметр

Тип

Формат

Опис

Об’єкт XDocType

опис_параметрів

type

int

id типу документа/квитанції

title

String

назва документа/квитанции

description

String

опис документа/квитанції (найменування кирилицею)

Таблиця 8 - Опис fieldName параметрів (объект ExtraQueryParameters)

id параметра

Найменування параметра

Обов’язкове / необов’язкове поле

Формат

Опис параметра

1

created_from

UUID

ідентифікатор документа або ланцюжка

2

is_signed

TINYINT

відмітка про підписання

3

encrypted

TINYINT

відмітка про шифрування

4

comdoc_reestr_id

INT

id факторингового Реєстру на підставі комерційного документа

5

comdoc_reestr_is_active

TINYINT

відмітка про активність факторингового договору

6

ftpex_file_name

VARCHAR

найменування файлу, відправленого по FTP

7

ftpex_file_date

INT

дата/час відправки документа по FTP

8

inv_date

INT

дата документа invrpt (Звіт про інвентаризацію)

9

inv_num

VARCHAR

номер документа invrpt (Звіт про інвентаризацію)

11

sub_doc_type_id

INT

id підтипу документа

12

sub_status_id

INT

id статусу документа (стан ланцюжка документів)

13

action

VARCHAR

статус документа за здійсненими діями користувача

14

buyer_uuid

VARCHAR

відправник документа

15

consignee_uuid

VARCHAR

вантажоодержувач

16

consignor_uuid

VARCHAR

вантажовідправник

17

customer_uuid

VARCHAR

покупець

18

performer_uuid

VARCHAR

виконавець

19

supplier_uuid

VARCHAR

постачальник

20

delivery_place_uuid

VARCHAR

місце доставки

21

contract_date

VARCHAR

дата договору

22

contract_number

VARCHAR

номер договору

23

delivery_date

M

INT

дата доставки

24

order_number

M

VARCHAR

номер замовлення

25

order_date

INT

дата замовлення

26

return_date

INT

дата повернення

27

summ

VARCHAR

сума з ПДВ

28

parent_chain_hash

MD5

хеш ланцюжка

29

period

VARCHAR

крайня дата підпису документа

31

trans_id

VARCHAR

id транзакції

32

ttn

VARCHAR

номер накладної

33

doc_start_date

VARCHAR

початок терміну підписання документа

34

doc_end_date

VARCHAR

закінчення терміну підписання документа

35

delivery_note_number

VARCHAR

номер накладної

42

contract_gln

VARCHAR

GLN місце доставки при товарному узгодженні (Agreem-> Comdoc)

43

doc_date

INT

дата з документа

44

delivery_agreement_number

VARCHAR

кількість узгоджень

45

delivery_agreement_date

INT

дата узгодження

46

varn

VARCHAR

ЮЗД id документа

47

other_info

TEXT

додаткові дані

48

sub_doc_date

INT

дата підтипу документа

49

sub_doc_number

VARCHAR

номер підтипу документа

50

doc_error

TEXT

помилка при роботі з документом

51

doc_info

TEXT

коментар до документа

52

old_doc_id

INT

id документа

53

sub_status_date

INT

дата статусу документа (стан ланцюжка документів)

54

from_doc_id

INT

порядковий номер документа в ланцюжку

56

doc_num

VARCHAR

номер документа

57

sender

VARCHAR

GLN відправника

58

recipient

VARCHAR

GLN одержувача

59

file_name

VARCHAR

найменування прикладаємого (вкладення) файлу

60

xml_hash

VARCHAR

хеш змісту документа

61

answer_doc_id

INT

id COMDOC документа відправленного у відповідь

80

identifier

VARCHAR

ідентифікатор документа в системі клієнта

82

compound_number

VARCHAR

складовий номер

85

doc_process

TINYINT

87

users

VARCHAR

88

basis_doc_subtype

INT

підтип документа-підстави

89

basis_doc_number

INT

номер документа-підстави

90

basis_doc_date

INT

дата документа-підстави

Таблиця 9 - Опис DocType параметрів (объект XDocType)

Тип

Назва

Опис (найменування кирилицею)

0

all

всі

1

invoice

Рахунок

2

orders

Замовлення

3

recadv

Повідомлення про прийом

4

desadv

Повідомлення про відвантаження

5

ordrsp

Підтвердження замовлення

6

pricat

Прайс-лист

10

declar

Податкова накладна

11

insdes

Інструкція з доставки

13

slsrpt

Звіт про продажі

14

invrpt

Звіт про інвентаризацію

15

coacsu

Акт звірки взаєморозрахунків

16

actset

Акт взаємозаліку

17

iftmin

Інструкція про транспортування

18

retann

Повідомлення про повернення

19

iftmbf

Замовлення транспортування

21

mscons

Звіт про надані послуги

25

retins

Інструкція з повернення

28

comdoc

Комерційний документ

29

declarj12

Коригування до податкової накладної

30

condra

Не структурований документ

42

iftmbc

Підтвердження замовлення транспортування

59

documentinvoice

Товарна накладна

67

doccorinvoice

doccorinvoice

75

waybill

Товарно-транспортна накладна (ТТН)

79

addbill

addbill

98

quotes

Додаток до Повідомлення про відвантаження

RESPONSE

У відповідь передається масив ланцюжків документів (об’єкт XChain).

Таблиця 10 - Опис параметрів об’єкта XChain

Параметр

Формат

Опис

Об’єкт XChain

id

long

ID шарда

uuid

UUID

UUID ланцюжка документів

packageID

long

ID пакета

type

XDocType

об’єкт; тип документа

docsCount

int

кількість документів в ланцюжку

lastInDocID

long

id останнього вхідного документа в ланцюжку

lastOutDocID

long

id останнього вихідного документа в ланцюжку

partnerId

long

id роздрібної мережі

important

boolean

відмітка важливий документ

status

XChainStatus

об’єкт; статус пари документів у відправника і одержувача

visualStatus

int

номер іконки

archive

boolean

відмітка; Архівний документ чи ні

childs

List< XDoc >

масив об’єктів; дані документів/квитанцій

chainsInPackage

List<XChain>

масив об’єктів; дані пов’язаних ланцюжків

hash

String

хеш-значення, отримане в результаті обробки

Таблиця 11 - Опис параметрів об’єкта XChainStatus

Параметр

Формат

Опис

Об’єкт XChainStatus

state

int

id статусу

title

String

статус

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання документа сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані документа (об’єкт `XDoc<https://wiki.edi-n.com/uk/latest/API_ETTN/Methods/XDocPage.html>`__ ).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання документа в вигляді архіву (json + XML + підписані дані)

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/doc/xml

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається файл-вкладення у вигляді *.zip архіву.

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

У відповідь передається файл-вкладення у вигляді *.zip архіву.

Отримання вкладення документа сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/attachment

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

type - тип вкладення; можливі значення: «bytes» - вкладення в вигляді набору байтів, «list» - вкладення в json вигляді (XDocAttachment)

Опціональні url-параметри:

attach_id - ідентифікатор вкладення (використовується при type=bytes)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається вкладення документа сервісу «ЕТТН» (в вигляді набору байтів при type=bytes чи в json вигляді при type=list (об’єкт XDocAttachment)).

Таблиця 1 - Опис параметрів об’єкта XDocAttachment

Параметр

Формат

Опис

Об’єкт XDocAttachment

id

long

id вкладення

docUUID

UUID

унікальний ідентифікатор документа

fileName

String

найменування файлу

createDate

long

дата створення вкладення; формат unix timestamp

type

String

тип вкладення

base64content

String

зміст вкладення в BASE64

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді для вкладення в вигляді набору байтів:

{
  приклад тимчасово відсутній
}

Приклад тіла відповіді для вкладення в json форматі:

{
  приклад тимчасово відсутній
}

Отримання тіла документа сервісу «ЕТТН» в json форматі

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/body

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається тіло документа сервісу «ЕТТН» (об’єкт ETTN чи TRANSHIPMENT відповідно).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді для «ЕТТН» документа в json форматі:

{
  приклад тимчасово відсутній
}

Приклад тіла відповіді для «Акт перевантаження товарів» документа в json форматі:

{
  приклад тимчасово відсутній
}

Отримання списку документів сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/docs/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передається масив документів (об’єкт `XDoc<https://wiki.edi-n.com/uk/latest/API_ETTN/Methods/XDocPage.html>`__ ).

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання даних підписантів документа сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP PATCH

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/signers

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані підписантів документа («ЕТТН» чи «Акт перевантаження товарів») (об’єкт EndUserSignInfo).

Таблиця 1 - Опис параметрів об’єкта EndUserSignInfo

Параметр

Формат

Опис

Об’єкт EndUserSignInfo

EndUserOwnerInfo

EndUserOwnerInfo

об’єкт; дані власника сертифікату

EndUserTimeInfo

EndUserTimeInfo

об’єкт; дата підписання сертифікату

Таблиця 2 - Опис параметрів об’єкта EndUserOwnerInfo

Параметр

Формат

Опис

Об’єкт EndUserOwnerInfo

isFilled

boolean

відмітка про заповненість сертифікату

issuer

string

видавець сертифікату

issuerCN

string

назва видавця сертифікату

serial

string

серійний номер сертифікату

subject

string

загальна інформація про власника сертифікату

subjCN

string

ім’я власника сертифікату

subjOrg

string

організація власника сертифікату

subjOrgUnit

string

підрозділ власника сертифікату

subjTitle

string

посада власника сертифікату

subjState

string

регіон/область власника сертифікату

subjLocality

string

місцеперебування власника сертифікату

subjFullName

string

повне ім’я власника сертифікату

subjAddress

string

адреса власника сертифікату

subjPhone

string

номер телефону власника сертифікату

subjEMail

string

e-mail власника сертифікату

subjDNS

string

subjEDRPOUCode

string

код ЕДРПОУ власника сертифікату

subjDRFOCode

string

код ДРФО власника сертифікату

Таблиця 3 - Опис параметрів об’єкта EndUserTimeInfo

Параметр

Формат

Опис

Об’єкт EndUserTimeInfo

version

number

версія

isTimeAvail

boolean

присутність часу підписання

isTimeStamp

boolean

присутність мітки часу

time

Date

час підписання в форматі „Feb 10, 2020 2:07:42 PM“

isSignTimeStampAvail

boolean

присутність мітки часу підписання

signTimeStamp

Date

мітка часу підписання

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  consignor: EndUserSignInfo[], carrier: EndUserSignInfo[], consignee: EndUserSignInfo[]
}

Отримання даних документа сервісу «ЕТТН» для підписання

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/xml/ticket

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані документа сервісу «ЕТТН» в вигляді набору байтів

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Підписання даних сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/doc/xml/sign

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

doc_uuid - ідентифікатор документа

trans_type - тип транзакції; можливі значення: «-3» - чернетка (вантажоодержувач); «-2» - чернетка (водій); «-1» - чернетка (вантажовідправник); «1» - відправлений; «2» - підтверджений вантажовідправником; «3» - підтверджений водієм; «4» - підтверджений вантажоодержувачем; «5» - підписаний вантажовідправником; «6» - підписаний водієм; «7» - підписаний вантажоодержувачем; «8» - відмінений вантажовідправником; «9» - відмінений водієм; «10» - відмінений вантажоодержувачем

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передається підпис в параметрі sign.

Увага

Підпис НЕ передається в BASE64 форматі!

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

{
  приклад тимчасово відсутній
}

У відповідь передається код сервера 200 (ok).

Заархівувати всі документи у вказаному ланцюжку

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/ettn/eds/chains/archive

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передається масив об’єктів з ідентифікаторами ланцюжків.

RESPONSE

У відповідь передається код сервера 200 (ok).

Приклади

Приклад тіла запиту в json форматі:

{
  приклад тимчасово відсутній
}

У відповідь передається код сервера 200 (ok).

Отримання даних про компанію за назвою / ІНН / ЄДРПОУ

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/oas/v2/company/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

query - текст пошуку (пошук здійснюється за назвою компанії, ІНН, ЄДРПОУ)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані компанії (об’єкт CompanyV2).

Таблиця 1 - Опис параметрів об’єкта CompanyV2

Параметр

Формат

Опис

Об’єкт CompanyV2

uuid

UUID

ідентифікатор компанії

name

String

назва компанії

type

int

форма власності; 1 - Юридична особа, 2 - Фізична особа

ipn

String

код ІПН

edrpou

String

код ЄДРПОУ

city

String

місто

address

String

адреса

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання даних про компанію по ідентифікатору компанії

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/oas/v2/company/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

company_uuid - ідентифікатор компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані компанії (об’єкт CompanyV2).

Таблиця 1 - Опис параметрів об’єкта CompanyV2

Параметр

Формат

Опис

Об’єкт CompanyV2

uuid

UUID

ідентифікатор компанії

name

String

назва компанії

type

int

форма власності; 1 - Юридична особа, 2 - Фізична особа

ipn

String

код ІПН

edrpou

String

код ЄДРПОУ

city

String

місто

address

String

адреса

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання адреси з довідника компанії за назвою / містом / вулицею / кодом КОАТУУ

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/oas/v2/company/addresses/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

edrpou - ЄДРПОУ компанії в довіднику якої здійснюється пошук

Опціональні url-параметри:

query - текст пошуку (пошук здійснюється за назвою / містом / вулицею / кодом КОАТУУ). Якщо не вказувати параметр query, то прийде список з перших 10 адрес з довідника даної компанії

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються список адрес (об’єкт Address).

Таблиця 1 - Опис параметрів об’єкта Address

Параметр

Формат

Опис

Об’єкт Address

uuid

UUID

ідентифікатор адреси

name

String

назва адреси

city

String

місто

street

String

вулиця

koatuu

String

код КОАТУУ

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання даних співробіника компанії за назвою / містом / вулицею / кодом КОАТУУ

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/oas/v2/company/employees/search

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові url-параметри:

uuid - ідентифікатор компанії АБО edrpou - ЄДРПОУ компанії в довіднику якої здійснюється пошук. edrpou є пріоритетнішим параметром

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються список співробітників компанії (об’єкт Employee).

Таблиця 1 - Опис параметрів об’єкта Employee

Параметр

Формат

Опис

Об’єкт Employee

uuid

UUID

ідентифікатор співробітника

userId

long

id користувача

lastName

String

прізвище співробітника

firstName

String

ім’я співробітника

middleName

String

по батькові співробітника

ipn

long

код ІПН співробітника

email

String

email співробітника

tel

String

номер телефону співробітника

identifiers

Map<Integer, String>

додаткові дані; контакти

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}

Отримання даних компанії, співробітників, адрес з довідників сервісу «ЕТТН»

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі)

URL запиту

{url серверу} /api/oas/v2/exdata

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі в json-тілі запиту передаються ідентифікатори компанії, співробітників, адрес у вигляді масивів. По кожному масиву ідентифікаторів здійснюється незалежний пошук даних.

RESPONSE

У відповідь передається json-тіло з даними компанії, співробітників, адрес в випадку, якщо в запиті передавався відповідний ідентифікатор (об’єкти CompanyV2, Employee, Address).

Таблиця 1 - Опис параметрів об’єкта CompanyV2

Параметр

Формат

Опис

Об’єкт CompanyV2

uuid

UUID

ідентифікатор компанії

name

String

назва компанії

type

int

форма власності; 1 - Юридична особа, 2 - Фізична особа

ipn

String

код ІПН

edrpou

String

код ЄДРПОУ

city

String

місто

address

String

адреса

Таблиця 2 - Опис параметрів об’єкта Employee

Параметр

Формат

Опис

Об’єкт Employee

uuid

UUID

ідентифікатор співробітника

userId

long

id користувача

lastName

String

прізвище співробітника

firstName

String

ім’я співробітника

middleName

String

по батькові співробітника

ipn

long

код ІПН співробітника

email

String

email співробітника

tel

String

номер телефону співробітника

identifiers

Map<Integer, String>

додаткові дані; контакти

Таблиця 3 - Опис параметрів об’єкта Address

Параметр

Формат

Опис

Об’єкт Address

uuid

UUID

ідентифікатор адреси

name

String

назва адреси

city

String

місто

street

String

вулиця

koatuu

String

код КОАТУУ

Приклади

Приклад тіла запиту в json форматі:

{
  "companies": [
    "uuid1",
    "uuid2"
  ],
  "employees": [
    "uuid1",
    "uuid2"
  ],
  "addresses": [
    "uuid1",
    "uuid2"
  ]
}

Приклад тіла відповіді в json форматі:

{
  "companies": {
    "uuid1": {
      дані по компанії
    }
  },
  "employees": {
    "uuid1": {
      дані по співробітнику
    }
  },
  "addresses": {
    "uuid1": {
      дані по адресі
    }
  }
}

Інструкції

Робота з сервісом EDIN-Tender 2.0

Вхід

Для роботи з WEB сервісом Ви можете використовувати будь-який браузер (рекомендованим є Google Chrome останньої версії). Для входу до сервісу платформи необхідно перейти за посиланням ВЖЕ ВІДОМА ПРОД АДРЕСА?????? https://dev-tender.edi-n.com .

При переході за вказаним посиланням відкриється вікно авторизації. Необхідно ввести Ваш логін і пароль користувача і натиснути «Вхід», як це зазначено на зображенні нижче:

_images/Work_with_Tender_01.png

Загальний вигляд платформи

Після успішної авторизації відкриється основне вікно сервісу EDIN Tender.

_images/Work_with_Tender_02.png

Основне вікно сервісу EDIN Tender:

  1. Меню ролей - дозволяє вибрати роль, відносно якої будуть виконуватись дії користувача

  2. Меню вибору тендерів - дозволяє вибрати тендери, що будуть відображатись в журналі («Усі», «Активні», «Завершені» та «Чернетки» для ролі «Організатор»)

    • «Усі тендери» - всі тендери, які проводяться або проводилися на платформі;

    • «Активні» - список поточних або майбутніх тендерів;

    • «Чернетки» - список створених Вами тендерів, які ще не були опубліковані;

    • «Завершені» - список створених Вами завершених тендерів;

  3. Налаштування підписок

  4. Журнал тендерів та налаштування їх відображення

  5. Рядок пошуку тенедра/лоту по назві чи опису

  6. Навігація на платформі

  7. Дані про компанію, вибір мови, вихід з платформи

Журнал тендерів

В журналі доступний пошук по заголовкам і описами, як тендерів так і лотів, можливість вибору формату відображення - «Компактний», «Докладний» (включає відображення статусу тендера і його короткий опис) і «З лотами» (включає відображення лотів всіх тендерів).

В лівій частині по кожному тендеру символами відображаються:

  • звезда / звезда2 - регульована відмітка користувача, «важливий»/»звичайний» тендер

  • відкрито / закрито - тип тендера, Відкритий / Закритий

  • рупор / судья - етап, Торги / Збір пропозицій

  • magic - відмітка про те, що увімкнена функція автопродовження

  • Кольорами відображається статус тендера, а цифрами «кількість лотів»/»загальна кількість ставок»

    • фіолетовий - тендер, у якого 1 лот ще не розпочався

    • зелений - тендер з 7 лотами триває (розпочався), по лоту/-ам якого вже зроблено 6 ставок

    • червоний - тендер з 7 лотами вже завершився, по лоту/-ам якого було зроблено 6 ставок

Також для Організатора по кожному тендеру в правій частині журналу доступні кнопки редагувати видалити для редагування та видалення тендера.

Інше

На платформі існує можливість зміни мови інтерфейсу. Для вибору мови Вам необхідно натиснути на знак прапора, у верхній правій частині сторінки. Доступні мови: українська, російська, англійська.

_images/Work_with_Tender_34.png

Робота з тендерами

Важливо

Сервіс EDIN Tender дозволяє користувачу вести роботу з тендерами в якості «Учасника» та «Організатора». Ці ролі суттєво відрізнються, логіка формування та налаштування тендера від імені «Організатора» описана в розділі «Створення тендера», а робота з тендером в якості «Учасника» - в розділі «Участь в тендері».

Створення тендера

Для створення тендера Вам необхідно:

  • Натиснути на кнопку «Організатор», вибравши відповідну роль на платформі

  • Натиснути на кнопку «Додати тендер»

_images/Work_with_Tender_03.png

Після цього відкриється форма створення тендера:

_images/Work_with_Tender_04.png

Форма створення тендера складається з «загальних налаштувань тендера» (1) та «налаштувань лотів тендера» (2).

В налаштуваннях тендера Вам доступні наступні параметри (поля позначені червоною зірочкою * - обов’язкові до заповнення):

  • Напрям тендера: «Закупівля» чи «Продаж»;

  • Етап: «Торги» чи «Збір пропозицій»;

  • Вид: «Відкритий» чи «Закритий»;

    • «Відкритий» тендер дозволяє всім користувачам сервісу переглядати информацію про тендер та його лоти; зробити ставку в «відкритому» тендері може будь-який користувач системи.

    • «Закритий» тендер НЕ відображається користувачам сервісу до початку тендера, а після його початку не запрошені користувачі можуть лише переглядати інформацію тендера. Приймати участь в тендері можливо по запрошенню Організатора або через «Подачу заявки» (детальніше в розділі «закритого» тендера ).

  • Дату та час початку/завершення аукціону. Час і дата початку аукціону повинні бути налаштовані не менш ніж +1 година від часу заповнення поля. Час і дата завершення повинні бути налаштовані не менш ніж +30 хвилин від часу і дати початку аукціону;

  • Автопродовження - відмітка, що активує функцію, котра спрацьовує в випадку коли один із участників робить ставку в останні 5 хвилин аукціону (до його завершення). Тендер автоматично продовжується на 5 хвилин;

  • Валюта: вибір валюти зі списку;

  • Ціна без ПДВ - відмітка, про те що ціни лотів будуть вказані без ПДВ;

  • Назва: короткий опис, інформація про тендер. Наприклад: Збір пропозицій, вівсяні пластівці;

  • Опис: повний опис тендера - інформація, що дасть учасникам максимально повне уявлення про майбутній тендер;

  • Налаштування для всіх лотів:

    • Не показувати ставки - активована функція приховує список всіх ставок для учасників;

    • Не показувати кращу ставку - активована функція приховує тільки кращу ставку;

    • Ховати лише імена учасників - за активованої функції імена участників будуть відображатись в вигляді номера, котрий буде змінюватись з кожною ставкою. При цьому кращаставка та список будуть доступні для перегляду

Важливо

Кожне налаштування виконує тільки одну дію! Всі налаштування можливо комбінувати між собою. Якщо Ви не визначили налаштування видимості, то інформація буде доступна всім користувачам EDIN-Tender. При створенні декількох лотів в одному аукціоні, є можливість використовувати налаштування, як для кожного лота індивідуально, так і для всіх відразу.

  • Завантажені файли: доступна можливість прикріплення файлів до опису тендера (не більше 5 файлів в одному тендері з обмеженням розміру файлу до 5 МБ)

Після налаштувань загальних параметрів тендера необхідно виконати налаштування лотів.

_images/Work_with_Tender_05.png

  • Кнопка «Додати лот» створює додатковий лот (в одному аукціоні може бути до 10 лотів);

  • Заголовок лота: поле для опису назви товару;

  • Код товару: необов’язкове поле, що використовується для введення артикулу або коду товару згідно з Вашою обліковою системою;

  • Опис: поле для більш детального опису товару;

  • Початок / Закінчення поставки: не є обов’язковими для заповнення, однак не повинні бути встановлені на дату раніше, ніж дата завершення аукціону;

  • Регіон: перелік регіонів України (за замовчуванням встановлено значення «Всі області»);

  • Категорія: до якої категорії відноситься лот (не є обов’язковими для заповнення). При натисканні на кнопку «Вибрати з довідника CPV», відкривається єдиний державний довідник товарних категорій, з’являється можливість вибрати категорію, до якої відноситься Ваш лот:

_images/Work_with_Tender_06.png

Можливо скористатись ієрархічним переходом до потрібної категорії чи пошуком: ввести назву категорії (1), натиснути «Знайти» (2), вибрати необхідну категорію (3) та натиснути на кнопку «Зберегти та вийти» (4);

Увага

Для того, щоб скинути пошук в категорії необхідно натиснути хрестик біля кнопки «Знайти»

  • Кількість та одиниці виміру: кількість товару, який вказаний в лоті та одиницю його виміру зі списку;

  • Стартова ціна: початкова вартість за одиницю товару, яку Ви встановлюєте, як організатор. При формуванні стартової ціни необхідно враховувати, що перша ставка в торгах на зниження - це стартова ціна з відрахуванням кроку ставки. Тобто постачальник не може запропонувати ставку в розмірі стартової ціни.

  • Крок ставки: мінімальна сума для зниження/підвищення ціни. Крок ставки вказується тільки при наявності стартової ціни.

  • Налаштування лота: в разі якщо Ви не налаштували відповідні налаштування в загальних налаштуваннях тендера, у Вас є можливість приховувати всі ставки, приховувати кращу ставку і приховувати імена учасників для конкретного лота.

  • Завантажені файли: доступна можливість прикріплення файлів до опису лота (не більше 5 файлів в одному лоті з обмеженням розміру файлу до 5 МБ)

Після установки всіх необхідних налаштувань, натисніть на кнопку «Попередній перегляд перед публікацією», для збереження Вашого тендера в «Чернетки».

_images/Work_with_Tender_08.png

Примітка

В разі, якщо при налаштуваннях тендера/лота були допущені явні помилки або незаповнені обов’язкові поля, то платформа повідомить про це:

_images/Work_with_Tender_09.png

У каталозі «Черновик», у вас є можливість Редагувати всі дані і налаштування Вашого тендера, після чого Ви можете Опублікувати тендер.

Примітка

Завершити достроково можливо лише активний (опублікований) тендер.

_images/Work_with_Tender_10.png

Увага

Після публікації тендера, у Вас не буде можливості редагувати його дані і налаштування.

В каталозі «Чернетки» або «Завершені» у Вас є можливість при натисканні на кнопку «Клонувати», копіювати інформацію та налаштування обраного тендера для його подальшого редагування і подальшої публікації.

_images/Work_with_Tender_11.png

Після натискання на кнопку «Опублікувати», Ваш тендер автоматично стає «Активним» а також з’являється в загальному списку «Усі тендери».

_images/Work_with_Tender_12.png

Увага

Якщо в налаштуваннях тендера було обрано «Закритий» Вид, то бажаних учасників тендера можливо запросити:

_images/Work_with_Tender_15.png _images/Work_with_Tender_16.png

Запрошений «Учасник» може переглянути нформацію по тендеру і його лотам, а у Організатора в цьому тендері відобразиться список запрошених учасників:

_images/Work_with_Tender_17.png

Увага

Кнопки Схвалити/Відхилити Учасника доступні Організатору лише до початку тендера.

Участь в тендері

Тендер (в залежності від налаштувань Організатора) може бути «відкритим» або «закритим».

Участь у «відкритому» тендері

Для того аби прийняти участь у «відкритому» тендері Вам необхідно:

  • Натиснути на кнопку «Учасник», вибравши відповідну роль на платформі

  • Перейти в каталог «Усі тендери»

_images/Work_with_Tender_13.png

  • Вибрати і натиснути на тендер в журналі, що Вас цікавить

  • У відкритому тендері зробити ставку по лоту (на кожен лот окрема ставка)

Підказка

Зробити ставку можна тільки на лот активного аукціону, який розпочався

_images/Work_with_Tender_14.png
Участь у «закритому» тендері

В даних тендерах беруть участь тільки ті учасники, участь яких була раніше підтверджена Організатором. Для цього необхідно подати заявку на участь або бути запрошеним організатором (в останньому випадку Учасник отримує повідомлення на e-mail про те, що він запрошений до участі в закритому тендері).

Для того, щоб подати заявку, необхідно зайти в Вас тендер, і натиснути на кнопку «Подати заявку».

_images/Work_with_Tender_18.png

Після натискання на кнопку «Подати заявку», на екрані з’явиться повідомлення про те, що Ваша заявка була успішно відправлена Організатору, кнопка «Подати заявку» після цього перестає бути активною («Заявка уже подана»). У Організатора в тендері, на який була подана заявка у вкладці Учасників відображається кількість запитів, що очікують відповіді.

_images/Work_with_Tender_20.png

Коли Організатор ухвалить рішення за Вашою заявою, ви отримаєте повідомлення на e-mail, по цьому тендеру відобразиться інформація по лотам, з’явиться можливість зробити ставку.

Примітка

Якщо Організатор відхилить заявку повторно відправити її не буде можливо

Закони та НПА

Закони, підзаконні нормативно-правові акти, які регулюють питання електронного документообігу та електронних довірчих послуг

1. Закон України “Про електронні документи та електронний документообіг” (https://zakon.rada.gov.ua/laws/show/851-15)

2. Закон України “Про електронні довірчі послуги” (https://zakon.rada.gov.ua/laws/main/2155-19)

3. Закон України “Про бухгалтерський облік та фінансову звітність в Україні” із змінами та доповненнями (ст. 9) (https://zakon.rada.gov.ua/laws/main/996-14)

4. Цивільний кодекс України (ч. 3 ст. 207, ст. 639) (https://zakon.rada.gov.ua/laws/show/435-15)

5. Цивільний процесуальний кодекс України (§5 Електронні докази) (https://zakon.rada.gov.ua/laws/show/1618-15)

6. Господарський процесуальний кодекс України (§5 Електронні докази) (https://zakon.rada.gov.ua/laws/main/1798-12)

7. Кодекс адміністративного судочинства України (§5 Електронні докази) (https://zakon.rada.gov.ua/laws/main/2747-15)

8. Порядок взаємного визнання українських та іноземних сертифікатів відкритих ключів, електронних підписів, а також використання інформаційно-телекомунікаційної системи центрального засвідчувального органу для забезпечення визнання в Україні електронних довірчих послуг, іноземних сертифікатів відкритих ключів, що використовуються під час надання юридично значущих електронних послуг у процесі взаємодії між суб’єктами різних держав, затверджений постановою Кабінету Міністрів України 23.01.2019 № 60 (https://zakon.rada.gov.ua/laws/show/60-2019-%D0%BF)

9. Порядок проведення процедури оцінки відповідності у сфері електронних довірчих послуг, затверджений постановою Кабінету Міністрів України 18.12.2018 № 1215 (https://zakon.rada.gov.ua/laws/show/1215-2018-%D0%BF)

10. Вимоги у сфері електронних довірчих послуг та Порядку перевірки дотримання вимог законодавства у сфері електронних довірчих послуг, затверджені постановою Кабінету Міністрів України 07.11.2018 № 992 (https://zakon.rada.gov.ua/laws/show/992-2018-%D0%BF)

11. Обов’язкові вимоги до Довірчого списку, затверджені постановою Кабінету Міністрів України 26.09.2018 № 775 (https://zakon.rada.gov.ua/laws/show/775-2018-%D0%BF)

12. Порядок використання електронних довірчих послуг в органах державної влади, органах місцевого самоврядування, підприємствах, установах та організаціях державної форми власності, затверджений ппостановою Кабінету Міністрів України 19.09.2018 № 749 (https://zakon.rada.gov.ua/laws/show/749-2018-%D0%BF)

13. Положення про документальне забезпечення записів у бухгалтерськомй обліку, затверджене наказом Міністерством фінансів України 24.05.1995 № 88, зареєстроване в Міністерстві юстції України 05.06.1995 за № 168/704, із змінами та доповненнями (пункти 2.1, 2.3, 2.12) (https://zakon.rada.gov.ua/laws/show/z0168-95)

14. Наказ Міністерства юстиції України, Адміністрації державної служби спеціального зв’язку та захисту інформації України від 01.02.2019 № 316/5/57, зареєстрований в Міністерстві юстиції України 05.02.2019 за № 123/33094 “Про позначку кваліфікованого сертифіката відкритого ключа” (https://zakon.rada.gov.ua/laws/show/z0123-19)

15. Регламент роботи центального засвідчувального органу, затверджений наказом Міністерства юстиції України 05.11.2018 № 3439/5, зареєстрований в Міністерстві юстиції України 05.11.2018 за № 1252/32704 (https://zakon.rada.gov.ua/laws/show/z1252-18)

16. Порядок ведення реєстру чинних, блокованих та скасованих сертифікатів відкритих ключів, затверджений наказом Міністерства юстиції України 05.11.2018 № 3440/5, зареєстрований в Міністерстві юстиції Ураїни 05.11.2018 за № 1253/32705 (https://zakon.rada.gov.ua/laws/show/z1253-18)

17. Порядок ведення довірчого списку, затверджений наказом Міністерства юстиції України 29.10.2018 № 3373/5. зареєстрований в Міністерстві юстиції України 29.10.2018 за № 1221/32673 (https://zakon.rada.gov.ua/laws/show/z1221-18)

18. Вимоги до форматів даних електронного документообігу в органах державної влади, затверджені наказом Державного агентства з питань електронного урядування України 07.09.2018 за № 1309/32761 (https://zakon.rada.gov.ua/laws/show/z1309-18)

19. Порядок обміну електронними документами з з контролюючими органами, затверджений наказом Міністерства фінансів України, зареєстрований в Міністерстві юстиції України 03.08.2017 № 959/30827 (https://zakon.rada.gov.ua/laws/show/z0959-17)

20. Формат (стандарт) електронного документа звітності суб’єктів господарювання та Опис довідників, що публікуються з Форматом (стандартом) електронного документа звітності суб’єктів господарювання, затверджений наказом Міністерства доходів і зборів України 29.11.2013 № 729, зареєстрований в Міністерстві юстиції України 06.02.2014 за № 243/25020 (https://zakon.rada.gov.ua/laws/show/z0243-14)

21. Типовий закон про електронну торгівлю Комісії Організації Об’єднаних Націй з права міжнародної торгівлі (https://zakon.rada.gov.ua/laws/show/995_321)

22. Типовий закон ЮНСІТРАЛ про електронні підписи (https://zakon.rada.gov.ua/laws/show/995_937)

  1. Наказ Міністерства інфраструктури України від 03.06.2019 № 413, зареєстрований в Міністерстві юстиції України 21.06.2019 за № 649/33620 «Про затвердження Змін до Правил перевезень вантажів автомобільним транспортом в Україні» (https://zakon.rada.gov.ua/laws/show/z0649-19)

Практика

  1. Що вважається оригіналом електронного документа (Загальнодоступний інформаційно-довідковий ресурс Інформаційно-доавідкового департаменту ДФС (ЗІР) , категорія 140.03);

  2. Лист Міністерства доходів і зборів України від 25.12.2013 № 6793/Ч/99-99-18-03-01-14(відносно паперових копій електронних документів);

  3. Лист Головного управління ДФС у Чернігівській області від 15.04.2016 № 1298/10/25-01-12-02-06;

  4. Лист Центального офісу з обслуговування великих платників Міжрегіонального управління ДФС від 10.09.2015 № 21705/10/28-10-06-11;

  5. Індивідуальна податкова консультація № 5044/6/99-99-14-05-01-15/ІПК (щодо можливості підписання касових документів та касової книги електронним підписом);

  6. Порядок зберігання податкових накладних та розрахунків коригування до податкових накладних, складених в електронній формі, для їх надання контролюючим органам під час проведення перевірки (ЗІР, категорія 101.6);

  7. Постанова Верховного суду у складі колегії суддів Касаційного господарського суду від 27.11.2018, справа № 914/2505/17;

  8. Постанова Вищого господарського суду України від 03.09.2015, справа № 910/27173/14;

  9. Постанова Вищого господарського суду України від 25.10.2016, справа № 916/4590/15;

  10. Постанова Вищого господарського суду України від 09.11.2017, справа № 910/25277/15;

  11. Постанова Вищого господарського суду України від 15.12.2014, справа № 910/5107/14;

  12. Постанова Дніпропетровського апелційного господарського суду від 25.07.2018, справа № 7/674/18;

  13. Постанова Другого апеляційного адміністративного суду від 18.03.2019, справа № 818/2417/18;

  14. Рішення Господарського суду м. Києва від 22.01.2019, справа № 910/12787/18;

  15. Постанова Господарського суду Дніпропетровської області від 14.03.2016, справа № 904/403/16;

  16. Рішення Господарського суду Дніпропетровської області від 12.05.2015, справа № 904/3438/15;

  17. Постанова Вищого господарського суду України від 01.10.2010, справа № 28/529-09;

  18. Ухвала Апеляційного суду Дніпропетровської області від 08.10.2013, справа № 410/5821/12;

  19. Рішення Господарського суду Донецької області від 10.04.2014, справа № 905/7066/13;

  20. Постанова Окружного адміністративного суду м. Києва від 17.02.2014, справа № 826/20454/13-а.

  21. Рішення Господарського суду міста Києва від 10.09.2019, справа № 910/6745/19.