Створення/редагування сценарію документообігу

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

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній contractId, то сценарій документообігу з зазначеним Id підлягає редагуванню. Відсутність параметра contractId веде до створення нового сценарію документообігу.

Метод запиту	HTTPS POST
Content-Type	application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту)
URL запиту	https://doc.edin.ua/bdoc/contract
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації
Обов’язкові параметри, що передаються в тілі запиту (json)	contractId (для редагування сценарію документообігу), clientCompany, companyId, contractName, ownerCompany, number

JSON-параметри в тілі HTTPS запиту/відповіді

REQUEST

Опис json-параметрів запиту метода API (об’єкт Contract)

Таблиця 1 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

В запиті в об’єкті Company передаються:

Параметр	Mandatory/Optional	Формат	Опис
companyId	M	long	id компанії
accountId	O	long	id аккаунту

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Contract)

Таблиця 3 - Опис параметрів об’єкта Contract

Параметр	Формат	Опис
	Об’єкт Contract
contractId	long	ID сценарію документообігу
number	String	номер документа
contractName	String	назва сценарію документообігу
date	long	дата документа у форматі UNIX TimeStamp
ownerCompany	Company	об’єкт; інформація про компанію відправника (власника)
clientCompany	Company	об’єкт; інформація про компанію одержувача (клієнта)
description	String	опис / додаткова інформація
expiredDate	long	дійсний до (дата у форматі UNIX TimeStamp)
sentDate	long	дата відправки у форматі UNIX TimeStamp
status	int	статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0»
paymentStatus	int	ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»;
isSpecialConditions	int	ознака використання спеціальних умов обслуговування
isAllClientSenderPackages	int	відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так
isAllOwnerSenderPackages	int	відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так
specialConditions	SpecialConditions_	об’єкт; спеціальні умови
dictionaries	List<Dictionary_>	масив об’єктів; дані довідників
tags	List<Tag_>	масив об’єктів; дані тегів
ownerPackages	List<PackageType_>	масив об’єктів; дані комплектів документів відправника
clientPackages	List<PackageType_>	масив об’єктів; дані комплектів документів одержувача

Таблиця 4 - Опис параметрів об’єкта Company

Параметр	Формат	Опис
	Об’єкт Company
companyId	long	ID компанії
accountId	long	ID аккаунта
type	int	тип компанії (1 - юр. особа; 2 - фіз. особа)
name	String	назва компанії
legalName	String	юридична назва
inn	String	ідентифікаційний номер платника податків
code	String	свідоцтво платника ПДВ
phone	String	телефон
info	String	додаткова інформація
isApproved	int	ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП
isSignedOffer	int	ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так
isActive	int	статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так
ownershipType	String	форма власності
atCode	String	код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України)
certNum	String	свідоцтво платника ПДВ
uuID	String	унікальний ідентифікатор компанії
bankAcc	BankAcc_	об’єкт; банківські реквізити
legalAddress	Address_	об’єкт; юридична адреса
actualAddress	Address_	об’єкт; фактична адреса
fizName	CompanyFizName_	об’єкт; ПІБ фіз. особи компанії
certificates	List<Certificate_>	масив об’єктів; сертифікати
dictionaries	List<Dictionary_>	масив об’єктів; довідники
notifySettings	List<EmailNotifySettings_>	масив об’єктів; налаштування відправки повідомлень на пошту

---

Приклади

Приклад тіла запиту (json) для Створення сценарію документообігу:

{
  "clientCompany": {
    "companyId": 823
  },
  "ownerCompany": {
    "companyId": 4
  },
  "contractName": "новый контракт ",
  "date": 1554336000,
  "description": "фсвымапроло",
  "expiredDate": 1554940800,
  "number": "1234354656"
}

---

Приклад тіла запиту (json) для Редагування сценарію документообігу:

{
  "contractId": 2129,
  "clientCompany": {
    "companyId": 823
  },
  "ownerCompany": {
    "companyId": 4
  },
  "contractName": "новый контракт ",
  "date": 1554336000,
  "description": "фсвымапроло",
  "expiredDate": 1554940800,
  "number": "1234354656"
}

---

Приклад тіла відповіді (json) - однаковий для Створення/Редагування:

{
  "contractId": 2129,
  "contractName": "новый контракт123245465 ",
  "date": 0,
  "ownerCompany": {
    "companyId": 4,
    "accountId": 8,
    "type": 1,
    "name": "Царь Царей",
    "legalName": "ПрАТ \"Літак\"",
    "inn": "123456789043",
    "code": "34554355",
    "phone": "4234234324",
    "info": "ewdw",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 4,
    "atCode": "12363",
    "prsNum": "43242352",
    "certNum": "456",
    "uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "clientCompany": {
    "companyId": 823,
    "accountId": 245,
    "type": 1,
    "name": "tyhtht",
    "code": "77778542",
    "isApproved": 1,
    "isSignedOffer": 1,
    "isActive": 1,
    "ownershipTypeId": 6,
    "uuid": "45953ef9-128d-4e4d-b02d-406a0777fb24",
    "certificates": [],
    "dictionaries": [],
    "notifySettings": []
  },
  "expiredDate": 0,
  "sentDate": 0,
  "status": 0,
  "paymentStatus": 0,
  "isSpecialConditions": 0,
  "isAllClientSenderPackages": 0,
  "isAllOwnerSenderPackages": 0,
  "dictionaries": [],
  "ownerPackages": [],
  "clientPackages": []
}