Отримання комплекту документів (пакету)

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

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edin.ua/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": []
}