Об'єкт 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[] (повна ієрархія) |