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)