Створення/редагування процесу узгодження

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

Важливо

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

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

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

REQUEST

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

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

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc_>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

RESPONSE

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

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

Параметр	Формат	Опис
	Об’єкт AgreementProc
agreementProcId	long	ID процесу узгодження
company	Company	об’єкт; інформація про компанію
companyId	long	ID компанії
name	String	назва процесу узгодження
comment	String	коментар
status	int	статус; «1 - активний; 2 - заблокований»
agreementProc2Docs	List<AgreementProc2Doc_>	масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані)
agrementSteps	List<AgreementStep_>	масив об’єктів; налаштування кроку узгодження

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

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

---

Приклади

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

{
  "name": "ывавы",
  "companyId": 989,
  "comment": null
}

---

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

{
  "name": "sabaka",
  "agreementProcId": 125,
  "companyId": 989,
  "comment": null
}

---

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

{
    "agrementSteps": [],
    "agreementProc2Docs": [],
    "agreementProcId": 125,
    "companyId": 989,
    "company": {
        "companyId": 989,
        "accountId": 0,
        "type": 0,
        "name": "dwdsss",
        "code": "433",
        "isApproved": 0,
        "isSignedOffer": 0,
        "isActive": 0,
        "ownershipTypeId": 0,
        "certificates": [],
        "dictionaries": [],
        "notifySettings": []
    },
    "name": "ывавы",
    "status": 1
}