Об'єкт UGIResponse
Відповідь UGI зі вкладеною структурою (відповідає файлу sample.json із реєстру схем)
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| ugiId | string or null | Внутрішній ідентифікатор УГІ в DES |
| ugiCode | string or null | Унікальний код УГІ |
| parentUgi | string or null | Код батьківського УГІ, якщо УГІ вкладене |
| desState | string or null | Поточний стан УГІ в DES |
| eExciseId | string or null | Ідентифікатор УГІ в системі еАкциз |
| eExciseStatus |
UGIStatuses string Enum: |
|
| eExciseStatusText | string or null | Текстове подання статусу УГІ в еАкцизі |
| groupLevel | integer($int32) | Рівень УГІ в ієрархії |
| groupTypeCode | integer($int32) | Код типу УГІ |
| readableCode | string or null | Людиночитаний код УГІ; для застарілих записів може бути null |
| description | string or null | Опис УГІ |
| otherInfo | string or null | Додаткова інформація про УГІ |
| countryCode | string or null | |
| firstOwner |
Об'єкт FirstOwnerResponse |
|
| current | Об'єкт CurrentResponse | Інформація про поточне місцезнаходження |
| packer | Об'єкт PackerResponse | |
| recipient | Об'єкт RecipientResponse | Інформація про отримувача (DES-1096: додано ObjectCode) |
| articles | Масив об'єктів ArticleResponse or null | Артикули, що містяться в УГІ |
| partialLoaded | boolean | Ознака часткового завантаження даних УГІ |
| documentId | string or null | Ідентифікатор пов’язаного електронного акцизного документа |
| documentType | string or null | Тип пов’язаного електронного акцизного документа |
| documentState | string or null | Поточний стан пов’язаного електронного акцизного документа |
| createdBy | string or null | Ідентифікатор користувача або системи, що створила УГІ |
| createdAt | string($date-time) | Дата й час створення УГІ. |
| updatedBy | string or null | Ідентифікатор користувача або системи, що востаннє оновила УГІ |
| updatedAt | string($date-time) or null | Дата й час останнього оновлення УГІ |
| deletedBy | string or null | Ідентифікатор користувача або системи, що видалила УГІ |
| deletedAt | string($date-time) or null | Дата й час видалення УГІ |
| allowedActions | [ nullable: true |
Операції, дозволені для УГІ у його поточному стані |
| items | Об'єкт ItemsResponse | DES-796: Елементи можуть містити або UgiCodeResponse[] (прості коди), або UGIResponse[] (повна ієрархія) |
JSON приклад:
{
"ugiId": "string",
"ugiCode": "string",
"parentUgi": "string",
"desState": "string",
"eExciseId": "string",
"eExciseStatus": "Active",
"eExciseStatusText": "string",
"groupLevel": 0,
"groupTypeCode": 0,
"readableCode": "string",
"description": "string",
"otherInfo": "string",
"countryCode": "string",
"firstOwner": {
"counterpartyId": "string",
"businessUnitId": "string",
"operatorCode": "string",
"objectCode": "string",
"objectType": "string",
"country": "string"
},
"current": {
"custodian": {
"counterpartyId": "string",
"businessUnitId": "string",
"operatorCode": "string",
"objectCode": "string"
},
"counterpartyId": "string",
"businessUnitId": "string",
"operatorCode": "string",
"objectCode": "string"
},
"packer": {
"custodianOperatorId": "string",
"isCustodian": true
},
"recipient": {
"businessUnitId": "string",
"objectCode": "string"
},
"articles": [
{
"articleId": "string",
"quantity": 0,
"barcode": "string"
}
],
"partialLoaded": true,
"documentId": "string",
"documentType": "string",
"documentState": "string",
"createdBy": "string",
"createdAt": "2026-11-18T15:39:42.663Z",
"updatedBy": "string",
"updatedAt": "2026-11-18T15:39:42.663Z",
"deletedBy": "string",
"deletedAt": "2026-11-18T15:39:42.663Z",
"allowedActions": [
"string"
],
"items": {
"ems": [
{
"stampId": "string",
"uniqueIdentifier": "string",
"barcode": "string",
"articleId": "string",
"readableCode": "string"
}
],
"uis": [
{
"stampId": "string",
"uniqueIdentifier": "string",
"articleId": "string",
"barcode": "string"
}
],
"ugi": [
"string"
]
}
}