Обʼєкти АРІ
- Об’єкт ApplicableTransportSettingTemperature
- Об’єкт ShippingMarks
- Об’єкт TransportLogisticsPackage
- Об’єкт ApplicableTransportDangerousGoods
- Об’єкт Identification
- Об’єкт ApplicableNote
- Об’єкт AttachedSpecifiedBinaryFile
- Об’єкт DateTimeString
- Об’єкт PostalTradeAddress
- Об’єкт ComunicationContact
- Об’єкт TradeContact
- Об’єкт PreviousAdministrativeReferencedDocument
- Об’єкт PhysicalGeographicalCoordinate
- Об’єкт EntityId
- Об’єкт ContentCode
- Об'єкт IncludedNote
- Об’єкт Partner (дані контрагентів)
- Метадані документа
- Об’єкт ParticipantGroup
- Об’єкт Access (дані запиту на участь в закритому аукціоні)
- Об’єкт AuctionView (дані про перегляди тендера)
- Об'єкт AccessLog
- Об'єкт CompanyAccessRequestStatus
- Об’єкт AuctionContacts
- Об’єкт Region
- Об’єкт Attachment (для сервісу Тендер)
- Об’єкт Unit
- Об’єкт Currency
- Об’єкт Lot
- Об’єкт OfferType
- Об’єкт Type
- Об’єкт AccessType (для сервісу Тендер)
- Об’єкт Status (для сервісу Тендер)
- Об’єкт Category
- Об’єкт SubscribeToCategory
- Об’єкт Subscribes
- Об’єкт Role
- Об’єкт StatusAcc
- Об’єкт Account (для сервісу Тендер)
- Об’єкт User (для сервісу Тендер)
- Об’єкт Comment
- Об’єкт Company (для сервісу Тендер)
- Об'єкт Filter (додаткові параметри виборки)
- Об’єкт Auction (дані тендера)
- Об’єкт Bet (дані ставки по тендеру)
- Об’єкт XDocApprovalStep
- Об'єкт XDocApprovalScenario (дані кроків за сценарієм)
- Об'єкт XQueryShipment
- Об'єкт XCertificateShipment
- Обʼєкт XPromotion
- Об'єкт XPromotionType
- Об’єкт mintransSubscription
- Об'єкт XQueryProduct
- Об’єкт XQueryCertificates
- Дані про сертифікат
- Об'єкт characteristics (характеристики Сертифіката)
- Об'єкт XCertificateProduct (дані товарів)
- Об'єкт Level
- Об'єкт AccessType
- Об’єкт XCertificateView
- Об’єкт XCertificateType
- Об’єкт XCertificate (дані Сертифіката)
- Об’єкт XProductGroup (Групи / категорії товарів)
- Об’єкт XSearchPositionsQuery (Фільтр за позиціями Комерційних пропозицій)
- Масив об’єктів XAgreemDocPosition (Дані позицій Комерційної пропозиції)
- Об’єкт DeliveryInstructions
- Об’єкт MainCarriageLogisticsTransportMovement
- Об’єкт UtilizedLogisticsTransportEquipment
- Об’єкт IncludedSupplyChainConsignmentItem
- Об’єкт TransportEvent
- Об’єкт HandlingInstructions
- Об’єкт ReferencedDocument
- Об’єкт SimpleIdentity
- Об’єкт TradeParty
- Об’єкт InvoiceAmount
- Об’єкт LogisticsLocation
- Об'єкт EcmrUnitValue
- Об’єкт DateTime
- Об’єкт DocumentCode
- Об’єкт SpecifiedSupplyChainConsignment
- Об’єкт ExchangedDocument
- Об’єкт DocumentContext
- Об’єкт Index
- Об’єкт Field
- Об’єкт XSearchDocsQuery (Критерії пошуку/фільтрації «Товарних узгоджень» AGREEM)
- Об’єкт XNoveltyContacts
- Об’єкт XNoveltyComment
- Об’єкт XNoveltyTrade
- Об’єкт XNoveltyMarketing
- Об’єкт XNoveltyPrices
- Об’єкт Ecmr
- Об'єкт Transport
- Об'єкт SignsPackageV2
- Об’єкт XNovelty (Дані комерційної пропозиції)
- Об’єкт RetailerEsSettings
- Об’єкт XAgreemDocStatus
- Об’єкт XAgreemDoc
- Об’єкт XSearchContractsQuery (Критерії пошуку/фільтрації довідника специфікацій/контрактів)
- Об’єкт RemoveProductDetail
- Об’єкт RemoveProductResponse (Деталі результату операції видалення)
- Об’єкт XContractProduct
- Об’єкт XContract (Контракти)
- Об’єкт XAgreemDocAttachment
- Об’єкт XAgreemDocComment
- Об’єкт SpecStatus
- Об'єкт DistribexOrderParams
- Об’єкт XChainStatus
- Об’єкт XChain
- Об’єкт RecurrenceRule
- Об’єкт Schedule
- Об’єкт XDistribexAccessGroup
- Об’єкт XProductGroup
- Об’єкт XDistribexProduct
- Об’єкт Document
- Об’єкт DocumentRequest (Дані пов’язаних документів)
- Об'єкт Signs (дані для здійснення операції підписання)
- Об’єкт SignInfo (інформація про підпис)
- Об’єкт ExEndUserTimeInfo
- Об’єкт EndUserOwnerInfo
- Об’єкт ExEndUserSignInfo (дані підписантів документа)
- Об’єкт DateTimeRange
- Об’єкт Limitation
- Об’єкт Direction
- Об’єкт ExtraQueryParameters
- Об’єкт StorageQuery (Дані для фільтрації)
- Додаткові поля (extra_fields)
- Об’єкт XStatus
- Об’єкт XTag в параметрах об'єкта XDoc
- Об’єкт XDocSignInfo
- Об’єкт XDocStatus
- Об’єкт XDocComment
- Об’єкт XDocCommentsList
- Об’єкт XDocBodyForms
- Об’єкт XDocBodyType
- Об’єкт XDocBody
- Об’єкт XDoc
- Об’єкт XDocType
- Об’єкт DistribexOrderResult
- Об’єкт XDistribexPreorder
- Об'єкт XDistribexPreorderPosition
- Об’єкт Сharacteristics (додаткові характеристики продукту)
- Об’єкт XPriceListProduct
- Об’єкт XPriceListElement
- Об’єкт XTicketBody
- Об’єкт XTicket
- Об’єкт XDocAttachmentSign
- Об’єкт XDocAttachment
- Масив об’єктів одиниць виміру
- Об'єкт Employee
- Об'єкт Company
- Об'єкт Account
- Об'єкти інформації по торгових мережах
- Об’єкт з values даними
- Об’єкт UsersDataStorage
- Об’єкт Retailer
- Об’єкт User
- Об’єкт XDistribexSurcharge
- Об’єкт Quotas
- Об’єкт Identificator
- Об’єкт XDistribexInvitation
- Обʼєкт Limits
- Обʼєкт XTag
- Об'єкт EttnV3Event
- Об'єкт XEvent (Подія за документом)
- Об'єкт DocumentEvent
- Об'єкт EventsStorageQueryResult (результати пошуку подій за документами)
- Об'єкт EventsStorageQuery (параметри пошуку подій)
Об’єкт ApplicableTransportSettingTemperature
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
minimum |
O |
string |
Мінімальне значення температури |
|
maximum |
O |
string |
Максимальне значення температури |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ShippingMarks
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
marking |
O |
string |
Назва транспортної упаковки (вільна назва), в якій перевозиться вантаж |
|
barcodeLogisticsLabel |
O |
об’єкт; Штрихкод товару |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TransportLogisticsPackage
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
itemQuantity |
O |
decimal |
Кількість місць, які визначаються за кожним найменуванням вантажу (це можуть бути ящики, кошики, мішки тощо; якщо вантаж упаковано на піддонах - вказують кількість піддонів) |
|
typeCode |
O |
string |
Вид пакування (Довідник видів упаковок) |
|
type |
O |
string |
Одиниця виміру для ItemQuantity |
|
physicalLogisticsShippingMarks |
O |
об’єкт; Маркування |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ApplicableTransportDangerousGoods
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
UNDGIdentificationCode |
O |
decimal |
Клас небезпечних речовин, до якого віднесено вантаж (у разі перевезення небезпечних вантажів). Код UNDG, 0 - якщо не використовується |
|
packagingDangerLevelCode |
O |
decimal |
Клас небезпечних речовин 1-4 |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт Identification
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
identification |
M |
string |
Найменування вантажу |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ApplicableNote
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
contentCode |
O/M |
string |
Код:
|
|
content |
O |
decimal |
Значення |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт AttachedSpecifiedBinaryFile
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
string |
Ідентифікатор (guid) документа-підстави (ТТН / Акта); має відповідати document.id еТТН/Акта в ЦБД (значення ettnId з методу Отримання списку подій з ЦБД = значення external_doc_id Отримання метаданих документа) |
|
uriid |
O |
string |
Посилання на документ |
|
MIMECode |
O |
string |
Код MIME типізація |
|
SizeMeasure |
O |
Long |
Розмір файла |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт DateTimeString
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
dateTime |
M |
datetime (2021-12-13T14:19:23+02:00) |
Дата і час складання документа |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт PostalTradeAddress
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
postCode |
O |
string |
Індекс |
|
streetName |
M |
string |
Адреса (назва вулиці + номер будівлі) |
|
cityName |
M |
string |
Місто (назва населеного пункту) |
|
countryID |
M |
string |
Країна (UA) |
|
countrySubDivisionName |
O |
string |
Область та район (за наявності) |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ComunicationContact
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
completeNumber |
O |
string |
Контактні дані |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TradeContact
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
personName |
O |
string |
ПІБ |
|
telephoneUniversalCommunication |
O |
об’єкт; Основний телефон |
|
|
mobileTelephoneUniversalCommunication |
O |
об’єкт; Мобільний телефон |
|
|
emailURIUniversalCommunication |
O |
об’єкт; Електронна адреса |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт PreviousAdministrativeReferencedDocument
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
typeCode |
O |
string |
Тип документа, на основі якого складено поточний документ. Довідник кодів документів |
|
id |
M |
string |
Відповідає ExchangedDocumentContext.SpecifiedTransactionID попередніх версій |
|
remarks |
O |
string |
Base64 документа попередньої версії |
|
formattedIssueDateTime |
O |
об’єкт; Дата складання документа, на основі якого складено поточний документ |
|
|
attachedSpecifiedBinaryFile |
M/O |
об’єкт; Дані документа до якого складається поточний документ. Обов’язковий при створенні Акта |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт PhysicalGeographicalCoordinate
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
latitudeMeasure |
O |
string |
Широта |
|
longitudeMeasure |
O |
string |
Довгота |
|
systemId |
M |
GLN |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт EntityId
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
schemeAgencyID |
O/M |
string |
ідентифікатор; приймає значення УКТЗЕД/ЄДРПОУ/РНОКПП/КАТОТТГ/GLN залежно від блоку, де застосовується - точніше вказано в параметрі на рівень вище |
|
value |
M |
decimal |
Значення |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт ContentCode
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
listAgencyID |
M для GLN (решта O) |
String |
Ідентифікатор:
Ідентифікатори logistic_unit_number_with_logger / gps_number / logger_number / reserve_number вказуються контрагентом з роллю «Вантажовідправник». Ідентифікатори transportation_max_temperature та logger_return вказуються контрагентом з роллю «Вантажоодержувач». Ідентифікатор comments може вказуватись усіма учасниками документообігу на етапі формування Чернетки ТТН-документа (для Водія/Перевізника це sub_status_id=1; для Вантажоодержувача / Експедитора (+ Водія/Перевізника в рамках опційного підписання) це sub_status_id=6) |
|
value |
M |
|
значення ідентифікатора |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт IncludedNote
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
contentCode |
M |
об’єкт; Контент запису |
|
|
content |
M |
String |
Код ролі учасника. Довідник ролей
|
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт Partner (дані контрагентів)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
O |
int(10) |
id контрагента |
|
employeeId |
O |
int(10) |
id співробітника, що виконує дію |
|
companyId |
O |
int(10) |
id компанії |
|
serviceId |
O |
tinyint(3) |
id сервісу; доступні значення: 9 - Вільний |
|
|
M |
String(255) |
email контрагента |
|
name |
O |
String(255) |
ПІБ контрагента |
|
companyName |
O |
String(255) |
назва компанії контрагента |
|
companyCode |
O |
String(12) |
код ЄДРПОУ / ІПН компанії |
|
inviteStatus |
O |
tinyint(10) |
статус запрошення; 0 - не запрошений, 1 - запрошений |
|
inviteDate |
O |
int(10) |
дата запрошення (unix-timestamp) |
|
isRegistered |
O |
boolean |
статус реєстрації: true - зареєстрований; false - незареєстрований |
JSON приклад об'єкта
{
"id":239,
"serviceId": 9,
"email": "kit@pes.ua",
"name": "Cat",
"companyName": "Dog",
"companyCode": "666666663"
}
JSON приклад масиву об'єктів
[
{
"serviceId": 9,
"email": "example@mail.com",
"name": "",
"companyName": "",
"companyCode": ""
},
{
"serviceId": 9,
"email": "stethem@ukr.mem",
"name": "Джейсон Стетхем",
"companyName": "Повар",
"companyCode": "858585888585"
},
{
"serviceId": 9,
"email": "ozk82086@eoopy.com",
"name": "",
"companyName": "",
"companyCode": ""
}
]
JSON приклад відповіді. Завантажені в сервіс контрагенти та контрагенти з помилковими даними (потребують правок)
{
"createdPartners": [
{
"id": 237,
"employeeId": 1035,
"companyId": 0,
"email": "hopa@mail.com",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
},
{
"id": 238,
"employeeId": 1035,
"companyId": 0,
"email": "parmezano@pam.ua",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
}
],
"errorPartners": [
{
"id": 0,
"employeeId": 1035,
"companyId": 0,
"email": "stethem@ukr.mem",
"name": "Джейсон Стетхем",
"companyName": "Повар",
"companyCode": "858585888585",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
},
{
"id": 0,
"employeeId": 1035,
"companyId": 0,
"email": "ozk82086@eoopy.com",
"inviteStatus": 0,
"inviteDate": 0,
"serviceId": 9,
"isRegistered": false
}
]
}
де
createdPartners - масив об’єктів Partner (дані контрагентів), що були завантажені в сервіс;
errorPartners - масив об’єктів Partner (дані контрагентів), що містять помилки і потребують правок (не завантажились).
Метадані документа
Опис параметрів
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
receivers |
M |
List<String> |
масив з UUID-ами отримувачів документа; для незареєстрованих на платформі користувачів передаються email адреси |
|
number |
O |
String |
номер документа |
|
date |
O |
String |
дата документа |
|
sum |
O |
String |
Сума (грн) |
|
text |
O |
String |
текст повідомлення |
|
title |
M |
String |
тема документа |
|
recipientEDRPOU |
O |
String |
ЄДРПОУ отримувача. Якщо поле заповнено, то сервіс «Вільний» буде перевіряти отримувача на етапі підписання документа (вказане значення ЄДРПОУ та ЄДРПОУ ключа ЕЦП підписанта повинні співпадати). В разі невідповідності значення під час підписання буде виникати помилка. |
|
senderEDRPOU |
O |
String |
ЄДРПОУ відправника. Якщо поле заповнено, то сервіс «Вільний» буде перевіряти відправника на етапі підписання документа (вказане значення ЄДРПОУ та ЄДРПОУ ключа ЕЦП підписанта повинні співпадати). В разі невідповідності значення під час підписання буде виникати помилка. |
|
googleFileName |
O |
String |
назва документа на Google Диску (відправка документа через віджет «EDIN еПідпис») |
|
handleDocumentRule |
M |
int |
код правила обробки документа отримувачами:
|
|
dateUpdate |
O |
long |
дата оновлення (unix timestamp) |
- [1] - Під визначенням колонки Тип поля мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад
{
"receivers": [
"85e32f82-9d86-4c36-8b3f-54eccf13b09c"
],
"date": "2022-08-02",
"title": "SomeSome",
"googleFileName": "SomeSome.pdf",
"handleDocumentRule": 2,
"dateUpdate": 1659454506,
"recipientEDRPOU": "12345678",
"senderEDRPOU": "12345678",
"number": "Number",
"sum": "50.26",
"text": "Message"
}
Об’єкт ParticipantGroup
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
groupId |
long |
ідентифікатор групи учасників |
|
companyId |
long |
ідентифікатор компанії, якій належить група |
|
groupName |
String(255) |
назва групи учасників |
|
comment |
String |
коментар |
|
companies |
List<Company> |
масив об’єктів; компанії в групі учасників |
|
cpvs |
List<Category> |
масив об’єктів; категорії групи учасників |
JSON приклад відповіді (дані груп учасників)
[
{
"groupId": 273,
"companyId": 3600,
"groupName": "Постачальники молока",
"companies": [
{
"id": 11,
"uuid": "e29a089f-3402-44a2-997b-4a263a82ab12",
"accountID": 0,
"name": "ТОВ \"ПРОДМАРКЕТПРОМ\"",
"edrpou": "36863714",
"inn": "368637106262",
"city": "м. Київ",
"address": "вул. Академіка Філатова, б.10-А, оф.2/51"
},
{
"id": 13,
"uuid": "14f91301-fb11-4361-b76b-6e4f495f3055",
"accountID": 0,
"name": "ТОВ \"КОМПАНІЯ \"УКРАВТОЛОГІСТИКА\"",
"edrpou": "39427556",
"inn": "394275515510",
"city": "м. Одеса",
"address": "вул. Академіка Вільямса, буд.86"
},
{
"id": 17,
"uuid": "5736889e-eed5-4894-a866-1ba2129b8d85",
"accountID": 37035,
"name": "ПП \"ПАТМОС\"",
"edrpou": "40756025",
"inn": "407560219187",
"city": "Тернопільська обл., Бережанський район, село Котів",
"address": "вул. Тиха, будинок 1"
}
],
"cpvs": [
{
"id": 9543,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "017",
"check_sum": "9",
"full_code": "99999017-9",
"description_ua": "Молочні продукти",
"description_en": "Dairy",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
},
{
"groupId": 275,
"companyId": 3600,
"groupName": "Постачальники зоотоварів",
"companies": [
{
"id": 19,
"uuid": "392d3548-e286-4593-96cb-6a3a361085c6",
"accountID": 1232,
"name": "ФОП Мріщук Олександр Петрович",
"edrpou": "1969710734",
"inn": "1969710734",
"city": "м. Вінниця",
"address": "Ленінський район вул. Вишенька, буд. 13"
},
{
"id": 21,
"uuid": "94fc5670-e97f-4b25-b2cb-ca532acc4fe8",
"accountID": 1232,
"name": "ТОВ «ФАКТОР»",
"edrpou": "13731254",
"inn": "137312510086",
"city": "м. Вишгород",
"address": "вул. Кургузова 6А"
}
],
"cpvs": [
{
"id": 9511,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "001",
"check_sum": "9",
"full_code": "99999001-9",
"description_ua": "Зоотовари",
"description_en": "Pet supplies",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
{
"id": 9597,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "044",
"check_sum": "9",
"full_code": "99999044-9",
"description_ua": "Послуги",
"description_en": "Services",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
},
{
"groupId": 279,
"companyId": 3600,
"groupName": "Визволителі України",
"comment": "тут будуть всі важливі для ниньошньої ситуації компанії - вони будуть в пріоритеті",
"companies": [
{
"id": 447,
"uuid": "0e4eca5a-b60d-4e18-b87c-05173ce5dfac",
"accountID": 11158,
"name": "СУБЛАНД УКРАЇНА",
"edrpou": "37212319",
"inn": "372123104628"
}
],
"cpvs": [
{
"id": 9555,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "023",
"check_sum": "9",
"full_code": "99999023-9",
"description_ua": "Ковбасні вироби",
"description_en": "Sausages",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
{
"id": 9567,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "029",
"check_sum": "9",
"full_code": "99999029-9",
"description_ua": "Табачні вироби",
"description_en": "Tobacco products",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
},
{
"groupId": 291,
"companyId": 3600,
"groupName": "Fatality",
"comment": "opa-opa",
"companies": [
{
"id": 5,
"uuid": "a32715ba-b7cb-4702-ae77-e8f6c3aaeb89",
"accountID": 24373,
"name": "тест ЕДІН",
"edrpou": "67553455",
"inn": "1010101016",
"city": "Kiev",
"address": "Mostobudivnykiv St, 17/11"
}
],
"cpvs": [
{
"id": 9525,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "008",
"check_sum": "9",
"full_code": "99999008-9",
"description_ua": "Проектні роботи",
"description_en": "Design work",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
}
]
}
]
JSON приклад запиту (дані групи учасників)
{
"companyId": 3600,
"groupName": "Fatality",
"comment": "hello",
"companies": [
{
"id": 5
},
{
"id": 9
}
],
"cpvs": [
{
"id": 9513
},
{
"id": 9519
},
{
"id": 9525
}
]
}
Об’єкт Access (дані запиту на участь в закритому аукціоні)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор доступа |
|
auctionId |
long |
ідентифікатор аукціону (тендера) |
|
auction |
об’єкт; дані аукціону (тендера) |
|
|
userId |
long |
ідентифікатор користувача |
|
user |
об’єкт; дані користувача |
|
|
companyId |
long |
ідентифікатор компанії |
|
company |
об’єкт; дані компанії |
|
|
dateCreated |
long |
дата створення |
|
message |
String |
коментар заявки на аукціон (тендер) |
|
status |
об’єкт; статус заявки на аукціон (тендер) |
|
|
contactName |
String(250) |
контактна особа (ПІБ) |
|
contactEmail |
String(250) |
контактний email |
|
contactPhone |
String(50) |
контактний телефон |
|
accessLog |
List<AccessLog> |
масив об’єктів; перебіг (лог) отримання доступу до аукціону (тендера) |
JSON приклад
{
"id": 3069,
"auctionId": 5799,
"userId": 50206653,
"user":
{
"id": 50206653,
"employeeId": 1056,
"accountId": 32657,
"account":
{
"id": 32657,
"name": "Test_EDS3",
"edrpou": "300000003",
"inn": "3030303030",
"status":
{
"code": 1,
"description": "Активный"
},
"emails":
[
"test@qw.we"
],
"phone": "134567890987",
"legalAddress": "#",
"dateCreate": 1572349280,
"dateChange": 1601881494
},
"login": "uaFelExSender",
"role":
{
"code": 1,
"description": "Пользователь"
},
"name": "Boris",
"surname": "Djonsonuk",
"dateLastLogin": 1681821485,
"emails":
[
"test@qw.we",
"storchevayas@edin.ua"
],
"isSubscribes": false
},
"companyId": 3627,
"company":
{
"id": 3627,
"uuid": "f96a5cb6-935b-4940-8c47-ff3f96aa300d",
"accountID": 32657,
"name": "Bimba Inc",
"edrpou": "1488883523",
"inn": "1488883523",
"city": "rrrrr",
"address": "323r23r"
},
"dateCreated": 1681821985,
"message": "password-baracuda",
"status":
{
"code": 2,
"description": "Запрос доступа (не принято решение)"
},
"contactName": "Djonsonuk Boris ",
"contactEmail": "test@qw.we",
"contactPhone": "380684856254"
}
Об’єкт AuctionView (дані про перегляди тендера)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифіктор перегляду |
|
auctionId |
long |
ідентифіктор тендера, що переглядався |
|
viewerId |
long |
ідентифіктор користувача, що переглядав тендер |
|
viewer |
об’єкт; дані користувача |
|
|
dateTime |
long |
дата і час перегляду (у форматі Unix timestamp) |
JSON приклад
[
{
"id": 4007,
"auctionId": 4607,
"viewerId": 60212904,
"viewer": {
"id": 60212904,
"employeeId": 1035,
"accountId": 36633,
"account": {
"id": 36633,
"name": "Общество с ограниченной ответственностью \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "123652632563",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"12356@ukr.net"
],
"phone": "355478563",
"legalAddress": "ююю",
"dateCreate": 1598894147,
"dateChange": 1638282398,
"about": "строительство и логистика ",
"logo": "/api/logo/accounts/logo_36633.jpg"
},
"login": "willnotgotomumbai@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Арбуз",
"surname": "Арбузов",
"secondName": "Иоанович ",
"phone": "380975560011",
"ipn": "111111111111",
"dateLastLogin": 1654519973,
"info": "self registered. IP: null",
"emails": [
"willnotgotomumbai@gmail.com"
],
"companies": [
{
"id": 3600,
"uuid": "c345ef8f-ba02-439a-afac-007ed088cf2e",
"accountID": 36633,
"name": "Общество с ограниченной ответственностью \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "125632589223",
"city": "Kiev"
},
{
"id": 3624,
"uuid": "164d8465-aad6-409d-b3a8-5b009e1ca542",
"accountID": 36633,
"name": "Общество с ограниченной ответственностью \"Институт инновационных технологий и строения космических ",
"edrpou": "6465656666",
"inn": "6465656666",
"city": "Львов",
"address": "Волкова"
},
{
"id": 4248,
"uuid": "8520b4ee-c799-461e-9b14-e129dcfef27d",
"accountID": 36633,
"name": "ТОВ \"Отправитель товар",
"edrpou": "643555552",
"inn": "643555552"
},
{
"id": 4408,
"uuid": "cf5def31-8849-4a30-b1fa-0bf3e1d39423",
"accountID": 36633,
"name": "апвапвапв",
"edrpou": "2563256222",
"inn": "2563256222"
}
],
"isSubscribes": false
},
"dateTime": 1654520720
},
{
"id": 3993,
"auctionId": 4607,
"viewerId": 60213504,
"viewer": {
"id": 60213504,
"employeeId": 1841,
"accountId": 36974,
"account": {
"id": 36974,
"name": "ТОВ Фомыч",
"edrpou": "FG258046",
"inn": "FG258046",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"kutsenkov@edin.ua"
],
"phone": "325954845956",
"legalAddress": "Киев, ул. Дегляревская 46",
"dateCreate": 1623405150,
"dateChange": 0
},
"login": "kutsenkov@edin.ua",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Ингибора",
"surname": "Куц",
"phone": "380123456789",
"ipn": "123654456123",
"dateLastLogin": 1654273155,
"info": "self registered. IP: null",
"emails": [
"kutsenkov@edin.ua"
],
"companies": [
{
"id": 3969,
"uuid": "e0ca4d6f-5572-4749-878b-2863a1e5e0c2",
"accountID": 36974,
"name": "ТОВ Фомич В.І.",
"edrpou": "FG258046",
"inn": "FG258046"
},
{
"id": 4233,
"uuid": "997234e1-ae18-4697-b117-e426b30bc5fa",
"accountID": 36974,
"name": "ТОВ Фома",
"edrpou": "653265666",
"inn": "653265666"
},
{
"id": 6933,
"uuid": "afee3e98-609a-4f29-8e46-2dab8d2c7443",
"accountID": 36974,
"name": "ФІЗ лице",
"edrpou": "569874566",
"inn": "569874566",
"city": "Київ",
"address": "вул.Хрещатик 1"
}
],
"isSubscribes": false
},
"dateTime": 1654273506
}
]
Об'єкт AccessLog
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор запису |
|
userId |
long |
ідентифікатор користувача |
|
date |
long |
дата логування |
|
message |
String |
повідомлення/коментар |
Об'єкт CompanyAccessRequestStatus
Опис параметрів об’єкта
Об’єкт AuctionContacts
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
auctionId |
long |
id тендера |
|
contactName |
String |
ПІБ контактної особи |
|
contactEmail |
String |
email контактної особи |
|
contactPhone |
String |
номер телефону контактної особи |
Об’єкт Region
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id регіону |
|
code |
String |
код регіону |
|
|
name |
String |
назва регіону |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді для отримання довідника регіонів
[ { "id": 1, "code": "01", "name": "Автономна Республіка Крим" }, { "id": 2, "code": "05", "name": "Вінницька область" }, { "id": 3, "code": "07", "name": "Волинська область" }, { "id": 4, "code": "12", "name": "Дніпропетровська область" }, { "id": 5, "code": "14", "name": "Донецька область" }, { "id": 6, "code": "18", "name": "Житомирська область" }, { "id": 7, "code": "21", "name": "Закарпатська область" }, { "id": 8, "code": "23", "name": "Запорізька область" }, { "id": 9, "code": "26", "name": "Івано-Франківська область" }, { "id": 10, "code": "32", "name": "Київська область" }, { "id": 11, "code": "35", "name": "Кіровоградська область" }, { "id": 12, "code": "44", "name": "Луганська область" }, { "id": 13, "code": "46", "name": "Львівська область" }, { "id": 14, "code": "48", "name": "Миколаївська область" }, { "id": 15, "code": "51", "name": "Одеська область" }, { "id": 16, "code": "53", "name": "Полтавська область" }, { "id": 17, "code": "56", "name": "Рівненська область" }, { "id": 18, "code": "59", "name": "Сумська область" }, { "id": 19, "code": "61", "name": "Тернопільська область" }, { "id": 20, "code": "63", "name": "Харківська область" }, { "id": 21, "code": "65", "name": "Херсонська область" }, { "id": 22, "code": "68", "name": "Хмельницька область" }, { "id": 23, "code": "71", "name": "Хмельницька область" }, { "id": 24, "code": "73", "name": "Чернівецька область" }, { "id": 25, "code": "74", "name": "Чернігівська область" }, { "id": 26, "code": "80", "name": "м. Київ " }, { "id": 27, "code": "85", "name": "м. Севастополь" } ] -
Об’єкт Attachment (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id вкладення |
|
auctionId |
long |
id тендера |
|
lotId |
long |
id лоту |
|
betId |
long |
id ставки |
|
userId |
long |
id користувача |
|
user |
об’єкт; дані користувача |
|
|
fileName |
String |
назва файлу |
|
description |
String |
опис |
|
body |
byte[] |
зміст тіла файлу в цілочисельному вигляді |
|
size |
long |
розмір вкладення |
JSON приклад
{
"id": 1673,
"auctionId": 5245,
"lotId": 0,
"betId": 0,
"userId": 0,
"user": {
"id": 60212904,
"employeeId": 1035,
"accountId": 36633,
"account": {
"id": 36633,
"name": "Товариство з обмеженою відповідальнстю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "123652632563",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"12356@ukr.net"
],
"phone": "355478563",
"legalAddress": "ююю",
"dateCreate": 1598894147,
"dateChange": 1638282398,
"about": "будівництво та логістика ",
"logo": "/api/logo/accounts/logo_36633.jpg"
},
"login": "willnotgotomumbai@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Арбуз",
"surname": "Арбузов",
"secondName": "Іоанович ",
"phone": "380975560011",
"ipn": "111111111111",
"dateLastLogin": 1659344038,
"info": "self registered. IP: null",
"emails": [
"willnotgotomumbai@gmail.com"
],
"isSubscribes": false
},
"fileName": "espec03.png",
"size": 142777
}
Об’єкт Unit
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id одиниці виміру |
|
code |
String |
код одиниці виміру |
|
|
name |
String |
назва одиниці виміру |
|
|
shortName |
String |
коротка назва одиниці виміру |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад відповіді для отримання довідника одиниць виміру
[
{
"id": 1,
"code": "2009",
"name": "штука",
"shortName": "шт"
},
{
"id": 2,
"code": "301",
"name": "кілограм",
"shortName": "кг"
},
{
"id": 3,
"code": "303",
"name": "грам",
"shortName": "г"
},
{
"id": 4,
"code": "2938",
"name": "комплект",
"shortName": "компл"
},
{
"id": 5,
"code": "138",
"name": "літр",
"shortName": "л"
},
{
"id": 6,
"code": "101",
"name": "метр",
"shortName": "м"
},
{
"id": 7,
"code": "123",
"name": "квадратний метр",
"shortName": "м2"
},
{
"id": 8,
"code": "134",
"name": "кубічний метр",
"shortName": "м3"
},
{
"id": 9,
"code": "144",
"name": "мілілітр",
"shortName": "мл"
},
{
"id": 10,
"code": "2424",
"name": "робоча година",
"shortName": "роб.год"
},
{
"id": 11,
"code": "2006",
"name": "партія",
"shortName": "партія"
},
{
"id": 12,
"code": "2116",
"name": "рулон",
"shortName": "рул"
},
{
"id": 13,
"code": "306",
"name": "тонна",
"shortName": "т"
},
{
"id": 14,
"code": "2013",
"name": "тисяча штук",
"shortName": "тис.шт."
},
{
"id": 15,
"code": "2110",
"name": "пакунок",
"shortName": "пак"
},
{
"id": 16,
"code": "0000",
"name": "послуга",
"shortName": "послуга"
},
{
"id": 17,
"code": "2075",
"name": "ящик",
"shortName": "ящ"
}
]
Об’єкт Currency
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id валюти |
|
code |
String |
код валюти |
|
|
name |
String |
назва валюти |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді для отримання довідника валют
[ { "id": 1, "code": "UAH", "name": "Українська гривня" }, { "id": 2, "code": "USD", "name": "Долар США" }, { "id": 3, "code": "EUR", "name": "Євро" }, { "id": 4, "code": "GBP", "name": "Фунт стерлінгів Великобританії" }, { "id": 5, "code": "CNY", "name": "Китайський юань женьмiньбi" }, { "id": 6, "code": "CHF", "name": "Швейцарський франк" } ] -
Об’єкт Lot
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
id лота |
|
|
auctionId |
long |
id тендера |
|
|
auction |
O |
об’єкт; дані тендера |
|
|
title |
M |
String |
заголовок лота |
|
description |
M |
String |
опис лота |
|
expectedValue |
M |
double |
стартова ціна |
|
stepValue |
M |
double |
крок ставки |
|
currencyId |
long |
id валюти |
|
|
currency |
M |
об’єкт; дані про валюту |
|
|
quantity |
M |
double |
кількість |
|
unitId |
long |
id одиниці виміру |
|
|
unit |
M |
об’єкт; одиниці виміру |
|
|
deliveryStartDate |
O |
long |
дата початку доставки |
|
deliveryEndDate |
O |
long |
дата закінчення доставки |
|
productCode |
O |
String |
код товару |
|
categoryId |
long |
id категорії товару (з довідника CPV) |
|
|
category |
M |
об’єкт; дані категорії товару (з довідника CPV) |
|
|
regionId |
long |
id області |
|
|
region |
M |
об’єкт; дані областей |
|
|
noShowBets |
O |
boolean |
відмітка: Не показувати ставки |
|
noShowBestBet |
O |
boolean |
відмітка: Не показувати кращу ставку |
|
hideParticipantNamesOnly |
O |
boolean |
відмітка: Ховати лише імена учасників |
|
betsCount |
Integer |
кількість ставок |
|
|
bestBet |
об’єкт; краща ставка |
||
|
bets |
List<Bet> |
масив об’єктів; список ставок |
|
|
attachmentsCount |
int |
кількість вкладень |
|
|
attachments |
O |
List<Attachment> |
масив об’єктів; вкладення |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт OfferType
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
code |
int |
код;
|
|
|
name |
String |
назва |
|
|
description |
String |
опис |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт Type
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
code |
M |
int |
код;
|
|
name |
String |
назва |
|
|
description |
String |
опис |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт AccessType (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
code |
M |
int |
код;
|
|
name |
String |
назва |
|
|
description |
String |
опис |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт Status (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
code |
int |
код; для аукціону (тендера):
для заявки на аукціон (тендер):
|
|
name |
String |
назва |
|
description |
String |
опис |
Об’єкт Category
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
ідентифікатор категорії |
|
section |
String |
розділ; перші 2 цифри визначають розділ. 1 рівень (XX000000-Y) |
|
|
group |
String |
група; перші 3 цифри визначають групу. 2 рівень (XXX00000-Y) |
|
|
categoryClass |
String |
клас; перші 4 цифри визначають клас. 3 рівень (XXXX0000-Y) |
|
|
category |
String |
категорія; перші 5 цифр визначають категорію. 4 рівень (XXXXX000-Y) |
|
|
detailing |
String |
деталізація; останні 3 цифри - деталізація в рамках категорії. 5 рівень (XXXXX000-Y) |
|
|
check_sum |
String |
контрольна сума номера (XXXXX000-Y) |
|
|
full_code |
String |
повний код з довідника (XXXXX000-Y) |
|
|
description_ua |
String |
назва українською |
|
|
description_en |
String |
назва англійською |
|
|
rank |
int |
рівень вкладення |
|
|
refId |
long |
посилання на материнський запис |
|
|
hasChildren |
int |
наявність дочірніх значень довідника. 0-ні, 1-так |
|
|
status |
int |
статус; 1-active, 2-not_active |
|
|
isSubscribes |
boolean |
підписка |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді для отримання довідника категорій
[ { "id": 9473, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "008", "check_sum": "3", "full_code": "09000008-3", "description_ua": "Проектні роботи", "description_en": "Design work", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9475, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "009", "check_sum": "3", "full_code": "09000009-3", "description_ua": "Меблі", "description_en": "Furniture", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9477, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "010", "check_sum": "3", "full_code": "09000010-3", "description_ua": "Автомобілі та запчастини", "description_en": "Cars and spare parts", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9479, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "011", "check_sum": "3", "full_code": "09000011-3", "description_ua": "Фрукти, ягоди", "description_en": "Fruits, berries", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9481, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "012", "check_sum": "3", "full_code": "09000012-3", "description_ua": "Консервовані продукти", "description_en": "Canned foods", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9483, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "013", "check_sum": "3", "full_code": "09000013-3", "description_ua": "Риба та морепродукти", "description_en": "Fish and seafood", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9485, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "014", "check_sum": "3", "full_code": "09000014-3", "description_ua": "Кондитерські вироби, солодощі", "description_en": "Confectionery, sweets", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9487, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "015", "check_sum": "3", "full_code": "09000015-3", "description_ua": "Напої", "description_en": "Beverages", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9489, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "016", "check_sum": "3", "full_code": "09000016-3", "description_ua": "Дитяче харчування", "description_en": "Baby food", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9491, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "017", "check_sum": "3", "full_code": "09000017-3", "description_ua": "Молочні продукти", "description_en": "Dairy", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9493, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "018", "check_sum": "3", "full_code": "09000018-3", "description_ua": "Хлібобулочні вироби", "description_en": "Bakery products", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9495, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "019", "check_sum": "3", "full_code": "09000019-3", "description_ua": "Снеки, насіння, горіхи, сухофрукти", "description_en": "Snacks, seeds, nuts, dried fruits", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9497, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "020", "check_sum": "3", "full_code": "09000020-3", "description_ua": "Заморожені продукти", "description_en": "Frozen products", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9499, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "021", "check_sum": "3", "full_code": "09000021-3", "description_ua": "Овочі, гриби, зелень", "description_en": "Vegetables, mushrooms, greens", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9501, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "022", "check_sum": "3", "full_code": "09000022-3", "description_ua": "М'ясо, птиця, яйце", "description_en": "Meat, bird, egg", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9503, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "023", "check_sum": "3", "full_code": "09000023-3", "description_ua": "Ковбасні вироби", "description_en": "Sausages", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9505, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "024", "check_sum": "3", "full_code": "09000024-3", "description_ua": "Цукор", "description_en": "Sugar", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, { "id": 9507, "section": "09", "group": "0", "categoryClass": "0", "category": "0", "detailing": "025", "check_sum": "3", "full_code": "09000025-3", "description_ua": "Крупи, борошно, макаронні вироби", "description_en": "Cereals, flour, pasta", "rank": 1, "refId": 9458, "hasChildren": 0, "status": 1, "isSubscribes": false }, ] -
Об’єкт SubscribeToCategory
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
categoryId |
long |
ідентифікатор категорії |
|
category |
об’єкт; дані категорії |
|
|
type |
int |
тип аукціону:
|
Об’єкт Subscribes
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
categories |
List<SubscribeToCategory> |
масив об’єктів; категорії |
|
companies |
List<Company> |
масив об’єктів; компанії |
|
users |
List<User> |
масив об’єктів; користувачі-організатори |
Об’єкт Role
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
code |
int |
код ролі;
|
|
description |
String |
опис ролі |
Об’єкт StatusAcc
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
code |
int |
код;
|
|
description |
String |
опис |
Об’єкт Account (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id аккаунту |
|
name |
String |
повна назва організації або ПІБ індивідуального підприємця |
|
edrpou |
String |
код ЕДРПОУ/КПП |
|
inn |
String |
код ІПН |
|
status |
об’єкт; опис статусу аккаунту |
|
|
emails |
List<String> |
масив E-mail адрес |
|
phone |
String |
№ телефону |
|
legalAddress |
String |
юридична адреса компанії |
|
dateCreate |
long |
дата створення акаунту |
|
dateChange |
long |
дата зміни (оновлення) акаунту |
|
about |
String |
додатковий опис |
|
comment |
об’єкт; коментар |
|
|
logo |
String |
лого |
Об’єкт User (для сервісу Тендер)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id користувача |
|
employeeId |
long |
id співробітника |
|
uuid |
UUID |
uuid співробітника |
|
accountId |
long |
id аккаунта |
|
account |
об’єкт; дані аккаунта |
|
|
login |
String |
логін |
|
role |
об’єкт; роль |
|
|
name |
String |
ім’я |
|
surname |
String |
прізвище |
|
secondName |
String |
по батькові |
|
phone |
String |
телефон |
|
ipn |
String |
код ІПН |
|
dateLastLogin |
long |
дата останньої сесії |
|
info |
String |
додакова інформація |
|
emails |
List<String> |
масив E-mail адрес |
|
comment |
об’єкт; коментар |
|
|
companies |
List<Company> |
масив об’єктів; компанії |
|
isSubscribes |
boolean |
підписка |
|
userSubscribes |
об’єкт; підписки на організаторів / категорії / користувачів |
JSON приклад масиву користувачів, на яких оформлена підписка
{
"users": [
{
"id": 60213990,
"employeeId": 2798,
"accountId": 37227,
"account": {
"id": 37227,
"name": "ТОВ \"Відправник товару\"",
"edrpou": "34554363-1",
"status": {
"code": 1,
"description": "Активний"
},
"emails": [
"otpraviteltovara@gmail.com"
],
"phone": "380123456789",
"legalAddress": "Київ, вул.Заболотного 29",
"dateCreate": 1624377561,
"dateChange": 0
},
"login": "test1515",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Girl",
"surname": "Good",
"phone": "380669798799",
"dateLastLogin": 0,
"info": "created from web",
"emails": [
"vdymk@mailto.plus",
"zertegokno@vusra.com"
],
"isSubscribes": false
},
{
"id": 60213984,
"employeeId": 2787,
"accountId": 37227,
"account": {
"id": 37227,
"name": "ТОВ \"Відправник товару\"",
"edrpou": "34554363-1",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"otpraviteltovara@gmail.com"
],
"phone": "380123456789",
"legalAddress": "Київ, вул.Заболотного 29",
"dateCreate": 1624377561,
"dateChange": 0
},
"login": "tender.vilnui2@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Vi",
"surname": "Kut",
"phone": "380646545646",
"dateLastLogin": 1637259663,
"info": "created from web",
"emails": [
"tender.vilnui2@gmail.com"
],
"companies": [
{
"id": 4553,
"uuid": "1a578a08-da65-41a8-a45d-74891a84b8ae",
"accountID": 37227,
"name": "ТОВ Тендер Вільний2",
"edrpou": "563256894",
"inn": "563256894"
}
],
"isSubscribes": false
},
{
"id": 60213983,
"employeeId": 2786,
"accountId": 37227,
"account": {
"id": 37227,
"name": "ТОВ \"Відправник товару\"",
"edrpou": "34554363-1",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"otpraviteltovara@gmail.com"
],
"phone": "380123456789",
"legalAddress": "Київ, вул.Заболотного 29",
"dateCreate": 1624377561,
"dateChange": 0
},
"login": "tender",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "ki",
"surname": "vi",
"phone": "380564654654",
"dateLastLogin": 1635936070,
"info": "created from web",
"emails": [
"tender.vilnui.ttn@gmail.com"
],
"companies": [
{
"id": 4552,
"uuid": "bb63a908-e453-41d4-ace0-d5c894691e92",
"accountID": 37227,
"name": "ТОВ Тендер Вільний",
"edrpou": "123654788",
"inn": "123654788"
}
],
"isSubscribes": false
}
]
}
Об’єкт Comment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id коментаря |
|
accountId |
long |
id аккаунту |
|
companyId |
long |
id компанії |
|
userId |
long |
id користувача |
|
adminId |
long |
id адміністратора |
|
dateChange |
long |
дата зміни коментаря |
|
text |
String |
текст коментаря |
Об’єкт Company (для сервісу Тендер)
Опис параметрів об'єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
long |
id компанії |
|
uuid |
UUID |
uuid компанії |
|
|
accountID |
long |
id аккаунту |
|
|
account |
Account |
об’єкт; дані аккаунту |
|
|
name |
String |
повне найменування організації чи ПІБ індивудуального підприємця |
|
|
edrpou |
String |
код ЄДРПОУ/КПП |
|
|
inn |
String |
код ІПН |
|
|
city |
String |
місто |
|
|
address |
String |
адреса |
|
|
comment |
об’єкт; коментар |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об'єкт Filter (додаткові параметри виборки)
Опис параметрів об'єкта (пошуку)
|
Параметр |
Формат |
Опис |
|---|---|---|
|
dateStartFrom |
int |
початок яких з |
|
dateStartTo |
int |
початок яких по |
|
dateEndFrom |
int |
завершення яких з |
|
dateEndTo |
int |
завершення яких по |
|
dateCreateFrom |
int |
котрі створені з |
|
dateCreateTo |
int |
котрі створені по |
|
title |
String |
частина назви тендера |
|
lotTitle |
String |
частина назви лота |
|
accessType |
tinyint |
тип доступу:
|
|
offerType |
tinyint |
етап:
|
|
type |
tinyint |
тип торгівлі:
|
|
withTax |
tinyint |
за ціною (ПДВ / без ПДВ):
|
|
organizator |
int |
id Організатора |
|
category |
int |
номер товарної категорії |
|
ordering |
String |
користувацьке сортування |
|
limit |
int |
ліміт вибірки (за замовчуванням 20) |
|
offset |
int |
зміщення відносно верхньої межі вибірки (за замовчуванням 0) |
|
count |
boolean |
значення true повертає у відповіді методу лише кількість відібраних запитом тендерів (число) |
|
status |
tinyint |
статус тендера:
|
Об’єкт Auction (дані тендера)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
id тендера |
|
|
uuid |
UUID |
uuid тендера |
|
|
companyId |
long |
id компанії |
|
|
company |
M |
об’єкт; дані компанії, якій належить тендер |
|
|
dateCreate |
long |
дата створення тендера (UNIX TimeStamp) |
|
|
dateStart |
M |
long |
дата початку тендера (UNIX TimeStamp) |
|
dateEnd |
M |
long |
дата закінчення тендера (UNIX TimeStamp) |
|
dateLastUpdate |
long |
дата останнього оновлення тендера (UNIX TimeStamp) |
|
|
userId |
long |
id користувача |
|
|
user |
об’єкт; дані користувача |
||
|
title |
M |
String |
назва (заголовок) тендера |
|
description |
M |
String |
опис тендера |
|
status |
об’єкт; статус тендера |
||
|
accessType |
M |
об’єкт; вид (тип доступу) |
|
|
type |
M |
об’єкт; напрям тендера (тип торгівлі) |
|
|
offerType |
M |
об’єкт; етап |
|
|
isAutoRenewal |
O |
boolean |
автоматичне продовження тендера (автопродовження) |
|
autoRenewalTime |
O |
int(0-10) |
час в хв, на який здійснюється автопродовження (лише при isAutoRenewal=true); При isAutoRenewal=false параметр autoRenewalTime=0; при isAutoRenewal=true параметр autoRenewalTime=5 за замовчуванням. |
|
autoRenewalMaxCount |
O |
int |
Максимальна кількість продовжень. Якщо значення 0, то тендер буде продовжуватись нескінченну кількість разів |
|
autoRenewalDateUntil |
O |
unixtimestamp |
Дата/час, після якої автопродовження не буде. Якщо значення 0, то тендер буде продовжуватися до нескінченності. |
|
autoRenewalIsWorkDays |
O |
boolean |
Враховувати робочі години. Якщо вказано “Так” і час завершення тендеру більше за 18:00, то такий тендер автоматично продовжується на наступний день на 09:30 |
|
isTax |
O |
boolean |
відображення ціни з ПДВ |
|
noShowBets |
O |
boolean |
приховувати ставки |
|
noShowBestBet |
O |
boolean |
приховувати кращу ставку |
|
hideParticipantNamesOnly |
O |
boolean |
приховувати імена учасників |
|
hideLotsAndBetsCounts |
O |
boolean |
Не показувати кількість ставок та лотів не запрошеним учасникам |
|
isFree |
boolean |
безкоштовна участь |
|
|
isProlonged |
boolean |
відмітка продовження тендера |
|
|
users |
O |
List<Integer> |
масив даних ID користувачів, яким буде надано доступ до відповідного тендеру після його публікації |
|
lots |
M |
List<Lot> |
масив об’єктів; дані лотів |
|
auctionContact |
об’єкт; дані контактної особи |
||
|
lotsCount |
Integer |
кількість лотів |
|
|
betsCount |
Integer |
кількість ставок |
|
|
attachments |
List<Attachment> |
масив об’єктів; вкладення |
|
|
companyAccessRequestStatus |
об’єкт; статус заявки на участь в закритому тендері і коментарями Організатора. Об’єкт доступний лише закритим тендерам для Організатора чи Учасника цього тендера. |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад запиту (дані для створення тендера)
{
"dateStart": 1654269080,
"dateEnd": 1654269880,
"type": {
"code": 1
},
"offerType": {
"code": 1
},
"accessType": {
"code": 1
},
"status": {
"code": 1
},
"company": {
"id": 3600
},
"title": "свиня",
"description": "поросятко",
"lots": [
{
"title": "поросятко",
"productCode": "",
"description": "поросятко",
"expectedValue": "2",
"stepValue": "3",
"currency": {
"id": 1
},
"region": {
"id": 0
},
"category": {
"id": 9523
},
"unit": {
"id": 17
},
"quantity": "3",
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"attachments": []
}
],
"isAutoRenewal": true,
"autoRenewalTime": 5,
"autoRenewalMaxCount": 10,
"autoRenewalDateUntil": 1732788000,
"autoRenewalIsWorkDays": true,
"isTax": true,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"hideLotsAndBetsCounts": false,
"auctionContact": null
}
JSON приклад відповіді (дані створеного тендера)
{
"id": 4623,
"uuid": "c79ae8fc-a2cf-4650-90c2-f987b1c28f38",
"companyId": 0,
"company": {
"id": 3600,
"uuid": "c345ef8f-ba02-439a-afac-007ed088cf2e",
"accountID": 36633,
"name": "Товариство з обмеженою відповідальністю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "125632589223",
"city": "Kiev"
},
"dateCreate": 1654243789,
"dateStart": 1654245540,
"dateEnd": 1654247340,
"dateLastUpdate": 1654243789,
"userId": 0,
"user": {
"id": 60212904,
"employeeId": 1035,
"accountId": 36633,
"account": {
"id": 36633,
"name": "Товариство з обмеженою відповідальністю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "123652632563",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"12356@ukr.net"
],
"phone": "355478563",
"legalAddress": "ююю",
"dateCreate": 1598894147,
"dateChange": 1638282398,
"about": "строительство и логистика ",
"logo": "/api/logo/accounts/logo_36633.jpg"
},
"login": "willnotgotomumbai@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Арбуз",
"surname": "Арбузов",
"secondName": "Иоанович ",
"phone": "380975560011",
"ipn": "111111111111",
"dateLastLogin": 1654243144,
"info": "self registered. IP: null",
"emails": [
"willnotgotomumbai@gmail.com"
],
"companies": [
{
"id": 3600,
"uuid": "c345ef8f-ba02-439a-afac-007ed088cf2e",
"accountID": 36633,
"name": "Товариство з обмеженою відповідальністю \"Скай'нет-56\"",
"edrpou": "89456891",
"inn": "125632589223",
"city": "Kiev"
},
{
"id": 3624,
"uuid": "164d8465-aad6-409d-b3a8-5b009e1ca542",
"accountID": 36633,
"name": "Товариство з обмеженою відповідальністю \"Інститут інноваційних технологій",
"edrpou": "6465656666",
"inn": "6465656666",
"city": "Львів",
"address": "Волкова"
},
{
"id": 4248,
"uuid": "8520b4ee-c799-461e-9b14-e129dcfef27d",
"accountID": 36633,
"name": "ТОВ \"Отправитель товар",
"edrpou": "643555552",
"inn": "643555552"
},
{
"id": 4408,
"uuid": "cf5def31-8849-4a30-b1fa-0bf3e1d39423",
"accountID": 36633,
"name": "апвапвапв",
"edrpou": "2563256222",
"inn": "2563256222"
}
],
"isSubscribes": false
},
"title": "Шнурок",
"description": "а може навіть хвіст",
"status": {
"code": 1,
"name": "draft",
"description": "Черновик"
},
"accessType": {
"code": 1,
"name": "public",
"description": "Открытый для всех"
},
"type": {
"code": 1,
"name": "purchase",
"description": "Покупка"
},
"offerType": {
"code": 1,
"name": "bargaining",
"description": "Торги"
},
"isAutoRenewal": true,
"isTax": true,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"hideLotsAndBetsCounts": false,
"isFree": false,
"isProlonged": false,
"lots": [
{
"id": 10063,
"auctionId": 4623,
"title": "Шнурок для віслючка",
"description": "нє ну як ще описати",
"expectedValue": 2345.0,
"stepValue": 23.0,
"currencyId": 0,
"currency": {
"id": 1,
"code": "UAH",
"name": "Українська гривня"
},
"quantity": 1.0,
"unitId": 0,
"unit": {
"id": 1,
"code": "2009",
"name": "штука",
"shortName": "шт"
},
"deliveryStartDate": 0,
"deliveryEndDate": 0,
"categoryId": 0,
"category": {
"id": 9511,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "001",
"check_sum": "9",
"full_code": "99999001-9",
"description_ua": "Зоотовари",
"description_en": "Pet supplies",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
"regionId": 0,
"region": {
"id": 0,
"code": "0",
"name": "Все области"
},
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"attachmentsCount": 0
}
],
"auctionContact": {
"auctionId": 4623
},
"lotsCount": 1
}
JSON приклад відповіді (отримання даних існуючого тендера)
{
"id": 4611,
"uuid": "5042fdf7-0985-4429-88d3-4fc1c0055f3f",
"companyId": 4216,
"company": {
"id": 4216,
"uuid": "eaf51f20-810e-4296-952f-b5a0c9c3b1ab",
"accountID": 37228,
"name": "ТОВ Перевозчик товара",
"edrpou": "987456321",
"inn": "987456321",
"city": "Тетиев",
"address": "центральная"
},
"dateCreate": 1654238475,
"dateStart": 1654240260,
"dateEnd": 1657438800,
"dateLastUpdate": 1654238479,
"userId": 60213516,
"user": {
"id": 60213516,
"employeeId": 2123,
"accountId": 37228,
"account": {
"id": 37228,
"name": "ТОВ \"Перевозчик товара\"",
"edrpou": "987456321",
"inn": "987456321",
"status": {
"code": 1,
"description": "Активный"
},
"emails": [
"perevozchiktovara@gmail.com"
],
"phone": "380635025677",
"legalAddress": "вул. Хрещатик 32",
"dateCreate": 1624374233,
"dateChange": 0
},
"login": "perevozchiktovara@gmail.com",
"role": {
"code": 1,
"description": "Пользователь"
},
"name": "Груз",
"surname": "Перевозчик",
"secondName": "LLLL",
"phone": "380534653460",
"ipn": "1234567891",
"dateLastLogin": 1654238418,
"info": "self registered. IP: null",
"emails": [
"perevozchiktovara@gmail.com"
],
"companies": [
{
"id": 4216,
"uuid": "eaf51f20-810e-4296-952f-b5a0c9c3b1ab",
"accountID": 37228,
"name": "ТОВ Перевозчик товара",
"edrpou": "987456321",
"inn": "987456321",
"city": "Тетиев",
"address": "центральная"
},
{
"id": 4219,
"uuid": "c067f69f-aaec-4e04-a3be-4d365fe24a02",
"accountID": 37228,
"name": "Тов Нов перевоз",
"edrpou": "456909720",
"inn": "7527785272",
"city": "Київ",
"address": "проспект Оболонський"
},
{
"id": 4230,
"uuid": "2d617de7-5624-4332-88ea-14529c8b1a73",
"accountID": 37228,
"name": "ДЛП ОРТ-арож",
"edrpou": "151515369",
"inn": "151515369"
},
{
"id": 4231,
"uuid": "eb9b40c4-ed5f-4cb2-820e-265fcb146f42",
"accountID": 37227,
"name": "ТОВ Перевозка",
"edrpou": "19369433",
"inn": "566666666666",
"city": "Київ",
"address": "проспект Бандери 35"
},
{
"id": 4234,
"uuid": "09279204-eda7-468b-bef1-8fe9a5327290",
"accountID": 37227,
"name": "ТОВ Заказчик",
"edrpou": "642456988",
"inn": "642456988",
"city": "Киев",
"address": "проспект Победы 40"
},
{
"id": 4574,
"uuid": "f28e0c65-9802-4cf6-9119-614f65222441",
"accountID": 37228,
"name": "ТОВ Валидный едрпоу",
"edrpou": "42746134",
"inn": "427461345555"
},
{
"id": 6991,
"uuid": "ee0735df-eb71-49a0-acd5-49363984de5f",
"accountID": 37487,
"name": "ТОВ Бурундук",
"edrpou": "5243543",
"inn": "6565315321"
}
],
"isSubscribes": false
},
"title": "Яблука",
"description": "Яблука",
"status": {
"code": 2,
"name": "active",
"description": "Активный"
},
"accessType": {
"code": 1,
"name": "public",
"description": "Открытый для всех"
},
"type": {
"code": 1,
"name": "purchase",
"description": "Покупка"
},
"offerType": {
"code": 1,
"name": "bargaining",
"description": "Торги"
},
"isAutoRenewal": true,
"isTax": true,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"hideLotsAndBetsCounts": false,
"isFree": false,
"isProlonged": false,
"lots": [
{
"id": 10051,
"auctionId": 4611,
"title": "Яблука",
"description": "Яблука",
"expectedValue": 333.0,
"stepValue": 3.0,
"currencyId": 1,
"currency": {
"id": 1,
"code": "UAH",
"name": "Українська гривня"
},
"quantity": 33333333,
"unitId": 14,
"unit": {
"id": 14,
"code": "2013",
"name": "тисяча штук",
"shortName": "тис.шт."
},
"deliveryStartDate": 0,
"deliveryEndDate": 0,
"categoryId": 9511,
"category": {
"id": 9511,
"section": "99",
"group": "9",
"categoryClass": "9",
"category": "9",
"detailing": "001",
"check_sum": "9",
"full_code": "99999001-9",
"description_ua": "Зоотовари",
"description_en": "Pet supplies",
"rank": 1,
"refId": 9458,
"hasChildren": 0,
"status": 1,
"isSubscribes": false
},
"regionId": 0,
"noShowBets": false,
"noShowBestBet": false,
"hideParticipantNamesOnly": false,
"betsCount": 0,
"attachmentsCount": 0
}
],
"lotsCount": 1,
"betsCount": 0,
"attachments": []
}
Об’єкт Bet (дані ставки по тендеру)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id ставки |
|
lotId |
long |
id лота |
|
lot |
Lot |
об’єкт; детальна інформація про лот |
|
userId |
long |
id користувача |
|
user |
User |
об’єкт; детальна інформація про користувача |
|
companyId |
long |
id компанії |
|
company |
Company |
об’єкт; детальна інформація про компанію |
|
value |
double |
значення ставки |
|
comment |
String |
коментар |
|
dateTime |
long |
дата і час ставки у форматі UNIX TimeStamp |
|
status |
Status |
статус |
|
removeComment |
String |
відмітка про видалення коментаря |
|
auctionChangedDateEnd |
long |
дата і час завершення тендера (у форматі UNIX TimeStamp) |
|
attachmentsCount |
int |
кількість прикладених до ставки файлів (max=5) |
Приклад JSON:
{
"id": 3269,
"lotId": 5681,
"userId": 198,
"user": {
"id": 198,
"employeeId": 198,
"accountId": 11158,
"account": {
"id": 11158,
"name": "СУБЛАНД УКРАЇНА",
"edrpou": "37212319",
"inn": "372123104628",
"status": {
"code": 1,
"description": "Активний"
},
"emails": [
"sinergiya@test.com"
],
"phone": "3805637318",
"legalAddress": "49069, м. Дніпро, вул. Лісова, буд. 49",
"dateCreate": 1371452537,
"dateChange": 1605700611,
"logo": "/api/logo/accounts/logo_11158.jpg"
},
"login": "biba",
"role": {
"code": 1,
"description": "Користувач"
},
"name": "first_name",
"surname": "last_name",
"secondName": "middle_name",
"phone": "9",
"ipn": "1",
"dateLastLogin": 1611594024,
"info": "1e4d3617\r\nЗаблокирован, за неуплату 2010-10-04 16:55\r\nРазблокирован 2010-10-06 17:31\r\nЗаблокирован, за неуплату 2011-03-29 11:47\r\nРазблокирован 2011-03-29 15:34\r\nЗаблокирован, за неуплату 2011-05-10 09:24\r\nРазблокирован 2011-05-10 11:44",
"emails": [
"biba",
"evo-dev@edi.su"
],
"companies": [
{
"id": 447,
"uuid": "0e4eca5a-b60d-4e18-b87c-05173ce5dfac",
"accountID": 11158,
"name": "СУБЛАНД УКРАЇНА",
"edrpou": "37212319",
"inn": "372123104628"
}
]
},
"companyId": 447,
"value": 42.0,
"comment": "Коментар2",
"dateTime": 0,
"status": {
"code": 1,
"name": "active",
"description": "Активна ставка"
},
"auctionChangedDateEnd": 1617178680,
"attachmentsCount": 0
}
Об’єкт XDocApprovalStep
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
docId |
long |
id документа |
|
|
scenarioId |
long |
id сценарію |
|
|
stepId |
M |
int |
id кроку погодження |
|
userId |
long |
id користувача |
|
|
stepStatus |
int |
статус кроку погодження
|
|
|
operationType |
M |
int |
тип операції
|
|
stepInfo |
String |
інфо кроку погодження (текст причини відхилення на даному кроці) |
|
|
dateChanged |
long |
дата останньої зміни (unix timestamp) |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об'єкт XDocApprovalScenario (дані кроків за сценарієм)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
id сценарію |
|
|
actual |
O |
boolean |
актуальність
actual=false - передається для видалення сценарію |
|
userId |
long |
id користувача |
|
|
docType |
O |
int |
тип документа для автопогодження:
|
|
auto |
O |
boolean |
автоматичний запуск погодження |
|
name |
M |
String |
назва сценарію |
|
subDocTypes |
O |
List<Integer> |
масив чисел; підтип COMDOC документа для автопогодження:
|
|
partners |
O |
List<String> |
масив значень; перелік GLN контрагентів, за якими буде запускатись автопогодження |
|
documentSumMin |
O |
double |
ВІД якої суми документа (з ПДВ) буде запускатись автопогодження |
|
documentSumMax |
O |
double |
ДО якої суми документа (з ПДВ) буде запускатись автопогодження |
|
steps |
M |
<Integer, List<XDocApprovalStep>> |
об’єкт з пронумерованими масивами об’єктів; тіло сценарію (кроки погодження документів) |
JSON приклад запиту
{
"name": "Бахмут - це Україна",
"userId": 50206653,
"actual": true,
"auto": false,
"partners":
[],
"documentSumMin": "500",
"documentSumMax": "1000",
"steps":
{
"1":
[
{
"userId": "50206653",
"operationType": "1"
}
],
"2":
[
{
"userId": "60215367",
"operationType": "2"
}
]
},
"docType": 28,
"subDocTypes":
[
13
]
}
JSON приклад відповіді за одним сценарієм
{
"id": 5,
"actual": true,
"userId": 50206655,
"docType": 28,
"auto": true,
"name": "СценкаНова",
"subDocTypes":
[
13
],
"partners":
[],
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
}
JSON приклад відповіді за всіма сценаріями
[
{
"id": 1,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "very short",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 2,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "Акт наданих послуг",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 3,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "test skip first step",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206661,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
]
}
},
{
"id": 4,
"actual": true,
"userId": 50206655,
"docType": 0,
"auto": false,
"name": "На Дарʼю",
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206661,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 5,
"actual": true,
"userId": 50206655,
"docType": 28,
"auto": true,
"name": "СценкаНова",
"subDocTypes":
[
13
],
"partners":
[],
"documentSumMin": 0.0,
"documentSumMax": 0.0,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
},
{
"id": 6,
"actual": false,
"userId": 50206655,
"docType": 28,
"auto": false,
"name": "На підтримку ЗСУ",
"subDocTypes":
[
13
],
"partners":
[
"1234567890AaB",
"4823058722214"
],
"documentSumMin": 5.0E+10,
"documentSumMax": 5000000000000001,
"steps":
{
"1":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 1,
"dateChanged": 0
}
],
"2":
[
{
"docId": 0,
"scenarioId": 0,
"stepId": 0,
"userId": 50206655,
"stepStatus": 0,
"operationType": 2,
"dateChanged": 0
}
]
}
}
]
Об'єкт XQueryShipment
Даний об'єкт використовується для пошуку сертифікатів по відвантаженню.
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
number |
FieldParams |
параметри пошуку по номеру відвантаження |
|
date |
|
|
|
buyer |
FieldParams |
|
Приклади пошуку сертифікатів по номеру відвантаження
Пошук сертифікатів, де є відвантаження з номером shipment_1 або shipment_231:
{"shipments":[{"number":{"operator":"AND","type":"IN","query":"'shipment_1','shipment_231'"}}],"queryType":"MY","limit":{"offset":0,"count":21}}
Пошук сертифікатів де є відвантаження з частковим співпадінням номера відвантаження:
{"shipments":[{"number":{"operator":"AND","type":"LIKE","query":"shipment_%"}}],"queryType":"MY","limit":{"offset":0,"count":21}}
Об'єкт XCertificateShipment
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
|
long |
id відвантаження |
|
creatorId |
|
long |
GLN id користувача, який створив відвантаження |
|
number |
|
String |
номер накладної |
|
date |
|
long |
дата накладної |
|
buyer |
O |
long |
покупець |
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Обʼєкт XPromotion
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
O/M |
long |
id акції |
|
code |
M |
String |
код акції |
|
name |
M |
String |
назва акції |
|
type_id |
M |
int |
id типу акції |
|
date_from |
M |
long |
дата початку акції |
|
date_to |
M |
long |
дата закінчення акції |
|
date_end |
M |
long |
останній день подання пропозицій |
|
date_changed |
O |
long |
дата створення/редагування/видалення акції зі сторони Мережі |
|
date_notification |
O |
long |
дата сповіщення про закінчення дії акції |
|
state |
O |
int |
стан акції (1 - активна) |
|
type |
O |
тип акції |
|
|
access |
O |
List<String> |
розділення доступу по GLN |
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об'єкт XPromotionType
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
type_id |
long |
id типу акції |
|
retailer_id |
int |
id Мережі на платформі EDIN |
|
gln_id |
long |
GLN id |
|
type |
String |
назва типу акції |
Об’єкт mintransSubscription
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор підписки |
|
gln |
String |
GLN компанії |
|
companyCode |
String |
код ЄДРПОУ / ІПН компанії |
|
expired |
long |
кінцевий термін дії підписки (unix timestamp); визначає державний орган що керує |
|
startDate |
long |
початок терміну дії підписки (unix timestamp); дата оформлення підписки на події |
Приклад запиту
{
"id": 14,
"gln": 3958152365482,
"companyCode": "12345678",
"expired": 1719409499,
"startDate": 1703868300
}
Об'єкт XQueryProduct
Опис параметрів об'єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
barcode |
O |
String |
штрихкод товару |
|
article |
O |
String |
артикул продавця |
|
buyerCode |
O |
String |
код покупця |
|
uktveds |
O |
List<Integer> |
масив; коди УКТЗЕД товарів |
|
partNumber |
O |
String |
номер партії |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт XQueryCertificates
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
queryType |
O |
enum (MY, PRIVATE, PUBLIC, DRAFT, ARCHIVE, LIMITED_ACCESS, PUBLIC_ACCESS, PRIVATE_ACCESS) |
розділ сертифікатів, по якому буде здійснюватись пошук:
|
|
companyId |
O |
long |
ідентифікатор компанії |
|
products |
O |
List<XQueryProduct> |
масив об’єктів; дані товарів |
|
number |
O |
String |
номер сертифіката |
|
numbers |
O |
Collection<String> |
список номерів сертифікатів |
|
createDate |
O |
дата створення |
|
|
updateDate |
O |
дата оновлення |
|
|
types |
O |
List<Integer> |
масив об’єктів; типи сертифікатів |
|
startDate |
O |
дата початку дії сертифіката |
|
|
endDate |
O |
дата завершення дії сертифіката |
|
|
isSigned |
O |
Boolean |
true - підписаний, false - не підписаний |
|
limit |
O |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
|
shipments |
O |
об'єкт з параметрами пошуку по пов'язаним відвантаженням |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад запиту для пошуку всіх сертифікатів, де Ви - власник:
{
"queryType": "MY"
}
JSON приклад запиту для пошуку по Номеру партії 492:
{
"characteristics": {
"Batch Number": "492"
},
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}
JSON приклад запиту для пошуку по Пов’язаній накладній 492:
{
"shipments": [
{
"number": {
"operator": "AND",
"type": "EQUALS",
"query": "492"
}
}
],
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}
JSON приклад запиту для пошуку по Артикулу продавця 419775:
{
"products": [
{
"buyerCode": {
"operator": "AND",
"type": "EQUALS",
"query": "419775"
}
}
],
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}
JSON приклад запиту для пошуку по Штрихкоду 4820275490223:
{
"products": [
{
"barcode": {
"operator": "AND",
"type": "EQUALS",
"query": "4820275490223"
}
}
],
"queryType": "ALL",
"limit": {
"offset": 0,
"count": 21
}
}
Дані про сертифікат
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
certificate |
об’єкт; дані сертифіката |
|
|
glns |
Map<gln_id, Identificator> |
об’єкт; дані власника публічного сертифіката / дані користувачів з правами перегляду |
JSON приклад відповіді:
{
"certificate":
{
"id": 167,
"uuid": "55ef04b2-281e-4fca-bb67-d48fe88ae74f",
"number": "Номер сертифіката1",
"createDate": 1705494187,
"updateDate": 1705499386,
"issueDate": 1704060000,
"type":
{
"id": 10,
"name": "протокол лабораторних досліджень",
"type": 0
},
"view":
{
"id": 1,
"description": "Період дії"
},
"access":
[
13203393
],
"startDate": 1705442400,
"endDate": 1705528800,
"isSigned": false,
"accessType":
{
"code": 2,
"description": "Закритий (приватний)"
},
"creator": 13205923,
"info": "Коментар",
"level":
{
"code": "A",
"description": "Непідписаний сертифікат з прив'язкою до товарів"
},
"bodies":
{
"1":
[]
},
"characteristics":
{
"Issuer Article": "Артикул виробника",
"VMD Number": "Номер ВМД",
"Batch Number": "Номер партії!"
},
"parents":
[],
"products":
[
{
"id": 203,
"certificateId": 167,
"name": "Шоколадка",
"barcode": "1212121212",
"article": "Артикул продавця ",
"buyerCode": "Артикул покупця",
"uktved": 123456,
"dkpp": "Код ДКПП"
}
],
"productsQty": 0,
"autoArchive": true
},
"glns":
{
"13203393":
{
"id": 13203393,
"gln": "9864232607052",
"companyId": 37663,
"retailerId": 0,
"isUzdAts": 0,
"isFinCrypt": 0,
"countryId": 2,
"isERNN": 3,
"name": "TW_Вантажовідправник",
"companyType": "fiz",
"companyInn": "111111111111",
"companyKpp": "11111111",
"zip": "121212",
"katottg": "UA05020030010063857",
"city": "м. Вінниця, Вінницький р-н",
"street": "Тестова 2",
"IBAN": "UA111111111111111111111111111",
"district": "Вінницька",
"dpiCReg": 0,
"dpiCRaj": 0,
"isListex": false,
"isDeclarDateNumRequired": true,
"distribexUser": 0,
"isWithoutTax": true,
"taxSource": 0,
"isDriver": false,
"isSignConfirm": 0,
"isSpecification": 0,
"isCompany": 1,
"isTemporary": 0,
"parentId": 0,
"constructorGroupID": 0
}
}
}
Об'єкт characteristics (характеристики Сертифіката)
Опис параметрів об'єкта
|
Назва |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
Batch Number |
O/M |
String |
Номер партії (обов’язково передається при view.id=2) |
|
Issuer Article |
O |
String |
Артикул виробника |
|
VMD Number |
O |
String |
Номер ВМД |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт XCertificateProduct (дані товарів)
| Параметр | Тип1 | Формат | Опис |
| id | O | long | ідентифікатор товару |
| certificateId | long | ідентифікатор сертифіката | |
| name | M | String | назва товару |
| barcode | M | String | штрихкод товару |
| article | M | String | артикул продавця |
| buyerCode | O | String | код покупця |
| uktved | O | long | код УКТЗЕД товару |
| dkpp | O | String | код ДКПП товару |
| partNumber | String | номер партії |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
JSON приклад відповіді:
-
[
{
"name": "Плотва",
"barcode": "yes it is",
"buyerCode": "Продаван",
"article": "Покупан",
"uktved": "2222222",
"dkpp": "333333"
},
{
"name": "Скумбрія",
"barcode": "121212122",
"dkpp": "12122",
"uktved": "333333",
"article": "Артикул2",
"buyerCode": "Артикул1"
}
]
Об'єкт Level
| Рівень | Опис |
| A+ | Підписаний сертифікат з прив'язкою до товарів |
| A | Непідписаний сертифікат з прив'язкою до товарів |
| B+ | Підписаний сертифікат без товарів |
| B | Непідписаний сертифікат без товарів |
| C | Без файлу сертификата |
Об'єкт AccessType
| Код | Опис |
| 0 | Неопубликований (DRAFT) |
| 1 | Відкритий для всіх (PUBLIC) |
| 2 | Закритий (приватний) (PRIVATE) |
| 3 | Доступний за посиланням (URL_ACCESS) |
Об’єкт XCertificateView
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
int |
ідентифікатор виду
|
|
description |
String |
опис виду |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт XCertificateType
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
int |
ідентифікатор типу
|
|
name |
String |
назва типу |
|
|
code |
String |
код типу |
|
|
type |
int |
тип |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт XCertificate (дані Сертифіката)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
ідентифікатор сертифіката |
|
|
uuid |
-/M |
UUID |
унікальний ідентифікатор сертифіката (передається при редагуванні сертифіката) |
|
number |
M |
String |
номер сертифіката |
|
createDate |
long |
дата створення (Unix timestamp) |
|
|
updateDate |
long |
дата оновлення (Unix timestamp) |
|
|
issueDate |
M |
long |
дата видачі (Unix timestamp) |
|
type |
M |
об’єкт; тип сертифіката |
|
|
view |
M |
об’єкт; вид сертифіката |
|
|
access |
List<Long> |
масив; доступність |
|
|
startDate |
M |
long |
дата початку дії сертифіката (Unix timestamp) |
|
endDate |
O/M |
long |
дата завершення дії сертифіката (Unix timestamp); параметр обов’язковий при view.id=1 |
|
isSigned |
boolean |
true - підписаний, false - не підписаний |
|
|
accessType |
об’єкт; тип доступу до сертифіката |
||
|
creator |
long |
ідентифікатор власника/автора сертифіката |
|
|
info |
O |
String |
коментар (додаткова інформація) |
|
level |
об’єкт; рівень сертифіката |
||
|
bodies |
Map<Integer, byte[]> |
вкладення |
|
|
characteristics |
O/M |
Map<String, String> |
характеристики characteristics (обов’язково передається при view.id=2) |
|
parents |
List<XCertificate> |
масив об’єктів; материнські сертифікати |
|
|
products |
List<XCertificateProduct_> |
масив об’єктів; товари |
|
|
productsQty |
int |
кількість товарів зв’язаних із сертифікатом |
|
|
autoArchive |
boolean |
true - автоматично архівувати, false - не архівувати автоматично |
|
|
is_structured |
int |
ознака, що документ структурований, приймає значення 0 (за замовчуванням) або 1 (якщо документ структурований) |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
JSON приклад:
{
"creator": 13205923,
"type":
{
"id": "10"
},
"view":
{
"id": "2"
},
"accessType":
{
"code": 0
},
"characteristics":
{
"Batch Number": "Номер партії*",
"Issuer Article": "Артикул виробника",
"VMD Number": "Номер ВМД"
},
"products":
[],
"number": "Номер сертифіката",
"issue_dateString": "2024-01-17",
"endDateString": "2024-01-17",
"startDateString": "2024-01-17",
"info": "Коментар",
"endDate": 1705442400,
"startDate": 1705442400,
"issueDate": 1705442400
}
Об’єкт XProductGroup (Групи / категорії товарів)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
groupd_id |
long |
ідентифікатор
|
|
parent_group_id |
long |
ідентифікатор приналежності до вищого рівня в структурі:
|
|
name |
String |
назва:
|
|
children |
List<groupd_id> |
масив;
|
JSON приклад
{
"1": {
"groupd_id": 1,
"parent_group_id": 0,
"name": "Бакалія",
"children": [
7,
16,
2
]
},
"2": {
"groupd_id": 2,
"parent_group_id": 1,
"name": "Безглютенові продукти",
"children": [
3,
5
]
},
"3": {
"groupd_id": 3,
"parent_group_id": 2,
"name": "Кондитерські вироби без глютену",
"children": [
4
]
},
"4": {
"groupd_id": 4,
"parent_group_id": 3,
"name": "Печиво без глютену",
"children": []
},
"5": {
"groupd_id": 5,
"parent_group_id": 2,
"name": "Хлібо булочні вироби без глютену",
"children": [
6
]
},
"6": {
"groupd_id": 6,
"parent_group_id": 5,
"name": "Хліб без глютену",
"children": []
},
"7": {
"groupd_id": 7,
"parent_group_id": 1,
"name": "Борошно",
"children": [
8,
10,
12
]
},
"8": {
"groupd_id": 8,
"parent_group_id": 7,
"name": "Борошно житнє",
"children": [
9
]
},
"9": {
"groupd_id": 9,
"parent_group_id": 8,
"name": "Борошно житнє 1кг",
"children": []
},
"10": {
"groupd_id": 10,
"parent_group_id": 7,
"name": "Борошно кукурудзяне",
"children": [
11
]
},
"11": {
"groupd_id": 11,
"parent_group_id": 10,
"name": "Борошно кукурудзяне 1кг",
"children": []
},
"12": {
"groupd_id": 12,
"parent_group_id": 7,
"name": "Борошно пшеничне",
"children": [
14,
15,
13
]
},
"13": {
"groupd_id": 13,
"parent_group_id": 12,
"name": "Борошно пшеничне 1кг",
"children": []
},
"14": {
"groupd_id": 14,
"parent_group_id": 12,
"name": "Борошно пшеничне 2кг",
"children": []
},
"15": {
"groupd_id": 15,
"parent_group_id": 12,
"name": "Борошно пшеничне 5кг",
"children": []
},
"16": {
"groupd_id": 16,
"parent_group_id": 1,
"name": "Консерви М'ясні, Рибні",
"children": [
17,
20
]
},
"17": {
"groupd_id": 17,
"parent_group_id": 16,
"name": "Консерви Рибні",
"children": [
18,
19
]
},
"18": {
"groupd_id": 18,
"parent_group_id": 17,
"name": "Тунець консервований",
"children": []
},
"19": {
"groupd_id": 19,
"parent_group_id": 17,
"name": "Шпроти консервовані",
"children": []
},
"20": {
"groupd_id": 20,
"parent_group_id": 16,
"name": "Консерви М'ясні",
"children": [
21
]
},
"21": {
"groupd_id": 21,
"parent_group_id": 20,
"name": "Консервоване мясо птиці",
"children": []
}
}
Об’єкт XSearchPositionsQuery (Фільтр за позиціями Комерційних пропозицій)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
retailerId |
long |
ідентифікатор мережі |
|
recipientGln |
String |
GLN отримувача |
|
recipientGlnId |
long |
ідентифікатор GLN отримувача |
|
senderGln |
String |
GLN відправника |
|
senderGlnId |
long |
ідентифікатор GLN відправника |
|
name |
String |
найменування позиції |
|
barcode |
String |
штрихкод позиції |
|
dateChanged |
DateTimeRange |
Пошук по даті, з можливістю вказати період. Приклад:
|
|
statuses |
List<Integer> |
масив статусів позицій (0 - чернетка; 1 - прийнято; 2 - відхилено; 3 - на узгодженні) |
|
groups |
Set<Long> |
масив категорій/груп/підгруп/товарних сегментів |
|
limit |
об’єкт; фільтр відбору (налаштування виводу даних) |
JSON приклад
{
"statuses": [
3
],
"groups": [
527,
487,
451,
533
],
"barcode": "111000222",
"retailerId": 7,
"limit": {
"count": 20,
"offset": 0
}
}
Масив об’єктів XAgreemDocPosition (Дані позицій Комерційної пропозиції)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор позиції |
|
uuid |
UUID |
унікальний ідентифікатор позиції |
|
name |
String |
найменування позиції |
|
barcode |
String |
штрихкод позиції |
|
status |
int |
статус позиції (0 - чернетка; 1 - прийнято; 2 - відхилено; 3 - на узгодженні) |
|
content |
byte[] |
контент (байтовий масив) |
|
doc_id |
long |
ідентифікатор Комерційної пропозиції |
|
doc_uuid |
UUID |
унікальний ідентифікатор Комерційної пропозиції |
|
sender_id |
long |
ідентифікатор відправника |
|
senderGln |
String |
GLN відправника |
|
recipient_id |
long |
ідентифікатор отримувача |
|
recipientGln |
String |
GLN отримувача |
JSON приклад запиту:
[
{
"doc_uuid": "3cbb2868-b61b-42d2-86d1-11ffdf4445aa",
"name": "Літун",
"barcode": "01010101010",
"status": 0,
"content": []
}
]
JSON приклад відповіді:
[
{
"id": 672,
"uuid": "d8910d0a-879d-41e9-894d-1b2dcc22494b",
"name": "тест",
"barcode": "12331233213",
"status": 1,
"content": [],
"doc_id": 2659,
"doc_uuid": "fe24ac93-0240-49d0-8a37-23530fb08d5f",
"sender_id": 13200665,
"recipient_id": 41249
},
{
"id": 673,
"uuid": "730bc81b-a17f-413e-a7e5-afbd6cb86790",
"name": "тест2",
"barcode": "1234567890123",
"status": 1,
"content": [],
"doc_id": 2659,
"doc_uuid": "fe24ac93-0240-49d0-8a37-23530fb08d5f",
"sender_id": 13200665,
"recipient_id": 41249
}
]
Об’єкт DeliveryInstructions
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
description |
O |
string |
Опис (вид роботи перевізника: за відрядним тарифом, за погодинним тарифом, за по кілометровому тарифу, централізовані перевезення тощо) |
|
descriptionCode |
M |
string |
Код (TRANSPORTATION_TYPE) |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт MainCarriageLogisticsTransportMovement
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
specifiedTransportEvents** |
M |
List<TransportEvent> |
масив об’єктів; Проміжне розвантаження |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт UtilizedLogisticsTransportEquipment
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M |
string |
Реєстраційний номер автомобіля згідно з техпаспортом
|
|
categoryCode |
M |
string |
Тип транспортного засобу (для автомобіля параметр не передається):
|
|
characteristicCode |
O |
string |
Код визначення Причіп/напівпричіп:
|
|
affixedLogisticsSeals |
M/O |
List<SimpleIdentity> |
масив об’єктів; Номера пломб. В Акті перепломбування для автомобіля цей об’єкт є обов’язковим |
|
handlingInstructions |
O |
об’єкт; Інструкції з експлуатації |
|
|
applicableNotes |
M/O |
List<ApplicableNote> |
масив об’єктів; Примітки |
|
applicableTransportDangerousGoods |
O |
об’єкт; Клас небезпечних речовин |
|
|
associatedReferencedLogisticsTransportEquipment |
O |
об’єкт; Номер контейнера, в якому завантажено цей вантаж. Використовується опційно для контейнерних перевезень і має відповідати даним тегу UtilizedLogisticsTransportEquipment |
|
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Документи з вантажем |
|
transportLogisticsPackage |
O |
об’єкт; Транспортно-логістичний пакет. ВАЖЛИВО: в Україні дозволяється лише один LogisticsPackage для одного ConsignmentItem! |
|
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт IncludedSupplyChainConsignmentItem
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
sequenceNumeric |
M |
int |
Порядковий номер рядка в таблиці |
|
invoiceAmount |
O |
об’єкт; Загальна сума з ПДВ |
|
|
grossWeightMeasure |
M |
об’єкт; Маса брутто вантажу (кг) |
|
|
tariffQuantity |
O |
об’єкт; Ціна без ПДВ за одиницю в грн. Це можуть бути як гривні на кілограм (грн/кг), так і гривні на ящик (грн/ящик) - залежить від зазначеної одиниці виміру |
|
|
globalID |
O |
об’єкт; Код УКТЗЕД продукції |
|
|
natureIdentificationTransportCargo |
M |
об’єкт; Найменування вантажу |
|
|
applicableTransportDangerousGoods |
O |
об’єкт; Клас небезпечних речовин |
|
|
associatedReferencedLogisticsTransportEquipment |
O |
об’єкт; Номер контейнера, в якому завантажено цей вантаж. Використовується опційно для контейнерних перевезень і має відповідати даним тегу UtilizedLogisticsTransportEquipment |
|
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Документи з вантажем |
|
transportLogisticsPackage |
O |
об’єкт; Транспортно-логістичний пакет. ВАЖЛИВО: в Україні дозволяється лише один LogisticsPackage для одного ConsignmentItem! |
|
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TransportEvent
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
O/- |
string |
Порядковий номер події (події завжди нумеруються в порядку поступового зростання за принципом N+1) |
|
typeCode |
O |
string |
Тип операції (розвантаження=5, завантаження=10) |
|
description |
O/- |
string |
Опис |
|
actualOccurrenceDateTime |
O |
об’єкт; Дата і час прибуття автомобіля на розвантаження |
|
|
scheduledOccurrenceDateTime |
O |
об’єкт; Дата і час вибуття автомобіля з-під розвантаження |
|
|
occurrenceLogisticsLocation |
O/M |
об’єкт; Місцезнаходження |
|
|
certifyingTradeParties |
O/M |
List<TradeParty> |
масив об’єктів; Інформація (РНОКПП) про відповідальних осіб (підписантів), що передбачені логікою документообігу |
|
applicableNotes |
O |
List<ApplicableNote> |
масив об’єктів; Примітки |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт HandlingInstructions
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
applicableTransportSettingTemperature |
O |
об’єкт; Температурний режим, необхідний для перевезення вантажу |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ReferencedDocument
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
typeCode |
O/M |
string |
Тип документа (довідник кодів документів) |
|
id |
O/M |
string |
Номер документа |
|
remarks |
O |
string |
UUID документа |
|
formattedIssueDateTime |
O |
об’єкт; Дата складання документа |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт SimpleIdentity
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M |
string |
ідентифікатор; приймає значення залежно від блоку, де використовується - точніше вказано в параметрі на рівень вище |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт TradeParty
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M/O |
об’єкт;
|
|
|
name |
M |
string |
Повна назва юридичної, або фізичної особи |
|
roleCode |
M |
string |
Роль учасника. Довідник ролей |
|
tradeContact |
O |
об’єкт; Контакти відповідального представника |
|
|
postalTradeAddress |
O/M |
об’єкт; Юридична адреса для юр. особи, або місце реєстрації для фіз. особи |
|
|
taxRegistration |
O |
об’єкт; Ідентифікаційний код відповідальної особи |
|
|
specifiedGovernmentRegistrations |
O/M |
об’єкт; Посвідчення Водія |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт InvoiceAmount
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
currencyId |
M |
string |
Тризначний код валюти (UAH) |
|
value |
M |
decimal |
Значення |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт LogisticsLocation
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M/- |
об’єкт; Код КАТОТТГ місце знаходження пункту навантаження/розвантаження/місця складання/складу
|
|
|
name |
O/M |
string |
Найменування місця складання / пункту навантаження / пункту розвантаження / складу
|
|
typeCode |
O/M/- |
string |
Тип операції: 10 - навантаження; 5 - розвантаження.
|
|
description |
O/M |
string |
Опис (адреса) місця складання / пункту навантаження / пункту розвантаження
|
|
physicalGeographicalCoordinate |
M/O/- |
об’єкт; Географічні координати
|
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт EcmrUnitValue
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
unitCode |
M |
string |
Код одиниці виміру (для tariffQuantity приймає значення «UAH») |
|
value |
M |
decimal |
Значення |
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт DateTime
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
dateTime |
datetime (2021-12-13T14:19:23+02:00) |
Дата і час складання документа |
Об’єкт DocumentCode
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
id |
M |
string |
код типу/підтипу документа |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт SpecifiedSupplyChainConsignment
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
|---|---|---|---|
|
grossWeightMeasure |
M |
Загальна вага перевезення (маса брутто) в кг |
|
|
associatedInvoiceAmount |
O |
Усього відпущено на загальну суму, грн |
|
|
consignmentItemQuantity |
M |
decimal |
Загальна кількість місць вантажу (контейнерів) |
|
consignor |
M |
Вантажовідправник |
|
|
consignee |
M |
Вантажоодержувач |
|
|
carrier |
M |
Перевізник |
|
|
notifiedTradeParties |
M/O |
List<TradeParty> |
масив об’єктів; інформація (ЄДРПОУ / РНОКПП) про учасників перевезення. Детальніше в специфікації відповідного документа. |
|
carrierAcceptanceLogisticsLocation |
M |
об’єкт; Пункт навантаження |
|
|
consigneeReceiptLogisticsLocation |
M |
об’єкт; Пункт розвантаження |
|
|
associatedReferencedDocuments |
O |
List<ReferencedDocument> |
масив об’єктів; Супровідні документи на вантаж |
|
deliveryTransportEvent |
O |
об’єкт; Розвантажувальні роботи |
|
|
pickUpTransportEvent |
O/M |
об’єкт; Навантажувальні роботи |
|
|
includedSupplyChainConsignmentItems |
M |
масив об’єктів; Відомості про вантаж |
|
|
utilizedLogisticsTransportEquipments |
O/M |
масив об’єктів; Запис про автомобіль в перевезенні. Обов’язково заповнюється для Автомобіля (для причепа/напівпричепа опційно) |
|
|
mainCarriageLogisticsTransportMovement |
O |
об’єкт; Маршрутизація (проміжні пункти перевантаження). Заповнюється Перевізником |
|
|
deliveryInstructions |
M/O |
об’єкт; Вид перевезень |
|
|
previousAdministrativeReferencedDocument |
-/M |
об’єкт; Попередня транзакція ECMR, на основі якої складено поточний документ. Блок не вказується, якщо документ створено з «нуля» |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт ExchangedDocument
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
M |
string |
порядковий номер (серія) документа |
|
issueDateTime |
M |
об’єкт; Дата і час складання документа |
|
|
remarks |
O |
string |
Ремарки |
|
includedNote |
M/O |
List<IncludedNote> |
Масив об’єктів; Додані записи. Поле обов’язкове для е-ТТН документа |
|
issueLogisticsLocation |
M |
об’єкт; Місце складання документа |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт DocumentContext
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
transactionID |
M |
string |
Номер версії документа (транзакції) в ланцюгу підписання документів |
|
documentCode |
M |
об’єкт; параметр контексту документа, визначений бізнес-процесом |
|
|
documentSubCode |
M |
об’єкт; параметр контексту визначеного документа |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт Index
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
operator |
enum (AND, OR) |
тип оператора;
|
|
type |
enum (MORE, EQUALS, LIKE) |
тип документа;
|
|
fieldName |
String |
назва параметра, за яким буде здійснюватись фільтрація
|
|
value |
String |
значення поля fieldName |
Об’єкт Field
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
operator |
enum (AND, OR) |
тип оператора;
|
|
type |
enum (MORE, EQUALS, LIKE) |
тип документа;
|
|
value |
String |
значення поля |
Об’єкт XSearchDocsQuery (Критерії пошуку/фільтрації «Товарних узгоджень» AGREEM)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
indexes |
List<Index> |
масив об’єктів; індекси |
|
direction |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
|
retailerId |
Long |
id мережі (ритейлера) |
|
retailers |
List<Long> |
масив; список мереж (ритейлерів) |
|
statuses |
List<Integer> |
масив; статус документа
|
|
types |
List<Integer> |
масив; тип документа
|
|
contractGlnIDs |
List<Integer> |
масив; id Gln-нів контрагентів |
|
contractNumber |
об’єкт; номер контракту/специфікації |
|
|
contractDescription |
об’єкт; опис контракту/специфікації |
|
|
dateCreated |
об’єкт; дата створення документа (в форматі UNIX-timestamp) з / по |
|
|
dateChanged |
об’єкт; дата зміни документа (в форматі UNIX-timestamp) з / по |
|
|
docDate |
об’єкт; дата документа (в форматі UNIX-timestamp) з / по |
|
|
limit |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
|
docNumber |
String |
номер документа |
|
archive |
Boolean |
відмітка про те, що документ оброблений (архівний) |
|
withChilds |
Boolean |
відмітка про наявність дочірніх документів |
JSON приклади:
Отримати 20 останніх неархівних (необроблених) «Товарних узгоджень» (AGREEM) для Відправника «13200665»
{
"indexes": [],
"types": [],
"statuses": [],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"archive": false,
"limit": {
"count": 20,
"offset": 0
}
}
Отримати 20 останніх важливих завершених «Товарних узгоджень» (AGREEM) типу «Промо ціна» для Відправника «13200665»
{
"indexes": [
{
"operator": "AND",
"type": "EQUALS",
"fieldName": "isFavorite",
"value": "true"
}
],
"types": [
2
],
"statuses": [
7
],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"limit": {
"count": 20,
"offset": 0
}
}
Отримати 20 останніх оброблених (архівних) «Товарних узгоджень» (AGREEM) типу «Регулярна ціна» для Відправника «13200665» з датою документа за період 2021-07-01-2021-07-27
{
"indexes": [],
"types": [
1
],
"statuses": [],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"archive": true,
"docDate": {
"startTimestamp": 1625086800,
"finishTimestamp": 1627419599
},
"limit": {
"count": 20,
"offset": 0
}
}
Отримати 40 останніх необроблених (неархівних) «Товарних узгоджень» (AGREEM) для Відправника «13200665» з номером контракту «666.333333»
{
"indexes": [],
"types": [],
"statuses": [],
"direction": {
"type": "EQ",
"sender": [
13200665
]
},
"archive": false,
"contractNumber": {
"operator": "AND",
"type": "EQUALS",
"value": "666.333333"
},
"limit": {
"count": 40,
"offset": 0
}
}
Об’єкт XNoveltyContacts
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
surname |
String |
Прізвище |
|
name |
String |
Ім’я |
|
middleName |
String |
По батькові |
|
|
String |
|
|
phone |
String |
Телефон |
|
uuid |
String |
Ідентифікатор контакту |
Об’єкт XNoveltyComment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
date |
long |
дата коментаря (зміни статусу КП) у форматі UNIX TimeStamp |
|
user |
String |
найменування користувача Мережі |
|
comment |
String |
коментар при обробці комерційної пропозиції |
Об’єкт XNoveltyTrade
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
national1 |
String |
Національна мережа №1 (грн) |
|
national2 |
String |
Національна мережа №2 (грн) |
|
regional1 |
String |
Регіональна мережа №1 (грн) |
|
regional2 |
String |
Регіональна мережа №2 (грн) |
Об’єкт XNoveltyMarketing
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
promotion |
String |
Просування (%) |
|
logistics |
String |
Логістика (%) |
|
damage |
String |
Псування продукту (%) |
|
TPR |
String |
ТPR бюджет (%) |
Об’єкт XNoveltyPrices
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
unit_price |
String |
Ціна за одиницю (грн) |
|
weight_price |
String |
Ціна за кг (грн) |
|
volume_price |
String |
Ціна за літр (грн) |
|
profitability |
String |
Націнка (%); може мати від’ємне значення |
Об’єкт Ecmr
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
documentContext |
M |
об’єкт; технічні дані |
|
|
exchangedDocument |
M |
об’єкт; реквізити е-ТТН |
|
|
specifiedSupplyChainConsignment |
M |
об’єкт; інформація про перевезення |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об'єкт Transport
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
long |
ідентифікатор транспортного засобу |
|
|
number |
M |
String |
номер транспортного засобу (у літеро сполученні допускається лише латинниця (case sensitive)) в форматі «AA0001AA» |
|
brand |
M |
String |
марка транспортного засобу («Hyundai») |
|
model |
M |
String |
модель транспортного засобу («HD 78») |
|
type |
M |
String |
тип транспортного засобу («рефрижератор») |
|
color |
O |
String |
колір транспортного засобу |
|
length |
O |
String |
довжина транспортного засобу (мм) |
|
width |
O |
String |
ширина транспортного засобу (мм) |
|
height |
O |
String |
висота транспортного засобу (мм) |
|
weight |
O |
String |
вага транспортного засобу без вантажу (кг) |
|
isTrailer |
O |
int |
відмітка про тип транспортного засобу:
|
-
[1] Під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Приклад запиту
[
{
"id": 93,
"number": "AA0000AA",
"brand": "Тестовий траспорт",
"model": "модель модель",
"type": "Тип",
"color": "брудний",
"isTrailer": 1
},
{
"id": 104,
"number": "AA0001AA",
"brand": "Trailer",
"model": "Модель",
"type": "Trailer",
"color": "lime",
"isTrailer": 2
},
{
"id": 130,
"number": "AA0020XH",
"brand": "1",
"model": "SCHMITZ",
"type": "рефрижератор",
"isTrailer": 0
},
{
"id": 150,
"number": "AA0000",
"brand": "vv",
"model": "78",
"type": "вантажний",
"isTrailer": 2
},
{
"id": 265,
"number": "AA0099BB",
"brand": "hyundai",
"type": "вантажний",
"isTrailer": 0
},
{
"id": 266,
"number": "AA0098AП",
"brand": "Renault",
"type": "грузовий",
"isTrailer": 0
},
{
"id": 267,
"number": "AA0002BA",
"brand": "Hyundai",
"type": "тестовий",
"isTrailer": 0
},
{
"id": 273,
"number": "AA0011AA",
"brand": "тест",
"model": "тест",
"type": "тягач",
"color": "Синій, Текст,ТекстекстТекстТекстТекст",
"isTrailer": 0
},
{
"id": 274,
"number": "AA0011BB",
"brand": "тест",
"model": "тест",
"type": "тягач",
"isTrailer": 0
},
{
"id": 431,
"number": "AA0003AA",
"brand": "Ferrari",
"model": "F40",
"type": "cabriolet",
"color": "yellow",
"isTrailer": 0
},
{
"id": 435,
"number": "AA0000BB",
"brand": "Марка",
"model": "Модель",
"type": "Тип",
"isTrailer": 0
},
{
"id": 457,
"number": "AA0000123AA",
"brand": "Mazda",
"model": "R8",
"type": "Fast",
"color": "Black",
"isTrailer": 0
},
{
"id": 495,
"number": "AA00000AA",
"brand": "Ferrari",
"model": "F40",
"type": "cabriolet",
"color": "yellow",
"isTrailer": 0
},
{
"id": 501,
"number": "AA001100AA",
"brand": "test1",
"model": "test2",
"type": "test3",
"isTrailer": 0
},
{
"id": 575,
"number": "AA000001AB",
"brand": "testMarka",
"model": "testModel",
"type": "testTypeCar",
"color": "testColorCar",
"isTrailer": 0
},
{
"id": 577,
"number": "AA000002BB",
"brand": "testMarka2",
"model": "testModel2",
"type": "testType2",
"isTrailer": 1
},
{
"id": 579,
"number": "AA000003BB",
"brand": "testMarka3",
"model": "testModel3",
"type": "testType3",
"isTrailer": 1
},
{
"id": 613,
"number": "AA00001AA",
"brand": "AUTO",
"model": "AUTO",
"type": "AUTO",
"color": "AUTO",
"isTrailer": 0
}
]
Об'єкт SignsPackageV2
Опис параметрів обʼєкта
|
Параметр |
Формат |
Код ролі |
Опис |
|---|---|---|---|
|
carrier |
List<ExEndUserSignInfo>
|
CA |
масив об’єктів; дані підписів Перевізника |
|
consignee |
CN |
масив об’єктів; дані підписів Вантажоодержувача |
|
|
consignor |
CZ |
масив об’єктів; дані підписів Вантажовідправника |
|
|
driver |
DR |
масив об’єктів; дані підписів Водія |
|
|
storage |
WD/WH |
масив об’єктів; дані підписів Проміжного складу |
|
|
customer |
OB |
масив об’єктів; дані підписів Замовника |
|
|
expeditor |
FW |
масив об’єктів; дані підписів Експедитора |
|
|
carrier_switch |
CH |
масив об’єктів; дані підписів Нового Перевізника |
|
|
security |
COP |
масив об’єктів; дані підписів Охорони |
Приклад запиту
{
"consignee": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1694158195
},
"certificateInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"driver": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1693231021
},
"certificateInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"carrier":
[
{
"isStamp": false,
"ownerInfo":
{
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "4691660700000000000000000000000000000001",
"subject": "O=ТОВ \"Тест\";CN=Тест Тест Тест;SN=Тест;GivenName=Тест Тест;Serial=1111111111D;C=UA;L=місто КИЇВ",
"subjCN": "Тест Тест Тест",
"subjOrg": "ТОВ \"Тест\"",
"subjLocality": "місто КИЇВ",
"subjFullName": "Тест Тест Тест",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1111111111"
},
"timeInfo":
{
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1677664504
},
"certificateInfo":
{
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "4691660700000000000000000000000000000001",
"subject": "O=ТОВ \"Тест\";CN=Тест Тест Тест;SN=Тест;GivenName=Тест Тест;Serial=1111111111D;C=UA;L=місто КИЇВ",
"subjCN": "Тест Тест Тест",
"subjOrg": "ТОВ \"Тест\"",
"subjLocality": "місто КИЇВ",
"subjFullName": "Тест Тест Тест",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1111111111",
"certBeginTime": "Jun 16, 2021, 10:30:43 AM",
"certEndTime": "Jun 15, 2023, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Jun 16, 2021, 10:30:43 AM",
"privKeyEndTime": "Jun 15, 2023, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "14 8C 49 63 CA 4C 0B 0F 80 C6 33 4A FE 2B 7B 34 C8 0C 37 D4 AF CE 42 D7 82 54 11 A0 78 DB 48 6E 00 ",
"publicKeyID": "DF 0E D5 34 E9 61 8C 46 3B 9F 1E C1 94 CE 09 AD 7F 6C B4 01 59 85 54 CE F2 CD 83 0A D0 53 65 B0 ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false
}
}
],
"consignor": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1693230800
},
"certificateInfo": {
"issuer": "O\u003dТОВ \"Центр сертифікації ключів \"Україна\";CN\u003dКНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial\u003dUA-36865753-2101;C\u003dUA;L\u003dКиїв;OI\u003dNTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O\u003dТОВ \"Вайтдок\";Title\u003d1;CN\u003dІванов Іван Іванович;SN\u003dІванов;GivenName\u003dІван Іванович;Serial\u003d1234567890D;C\u003dUA;L\u003dмісто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
]
}
Об’єкт XNovelty (Дані комерційної пропозиції)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
novelty_id |
long |
id комерційної пропозиції |
|
novelty_uuid |
UUID |
uuid комерційної пропозиції |
|
status |
int |
Статус комерційної пропозиції
|
|
date_created |
long |
Дата створення (UNIX TimeStamp) |
|
date_changed |
long |
Дата останніх змін (UNIX TimeStamp) |
|
supplier |
String |
GLN Постачальника |
|
retailer |
String |
GLN Мережі |
|
supplier_gln_id |
long |
GLN id Постачальника |
|
retailer_gln_id |
long |
GLN id Мережі |
|
retailer_id |
long |
id Мережі на платформі EDIN |
|
group_id |
int |
id групи товарів |
|
name |
String |
Найменування |
|
barcode |
String |
Штрихкод |
|
brand |
String |
Торгова марка |
|
producer_name |
String |
Виробник |
|
postponement |
int |
Відстрочка платежу (днів) |
|
unit_id |
int |
Код одиниці виміру
|
|
unit_weight |
String |
Вага одиниці виміру (кг) |
|
unit_volume |
String |
Обсяг/об’єм одиниці виміру (літр) |
|
tax_id |
int |
Код ставки ПДВ
|
|
prices |
об’єкт; ціни |
|
|
marketing |
об’єкт; маркетинг |
|
|
trade |
об’єкт; торгівля |
|
|
listex_link |
String |
Посилання на Listex |
|
icon_link |
String |
Посилання на фото товару |
|
comments |
об’єкт; коментарі |
|
|
supplierContacts |
об’єкт; контакти Постачальника |
JSON приклад запиту
{
"novelty_id": 1164,
"novelty_uuid": "9b1b51c6-c0d3-4899-8f73-0d04ee443f66",
"status": 0,
"date_created": 1622625545,
"date_changed": 1622625545,
"supplier": "9864232399285",
"retailer": "9864232377986",
"supplier_gln_id": 179438,
"retailer_gln_id": 174988,
"retailer_id": 17548,
"group_id": 51,
"name": "Багет колоСок",
"barcode": "020202020",
"brand": "Мучне",
"producer_name": "Піч",
"postponement": 1,
"unit_id": 8,
"unit_weight": "250",
"unit_volume": "2",
"tax_id": 5,
"prices": {
"unit_price": "25",
"weight_price": "0.1",
"volume_price": "12.5",
"profitability": "12"
},
"marketing": {
"promotion": "12",
"logistics": "23",
"damage": "34",
"TPR": "34"
},
"trade": {
"national1": "23",
"national2": "12",
"regional1": "32",
"regional2": "45"
},
"icon_link": "https://static.edi-n.com/agreement/novelties/icon/1164.jpg",
"comments": [],
"supplierContacts": {
"surname": "Криптонець",
"name": "Зоряний",
"middleName": "Косоокий",
"email": "jedolab332@edmondpt.com",
"phone": "380000000000",
"uuid": "fa9de12d-a3c1-49d8-8f28-3fb1994eebaa"
}
}
Об’єкт RetailerEsSettings
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
changePriceTerm |
int |
термін подачі на розгляд регулярних цін |
|
isPriceWithDiscount |
boolean |
робота з ціною зі знижкою |
|
isPriceWithVat |
boolean |
узгодження за ціною з ПДВ |
|
maxNumbersOfAgreements |
int |
максимальна кількість узгоджень |
|
isChangePricePeriod |
boolean |
доступ до зміни термінів дії |
|
changePromoPriceTerm |
int |
термін подачі на розгляд промо цін |
|
changeLastingTerm |
int |
період дії регулярних цін (за замовчуванням) |
|
changePromoLastingTerm |
int |
період дії промо цін (за замовчуванням) |
|
changeOutputGoodsTerm |
int |
термін подачі на розгляд призупинки/виводу товарів |
|
isNewPositions |
boolean |
відображення списка мереж на стороні Постачальника у вкладці Новинки |
|
isExtendedSpec |
boolean |
тільки розширені характеристики |
|
isOutputGoods |
boolean |
призупинка/вивід товарів з асортимента |
|
isTypePromo |
boolean |
узгодження промо ціни |
|
isPromoQuantity |
boolean |
відображення колонки Кількість товарів промо |
|
isExtendedSpecUcat |
boolean |
тільки розширені характеристики Ucat |
|
isSignUnBlock |
boolean |
можливо підписувати «Товарну специфікацію» (COMDOC_008) за день до початку дії ціни |
|
isProlongationContract |
boolean |
автоматична пролонгація контракту |
|
isNewSupplier |
boolean |
нові постачальники |
|
isReplaceProductlistData |
boolean |
попередня очистка «Електронної специфікації» (PRODUCTLIST) |
|
isActionControl |
boolean |
керування акціями |
|
isWorkWithUKTVED |
boolean |
робота з кодом УКТЗЕД |
JSON:
{
"changePriceTerm": 1,
"isPriceWithDiscount": false,
"isPriceWithVat": false,
"maxNumbersOfAgreements": 0,
"isChangePricePeriod": true,
"changePromoPriceTerm": 2,
"changeLastingTerm": 0,
"changePromoLastingTerm": 0,
"changeOutputGoodsTerm": 2,
"isNewPositions": true,
"isExtendedSpec": false,
"isOutputGoods": true,
"isTypePromo": false,
"isPromoQuantity": false,
"isExtendedSpecUcat": false,
"isSignUnBlock": false,
"isProlongationContract": false,
"isNewSupplier": true,
"isReplaceProductlistData": true,
"isActionControl": true,
"isWorkWithUKTVED": false
}
Об’єкт XAgreemDocStatus
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
int |
id статусу
|
|
name |
String |
назва статусу |
|
description |
String |
опис статусу |
Об’єкт XAgreemDoc
Об'єкт використовується для отримання даних по перегляду пропозицій, а також для отримання даних комерційної пропозиції / товарного узгодження
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
body |
Map<Integer, byte[]> |
тіло документа |
|
indexes |
Map<String, String> |
набір параметрів для фільтрації
|
|
childs |
List<XAgreemDoc> |
дочірні документи |
|
id |
long |
id документу |
|
uuid |
UUID |
GUID документу |
|
parentDocId |
transient long |
id батьківського документу; число |
|
parentDocUUID |
UUID |
GUID батьківського документу |
|
sender |
long |
GLN відправника; число |
|
recipient |
long |
GLN одержувача; число |
|
retailerId |
long |
id мережі (ритейлера); число |
|
contractUUID |
UUID |
GUID контракту / договору |
|
status |
статус узгодження; число |
|
|
type |
int |
тип документа; число
|
|
dateCreated |
long |
дата створення документа; число |
|
dateChanged |
long |
дата зміни документа; число |
|
docDate |
long |
дата з документу; число |
|
docNumber |
String |
номер документу |
|
isArchive |
Boolean |
відмітка про те, що документ оброблений (архівний) |
JSON приклади відповіді:
Отримання списку документів в журналі
[
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "2",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isFavorite": "false"
},
"childs": [],
"id": 369,
"uuid": "1168fc16-6473-4c82-9fbe-4d2ba210fafa",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cd0d1033-a442-4971-8f94-abab35e36414",
"status": {
"id": 12,
"name": "sub_onagreement"
},
"type": 2,
"dateCreated": 1588861558,
"dateChanged": 1588861558,
"docDate": 1588859657,
"docNumber": "JJJ"
},
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "2",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isFavorite": "false"
},
"childs": [],
"id": 368,
"uuid": "1cac7b65-46a0-4924-9611-29967aca3ec5",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cd0d1033-a442-4971-8f94-abab35e36414",
"status": {
"id": 12,
"name": "sub_onagreement"
},
"type": 1,
"dateCreated": 1588856745,
"dateChanged": 1588856745,
"docDate": 1588857,
"docNumber": "Time-03"
},
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "1",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "1",
"decrease": "0",
"isFavorite": "false"
},
"childs": [
{
"body": {},
"indexes": {},
"childs": [],
"id": 367,
"uuid": "78d27dce-0576-450f-83bb-14b8467d94cf",
"parentDocUUID": "5b19556e-65ab-40e9-b397-64f6183e35b3",
"sender": 41249,
"recipient": 13200665,
"retailerId": 7,
"contractUUID": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"status": {
"id": 3,
"name": "onagreement"
},
"type": 2,
"dateCreated": 1588853003,
"dateChanged": 1588853003,
"docDate": 1588853003,
"docNumber": "Time-02"
}
],
"id": 366,
"uuid": "5b19556e-65ab-40e9-b397-64f6183e35b3",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"status": {
"id": 6,
"name": "onsigning2"
},
"type": 1,
"dateCreated": 1588850830,
"dateChanged": 1588852976,
"docDate": 0,
"docNumber": "Time-02"
}
]
Отримання даних комерційної пропозиції / товарного узгодження
{
"body": {},
"indexes": {
"isComments": "false",
"isSigns": "false",
"rejected": "0",
"count": "2",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isFavorite": "false"
},
"childs": [],
"id": 369,
"uuid": "1168fc16-6473-4c82-9fbe-4d2ba210fafa",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cd0d1033-a442-4971-8f94-abab35e36414",
"status": {
"id": 12,
"name": "sub_onagreement"
},
"type": 2,
"dateCreated": 1588861558,
"dateChanged": 1588861558,
"docDate": 1588859657,
"docNumber": "JJJ"
}
Перегляд даних документів-узгоджень
[
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"rejection_reason": "проверка раз раз как-то так раз два три, ну всем понятно, Отклоняю док как тока могу по полной",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1930,
"uuid": "49b8640a-8393-4235-a506-696eecc14c3c",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 4,
"name": "rejected",
"description": "Відхилено"
},
"type": 1,
"dateCreated": 1631101503,
"dateChanged": 1631101958,
"docDate": 1631101502,
"docNumber": "2000001011",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1912,
"uuid": "8f9efb2e-022b-450a-92d4-6f2b32bf5f99",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630922241,
"dateChanged": 1630922251,
"docDate": 1630922240,
"docNumber": "2000001004",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1910,
"uuid": "e74c280a-8db6-4079-b6e7-0375014f7c7f",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630922196,
"dateChanged": 1630922207,
"docDate": 1630922195,
"docNumber": "2000001003",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "2",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"rejection_reason": "Отклонение",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1900,
"uuid": "e44d62d5-9ffd-4e5b-b704-9cd47c2ff141",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 4,
"name": "rejected",
"description": "Відхилено"
},
"type": 1,
"dateCreated": 1630917718,
"dateChanged": 1630920092,
"docDate": 1630917718,
"docNumber": "2000000998",
"isArchive": false
},
{
"body": {},
"indexes": {
"lastSignDate": "undefined"
},
"childs": [],
"id": 1894,
"uuid": "bb1e3f94-320a-4f36-b45c-6245b15a7616",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 1,
"name": "draft",
"description": "Чернетка"
},
"type": 1,
"dateCreated": 1630851806,
"dateChanged": 1630851806,
"docDate": 1630851807,
"docNumber": "2000000995",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1892,
"uuid": "049cdec2-10ab-4233-a5a2-e497ae199d33",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630851450,
"dateChanged": 1630851507,
"docDate": 1630851451,
"docNumber": "2000000994",
"isArchive": false
},
{
"body": {},
"indexes": {
"lastSignDate": "undefined"
},
"childs": [],
"id": 1890,
"uuid": "698a7a22-f983-4b0e-8f59-62d9204ea681",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 1,
"name": "draft",
"description": "Чернетка"
},
"type": 1,
"dateCreated": 1630851109,
"dateChanged": 1630851109,
"docDate": 1630851109,
"docNumber": "2000000993",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "1",
"isRead": "false",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1888,
"uuid": "a92a664c-3977-4858-8737-e2a634e2b3c5",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 3,
"name": "onagreement",
"description": "На узгодженні"
},
"type": 1,
"dateCreated": 1630686290,
"dateChanged": 1630686340,
"docDate": 1630686291,
"docNumber": "2000000992",
"isArchive": false
},
{
"body": {},
"indexes": {
"isSigns": "false",
"flag": "0",
"discount_increase": "0",
"rejected": "0",
"count": "2",
"isRead": "true",
"isAttaches": "false",
"isTags": "false",
"increase": "0",
"confirmed": "0",
"decrease": "0",
"isComments": "false",
"afterDeadline": "false",
"rejection_reason": "Отклонение",
"discount_decrease": "0",
"lastSignDate": "undefined",
"isFavorite": "false"
},
"childs": [],
"id": 1886,
"uuid": "bcf032f9-3411-4d9f-b6c8-4ac7f34d728f",
"sender": 13200665,
"recipient": 41249,
"retailerId": 7,
"contractUUID": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"status": {
"id": 4,
"name": "rejected",
"description": "Відхилено"
},
"type": 1,
"dateCreated": 1630674569,
"dateChanged": 1630678024,
"docDate": 1630674568,
"docNumber": "2000000991",
"isArchive": false
}
]
Об’єкт XSearchContractsQuery (Критерії пошуку/фільтрації довідника специфікацій/контрактів)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
direction |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
|
contractGlnId |
List<Long> |
масив; id Gln-у контракту/специфікації |
|
contractGln |
List<String> |
масив; Gln-у контракту/специфікації |
|
productBarcode |
List<String> |
масив; список товарних штрихкодів |
|
buyerArticle |
List<String> |
масив; артикул продавця |
|
retailerId |
Long |
id мережі (ритейлера) |
|
retailers |
List<Long> |
масив; список мереж (ритейлерів) |
|
contractStatus |
List<Integer> |
масив; список статусів контрактів: 1 - активний, 2 - неактивний / видалений |
|
productStatus |
List<Integer> |
масив; список статусів товарів: 1 - активний, 2 - неактивний / видалений |
|
number |
String |
номер специфікації |
|
subContractNumber |
String |
номер договору |
|
expireDate |
об’єкт; дата закінчення специфікації (в форматі UNIX-timestamp) з / по |
|
|
subContractExpireDate |
об’єкт; дата договору (в форматі UNIX-timestamp) з / по |
|
|
changeDate |
об’єкт; дата зміни специфікації (в форматі UNIX-timestamp) з / по |
|
|
limit |
об’єкт; фільтр відбору (налаштування виводу даних) |
JSON приклад запиту для отримання всіх завершених контрактів / специфікацій для Отримувача «13200665»:
{
"contractGlnId": [],
"productBarcode": [],
"buyerArticle": [],
"contractStatus": [],
"productStatus": [],
"direction": {
"type": "EQ",
"recipient": [
13200665
]
},
"expireDate": {
"startTimestamp": 1631353973
}
}
Об’єкт RemoveProductDetail
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
productID |
long |
id товарної позиції, що була в запиті на видалення |
|
removed |
boolean |
чи видалено товарну позицію з контракту |
|
cause |
String |
якщо [removed == false] - указана причина неможливості видалити товарну позицію (наприклад, відсутність позиції в контракті) |
Об’єкт RemoveProductResponse (Деталі результату операції видалення)
Опис параметрів обєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
contractUUID |
UUID |
uuid контракту |
|
removedContract |
boolean |
чи видалено весь контракт |
|
contractProducts |
int |
кількість позицій в контракті |
|
requestProducts |
int |
кількість позицій в запиті на видалення |
|
removedProducts |
int |
кількість видалених позицій |
|
details |
List<RemoveProductDetail> |
масив об’єктів; деталі виконання операції видалення для кожної позиції |
JSON приклад відповіді при видаленні товарних позицій
{
"contractProducts": 2,
"contractUUID": "43cea8c2-320a-439b-a596-d39c0ad0f0f8",
"details": [
{
"cause": "XContract 43cea8c2-320a-439b-a596-d39c0ad0f0f8 does not have product ID 0",
"productID": 0,
"removed": false
},
{
"cause": "XContract 43cea8c2-320a-439b-a596-d39c0ad0f0f8 does not have product ID 21212121",
"productID": 21212121,
"removed": false
},
{
"productID": 113,
"removed": true
}
],
"removedContract": false,
"removedProducts": 1,
"requestProducts": 3
}
JSON приклад відповіді при видаленні всього контракту
{
"contractUUID": "41bee947-abfc-471a-86e6-4c85f813ad9f",
"removedContract": true,
"contractProducts": 51,
"requestProducts": 0,
"removedProducts": 51,
"details": [
{
"productID": 2,
"removed": true
},
{
"productID": 3,
"removed": true
},
...
{
"productID": 50,
"removed": true
},
{
"productID": 51,
"removed": true
},
{
"productID": 52,
"removed": true
}
]
}
Об’єкт XContractProduct
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id документа |
|
contractId |
long |
id контракту / договору; |
|
barcode |
String |
штрих-код продукту |
|
product |
XProduct |
список товарних позицій |
|
buyerArticle |
String |
артикул покупця |
|
status |
int |
статус узгодження; число |
|
dateFrom |
int |
дата початку дії асортименту |
|
dateTo |
int |
дата закінчення дії асортименту |
|
content |
byte[] |
набір байт; закодоване в utf8 JSON-тіло позиції (сервіс онлайн дешифрування) |
Об’єкт XContract (Контракти)
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
products |
List<XContractProduct> |
список товарних позицій |
|
id |
long |
id контракту / договору; |
|
uuid |
UUID |
GUID контракту / договору; число |
|
retailerId |
long |
id мережі (ритейлера); |
|
sender |
long |
ID GLN відправника; число |
|
senderGln |
String(13) |
GLN одержувача |
|
recipient |
long |
ID GLN одержувача; число |
|
recipientGln |
String(13) |
GLN одержувача |
|
number |
String |
номер контракту / договору; число |
|
expireDate |
long |
дата закінчення дії договору |
|
description |
String |
опис / коментарі |
|
subContractNumber |
String |
номер дочірнього договору |
|
subContractExpireDate |
long |
дата закінчення дії дочірнього договору |
|
contractGlnId |
long |
ID GLN-ну контракту/специфікації |
|
contractGln |
String(13) |
GLN контракту/специфікації |
|
reviewDeadLine |
int |
кількість днів на розгляд |
|
agrementsNumber |
int |
допустима кількість погоджень |
|
discountWorkStatus |
int |
робота з ціною зі знижкою: 0-ні, 1-так |
|
changeDate |
long |
дата зміни документу |
|
prolongationContract |
int |
автоматична пролонгація контракту; 0-ні, 1-так |
|
region |
String |
код регіону; число |
|
content |
byte[] |
набір байт; закодоване в utf8 JSON-тіло документа PRODUCTLIST (сервіс онлайн дешифрування) |
JSON приклади відповіді:
[
{
"products": [],
"id": 8,
"uuid": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "1200.996633",
"expireDate": 1590872400,
"description": "Карантин",
"subContractNumber": "1200",
"subContractExpireDate": 1595797200,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 3,
"changeDate": 1588673640,
"prolongationContract": 0
},
{
"products": [],
"id": 7,
"uuid": "eac52f9f-1487-43e4-8eeb-88c61136dd84",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "1200.66333",
"expireDate": 1585602000,
"description": "Отходы",
"subContractNumber": "1200",
"subContractExpireDate": 1595797200,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 0,
"changeDate": 1583324665,
"prolongationContract": 0
},
{
"products": [],
"id": 6,
"uuid": "2ca3ce28-0b13-4163-b7c4-e5c178114ab2",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "98765.12345",
"expireDate": 1609365600,
"description": "Пятница - хороший день",
"subContractNumber": "98765",
"subContractExpireDate": 1574719200,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 0,
"changeDate": 1582301296,
"prolongationContract": 0
}
]
[
{
"products": [],
"id": 922,
"uuid": "cb35cd0c-1b3d-45d8-b96f-b49b34c9153f",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "666.333333",
"expireDate": 1640901600,
"status": {
"code": 1,
"description": "Активный"
},
"description": "МясоНеСодержащие",
"subContractNumber": "666",
"subContractExpireDate": 1630443600,
"contractGlnId": 41249,
"reviewDeadLine": 24,
"agrementsNumber": 5,
"discountWorkStatus": 3,
"changeDate": 1630503488,
"prolongationContract": 0
},
{
"products": [],
"id": 12,
"uuid": "ebe77c79-85fc-4c58-a07b-833caac25d65",
"retailerId": 7,
"sender": 41249,
"recipient": 13200665,
"number": "1200.996633",
"expireDate": 1672437600,
"status": {
"code": 1,
"description": "Активный"
},
"description": "Карантин",
"subContractNumber": "1200",
"subContractExpireDate": 1609365600,
"contractGlnId": 41249,
"reviewDeadLine": 0,
"agrementsNumber": 5,
"discountWorkStatus": 3,
"changeDate": 1609365600,
"prolongationContract": 0
},
{
"products": [],
"id": 4,
"uuid": "e940fe80-1b9d-4240-aa71-52a7eafc2afe",
"retailerId": 16244,
"sender": 54968,
"recipient": 13200665,
"number": "1000.50001",
"expireDate": 1652907600,
"status": {
"code": 1,
"description": "Активный"
},
"description": "Носочки, резиночки",
"subContractNumber": "1000",
"subContractExpireDate": 1529701200,
"contractGlnId": 54968,
"reviewDeadLine": 0,
"agrementsNumber": 0,
"discountWorkStatus": 0,
"changeDate": 1569844604,
"prolongationContract": 0
}
]
Об’єкт XAgreemDocAttachment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
attachment_id |
long |
ідентифікатор вкладення |
|
comment_id |
long |
ідентифікатор коментаря |
|
file_name |
String |
назва файлу |
|
file_type |
String |
тип файлу згідно MIME типізації |
|
content |
byte[] |
тіло вкладення |
JSON приклад відповіді (Інформація про вкладення до пропозиції товарного переузгодження чи конкретного коментаря документа)
[
{
"attachment_id": 610,
"comment_id": 0,
"file_name": "1625493467304.png",
"file_type": "image/png"
},
{
"attachment_id": 612,
"comment_id": 0,
"file_name": "1624010092199.png",
"file_type": "image/png"
},
{
"attachment_id": 614,
"comment_id": 0,
"file_name": "323232323.png",
"file_type": "image/png"
}
]
Об’єкт XAgreemDocComment
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id коментаря |
|
docId |
long |
id документа (пропозиції) |
|
date |
long |
дата коментаря |
|
user |
String |
id користувача |
|
comment |
String |
текст коментаря |
|
attachments |
List<XAgreemDocAttachment> |
масив об’єктів; дані файла-вкладення |
JSON приклад відповіді при створенні коментаря
{
"id": 436,
"docId": 1664,
"date": 1625662188,
"user": "uatestuserfx01",
"comment": "text comment",
"attachments": [
{
"attachment_id": 646,
"comment_id": 436,
"file_name": "Модель Кеневин (Cynefin framework).pdf",
"file_type": "application/pdf"
},
{
"attachment_id": 648,
"comment_id": 436,
"file_name": "1625493467304.png",
"file_type": "image/png"
},
{
"attachment_id": 650,
"comment_id": 436,
"file_name": "323232323.png",
"file_type": "image/png"
}
]
}
JSON приклад відповіді при отриманні списку коментарів
[
{
"docId": 378,
"date": 1589454390,
"user": "uatestuserfx01",
"comment": "qwertyui"
},
{
"docId": 378,
"date": 1589454390,
"user": "uatestuserfx01",
"comment": "helloworld"
}
]
Об’єкт SpecStatus
Об'єкт SpecStatus використовується для
- налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM.
-
вказання нових дій узгодження в розрізі кожного підтипу документа AGREEM
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
userId |
long |
ID користувача |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація (0-ні; 1-так) |
|
isContractDivide |
boolean |
підв’язаний контракт (за GLN роздрібної мережі) |
|
isViewStatusDivide |
boolean |
відображати документи |
|
writeStatuses |
Map<String, Integer> |
підтип документа:
|
|
workStatuses |
Map<String, Integer> |
підтип документа:
|
Доступні значення статусів для вказання нових дій узгодження:
-
12 - На узгодженні (на стороні мережі)
-
13 - Підготовлено (на стороні мережі)
-
14 - Готовий до підписання (на стороні мережі)
-
15 - Погоджено (на стороні мережі)
-
17 - Перевірено (на стороні мережі)
-
18 - Підтверджено (на стороні мережі)
-
19 - Підписання постачальником (на стороні мережі)
-
20 - Підписання мережею (на стороні мережі)
JSON приклад налаштування дій узгодження для вказаного користувача в розрізі кожного підтипу документа AGREEM:
{
"userId": 13191,
"isSpecification": 1,
"isContractDivide": true,
"isViewStatusDivide": true,
"writeStatuses": {
"offer": 26,
"promo_combo": 14,
"regular": 14
},
"workStatuses": {
"offer": 4,
"promo_combo": 12,
"regular": 12
}
}
JSON приклад вказання нових дій узгодження в розрізі кожного підтипу документа AGREEM:
{
"writeStatuses": {
"offer": 26,
"promo": 14,
"promo_compensation": 12,
"promo_combo": 12,
"regular": 14
},
"workStatuses": {
"offer": 21,
"promo": 12,
"promo_compensation": 12,
"promo_combo": 12,
"regular": 12
}
}
Об'єкт DistribexOrderParams
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|
senderName |
String |
імʼя відправника |
| senderLastName | String | прізвище відправника |
| senderPhone | String | телефон відправника |
Приклад
[
{
"senderName": "Микола",
"senderLastName": "Стрига",
"senderPhone": "380967929292"
}
]
Об’єкт XChainStatus
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
Об’єкт XChainStatus |
||
|
state |
int |
id статусу |
|
title |
String |
статус |
Опис ChainStatus параметрів
|
id статусу |
статус |
|---|---|
|
0 |
ALL - будь-який статус |
|
1 |
OPEN - чернетка (відправник) |
|
2 |
SENT - відправлений (відправник) |
|
3 |
DELIVERED - доставлений (відправник) |
|
4 |
INBOX - вхідний (одержувач) |
|
5 |
READ - прочитаний (одержувач) |
|
6 |
ERROR - помилка |
|
7 |
DELETED - видалений |
Об’єкт XChain
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ID ланцюжка |
|
uuid |
UUID |
UUID ланцюжка документів |
|
packageID |
long |
ID пакета |
|
type |
об’єкт; тип документа |
|
|
docsCount |
int |
кількість документів в ланцюжку |
|
lastInDocID |
long |
id останнього вхідного документа в ланцюжку |
|
lastOutDocID |
long |
id останнього вихідного документа в ланцюжку |
|
partnerId |
long |
id роздрібної мережі |
|
important |
boolean |
відмітка важливий документ |
|
status |
об’єкт; статус пари документів у відправника і одержувача |
|
|
visualStatus |
int |
номер іконки |
|
archive |
boolean |
відмітка; Архівний документ чи ні |
|
childs |
List<XDoc> |
масив об’єктів; дані документів/квитанцій |
|
chainsInPackage |
List<XChain> |
масив об’єктів; дані пов’язаних ланцюжків |
|
hash |
String |
хеш-значення, отримане в результаті обробки |
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"
}
Об’єкт RecurrenceRule
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
frequency |
M |
enum |
об’єкт; частота, допустимі значення:
|
|
interval |
M |
int |
інтервал |
|
count |
O |
int |
кількість повторів події (значення розраховується: кількість з дати старту графіка) |
|
dateUntil |
O |
long |
дата до якої діють повтори - НЕ ЗАВЖДИ дата закінчення графіку (Unix timestamp) |
|
byDay |
-/M |
List<Integer> |
Масив; список номерів днів тижня за якими можливо відправляти замовлення. Параметр обов’язковий для frequency=WEEKLY (тобто потрібно обрати, як мінімум 1 день тижня) |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт Schedule
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
-/M |
long |
ідентифікатор графіка замовлень; параметр обов’язковий при оновленні графіка |
|
producerId |
long |
ідентифікатор Продавця (Виробника) |
|
|
name |
M |
String |
назва графіка замовлень |
|
dateCreated |
long |
дата створення (Unix timestamp) |
|
|
dateChanged |
long |
дата останньої зміни (Unix timestamp) |
|
|
dateStart |
M |
long |
дата початку графіка замовлень (Unix timestamp) |
|
dateEnd |
long |
дата останньої події (Unix timestamp); примітка:
|
|
|
timeFrom |
M |
String |
час З якого можливо відправляти замовлення (ГГ:ХХ:СС) |
|
timeTo |
M |
String |
час ДО якого можливо відправляти замовлення (ГГ:ХХ:СС) |
|
timeRemind |
O |
String |
час нагадування (о котрій годині нагадати) - працює лише тоді коли Продавець (Виробник) передав значення |
|
block |
O |
boolean |
блокуємо (true) / не блокуємо (false) замовлення, які не задовольняють налаштуванням графіка; за замовчуванням false |
|
type |
O |
int |
тип графіка замовлень:
Якщо не передається, то встановлюється автоматично за значенням distributors параметра |
|
recurrenceRule |
O |
об’єкт; правила повторів (передається, якщо Продавець (Виробник) налаштував повтори) |
|
|
distributors |
O/M |
List<Long> |
масив; список GLN-ів Покупців (Дистрибʼюторів), обов’язковий при type=1 |
|
dateClosest |
long |
дата найближчої можливості відправлення замовлень на сьогодні - це поле динамічне (кожен день може змінюватись); якщо у продавця немає графіка або графік є, але він вже закінчився - даного параметра у відповіді не буде |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Приклад запиту
{
"name": "Test5",
"dateStart": 1761516000,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 1,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 50,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"distributors":
[
13200791,
13202863
]
}
Приклад відповіді
[
{
"id": 9,
"producerId": 13200757,
"name": "Test3",
"dateCreated": 1700659795,
"dateChanged": 1700659795,
"dateStart": 1701381600,
"dateEnd": 1702159200,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 2,
"recurrenceRule":
{
"frequency": "DAILY",
"interval": 1,
"count": 10,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 0
},
{
"id": 1,
"producerId": 13200757,
"name": "Test2",
"dateCreated": 1700656825,
"dateChanged": 1700658476,
"dateStart": 1704060000,
"dateEnd": 0,
"timeFrom": "09:00:00",
"timeTo": "21:00:00",
"block": false,
"type": 2,
"recurrenceRule":
{
"frequency": "WEEKLY",
"interval": 1,
"count": 0,
"dateUntil": 0,
"byDay":
[
1,
2,
4,
6
]
},
"dateClosest": 0
}
]
Об’єкт XDistribexAccessGroup
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
producerId |
long |
ідентифікатор Продавця (Виробника) |
|
name |
String |
назва групи |
|
groupId |
long |
ідентифікатор групи |
Приклад запиту
{
"name": "ШахИМат",
"producerId": 13200791,
"groupId": 28
}
Об’єкт XProductGroup
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
groupd_id |
long |
ідентифікатор
|
|
parent_group_id |
long |
ідентифікатор приналежності до вищого рівня в структурі:
|
|
name |
String |
назва:
|
|
children |
List<groupd_id> |
масив;
|
Приклад запиту
[
{
"groupd_id": 135,
"parent_group_id": 115,
"name": "Листовой ж/б"
},
...
{
"groupd_id": 156,
"parent_group_id": 155,
"name": "Кастрюлі"
},
{
"groupd_id": 155,
"parent_group_id": 0,
"name": "Кухня"
}
]
Об’єкт XDistribexProduct
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор запису |
|
date_changed |
long |
дата внесених змін в дані товару |
|
producer_id |
long |
ідентифікатор Продавця (Виробника) |
|
product_id |
long |
ідентифікатор товару |
|
unit_id |
long |
ідентифікатор одиниці виміру; допустимі значення:
|
|
price_without_vat |
Double |
ціна одиниці без ПДВ, грн |
|
vat |
int |
ставка ПДВ, % |
|
price_with_vat |
Double |
ціна одиниці з ПДВ, грн |
|
price_discont |
Double |
ціна одиниці зі знижкою без ПДВ, грн |
|
price_with_vat_discont |
Double |
ціна одиниці зі знижкою з ПДВ, грн |
|
date_from |
long |
період дії з |
|
date_to |
long |
період дії по |
|
stock_balance |
Double |
залишок |
|
comment |
String |
коментарі |
|
quota |
Double |
квота на замовлення |
|
multiplicity |
double |
кратність кількості в замовленні. Значення кратно якому має бути заповнена кількість замовленої позиції |
|
is_promo |
boolean |
відмітка «Акція!» |
|
is_new |
boolean |
відмітка «Новинка!» |
|
is_public |
boolean |
відмітка «Публічна позиція!» |
|
is_surcharge |
boolean |
відмітка «Надбавка!» |
|
is_bestseller |
boolean |
відмітка «Хіт продажу!» |
|
add_characteristics |
String |
характеристики |
Об’єкт Document
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
fileName |
M |
String |
назва файлу разом з розширенням |
|
type |
M |
String |
|
|
uuid |
O |
String |
унікальний ідентифікатор документа |
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об’єкт DocumentRequest (Дані пов’язаних документів)
Опис параметрів об’єкта DocumentRequest
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
documents |
M |
List<Document> |
масив об’єктів; дані документів |
JSON приклад:
{
"documents":
[
{
"fileName": "comdoc_32_from_atb.p7s",
"type": "comdoc"
},
{
"fileName": "comdoc_33_from_atb.p7s",
"type": "comdoc"
}
]
}
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об'єкт Signs (дані для здійснення операції підписання)
Опис json-параметрів
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
signs |
M |
ArrayList<Signs> |
Масив об’єктів; підписи |
|
signInfo |
M |
Об’єкт; інформація про підписи |
Опис параметрів об’єкта Signs
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
sign |
string |
підписані дані |
|
|
type |
number |
кількість sign в об’єкті Signs (число N ) |
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
}
]
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт SignInfo (інформація про підпис)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
doc_id |
number |
id конкретного документа |
|
|
date |
any |
дата підписання |
|
|
count |
number |
кількість підписів |
|
|
hash |
string |
хеш контента підпису |
|
|
certData |
{…} |
об’єкт; {} - умовний елемент масиву з інформацією про підписи, котрі містять дані (поля) з сертификату : ownerName, EDRPOUCode, subjTitle, subjOrg, signDate, isTimeStamp, serial |
JSON приклад
{
"doc_id": 0,
"date": 0,
"count": 1,
"certData": [
{
"ownerName": "Сидоренко Василь Леонідович (Тест)",
"EDRPOUCode": "34554362",
"subjTitle": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Сидоренко Василь Леонідович (Тест)",
"signDate": "10.03.2020 16:07 ",
"isTimeStamp": true,
"serial": "58E2D9E7F900307B00000000F6AA2500E59F7B00"
}
],
"hash": "EF3DE5D9CFA92CC4BB5CE71F20C42F6B"
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ExEndUserTimeInfo
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
isTimeAvail |
boolean |
присутність часу підписання |
|
isTimeStamp |
boolean |
присутність мітки часу |
|
dateTime |
long |
мітка часу підписання (Unix timestamp) |
Об’єкт 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 |
код ДРФО власника сертифікату |
Об’єкт ExEndUserSignInfo (дані підписантів документа)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
isStamp |
boolean |
true - печатка; false - підпис |
|
ownerInfo |
об’єкт; дані власника сертифікату |
|
|
timeInfo |
об’єкт; дата підписання сертифікату |
|
|
certificateInfo |
EndUserCertificateInfo |
об’єкт; дані про сертифікат |
JSON приклад масиву об'єктів з даними підписантів
[
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-43177711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E777----------AA2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=2467778;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101777014"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1583849275
},
"certificateInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-4317777711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E7F900307-------2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=24677798;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101077714",
"certBeginTime": "Nov 21, 2019 12:00:00 AM",
"certEndTime": "Nov 21, 2021 12:00:00 AM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Nov 21, 2019 12:00:00 AM",
"privKeyEndTime": "Nov 21, 2021 12:00:00 AM",
"publicKeyBits": 264,
"publicKey": "6896AF6336BE76B0F9-----------FF69E18E4C74AE2E512A1500",
"publicKeyID": "88 B9 20 A1 91 B2 40 2E 86 F5 ---- 73 5B 0D 97 34 B7 26 6B 80 F1 56 ",
"ecdhPublicKeyAvail": false,
"ecdhPublicKeyBits": 0,
"issuerPublicKeyID": "D8 E2 D9 E7 F9 00 30 7B 38 F---- 91 D0 64 A7 33 8C 5C ",
"keyUsage": "ЕЦП, Неспростовність",
"polices": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://acskidd.gov.ua/download/crls/CA-D87779E7-Full.crl",
"crlDistribPoint2": "http://acskidd.gov.ua/download/crls/CA-D8777E7-Delta.crl",
"powerCert": true,
"subjTypeAvail": true,
"subjCA": false
}
},
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-43177711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E777----------AA2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=2467778;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101777014"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1583849275
},
"certificateInfo": {
"issuer": "O=Інформаційно-довідковий департамент ДПС;OU=Управління (центр) сертифікації ключів ІДД ДПС;CN=КНЕДП - ІДД ДПС;Serial=UA-4317777711-2019;C=UA;L=Київ",
"issuerCN": "КНЕДП - ІДД ДПС",
"serial": "58E2D9E7F900307-------2500E59F7B00",
"subject": "O=Тестовий платник 3 (Тестовий сертифікат);CN=Сидоренко Василь Леонідович (Тест);SN=Сидоренко;GivenName=Василь Леонідович (Тест);Serial=24677798;C=UA;L=Жашків;ST=Черкаська",
"subjCN": "Сидоренко Василь Леонідович (Тест)",
"subjOrg": "Тестовий платник 3 (Тестовий сертифікат)",
"subjState": "Черкаська",
"subjLocality": "Жашків",
"subjFullName": "Сидоренко Василь Леонідович (Тест)",
"subjPhone": "+38 (0 88) 888-88-88",
"subjEMail": "777test1@gmail.com",
"subjEDRPOUCode": "34577762",
"subjDRFOCode": "101077714",
"certBeginTime": "Nov 21, 2019 12:00:00 AM",
"certEndTime": "Nov 21, 2021 12:00:00 AM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Nov 21, 2019 12:00:00 AM",
"privKeyEndTime": "Nov 21, 2021 12:00:00 AM",
"publicKeyBits": 264,
"publicKey": "6896AF6336BE76B0F9-----------FF69E18E4C74AE2E512A1500",
"publicKeyID": "88 B9 20 A1 91 B2 40 2E 86 F5 ---- 73 5B 0D 97 34 B7 26 6B 80 F1 56 ",
"ecdhPublicKeyAvail": false,
"ecdhPublicKeyBits": 0,
"issuerPublicKeyID": "D8 E2 D9 E7 F9 00 30 7B 38 F---- 91 D0 64 A7 33 8C 5C ",
"keyUsage": "ЕЦП, Неспростовність",
"polices": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://acskidd.gov.ua/download/crls/CA-D87779E7-Full.crl",
"crlDistribPoint2": "http://acskidd.gov.ua/download/crls/CA-D8777E7-Delta.crl",
"powerCert": true,
"subjTypeAvail": true,
"subjCA": false
}
}
]
JSON приклад масиву об'єктів з даними підписантів до кожної вказаної транзакції
{
"1": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981706
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"2": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981706
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
},
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981971
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"11": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981988
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
],
"12": [
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695981988
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
},
{
"isStamp": false,
"ownerInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890"
},
"timeInfo": {
"isTimeAvail": true,
"isTimeStamp": true,
"dateTime": 1695988091
},
"certificateInfo": {
"issuer": "O=ТОВ \"Центр сертифікації ключів \"Україна\";CN=КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\";Serial=UA-36865753-2101;C=UA;L=Київ;OI=NTRUA-36865753",
"issuerCN": "КНЕДП ТОВ \"Центр сертифікації ключів \"Україна\"",
"serial": "5897920700000000000000000000000000000001",
"subject": "O=ТОВ \"Вайтдок\";Title=1;CN=Іванов Іван Іванович;SN=Іванов;GivenName=Іван Іванович;Serial=1234567890D;C=UA;L=місто КИЇВ",
"subjCN": "Іванов Іван Іванович",
"subjOrg": "ТОВ \"Вайтдок\"",
"subjTitle": "1",
"subjLocality": "місто КИЇВ",
"subjFullName": "Іванов Іван Іванович",
"subjEMail": "info@uakey.com.ua",
"subjEDRPOUCode": "12345678",
"subjDRFOCode": "1234567890",
"certBeginTime": "Mar 30, 2022, 5:56:29 PM",
"certEndTime": "Mar 29, 2024, 11:59:59 PM",
"privKeyTimesAvail": false,
"privKeyBeginTime": "Mar 30, 2022, 5:56:29 PM",
"privKeyEndTime": "Mar 29, 2024, 11:59:59 PM",
"publicKeyBits": 264,
"publicKey": "33 AC 59 40 D1 B8 6C 6D C3 9D 55 C7 43 A0 51 8F 55 09 6A D4 AA 26 98 86 08 0D 32 B1 71 3D E4 02 00 ",
"publicKeyID": "F1 73 2A 78 C0 F7 86 A2 3D B6 18 AF DE 4A 87 89 20 EE 0C FE F4 A0 12 06 1B 95 BB 0A BD 01 77 1F ",
"issuerPublicKeyID": "52 ED 74 ED 3A E9 49 36 C5 78 B5 A0 60 0B 65 F1 10 09 BF EF 5F 1E ED 43 CD 23 A4 98 F0 7D E3 80 ",
"keyUsage": "ЕЦП, Неспростовність",
"extKeyUsages": "1.2.804.2.1.1.1.11.36865753.1",
"policies": "Правила посиленої сертифікації",
"crlDistribPoint1": "http://uakey.com.ua/list.crl",
"crlDistribPoint2": "http://uakey.com.ua/list-delta.crl",
"powerCert": true,
"subjTypeAvail": false,
"subjCA": false,
"chainLength": 0,
"publicKeyType": 1,
"keyUsageType": 3,
"OCSPAccessInfo": "http://uakey.com.ua/services/ocsp/",
"issuerAccessInfo": "http://uakey.com.ua/uakeycert.p7b",
"TSPAccessInfo": "http://uakey.com.ua/services/tsp/",
"limitValueAvailable": false,
"limitValue": 0,
"subjType": 4,
"subjSubType": 0,
"subjCountry": "UA",
"qscd": false,
"certHashType": 1
}
}
]
}
Об’єкт DateTimeRange
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
startTimestamp |
long |
початок часового діапазону |
|
finishTimestamp |
long |
закінчення часового діапазону |
Об’єкт Limitation
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
offset |
O |
int |
зміщення першого елемента списку щодо верхньої межі вибірки (за замовчуванням 0) |
|
count |
O |
int |
ліміт вибірки (кількість); за замовчуванням 20 |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт Direction
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
type |
enum (EQ, OR, IN) |
тип вибірки; можливі значення: » EQ » / » OR » / » IN »
|
|
|
sender |
M/O |
List<String> |
масив; відправники; GLN відправників - обов’язковий, але може бути порожнім якщо зазначений масив GLN одержувачів (receiver) |
|
receiver |
M/O |
List<String> |
масив; одержувачі; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначений масив GLN відправників (sender) |
|
senderGln |
M/O |
List<String> |
масив; GLN відправників - обов’язковий, але може бути порожнім якщо зазначені інші параметри (для об’єкта XSearchContractsQuery) |
|
recipient |
M/O |
List<String> |
масив; id GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначені інші параметри(для об’єкта XSearchContractsQuery) |
|
recipientGln |
M/O |
List<String> |
масив; GLN одержувачів - обов’язковий, але може бути порожнім якщо зазначені інші параметри(для об’єкта XSearchContractsQuery) |
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт ExtraQueryParameters
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
Об’єкт ExtraQueryParameters |
|||
|
operator |
enum (AND, OR) |
||
|
type |
М |
enum (EQUALS, EQUALS_UUID, EQUALS_MD5, LIKE, MORE, MORE_EQ, LESS, LESS_EQ, IN) |
|
|
String |
найменування параметру |
||
|
value |
String |
id параметра |
Опис fieldName параметрів
|
id параметра |
Найменування параметра |
Тип 1 |
Формат |
Опис параметра |
|---|---|---|---|---|
|
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 (Звіт про інвентаризацію) |
|
|
10 |
error_code |
INT |
код помилки документообігу |
|
|
11 |
sub_doc_type_id |
INT |
id підтипу документа ( опис_підтипів ) |
|
|
12 |
sub_status_id |
INT |
id статусу документа (опис + опис для ETTN v3); характеризує стан ланцюжка документів для PRDRSRVN:
|
|
|
13 |
action |
VARCHAR |
статус/стан документа за здійсненими діями користувача; Для EDI: ORDER (тип документа):
RETANN:
PRICAT (тип документа):
COACSU (тип документа):
CONDRA:
Для Вільний:
Для ЕТТН:
|
|
|
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 |
decimal |
сума з ПДВ / загальна сума штрафу (ORDRPT) |
|
|
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) для сервісу Е-Специфікація. Також для EDI сервісу в нього пишеться поле ContractGLN з документа Метро 7а |
|
|
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 |
дата документа-підстави |
|
|
116 |
ready_for_sign |
INT |
відмітка готовності до підписання (0-ні; 1-так) |
|
|
118 |
ready_for_send |
INT |
відмітка готовності до відправки (0-ні; 1-так) |
|
|
95 |
summ_without_tax |
decimal |
сума без ПДВ |
|
|
tax_summ |
decimal |
сума ПДВ |
||
|
129 |
receiving_note_number |
VARCHAR |
Номер повідомлення про прийом (DOCUMENTINVOICE…ReceivingAdviceNumber) |
|
|
137 |
branch_uuid |
VARCHAR |
uuid «гілки поставки» для мережі АТБ (документи однієї поставки). Використовується для COMDOC та ETTNv3 документів. Поле заповнюється при відправці е-ТТН чи фомується автоматично платформою EDI Network на підставі даних з документа-основи: «Повідомлення про відвантаження» (DESADV.NUMBER + DESADV.DATE + DESADV.ORDERNUMBER + DESADV.ORDERDATE). |
|
|
parent_doc_uuid |
VARCHAR |
uuid початкового документа / документа-підстави (записується також при заміні відправленої чернетки) |
||
|
139 |
format_version |
VARCHAR |
номер версії (поле C_DOC_VER) з Податкової накладної (DECLAR) чи Коригування до податкової накладної (DECLARj12) |
|
|
142 |
parent_docs_match |
INT |
0 - comdoc_007 зі зміненими даними для звірки по desadv; 1 - comdoc_007 з коректними / не зміненими даними для звірки по desadv |
|
|
149 |
post_start_date |
[yyyy-MM-dd] |
дата дедлайну для документів Метро 7а |
|
|
153 |
review_deadline_date |
[yyyy-MM-dd] |
термін подачі на перегляд для документів Метро 7b (ReviewDeadlineDate) |
|
|
sign_hash |
VARCHAR |
хеш підпису |
||
|
draft_date_created |
INT |
дата створення чернетки |
||
|
carrier_b_uuid |
BINARY |
ідентифікатор перевізника |
||
|
consignee_b_uuid |
BINARY |
ідентифікатор вантажоодержувача |
||
|
consignor_b_uuid |
BINARY |
ідентифікатор вантажовідправника |
||
|
external_doc_id |
INT |
id ТТН документа в ЦБД |
||
|
orderpartner_uuid |
BINARY |
ідентифікатор замовника (для документа ORDER з поля ORDERPARTNER) |
||
|
invoicepartner_uuid |
BINARY |
ідентифікатор платника (для документа ORDER з поля INVOICEPARTNER) |
||
|
finalrecipient_uuid |
BINARY |
ідентифікатор кінцевого консигнатора (для документів ORDER та DESADV з поля FINALRECIPIENT) |
||
|
is_offline_sign |
INT |
документ з офлайн підписом (мітка часу не підтверджена); 0-ні / 1-так |
||
|
car_number |
VARCHAR |
номер авто |
||
|
carrier |
VARCHAR |
GLN перевізника |
||
|
carrier_signed |
INT |
відмітка підписання перевізником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignee |
VARCHAR |
GLN вантажоодержувача |
||
|
consignee_signed |
INT |
відмітка підписання вантажоодержувачем (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignor |
VARCHAR |
GLN вантажовідправника |
||
|
consignor_signed |
INT |
відмітка підписання вантажовідправником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
customer |
VARCHAR |
GLN замовника |
||
|
driver |
VARCHAR |
GLN водія |
||
|
driver_signed |
INT |
відмітка підписання водієм (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
expeditor_signed |
INT |
відмітка підписання експедитором (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
gross_weight |
INT |
маса брутто (кг) |
||
|
load_point |
VARCHAR |
GLN пункту завантаження |
||
|
sub_status_next |
INT |
|||
|
trailer_number |
VARCHAR |
номер причіпа |
||
|
unload_point |
VARCHAR |
GLN пункту розвантаження |
||
|
family |
INT |
сімейство
|
||
|
hash |
VARCHAR |
хеш документа |
||
|
is_archive |
VARCHAR |
документ перенесено в архів (true / false) |
||
|
user_status |
INT |
список користувачів із відповідним статусом погодження (сценарії) в форматі: userID:statusID, де statusID:
|
||
|
ettn_process_act |
INT |
Присутність значення свідчить про створений Акт до ТТН v3: 1 - ТТН v3 заблоковано від певних дій (Акт знаходиться в опрацьовуванні (життєвий цикл Акта не завершено) |
||
|
ettn_process_act_type |
INT |
ідентифікатор типу (doc_type) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 133,134,135,136,137,138,139,140,141. За наявності цього параметра блокуються дії:
Розблокування дій з ТТН виконується автоматично після завершення життєвого циклу Акта. |
||
|
carrier_uuid |
VARCHAR |
GLN перевізника (він же sender Акта наданих послуг (Логістика)) |
||
|
driver_switch_uuid |
VARCHAR |
GLN нового водія (Акт перевантаження) |
||
|
driver_uuid |
VARCHAR |
Водій |
||
|
expeditor_uuid |
VARCHAR |
Експедитор |
||
|
load_place_uuid |
VARCHAR |
Місце завантаження (COMDOC_027/МісцеНавантаження/GLN) |
||
|
ettn_onstorage |
INT |
ідентифікатор статусу документа: Вантаж розвантажено та отримувач підписав Акт перевантаження на проміжному складі |
||
|
track_number |
VARCHAR |
Номер рейсу (може вказуватись Вантажовідправником для ТТН v2) |
||
|
last_trans_id |
VARCHAR |
Ідентифікатор останньої транзакції (додається після реєстрації транзакції або при створенні документа з нуля) |
||
|
finalised |
INT |
Відмітка про фіналізацію замовлення в сервісі Маркет (0-ні, 1-так) |
||
|
236 |
currency |
VARCHAR |
Валюта; доступні значення:
|
|
|
237 |
is_unilateral_signing |
INT |
Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так |
|
|
cloned_from |
UUID |
унікальний ідентифікатор документа, з якого даний документ був клонований |
||
|
ttn_in_process |
INT |
індекси для доаткових ключів пошуку Заявки / Підтвердження:
|
||
|
invoice_exist |
INT |
відмітка існування Рахунку в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Рахунку)
|
||
|
act_exist |
INT |
відмітка існування Акта наданих послуг в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Акта наданих послуг)
|
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт StorageQuery (Дані для фільтрації)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
extraParams |
List<ExtraQueryParameters> |
масив об’єктів; набір індексів |
|
|
multiExtraParams |
List<ExtraQueryParameters> |
масив об’єктів; мультиіндекс (може приймати масив параметрів з масивами значень для кожного з параметрів) |
|
|
type |
M |
List<XDocType> |
масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа |
|
statuses |
M |
List<Integer> |
масив; список статусів (станів) документів, за якими буде відбуватися відбір:
|
|
extraStatuses |
List<Integer> |
масив; список екстрастатусів |
|
|
tags |
List<Long> |
масив; тег |
|
|
exchangeStatus |
O |
List<Integer> |
масив; статус документообігу |
|
docs |
List<Long> |
масив; документи |
|
|
docUUIDs |
List<UUID> |
масив; унікальні ідентифікатори документів |
|
|
partners |
List<Long> |
масив; ідентифікатори контрагентів |
|
|
families |
List<Integer> |
масив; ознака сервісу (сімейство)
|
|
|
direction |
M |
об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів |
|
|
limit |
O |
об’єкт; фільтр відбору (налаштування виводу даних) |
|
|
orderBy |
O |
OrderBy |
фільтрувати по даті чи опису документа |
|
groupBy |
O |
String |
об’єднані по id ланцюжка/документа |
|
number |
O |
String |
номер документа |
|
family |
O |
int |
сімейство
|
|
partnerId |
Long |
id роздрібної мережі |
|
|
chainHash |
String |
хеш-значення, отримане в результаті обробки ланцюжка |
|
|
docHash |
String |
хеш-значення, отримане в результаті обробки документа |
|
|
docCreate |
O |
об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по |
|
|
docRead |
O |
об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по |
|
|
docChanged |
O |
об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по |
|
|
archive |
Boolean |
відмітка наявності архівної ознаки документа |
|
|
important |
boolean |
відмітка важливий документ |
|
|
visible |
boolean |
відмітка видимості |
|
|
loadBody |
boolean |
відмітка наявності тіла документа |
|
|
loadComments |
boolean |
відмітка наявності коментарів до документа |
|
|
loadStatuses |
boolean |
відмітка наявності статусів документа |
|
|
loadTags |
boolean |
відмітка наявності тегів документа |
|
|
loadChain |
boolean |
відмітка наявності ланцюжка документів |
|
|
loadAttachments |
boolean |
відмітка наявності вкладень |
Приклади для сервісу «EDI Network»
Отримати всі документи-чернетки, в яких відправником зазначений GLN 9864065732303
JSON приклад
{
"archive": false,
"direction":
{
"type": "EQ",
"sender":
[
"9864065732303"
]
},
"exchangeStatus":
[],
"family": 1,
"limit":
{
"offset": "0",
"count": 21
},
"statuses":
[
1
],
"tags":
[],
"type":
[
{
"type": 0,
"title": "all",
"description": "all"
}
],
"families":
[
1,
7
]
}
Отримати всі вхідні «Видаткові накладні», що знаходяться в статусі «Потребує підписання отримувачем»
JSON приклад
{
"statuses": [4, 5, 6],
"type": [
{
"type": 28
}
],
"limit": {
"offset": "0",
"count": 21
},
"exchangeStatus": [
1
],
"extraParams": [
{
"operator": "AND",
"type": "EQUALS",
"value": "6",
"fieldName": "sub_doc_type_id"
},
{
"operator": "AND",
"type": "EQUALS",
"value": "1",
"fieldName": "sub_status_id"
}
],
"tags": [],
"archive": false,
"direction": {
"type": "EQ",
"receiver": [
"9864066822430"
],
"sender": []
},
"family": 1
}
Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких отримувачем є GLN 9864232304302
JSON приклад
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
]
}
Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких відправником є GLN 9864232304302
JSON приклад
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
]
}
Отримати всі вхідні документи (GLN отримувача 9864232304302)
JSON приклад
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["4","5","6"],
"type": [
{
"type": "0"
}
]
}
Отримати всі відправлені документи (GLN відправника 9864232304302)
JSON приклад
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","6"],
"type": [
{
"type": "0"
}
]
}
Отримати документи з номером, рівним значенню «1001» (пошук серед усіх документів, окрім чернеток), в яких отримувачем є GLN 9864232304302
JSON приклад
{
"direction": {
"sender": [],
"receiver": ["9864232304302"],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"number": "1001",
"type": [
{
"type": "0"
}
]
}
Отримати всі документи, окрім чернеток, для GLN відправника 9864232304302, що створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp за київським часом відносно UTC)
JSON приклад
{
"direction": {
"sender": ["9864232304302"],
"receiver": [],
"type": "EQ"
},
"exchangeStatus": [],
"family": "1",
"statuses": ["2","3","4","5","6","7"],
"type": [
{
"type": "0"
}
],
"extraParams": [
{
"operator": "AND",
"type": "MORE_EQ",
"fieldName": "doc_date",
"value": "1556668800"
},
{
"operator": "AND",
"type": "LESS_EQ",
"fieldName": "doc_date",
"value": "1559347199"
}
}
Приклади для сервісу «Маркет»
Отримати список всіх відправлених «Замовлень» (ORDERS) для GLN відправника 9864232324065
JSON приклад
{
"archive": false,
"direction": {
"receiver": [],
"sender": ["9864232324065"],
"type": "EQ"
},
"exchangeStatus": [],
"extraParams": [],
"family": 8,
"multiExtraFields": [],
"statuses": [2],
"type": [
{
"type": 2
}
]
}
Отримати список всіх чернеток «Замовлень» (ORDERS) для GLN 9864232324065 (створювач-відправник)
JSON приклад
{
"archive": false,
"direction": {
"receiver": [],
"sender": ["9864232324065"],
"type": "EQ"
},
"exchangeStatus": [],
"extraParams": [],
"family": 8,
"multiExtraFields": [],
"statuses": [1],
"type": [
{
"type": 2
}
]
}
Приклади для сервісу «Вільний»
Отримати всі надіслані документи («statuses»: 2,3), що очікують підпису («action»: 0)
JSON приклад
{
"statuses": [
2,
3
],
"type": [
{
"type": 0
}
],
"limit": {
"count": 21,
"offset": "0"
},
"exchangeStatus": [],
"extraParams": [
{
"operator": "AND",
"type": "IN",
"value": "0",
"fieldName": "action"
}
],
"multiExtraParams": [],
"tags": [],
"archive": false,
"direction": {
"type": "EQ",
"sender": [
"7c30a623-b84f-44d1-bda1-fdcc5f8be3d7"
],
"receiver": []
},
"loadChain": true,
"family": 9
}
Отримати всі вхідні документи («statuses»: 4,5) від вказаного відправника/-ів (sender:uuid)
JSON приклад
{
"statuses": [
4,
5
],
"type": [
{
"type": 0
}
],
"limit": {
"count": 21,
"offset": "0"
},
"exchangeStatus": [],
"extraParams": [],
"multiExtraParams": [],
"tags": [],
"archive": false,
"direction": {
"type": "EQ",
"sender": [
"831714cf-064b-4ce9-bdc4-b6a79784639c"
],
"receiver": [
"7c30a623-b84f-44d1-bda1-fdcc5f8be3d7"
]
},
"loadChain": true,
"family": 9
}
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Додаткові поля (extra_fields)
Опис json-параметрів
|
Найменування |
Формат |
Опис |
|---|---|---|
|
extra_fields |
Map<String, String> |
масив об’єктів; набір індексів |
|
multi_extra_fields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Може бути використаний для індексування елементів рядка |
Опис extra_fields параметрів
|
id параметра |
Найменування параметра |
Тип 1 |
Формат |
Опис параметра |
|---|---|---|---|---|
|
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 (Звіт про інвентаризацію) |
|
|
10 |
error_code |
INT |
код помилки документообігу |
|
|
11 |
sub_doc_type_id |
INT |
id підтипу документа ( опис_підтипів ) |
|
|
12 |
sub_status_id |
INT |
id статусу документа (опис + опис для ETTN v3); характеризує стан ланцюжка документів для PRDRSRVN:
|
|
|
13 |
action |
VARCHAR |
статус/стан документа за здійсненими діями користувача; Для EDI: ORDER (тип документа):
RETANN:
PRICAT (тип документа):
COACSU (тип документа):
CONDRA:
Для Вільний:
Для ЕТТН:
|
|
|
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 |
decimal |
сума з ПДВ / загальна сума штрафу (ORDRPT) |
|
|
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) для сервісу Е-Специфікація. Також для EDI сервісу в нього пишеться поле ContractGLN з документа Метро 7а |
|
|
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 |
дата документа-підстави |
|
|
116 |
ready_for_sign |
INT |
відмітка готовності до підписання (0-ні; 1-так) |
|
|
118 |
ready_for_send |
INT |
відмітка готовності до відправки (0-ні; 1-так) |
|
|
95 |
summ_without_tax |
decimal |
сума без ПДВ |
|
|
tax_summ |
decimal |
сума ПДВ |
||
|
129 |
receiving_note_number |
VARCHAR |
Номер повідомлення про прийом (DOCUMENTINVOICE…ReceivingAdviceNumber) |
|
|
137 |
branch_uuid |
VARCHAR |
uuid «гілки поставки» для мережі АТБ (документи однієї поставки). Використовується для COMDOC та ETTNv3 документів. Поле заповнюється при відправці е-ТТН чи фомується автоматично платформою EDI Network на підставі даних з документа-основи: «Повідомлення про відвантаження» (DESADV.NUMBER + DESADV.DATE + DESADV.ORDERNUMBER + DESADV.ORDERDATE). |
|
|
parent_doc_uuid |
VARCHAR |
uuid початкового документа / документа-підстави (записується також при заміні відправленої чернетки) |
||
|
139 |
format_version |
VARCHAR |
номер версії (поле C_DOC_VER) з Податкової накладної (DECLAR) чи Коригування до податкової накладної (DECLARj12) |
|
|
142 |
parent_docs_match |
INT |
0 - comdoc_007 зі зміненими даними для звірки по desadv; 1 - comdoc_007 з коректними / не зміненими даними для звірки по desadv |
|
|
149 |
post_start_date |
[yyyy-MM-dd] |
дата дедлайну для документів Метро 7а |
|
|
153 |
review_deadline_date |
[yyyy-MM-dd] |
термін подачі на перегляд для документів Метро 7b (ReviewDeadlineDate) |
|
|
sign_hash |
VARCHAR |
хеш підпису |
||
|
draft_date_created |
INT |
дата створення чернетки |
||
|
carrier_b_uuid |
BINARY |
ідентифікатор перевізника |
||
|
consignee_b_uuid |
BINARY |
ідентифікатор вантажоодержувача |
||
|
consignor_b_uuid |
BINARY |
ідентифікатор вантажовідправника |
||
|
external_doc_id |
INT |
id ТТН документа в ЦБД |
||
|
orderpartner_uuid |
BINARY |
ідентифікатор замовника (для документа ORDER з поля ORDERPARTNER) |
||
|
invoicepartner_uuid |
BINARY |
ідентифікатор платника (для документа ORDER з поля INVOICEPARTNER) |
||
|
finalrecipient_uuid |
BINARY |
ідентифікатор кінцевого консигнатора (для документів ORDER та DESADV з поля FINALRECIPIENT) |
||
|
is_offline_sign |
INT |
документ з офлайн підписом (мітка часу не підтверджена); 0-ні / 1-так |
||
|
car_number |
VARCHAR |
номер авто |
||
|
carrier |
VARCHAR |
GLN перевізника |
||
|
carrier_signed |
INT |
відмітка підписання перевізником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignee |
VARCHAR |
GLN вантажоодержувача |
||
|
consignee_signed |
INT |
відмітка підписання вантажоодержувачем (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
consignor |
VARCHAR |
GLN вантажовідправника |
||
|
consignor_signed |
INT |
відмітка підписання вантажовідправником (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
customer |
VARCHAR |
GLN замовника |
||
|
driver |
VARCHAR |
GLN водія |
||
|
driver_signed |
INT |
відмітка підписання водієм (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
expeditor_signed |
INT |
відмітка підписання експедитором (0-ні; 1-підписано (ТТН в статусі 6); 2-підписано (ТТН в статусі 7)) |
||
|
gross_weight |
INT |
маса брутто (кг) |
||
|
load_point |
VARCHAR |
GLN пункту завантаження |
||
|
sub_status_next |
INT |
|||
|
trailer_number |
VARCHAR |
номер причіпа |
||
|
unload_point |
VARCHAR |
GLN пункту розвантаження |
||
|
family |
INT |
сімейство
|
||
|
hash |
VARCHAR |
хеш документа |
||
|
is_archive |
VARCHAR |
документ перенесено в архів (true / false) |
||
|
user_status |
INT |
список користувачів із відповідним статусом погодження (сценарії) в форматі: userID:statusID, де statusID:
|
||
|
ettn_process_act |
INT |
Присутність значення свідчить про створений Акт до ТТН v3: 1 - ТТН v3 заблоковано від певних дій (Акт знаходиться в опрацьовуванні (життєвий цикл Акта не завершено) |
||
|
ettn_process_act_type |
INT |
ідентифікатор типу (doc_type) документа (Акта), що був складений до ТТН і зараз знаходиться в опрацьовуванні (життєвий цикл Акта не завершено). Доступні значення: 133,134,135,136,137,138,139,140,141. За наявності цього параметра блокуються дії:
Розблокування дій з ТТН виконується автоматично після завершення життєвого циклу Акта. |
||
|
carrier_uuid |
VARCHAR |
GLN перевізника (він же sender Акта наданих послуг (Логістика)) |
||
|
driver_switch_uuid |
VARCHAR |
GLN нового водія (Акт перевантаження) |
||
|
driver_uuid |
VARCHAR |
Водій |
||
|
expeditor_uuid |
VARCHAR |
Експедитор |
||
|
load_place_uuid |
VARCHAR |
Місце завантаження (COMDOC_027/МісцеНавантаження/GLN) |
||
|
ettn_onstorage |
INT |
ідентифікатор статусу документа: Вантаж розвантажено та отримувач підписав Акт перевантаження на проміжному складі |
||
|
track_number |
VARCHAR |
Номер рейсу (може вказуватись Вантажовідправником для ТТН v2) |
||
|
last_trans_id |
VARCHAR |
Ідентифікатор останньої транзакції (додається після реєстрації транзакції або при створенні документа з нуля) |
||
|
finalised |
INT |
Відмітка про фіналізацію замовлення в сервісі Маркет (0-ні, 1-так) |
||
|
236 |
currency |
VARCHAR |
Валюта; доступні значення:
|
|
|
237 |
is_unilateral_signing |
INT |
Відправлений COMDOC містить поле «ОдностороннєПідписання» (документ підписується лише відправником); 0-ні, 1-так |
|
|
cloned_from |
UUID |
унікальний ідентифікатор документа, з якого даний документ був клонований |
||
|
ttn_in_process |
INT |
індекси для доаткових ключів пошуку Заявки / Підтвердження:
|
||
|
invoice_exist |
INT |
відмітка існування Рахунку в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Рахунку)
|
||
|
act_exist |
INT |
відмітка існування Акта наданих послуг в ланцюжку з TRANSPORTATIONORDER (+ дозволи створення Акта наданих послуг)
|
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"
}
}
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
Об’єкт XStatus
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
docId |
long |
id документа/квитанції |
|
date |
long |
дата статусу; формат unix timestamp |
|
type |
int |
тип статусу:
|
|
text |
String |
зміст статусу |
JSON приклад:
[
{
"docId": 3914,
"date": 1607695844,
"type": 1
}
]
Об’єкт XTag в параметрах об'єкта XDoc
Опис параметрів об’єкта XTag
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id тега |
|
name |
String |
зміст тега |
|
shortName |
String |
коротка назва тега |
Об’єкт XDocSignInfo
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
doc_id |
long |
id документа/квитанції |
|
date |
long |
дата підписання; формат unix timestamp |
|
count |
short |
кількість підписів |
|
info |
String |
додаткова інформація |
|
hash |
String |
хеш-значення, отримане в результаті обробки |
Об’єкт XDocStatus
Опис параметрів об’єкту
|
id статусу |
статус |
|---|---|
|
0 |
ALL - будь-який статус |
|
1 |
OPEN - чернетка (відправник) |
|
2 |
SENT - відправлений (відправник) |
|
3 |
DELIVERED - доставлений (відправник) |
|
4 |
INBOX - вхідний (одержувач) |
|
5 |
READ - прочитаний (одержувач) |
|
6 |
ERROR - помилка |
|
7 |
DELETED - видалений |
Об’єкт XDocComment
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id коментаря |
|
docUUID |
UUID |
унікальний ідентифікатор документа |
|
createTimestamp |
long |
дата створення коментаря у форматі timestamp |
|
authorLogin |
String |
автор коментаря |
|
comment |
String |
зміст коментаря |
Об’єкт XDocCommentsList
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
XDocCommentsList |
List<XDocComment> |
масив об’єктів; коментарі до документа |
Об’єкт XDocBodyForms
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
forms |
HashMap<String, XDocBody> |
масив об’єктів; тіло документа |
Об’єкт XDocBodyType
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
int |
id типу тіла документа |
|
name |
String |
назва типу тіла документа |
Об’єкт XDocBody
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
type |
об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6 |
|
|
base64content |
String |
зміст тіла документа в BASE64 |
Об’єкт XDoc
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
body |
об’єкт; тіла документів |
|
|
attachments |
List<XDocAttachment> |
масив об’єктів; вкладення (може не використовуватися) |
|
comments |
об’єкт (в якому масив об’єктів); список коментарів |
|
|
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 |
сімейство
|
|
hash |
String |
хеш-значення, отримане в результаті обробки |
|
type |
об’єкт; тип документа |
|
|
status |
об’єкт; статус пари документів у відправника і одержувача |
|
|
exchange_status |
String |
сабстатус документа (детальніше) |
|
is_archive |
boolean |
відмітка; Архівний документ чи ні |
|
signInfo |
об’єкт; дані про підписи |
|
|
chain |
XChain |
об’єкт; дані пов’язаних ланцюжків |
|
extraFields |
Map<String, String> |
масив об’єктів; набір індексів (аналог індексних таблиць) |
|
tags |
List<XTag> |
масив об’єктів; прикріплені теги |
|
statuses |
List<XStatus> |
масив об’єктів; статуси обробки відправлених документів |
|
multiExtraFields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка |
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"
}
JSON приклад для сервіса Вільний
{
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
}
}
},
"attachments": [
{
"id": 247,
"docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"attachmentUUID": "66c673fe-4beb-48e1-94bc-16bbae74ead6",
"fileName": "21-Speed-Front-Suspension-MTB-Snow-Beach-Bike-Fat-Bike.jpg",
"createDate": 1613753224,
"type": "image/jpeg",
"signs": [],
"signHash": "EQt6XqKdKdTsjH1e+zgHOyi6FwFohC/jS5XyBgYN4k8="
},
{
"id": 249,
"docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"attachmentUUID": "37280d06-c85e-42bc-aa97-670950d1739f",
"fileName": "1613469397472.png",
"createDate": 1613754039,
"type": "image/png",
"signs": [],
"signHash": "6zcK6RDHUxAV3icq6p0uMHmGfA1DYhfKZz053tw75+Y="
},
{
"id": 250,
"docUUID": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"attachmentUUID": "14904c6b-a83d-4e08-9bbf-5427d1d015f0",
"fileName": "8cb20e57bcf705981d4605d6af413a91.png",
"createDate": 1613754581,
"type": "image/png",
"signs": [],
"signHash": "B5qPxPAju4pZ3x9blBo+NQVFRv8TU/5rxkwAWnhAyPw="
}
],
"comments": [],
"doc_id": 125,
"doc_uuid": "a4ab5f49-9f5b-4a05-ae61-825b76ef3e4a",
"uuidSender": "7c30a623-b84f-44d1-bda1-fdcc5f8be3d7",
"uuidReceiver": "831714cf-064b-4ce9-bdc4-b6a79784639c",
"uuidReceivers": [
"831714cf-064b-4ce9-bdc4-b6a79784639c"
],
"docNumber": "1613753224",
"dateCreated": 1613753224,
"dateChanged": 1613754581,
"dateRead": 0,
"docDate": 1613753224,
"chain_id": 0,
"family": 9,
"hash": "D6387945D930C872219A5BA48FD50849",
"type": {
"type": 122,
"title": "simple_doc",
"description": "simple_doc"
},
"status": {
"status": 1,
"title": "open"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"doc_title": "rock&roll123",
"action": "0"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
}
Об’єкт XDocType
Таблиця 1. Опис параметрів об'єкту XDocType
|
Параметр |
Формат |
Опис |
|
Об’єкт XDocType |
||
|
type |
int |
id типу документа/квитанції |
|
title |
String |
назва документа/квитанции |
|
description |
String |
опис документа/квитанції (найменування кирилицею) |
Таблиця 2. Опис типів документів для об'єкту XDocType
|
Тип |
Назва (doc_type) |
Опис (найменування кирилицею) |
|---|---|---|
|
0 |
all |
всі |
|
1 |
invoice |
|
|
2 |
orders |
|
|
3 |
recadv |
|
|
4 |
desadv |
|
|
5 |
ordrsp |
|
|
6 |
pricat |
|
|
7 |
comdis |
|
|
10 |
declar |
|
|
11 |
insdes |
|
|
12 |
desscc |
|
|
13 |
slsrpt |
|
|
14 |
invrpt |
|
|
15 |
coacsu |
|
|
17 |
iftmin |
|
|
18 |
retann |
|
|
19 |
iftmbf |
|
|
20 |
partin |
|
|
21 |
mscons |
|
|
22 |
transportationorder |
Заявка на транспортування / Підтвердження заявки на транспортування |
|
25 |
retins |
|
|
28 |
comdoc |
|
|
29 |
declarj12 |
|
|
30 |
condra |
|
|
35 |
metro7a |
|
|
39 |
metro7b |
|
|
40 |
prodlist |
|
|
41 |
agreem |
|
|
42 |
iftmbc |
|
|
59 |
documentinvoice |
|
|
60 |
prdrsrvn |
|
|
67 |
doccorinvoice |
|
|
72 |
metro7c |
|
|
98 |
quotes |
|
|
111 |
transhipment |
|
|
115 |
ordrpt |
|
|
118 |
docinvoiceact |
|
|
119 |
discrepancy |
|
|
120 |
contrl |
|
|
122 |
simple_doc |
Документ сервісу «Вільний» |
|
132 |
ttn_ecmr |
ETTN (v3) |
|
133 |
reload_ecmr |
Акт перевантаження (v3) |
|
134 |
disagreement_ecmr |
Акт розбіжностей (v3) |
|
135 |
consignee_change_ecmr |
|
|
136 |
storage_delivery_ecmr |
|
|
137 |
adjustment_ecmr |
Акт коригування (v3) |
|
138 |
storage_pickup_ecmr |
|
|
139 |
resealing_ecmr |
Акт переопломбування (v3) |
|
140 |
load_reject_ecmr |
|
|
141 |
stop_ecmr |
Об’єкт DistribexOrderResult
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
status |
String |
статус виконання запиту |
|
doc_uuid |
String |
ідентифікатор документа |
|
errors |
List<String> |
масив; помилки при формуванні Замовлення |
Приклад відповіді
{
"status": "OK",
"doc_uuid": "80928188-e10b-4f99-9db9-604addb77264",
"errors": []
}
Приклад відповідей помилок
1. {
"status": "ERROR",
"errors": [
"Замовлена кількість перевищує встановлену квоту [1]"
]
}
2. {
"status": "ERROR",
"errors": [
"Замовлена кількість перевищує наявний залишок [1]"
]
}
3. {
"status": "ERROR",
"errors": [
"Сума замовлення менше мінімально встановленої суми"
]
}
4. {
"status": "ERROR",
"errors": [
"Сума замовлення перевищує максимально встановлену суму"
]
}
5. {
"status": "ERROR",
"errors": [
"Перевищена максимальна вага замовлення"
]
}
6. {
"status": "ERROR",
"errors": [
"Перевищено максимальну кількість позицій у замовленні"
]
}
7. {
"status": "ERROR",
"errors": [
"Перевищено максимальну кількість коробок на замовлення"
]
}
8. {
"status": "ERROR",
"errors": [
"Перевищено максимальну кількість палет на замовлення"
]
}
9. {
"status": "ERROR",
"errors": [
"Замовлена кількість не кратна упаковці [1]"
]
}
10. {
"status": "ERROR",
"errors": [
"java.sql.SQLException: Product not found: 42541040" // вказана позиція відсутня в прайс-листі
]
}
------------------------------
{
"status": "ERROR",
"errors": [
"Замовлена кількість перевищує встановлену квоту [1]",
"Замовлена кількість перевищує наявний залишок [1]",
"Замовлена кількість не кратна упаковці [1]",
"Замовлена кількість не кратна упаковці [2]",
"Сума замовлення перевищує максимально встановлену суму",
"Перевищена максимальна вага замовлення",
"Перевищено максимальну кількість позицій у замовленні",
"Перевищено максимальну кількість коробок на замовлення",
"Перевищено максимальну кількість палет на замовлення",
"java.sql.SQLException: Product not found: 42541040" // вказана позиція відсутня в прайс-листі
]
}
Об’єкт XDistribexPreorder
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
positions |
List<Long> |
масив; позиції Замовлення |
|
id |
long |
ідентифікатор Замовлення |
|
producerId |
long |
ідентифікатор Продавця (Виробника) |
|
type |
int |
ідентифікатор підтипу документа:
|
|
docUuid |
UUID |
ідентифікатор документа-підстави |
|
content |
byte[] |
масив байтів; контент |
Приклад
{
"positions": [1186],
"id": 22,
"producerId": 13200791,
"type": 3,
"docUuid": "19e049cd-190d-4774-bdbe-e8801f6869a7",
"content": [91,123,34,108,105,115,116,95,105,100,34,58,49,49,56,54,44,34,113,110,116,121,34,58,53,54,125,93]
}
Об'єкт XDistribexPreorderPosition
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
list_id |
long |
ідентифікатор товарної позиції |
|
barcode |
String |
штрихкод товарної позиції |
|
article |
String |
артикул товарної позиції |
|
qnty |
double |
кількість товарів для Попереднього замовлення (альтернативна назва quantity) |
Приклад запиту
{
"list_id": 123,
"barcode": "12000123",
"article": "art1",
"qnty": 123.00
}
Об’єкт Сharacteristics (додаткові характеристики продукту)
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
recommended_order_pce |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Рекомендоване замовлення, шт |
|
recommended_order_box |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Рекомендоване замовлення, ящ |
|
secondary_sales |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Вторинні продажі за 21 день, шт (у Покупця (Дистрибʼютора) по звітах. інформаційне) |
|
average_sales |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Середньомісячні вторинні продажі (середні за останні 3 місяці), шт (у Покупця (Дистрибʼютора) по звітах. інформаційне) |
|
actual_qty_buyer |
О |
Число з плаваючою точкою (максимально: 10 знаків до крапки та 3 знаки після крапки) |
Залишок покупця, шт (у Покупця (Дистрибʼютора) по звітах. інформаційне) |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт XPriceListProduct
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
group_id |
long |
ідентифікатор групи |
|
|
article |
M |
String |
артикул |
|
name |
M |
String |
назва товару |
|
barcode |
M |
String |
штрихкод |
|
user_code |
O |
String |
код УКТ ЗЕД |
|
unit_weight |
O |
String |
вага одиниці товару, кг |
|
box_qty |
M |
String |
одиниць в коробці |
|
box_weight |
O |
String |
вага коробки, кг |
|
box_in_layer |
O |
String |
кількість коробок в шарі, шт. |
|
box_in_palette |
O |
String |
кількість коробок на палеті, шт. |
|
palette_weight |
O |
String |
вага палети, кг |
|
producer_code |
O |
String |
код Продавця (Виробника) |
|
min_order_qty |
O |
float (10,3) |
Мінімальна кількість замовлення |
|
regions |
M |
String |
Область/країни наявності товару (перелік назв через кому) |
|
characteristics |
O |
об’єкт; додаткові характеристики продукту |
|
|
id |
long |
ідентифікатор товарної позиції |
|
|
date_created |
long |
дата створення запису про товар |
|
|
date_changed |
long |
дата внесених змін в дані товару |
|
|
producer_id |
long |
ідентифікатор Продавця (Виробника) |
|
|
product_id |
long |
ідентифікатор товару |
|
|
unit_id |
O |
long |
ідентифікатор одиниці виміру; допустимі значення:
|
|
price_without_vat |
M |
Double |
ціна одиниці без ПДВ, грн |
|
vat |
O |
int |
ставка ПДВ, % |
|
price_with_vat |
O |
Double |
ціна одиниці з ПДВ, грн |
|
price_discont |
O |
Double |
ціна одиниці зі знижкою без ПДВ, грн |
|
price_with_vat_discont |
O |
Double |
ціна одиниці зі знижкою з ПДВ, грн |
|
date_from |
long |
період дії з |
|
|
date_to |
long |
період дії по |
|
|
stock_balance |
O |
Double |
залишок |
|
comment |
O |
String |
коментарі |
|
quota |
O |
Double |
квота на замовлення |
|
multiplicity |
O |
int |
кратність кількості в замовленні. Значення кратно якому має бути заповнена кількість замовленої позиції |
|
is_promo |
O |
boolean |
відмітка «Акція!» |
|
is_new |
O |
boolean |
відмітка «Новинка!» |
|
is_public |
O |
boolean |
відмітка «Публічна позиція!» |
|
is_surcharge |
O |
boolean |
відмітка «Надбавка!» |
|
is_pickup |
O |
boolean |
відмітка «Самовивіз!» |
|
is_bestseller |
O |
boolean |
відмітка «Хіт продажу!» |
|
add_characteristics |
O |
String |
характеристики |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Об’єкт XPriceListElement
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
currency |
M |
String |
код валюти:
|
|
category_id |
O |
long |
ідентифікатор
|
|
category_name |
M |
String |
назва:
|
|
children |
O/M |
List<XPriceListElement> |
масив об’єктів;
|
|
prods |
M |
List<XPriceListProduct> |
масив об’єктів; дані товарів |
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
Приклад запиту
[
{
"currency": "UAH",
"category_id": 504,
"category_name": "Хлібобулочні вироби",
"children":
[
{
"category_id": 507,
"category_name": "Слойка",
"children":
[
{
"category_id": 508,
"category_name": "Слойка",
"children":
[],
"prods":
[
{
"group_id": 508,
"article": "2261628093012",
"name": "Палички листкові 1 кг",
"barcode": "2261628093012",
"box_qty": "1",
"box_weight": "1",
"characteristics":
{
"box_qty": "1",
"box_weight": "1"
},
"is_pickup": false,
"id": 19163,
"date_created": 1707489221,
"date_changed": 1707489221,
"producer_id": 13200791,
"product_id": 965,
"unit_id": 12,
"price_without_vat": 125.83,
"vat": 5,
"price_with_vat": 151.0,
"date_from": 1707429600,
"date_to": 1709157600,
"multiplicity": 0,
"is_promo": false,
"is_new": false,
"is_public": false,
"is_surcharge": false,
"is_bestseller": false
}
]
}
],
"prods":
[]
}
]
}
]
Об’єкт XTicketBody
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
docID |
long |
ідентифікатор документа |
|
transactionType |
int |
тип транзакції Для EDI:
Для ЕТТН v3: значення співпадають з sub_status_id |
|
type |
int |
тип квитанції |
|
version |
int |
версія; використовується для підрахунку кількості анулювань |
|
content |
byte[] |
вміст тіла квитанції |
|
base64content |
String |
вміст тіла квитанції в BASE64 |
Об’єкт XTicket
В масиві даних об'єктів передаються квитанції документа.
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
docID |
long |
ідентифікатор документа |
|
transactionType |
int |
тип транзакції |
|
version |
int |
версія; використовується для підрахунку кількості анулювань |
|
documentType |
int |
|
|
date |
long |
дата/час транзакції (у форматі UNIX TimeStamp) |
|
uuid |
UUID |
ідентифікатор документообігу (однаковий у межах ланцюжка) |
|
senderID |
long |
ідентифікатор відправника |
|
recipientID |
long |
ідентифікатор отримувача |
|
sosID |
int |
ідентифікатор провайдера документообігу |
|
status |
String |
статус квитанції
|
|
bodys |
List<XTicketBody> |
масив об’єктів; тіла квитанцій |
JSON приклад
[
{
"docID": 3788,
"transactionType": 1,
"version": 1,
"documentType": 59,
"date": 1635410558,
"uuid": "96c9669f-72eb-4a62-aba5-ccc0cf2b4557",
"senderID": 13200757,
"recipientID": 15399,
"sosID": 0,
"status": "00000100",
"bodys": [
{
"docID": 3788,
"transactionType": 1,
"type": 1,
"version": 1
}
]
},
{
"docID": 3788,
"transactionType": 2,
"version": 1,
"documentType": 59,
"date": 1635410741,
"uuid": "648b527c-6a7e-4e50-bc14-8ae6b6b51734",
"senderID": 15399,
"recipientID": 13200757,
"sosID": 0,
"status": "00010000",
"bodys": [
{
"docID": 3788,
"transactionType": 2,
"type": -1,
"version": 1
},
{
"docID": 3788,
"transactionType": 2,
"type": 1,
"version": 1
}
]
}
]
Об’єкт XDocAttachmentSign
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
attachmentId |
long |
id вкладення |
|
identifierId |
long |
id запису |
|
crc32hash |
long |
хеш контрольної суми підпису (CRC32 кодування) |
|
signerUUID |
String |
унікальний ідентифікатор підписанта |
|
signBody |
transient byte[] |
байтовий масив тіла підпису |
Об’єкт XDocAttachment
В даному об'єкті передаються дані файла-вкладення.
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id вкладення |
|
docUUID |
UUID |
унікальний ідентифікатор документа |
|
attachmentUUID |
UUID |
унікальний ідентифікатор вкладення |
|
identifierId |
long |
ідентифікатор (id запису) |
|
fileName |
String |
найменування файлу |
|
createDate |
long |
дата створення вкладення; формат unix timestamp |
|
type |
String |
тип вкладення; це може бути числове значення (1-25) з довідника DICT.01.10 |
|
status |
int |
статус реєстрації в ЦБД
|
|
creatorUUID |
UUID |
GLN, від імені якого додається вкладення |
|
base64content |
String |
зміст вкладення в BASE64 |
|
content |
transient byte[] |
байтовий масив контенту |
|
signs |
List<XDocAttachmentSign> |
масив об’єктів; підписи вкладень (файлів) |
|
signHash |
String |
хеш тіла вкладення (в base64) для формування підпису |
JSON приклад
{
"id": 257,
"docUUID": "b6d1c701-86f3-4d6d-9da5-f7db284f78b9",
"attachmentUUID": "b7e53a94-dd61-4e8b-bc98-44100e434efb",
"fileName": "1613574143975.png",
"createDate": 0,
"type": "image/png",
"signs": [],
"signHash": "6FZSWM0tGh4+P6KoLF1ZA6+wo73WZZgaY3JHQB7hgu8="
}
Масив об’єктів одиниць виміру
Опис параметрів відповіді методу
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор одиниці виміру |
|
name |
String |
найменування |
|
nameOKEI |
String |
найменування згідно державного класифікатора |
|
shortNameOKEI |
String |
сокращение згідно державного класифікатора |
|
OKEI |
String |
код державного класифікатора |
|
KSPOVO |
String |
код КСПОВО |
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"
}
]
Об'єкт Employee
Опис параметрів об’єкта
|
Параметр |
Тип поля 1 |
Формат |
Опис |
|---|---|---|---|
|
uuid |
O/M |
UUID |
ідентифікатор співробітника (параметр обов’язковий для редагування/оновлення даних співробітника) |
|
userId |
O |
long |
id користувача |
|
lastName |
M |
String |
прізвище співробітника |
|
firstName |
M |
String |
ім’я співробітника |
|
middleName |
O |
String |
по батькові співробітника |
|
ipn |
O |
long |
код ІПН співробітника |
|
|
M |
String |
email співробітника |
|
tel |
M |
String |
номер телефону співробітника |
|
docNum |
O |
String |
документ підстава |
|
docDate |
O |
long |
дата документа підстави у форматі UNIX TimeStamp |
|
chatId |
O |
long |
ідентифікатор чату (telegram помічник) |
|
identifiers |
O |
Map<Integer, String> |
додаткові дані; контакти |
|
aliases |
O |
List<String> |
масив аліасів (email) для сервісу Вільний |
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
JSON приклад
[
{
"uuid": "ac970fb6-194f-4801-8fe9-02cbeaa5c03e",
"userId": 2000988,
"lastName": "LastName",
"firstName": "FirstName",
"middleName": "MiddleName",
"ipn": "1111111111",
"email": "1@mail.com",
"tel": "380954443919",
"identifiers": {
"1": "AAA770099"
}
}
]
Об'єкт Company
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
id компанії; число |
|
account |
об’єкт; дані акаунта |
|
|
name |
String |
повне найменування організації або ПІБ індивідуального підприємця |
|
ownership |
String |
форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа |
|
edrpou |
String |
код ЄДРПОУ/КПП; рядок 50 символів |
|
inn |
String |
код ІПН; рядок 50 символів |
|
|
String |
пошта |
|
phone |
String |
№ телефону; рядок 50 символів |
|
ndsNumber |
String |
№ свідоцтва ПДВ; рядок 50 символів |
|
bankAccount |
String |
розрахунковий рахунок банку; рядок 50 символів |
|
bankName |
String |
назва банку; рядок 100 символів |
|
bankMfo |
String |
МФО банку, код-реквізит банку |
|
bankAddress |
String |
адреса банку; рядок 150 символів |
|
users |
List<User> |
масив об’єктів; |
Об'єкт Account
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
accountId |
long |
ID акаунта |
|
companyId |
long |
ID компанії |
|
company |
об’єкт; дані про компанію |
|
|
mfo |
String |
МФО банку |
|
paymentAccount |
String |
розрахунковий рахунок |
|
tariffId |
int |
ID тарифу |
|
fullName |
String |
ПІП користувача |
|
phone |
String |
телефон |
|
|
String |
|
|
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_ |
об’єкт; данні по акаунту в Адмінці |
Об'єкти інформації по торгових мережах
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
число |
ідентифікатор роздрібної мережі |
|
name |
рядок |
ім’я роздрібної мережі |
|
gln |
рядок (13) |
номер GLN організації |
|
aliasName |
рядок |
бренд ТЗ, альтернативне ім’я |
|
type |
число |
тип мережі, 1 - пряма, 2 - роумінгова |
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
}
]
Об’єкт з values даними
Масив об’єктів з values даними використовується для передачі даних віртуального довідника.
Опис параметрів об'єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
Для name=TRANSPORT: |
|||
|
isTrailer |
M |
int |
тип транспортного засобу:
|
|
number |
M |
String |
реєстраційний номер |
|
brand |
M |
String |
марка |
|
model |
M |
String |
модель |
|
type |
M |
String |
тип |
|
color |
O |
String |
колір |
|
Для name=TTN_RESPONSIBLE_PERSONS: |
|||
|
name |
M |
String |
ПІБ |
|
ipn |
M |
String |
IПН |
|
position |
M |
String |
Посада |
|
phone |
M |
String |
Телефон |
|
|
O |
String |
|
|
isPartner |
M |
String |
чи є представником Мережі: 0 -ні, 1-так |
|
companyGln |
M |
String |
GLN компанії |
|
Для name=comdoc_responsible: |
|||
|
surname |
M |
String |
Прізвище |
|
name |
M |
String |
Ім’я |
|
basement |
M |
String |
На підставі |
|
ipn |
M |
String |
ІПН Відповідальної Особи |
|
basementDate |
M |
Дата (РРРР-ММ-ДД) |
На підставі (дата) |
|
unit |
M |
String |
Посада |
|
secondName |
M |
String |
По батькові |
JSON приклад
[
"{\"isTrailer\":0,\"number\":\"AA0000AA\",\"brand\":\"Ferrari\",\"model\":\"F40\",\"type\":\"гоночна\",\"color\":\"червона\"}"
]
[
"{\"name\":\"Антимоскаль Іван Микитович\",\"ipn\":\"1234568445\",\"position\":\"артилерист\",\"phone\":\"380562351849\",\"email\":\"xevesid221@breazeim.com\",\"isPartner\":false,\"companyGln\":\"9864065732181\"}"
]
[
"{\"surname\":\"Шевченко\",\"name\":\"Тарас\",\"basement\":\"Важная\",\"ipn\":\"111111111111\",\"basementDate\":\"2022-09-01\",\"unit\":\"Гендир\",\"secondName\":\"Григорьевич\"}"
]
- [1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Об’єкт UsersDataStorage
Даний об'єкт використовується для передачі значення з віртуального довідника.
Опис параметрів об'єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор довідника |
|
name |
String |
назва довідника; допустимі значення:
|
|
values |
text |
json = набір полів, як значення довідника |
JSON приклад
{
"id": 2,
"name": "TRANSPORT",
"values": {
"16": "{\"isTrailer\":0,\"number\":\"AA0000AA\",\"brand\":\"Ferrari\",\"model\":\"F40\",\"type\":\"гоночна\",\"color\":\"червона\"}",
"17": "{\"isTrailer\":0,\"number\":\"ББ00000ББ\",\"brand\":\"Бусік\",\"model\":\"Старий\",\"type\":\"їздить\",\"color\":\"натуральний\"}"
}
}
Об’єкт Retailer
За допомогою масиву об'єктів Relailer передається інформація по торговельним мережам.
Опис параметрів об’єкта Retailer
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор торгової мережі |
|
accountId |
long |
ідентифікатор акаунту |
|
name |
String |
назва торгової мережі |
|
gln |
String |
GLN торгової мережі |
|
aliasName |
String |
бренд торгової мережі |
|
details |
String |
|
|
type |
int |
тип/ознака торгової мережі (type=1) |
|
countryId |
int |
ідентифікатор країни |
|
startDate |
String |
дата додавання нової мережі (YYYY-MM-DD) |
|
visible |
boolean |
true - мережа відображається в Особистому кабінеті в списку доступних до підключення до Постачальника; false - мережа не відображається в Особистому кабінеті |
|
special |
boolean |
true - в мережі наявні спеціальні умови; false - мережа без спеціальних умов |
|
emails |
String |
список Email (через крапку з комою) отримувачів заявки на підключення до мережі |
|
copyEmails |
String |
список Email (через крапку з комою) для копії |
|
docTypes |
List<Integer> |
список ідентифікаторів підключених типів документів |
|
services |
List<String> |
список сервісів, які використовує мережа |
|
edrpouCode |
String |
код ЄДРПОУ торгової мережі |
|
legalAddress |
String |
юридична адреса торгової мережі |
|
isNewPositions |
boolean |
true - в Особистому кабінеті в мережу можливо Відправити комерційну пропозицію |
JSON приклад
[
{
"id": 17,
"accountId": 6442,
"name": "Метро",
"gln": "4820086630009",
"aliasName": "Метро",
"type": 1,
"visible": true,
"special": false,
"docTypes": [],
"services": [],
"isNewPositions": true
},
{
"id": 13,
"accountId": 1557,
"name": "Ашан",
"gln": "4824027999989",
"aliasName": "Ашан",
"type": 1,
"visible": true,
"special": false,
"docTypes": [],
"services": [],
"isNewPositions": true
},
{
"id": 246,
"accountId": 4530,
"name": "ЕКО-МАРКЕТ",
"gln": "4820129370008",
"aliasName": "ЕКО-МАРКЕТ",
"type": 1,
"visible": true,
"special": false,
"docTypes": [],
"services": [],
"isNewPositions": false
},
{
"id": 7,
"accountId": 9549,
"name": "Варус (ОМЕГА)",
"gln": "9864119011415",
"aliasName": "Варус(ОМЕГА)",
"type": 1,
"visible": true,
"special": false,
"emails": "kutsenkov@edin.ua",
"docTypes": [],
"services": [],
"isNewPositions": true
}
]
Об’єкт User
В даному об'єкті передається інформація про користувача або кількох користувачів .
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
blockedServices |
List<String> |
масив; список коротких назв заблокованих сервісів, наприклад:
|
|
role |
int |
id ролі доступу користувача:
|
|
roleAccess |
int |
id типу ролі:
|
|
accountRole |
int |
id ролі в акаунті |
|
access |
Map<String, AccessStatus> |
масив; доступ |
|
identificators |
List<Identificator> |
масив; ідентифікатори |
|
filters |
List<UserFilterData> |
фільтри |
|
id |
long |
id користувача |
|
accountId |
long |
id акаунта |
|
login |
String |
логін користувача |
|
stringEmails |
String |
список E-mail адрес в одному рядку |
|
phone |
String |
телефон |
|
emails |
List<String> |
масив; E-mail адреси |
|
blocked |
int |
відмітка про блокування; число; 0 - немає, 1 - так |
|
allowFTP |
int |
відмітка доступу до FTP; число; 0 - немає, 1 - так |
|
autoSending |
boolean |
автовідправка документів |
|
statusFile |
int |
створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання |
|
isNotificationEnabled |
int |
повідомлення на E-mail
|
|
isSatusFromOut |
boolean |
|
|
isAdmin |
boolean |
користувач є адміністратором |
|
isSpecXML |
boolean |
включена конвертація файлів |
|
isCerts |
int |
доступ до сервісу Е-Сертифікати; 0 - ні, 1 - так, 2 - так (Адміністратор) |
|
XMLConv |
int |
XML-конвертор
|
|
account |
об’єкт; дані акаунта |
|
|
companies |
List<Company> |
масив об’єктів; дані компаній |
|
employee |
об’єкт; дані співробітника |
|
|
isStatusNotification |
boolean |
статус повідомлення |
|
isPasswordChange |
boolean |
зміна паролю |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація; 0-ні, 1-так |
|
statusNotifyTypes |
List<Integer> |
масив; типи статусів |
|
otherInfo |
UserOtherInfo |
об’єкт; додаткове інфо |
JSON приклад для передачі даних одного користувача
{
"blockedServices": [],
"role": 0,
"roleAccess": 0,
"accountRole": 4,
"access": {},
"identificators": [],
"filters": [],
"id": 77016,
"accountId": 40692,
"login": "FelexSpec1",
"stringEmails": "docerrors@edi-n.com",
"emails": [
"docerrors@edi-n.com"
],
"blocked": 0,
"allowFTP": 1,
"autoSending": true,
"statusFile": 0,
"isNotificationEnabled": 4,
"isSatusFromOut": false,
"isAdmin": false,
"isSpecXML": false,
"isCerts": 0,
"XMLConv": 0,
"account": {},
"employee": {},
"isStatusNotification": false,
"isPasswordChange": false,
"isSpecification": 1,
"statusNotifyTypes": [],
"otherInfo": {
"needOriginalFilename": 0
}
}
JSON приклад для передачі даних кількох користувачів
[
{
"blockedServices": [],
"role": 2,
"roleAccess": 0,
"accountRole": 127,
"access": {},
"identificators": [],
"filters": [],
"id": 90688,
"accountId": 40692,
"login": "g1@gmail.com",
"stringEmails": "g1@gmail.com",
"phone": "380992369658",
"emails": [
"g1@gmail.com"
],
"blocked": 0,
"allowFTP": 0,
"autoSending": false,
"statusFile": 0,
"isNotificationEnabled": 1,
"isSatusFromOut": false,
"isAdmin": true,
"isSpecXML": false,
"isCerts": 2,
"XMLConv": 0,
"account": {
"id": 40692,
"name": "\"Тестова мережа - EDIN\"",
"ownership": "ТОВ",
"inn": "#",
"kpp": "34554363",
"mail": "kozlenkoy@edi-n.com",
"identificators": [],
"phone": "0443590112",
"ndsNumber": "#",
"users": [],
"billingMail": "kozlenkoy@edi-n.com",
"bankName": "#",
"bankAccount": "#",
"bankMfo": "#",
"bankAddress": "#",
"isOffert": false,
"country": "UA",
"address": "м. Київ, вул. Михайла Донця, буд.6",
"legalAddress": "м. Київ, вул. Михайла Донця, буд.6",
"factAddress": "м. Київ, вул. Михайла Донця, буд.6",
"directorName": "Франко І.Я.",
"tariffVersion": 1,
"directorPosition": "Директор",
"registrationDate": "2020-08-17 00:00:00",
"allowUnsignedComdoc": 0,
"allowUnsignedCondra": 0,
"platform": "FELEX",
"autoProlongation": true,
"docBasisForNTM": 0,
"isSignConfirm": 0,
"sessionsTTL": 3600,
"companies": []
},
"employee": {
"uuid": "3492a46f-998c-4aeb-990c-0293a8d59067",
"userId": 90688,
"lastName": "Прізвище",
"firstName": "Ім'я",
"email": "g1@gmail.com",
"tel": "380992369658",
"docDate": 0,
"identifiers": {},
"aliases": []
},
"isStatusNotification": false,
"isPasswordChange": false,
"isSpecification": 0,
"statusNotifyTypes": []
}
]
Об’єкт XDistribexSurcharge
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
surcharge |
boolean |
відмітка про надбавку |
|
producer_id |
long |
id Продавця (Виробника) |
|
distributor_id |
long |
id Покупця (Дистрибʼютора) |
|
distributor_gln |
String |
GLN Покупця (Дистрибʼютора) |
|
product_id |
long |
id товарної позиції |
|
barcode |
String |
штрихкод товарної позиції |
|
article |
String |
артикул товарної позиції |
Приклад запиту
[
{
"distributor_gln": "1234567890123",
"barcode" : "123000321",
"article" : "ART01",
"product_id" : 101,
"surcharge" : true
},
{
"distributor_gln": "1234567890123",
"barcode" : "123000322",
"article" : "ART02",
"product_id" : 102,
"surcharge" : true
}
]
Приклад відповіді
{
"surcharge": false,
"producer_id": 13200791,
"distributor_id": 13200793,
"product_id": 149,
"barcode": "4820022867421",
"article": "7127"
}
Об’єкт Quotas
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
quota |
double |
квота |
|
produser_id |
long |
ідентифікатор компанії-Продавця (Виробника) |
|
distrib_id |
long |
ідентифікатор компанії-Покупця (Дистрибʼютора) |
|
distrib_gln |
String |
GLN компанії-Покупця (Дистрибʼютора) |
|
product_id |
long |
ідентифікатор товару |
|
gtin |
String |
штрихкод |
|
name |
String |
назва компанії-Покупця (Дистрибʼютора) |
Приклад запиту
[
{
"distrib_gln": "9864065732327",
"gtin": "4820022867438",
"name": "Dist_Test_1",
"quota": 100.201
},
{
"distrib_gln": "9864065732334",
"gtin": "4820022867421",
"name": "Dist_Test_2",
"quota": 310.118
}
]
Приклад відповіді
{
"quota": 25,
"produser_id": 13200791,
"distrib_id": 13200795,
"product_id": 149,
"gtin": "4820022867421"
}
Об’єкт Identificator
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
guid |
String |
GUID організації |
|
taxNum |
String(50) |
Податковий ідентифікаційний номер |
|
ndsNum |
String(50) |
№ свідоцтва ПДВ |
|
manager |
String(100) |
ПІБ менеджера |
|
accountant |
String(100) |
ПІБ бухгалтера |
|
id |
long |
GLN ID |
|
gln |
String(13) |
GLN організації |
|
companyId |
long |
id акаунта |
|
retailerId |
long |
id мережі (ритейлера) |
|
isUzdAts |
int |
ЮЗД від АТС; 0-ні, 1-так |
|
isFinCrypt |
int |
шифрування FINDOC; 0-ні, 1-так |
|
countryId |
int |
ідентифікатор країни |
|
isERNN |
int |
схема обробки DECLAR; 0 - надсилання отримувачу тільки після успішної реєстрації в реєстрі, 1 - реєстрація після перевірки отримувачем, 3 - надсилання отримувачу без реєстрації |
|
name |
String(100) |
назва організації |
|
nameEn |
String |
назва організації латинницею |
|
companyType |
String(5) |
форма власності: jur - Юридична особа, fiz - Фізична особа |
|
companyInn |
String(50) |
код ІПН компанії |
|
companyKpp |
String(50) |
код ЄДРПОУ/КПП |
|
companyOgrn |
String(15) |
Основний Державний Реєстраційний Номер |
|
companyTaxDepartmentID |
String |
ідентифікатор відділення податкової інспекції |
|
dirLastName |
String(150) |
прізвище директора |
|
dirFirstName |
String(150) |
ім’я директора |
|
director |
String(100) |
ПІБ директора |
|
apartment |
String(20) |
квартира |
|
zip |
String(20) |
поштовий індекс |
|
katottg |
String(20) |
код КАТОТТГ |
|
city |
String(50) |
місто |
|
street |
String(100) |
назва вулиці |
|
regionCode |
String(3) |
код регіону |
|
bankName |
String(100) |
назва банку |
|
bankMfo |
String |
МФО банку, код-реквізит банку |
|
phone |
String(50) |
№ телефону |
|
bankAccount |
String(50) |
розрахунковий рахунок банку |
|
otherInfo |
String |
коментарі |
|
|
String(255) |
|
|
metroCode |
String(20) |
код точки доставлення |
|
IBAN |
String |
IBAN (англ. International Bank Account Number) |
|
district |
String |
назва району |
|
dpiCReg |
String |
регіон/область податкової |
|
dpiCRaj |
String |
район (по регіону) прив’язки до податкової |
|
account |
Account_ |
id акаунту |
|
isListex |
boolean |
підключений довідник Listex |
|
isDeclarDateNumRequired |
boolean |
обов’язковість № і дати ПН в ТН (МЕТРО) |
|
distribexUser |
int |
користувач сервісу; 1-Виробник; 2-Дистриб’ютор |
|
isWithoutTax |
boolean |
неплатник ПДВ |
|
additionalInfo |
IdentificatorAdditionalInfo_ |
додаткова інформація |
|
taxSource |
int |
Код ознаки джерела податкового номера
|
|
driverLicense |
String |
номер водійського посвідчення |
|
isDriver |
boolean |
має роль Водій (робота з ТТН та коригуючими Актами) |
|
isSignConfirm |
int |
gln підтверджений КЕП (0-ні; 1-так) |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація (0-ні; 1-так) |
|
isCompany |
int |
атрибут; Основний GLN компанії (0-ні; 1-так) |
|
parentId |
long |
значення Основного GLN компанії |
|
parentIdentificator |
Identificator |
дані Основного GLN (за наявності) |
Приклад запиту
[
{
"manager": "#",
"id": 13200791,
"gln": "9864065732303",
"companyId": 32657,
"retailerId": 0,
"isUzdAts": 0,
"isFinCrypt": 0,
"countryId": 2,
"isERNN": 0,
"name": "PRO_Test",
"companyType": "fiz",
"companyInn": "1010101016",
"companyKpp": "34554363",
"zip": "996633",
"city": "г. Киев",
"street": "вул. Трудітся, 7",
"phone": "380696969696",
"otherInfo": "[]",
"IBAN": "UA696456000000147852369000696",
"dpiCReg": 26,
"dpiCRaj": 1,
"isListex": true,
"isDeclarDateNumRequired": true,
"distribexUser": 1,
"isWithoutTax": false,
"taxSource": 0,
"isDriver": false,
"isSignConfirm": 1,
"isSpecification": 0,
"isCompany": 0,
"isTemporary": 0,
"parentId": 13200757,
"constructorGroupID": 0
}
]
Об’єкт XDistribexInvitation
Опис параметрів обʼєкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
-/M |
long |
ідентифікатор запрошення; параметр обов’язковий при оновленні запрошення |
|
userId |
long |
ідентифікатор користувача Продавця (Виробника) |
|
|
producer |
long |
ідентифікатор Продавця (Виробника) |
|
|
buyerContact |
O/M |
String |
контакт (email або мобільний номер телефону) Покупця (Дистриб’ютора); параметр обов’язковий при масовому надсиланню запрошень |
|
buyerIPN |
O |
String |
ЄДРПОУ / ІПН Покупця (Дистриб’ютора) |
|
status |
int |
статус запрошення:
|
|
|
date |
long |
дата/час надсилання запрошення (у форматі Unix timestamp) |
|
|
comment |
String |
текстовий коментар, що додається при відхиленні запрошення |
|
|
attachmentId |
long |
ідентифікатор вкладення (pdf-файлу) - інформаційного листа від Продавця |
|
|
attachment |
transient byte[] |
контент вкладення (pdf-файлу) |
|
|
producerId |
об’єкт; ідентифікатори Продавця (Виробника) |
-
[1] - під визначенням колонки Тип мається на увазі скорочене позначення:
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
Приклад запиту
[
{
"id": 1249,
"userId": 50206659,
"producer": 13200791,
"buyerContact": "maxecid823@craftapk.com",
"buyerIPN": "125365845",
"status": 0,
"date": 1729004947,
"attachmentId": 37,
"producerId":
{
"manager": "#",
"id": 13200791,
"gln": "9864065732303",
"companyId": 32657,
"retailerId": 0,
"isUzdAts": 0,
"isFinCrypt": 0,
"countryId": 2,
"isERNN": 0,
"name": "PRO_Test",
"companyType": "fiz",
"companyInn": "1010101016",
"companyKpp": "34554363",
"zip": "996633",
"city": "г. Киев",
"street": "вул. Трудітся, 7",
"phone": "380696969696",
"otherInfo": "[]",
"IBAN": "UA696456000000147852369000696",
"dpiCReg": 26,
"dpiCRaj": 1,
"isListex": true,
"isDeclarDateNumRequired": true,
"distribexUser": 1,
"isWithoutTax": false,
"taxSource": 0,
"isDriver": false,
"isSignConfirm": 1,
"isSpecification": 0,
"isCompany": 0,
"isTemporary": 0,
"parentId": 13200757,
"constructorGroupID": 0
}
}
]
Обʼєкт Limits
Опис параметрів обʼєкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
credit_limit |
float (10,4) |
кредитний ліміт |
|
max_pack_qty |
число позитивне (10) |
максимальна кількість коробок / ящиків |
|
max_pallet_qty |
число позитивне (10) |
максимальна кількість палет |
|
max_pos_qty |
число позитивне (10) |
Макс. кількість товарних позицій |
|
max_sum_nds |
float (10,4) |
максимальна сума замовлення з ПДВ |
|
max_sum_without_nds |
float (10,4) |
максимальна сума замовлення без ПДВ |
|
max_weight |
float (13,3) |
максимальна вага замовлення, кг |
|
min_sum_nds |
float (10,4) |
мінімальна сума замовлення з ПДВ |
|
min_sum_without_nds |
float (10,4) |
мінімальна сума замовлення без ПДВ |
|
multiplicity_packing |
int |
кратність коробці/ящику; 0-ні, 1-так |
|
surcharge_rate |
float (10,2) |
Тариф для надбавки |
|
multiplicity_min_order_qty |
int |
Кратність мінімальній кількості одиниць; 0-ні, 1-так |
|
balance_quota_control |
int |
Контроль залишків та квот; 0-ні, 1-так. За balance_quota_control=0 Покупець може замовити більше встановленого залишку та/або квоти |
|
max_return_days |
число позитивне (3) |
Максимальна кількість днів для повернення товару |
Приклад запиту
{
"9864065732327": {
"credit_limit": "25005678.0124",
"max_pack_qty": "11",
"max_pallet_qty": "3",
"max_pos_qty": "6",
"max_sum_nds": "20005678.1124",
"max_weight": "50.001",
"min_sum_nds": "1000.0124",
"multiplicity_packing": "1"
}
}
Приклад відповіді
{
"max_pallet_qty": "3",
"max_weight": "50.001",
"max_pack_qty": "11",
"max_sum_nds": "20005678.1124",
"credit_limit": "25005678.0124",
"multiplicity_packing": "0",
"min_sum_nds": "1000.0124",
"max_pos_qty": "6"
}
Обʼєкт XTag
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
id |
|
long |
id тега |
|
name |
|
String |
назва тега |
|
shortName |
O |
String |
коротка назва тега (необов'язково) |
Приклад запиту
[
{
"id": "ід тега",
"name": "назва тега"
}
]
-
[1] - Під визначенням колонки Тип мається на увазі скорочене позначення:
-
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-
-
-
Об'єкт EttnV3Event
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
entityId |
String |
id події |
|
entityType |
String |
тип події |
|
ettnId |
String |
id ТТН документа в ЦБД (= external_doc_id) |
|
entityStatus |
String |
статус події |
|
timestamp |
String |
дата/час події |
|
documentId |
String |
id документа |
|
actorIdentifier |
String |
ЄДРПОУ/ІПН компанії |
JSON приклад
[
{
"entityId": "050ae960-1a34-4720-ad8b-19e03d87ff03",
"entityType": "ETTN",
"ettnId": "050ae960-1a34-4720-ad8b-19e03d87ff03",
"entityStatus": "PLANNED",
"timestamp": "2022-01-10T15:31:13.863Z",
"documentId": "bb1f6c52-273f-4442-97ee-6f28340cb30d",
"actorIdentifier": "12345678"
},
{
"entityId": "40123cf2-498c-4386-ba2d-72f190accbfb",
"entityType": "ETTN",
"ettnId": "40123cf2-498c-4386-ba2d-72f190accbfb",
"entityStatus": "PLANNED",
"timestamp": "2022-01-10T16:22:13.995Z",
"documentId": "abf60787-e884-418b-8718-2be189081287",
"actorIdentifier": "12345678"
},
{
"entityId": "20bf123b-1b6b-4707-b728-f62e40f3b0e5",
"entityType": "ETTN",
"ettnId": "20bf123b-1b6b-4707-b728-f62e40f3b0e5",
"entityStatus": "PLANNED",
"timestamp": "2022-01-11T08:05:37.896Z",
"documentId": "c59aab2b-8d6e-4f08-9203-0d1a0d7718b4",
"actorIdentifier": "12345678"
},
{
"entityId": "cf53985a-8af8-46e2-bd28-de50eb84421d",
"entityType": "ETTN",
"ettnId": "cf53985a-8af8-46e2-bd28-de50eb84421d",
"entityStatus": "PLANNED",
"timestamp": "2022-01-11T08:08:22.232Z",
"documentId": "c62fe08b-5837-4acc-b812-70bb5a464447",
"actorIdentifier": "12345678"
}
]
Об'єкт XEvent (Подія за документом)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
id |
long |
ідентифікатор події |
|
docId |
long |
id документа |
|
type |
int |
тип події:
|
JSON приклад об'єкту:
{
"id": 25,
"docId": 3229,
"type": 2
}
JSON приклад масиву об'єктів:
-
-
[ { "id": 23, "docId": 2227, "type": 4 }, { "id": 24, "docId": 3228, "type": 2 }, { "id": 25, "docId": 3229, "type": 2 } ]
-
Об'єкт DocumentEvent
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
event |
об’єкт; дані події |
|
|
doc |
об’єкт; дані документа (можуть бути відсутні при типі події (XEvent.type) = 6 (чернетку видалено) |
Об'єкт EventsStorageQueryResult (результати пошуку подій за документами)
Опис параметрів об’єкта
|
Параметр |
Формат |
Опис |
|---|---|---|
|
lastEventId |
long |
ідентифікатор останньої події |
|
items |
List<DocumentEvent> |
масив об’єктів; дані подій та документів |
JSON приклад:
{
"lastEventId": 26,
"items": [
{
"event": {
"id": 22,
"docId": 2229,
"type": 4
},
"doc": {
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
},
"content": {
"type": {
"id": 1,
"name": "content"
}
}
}
},
"attachments": [
{
"id": 92,
"docUUID": "c4893135-155c-4c77-a4a7-00145e819217",
"attachmentUUID": "205d3da1-59e0-427d-bd5e-e65f2081d629",
"fileName": "dobroe_utro.jpg",
"createDate": 1669996758,
"type": "image/jpeg",
"signs": [],
"signHash": "W/kdOwRWzCxNIq230Q5lLbMpxYvUhwQHwH8VlTmFfHE="
}
],
"comments": [],
"doc_id": 2229,
"doc_uuid": "c4893135-155c-4c77-a4a7-00145e819217",
"uuidSender": "9864065732181",
"uuidReceiver": "9864065732211",
"uuidReceivers": [
"9864065732211"
],
"docNumber": "882_3",
"dateCreated": 1599117969,
"dateChanged": 1669996758,
"dateRead": 0,
"docDate": 1599080400,
"chain_id": 661,
"chain_uuid": "10d8731d-8575-4d01-9de3-5d7a880dfe07",
"family": 1,
"hash": "FC38F425650BF9CAA0ACB6583B529F35",
"type": {
"type": 30,
"title": "condra",
"description": "Не структурированный документ "
},
"status": {
"status": 4,
"title": "inbox"
},
"exchange_status": "000000000000000000000001",
"is_archive": false,
"chain": {
"id": 661,
"uuid": "10d8731d-8575-4d01-9de3-5d7a880dfe07",
"packageID": 0,
"type": 0,
"docsCount": 1,
"lastInDocID": 2229,
"lastOutDocID": 0,
"partnerId": 17264,
"important": false,
"status": {
"status": 4,
"title": "inbox"
},
"visualStatus": 0,
"archive": false,
"childs": [],
"hash": "DC66EF41FFC2E4EED451D6EE28104973"
},
"extraFields": {
"varn": "3fdd4faf-df46-49c4-9e43-7ac94b5b64a2",
"partner_id": "17264",
"sender": "9864065732181",
"doc_num": "882_3",
"file_name": "dobroe_utro.jpg",
"doc_date": "1599080400",
"recipient": "9864065732211",
"action": "1",
"trans_id": "fc1eba11-1ddb-40dc-8659-6bec23904862"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
}
}
]
}
Об'єкт EventsStorageQuery (параметри пошуку подій)
Опис параметрів об’єкта
|
Параметр |
Тип 1 |
Формат |
Опис |
|---|---|---|---|
|
fromId |
M |
long |
ідентифікатор події, після якої (починаючи з наступної) необхідно отримати список наступних подій |
|
limit |
O |
int |
кількість подій, що будуть повернені за пошуком. Max=100 (за замовчуванням) |
|
skipTypes |
O |
List<Integer> |
масив; типи подій, що НЕ потрібно враховувати при пошуку
|
|
loadBody |
O |
boolean |
передавати у відповіді пошуку тіло документа |
|
loadComments |
O |
boolean |
передавати у відповіді пошуку коментарі документа |
|
loadStatuses |
O |
boolean |
передавати у відповіді пошуку статуси документа |
|
loadTags |
O |
boolean |
передавати у відповіді пошуку теги документа |
|
loadChain |
O |
boolean |
передавати у відповіді пошуку дані пов’язаного ланцюжка документів |
|
loadAttachments |
O |
boolean |
передавати у відповіді пошуку вкладення до документа |
JSON приклад:
{
"fromId": 21,
"loadBody": true,
"loadComments": true,
"loadStatuses": true,
"loadTags": true,
"loadChain": true,
"loadAttachments": true
}
- 1 - Під визначенням колонки Тип поля мається на увазі скорочене позначення:
-
-
M (mandatory) — обов’язкові до заповнення поля;
-
O (optional) — необов’язкові (опціональні) до заповнення поля.
-