Робота з API продукту Е-Акциз
- Алгоритми роботи з API продукту Е-Акциз
- Клієнти
- Довідники
- Протоколи сканування
- Перелік методів API для протоколу сканування
- Знайти протоколи за зв'язком операційного документа GET /api/des-scan/protocols/lookup
- Створити новий протокол сканування POST /api/des-pscan/protocols
- Отримати протокол сканування за protocolId GET /api/des-pscan/protocols/{protocolId}
- Оновити протокол сканування PUT /api/des-pscan/protocols/{protocolId}
- Видалити протокол сканування за protocolId DELETE /api/des-pscan/protocols/{protocolId}
- Створити позиції протоколу POST /api/des-pscan/protocols/{protocolId}/items
- Отримати позиції протоколу GET /api/des-pscan/protocols/{protocolId}/items
- Видалити позиції для протоколу сканування DELETE /api/des-pscan/protocols/{protocolId}/items
- Частково оновити кількість позицій протоколу PATCH /api/des-pscan/protocols/{protocolId}/items
- Оновити позиції протоколу PUT /api/des-pscan/protocols/{protocolId}/items
- Перевірити позиції протоколу POST /api/des-pscan/protocols/validate-items
- POST /api/des-pscan/protocols/resolve-items
- Закрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/close
- Відкрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/open
- Валідація протоколу сканування POST /api/des-pscan/protocols/{protocolId}/action/validate
- Отримати документи для повернення протоколу сканування GET /api/des-pscan/protocols/{protocolId}/return-documents
- Корекція протоколу сканування POST /api/des-pscan/protocols/{protocolId}/action/correction
- Отримати товарні документи протоколу сканування GET /api/des-pscan/protocols/{protocolId}/operation-documents
- Додати товарні документи до протоколу сканування POST /api/des-pscan/protocols/{protocolId}/operation-documents
- Повністю замінити товарний документ у протоколі сканування PUT /api/des-pscan/protocols/{protocolId}/operation-documents/{documentId}
- Видалити товарний документ з протоколу сканування DELETE /api/des-pscan/protocols/{protocolId}/operation-documents/{documentId}
- Скорочені результати валідації GET /api/des-pscan/protocols/validation-results/brief
- Детальні результати валідації GET /api/des-pscan/protocols/validation-results/protocol/detail
- GET /api/des-pscan/protocols/validation-results/eed/detail
- GET /api/des-pscan/protocols/validation-results/operational/detail
- GET /api/des-pscan/protocols/validation/matching-data
- Каса
- Перевірка акцизних марок /api/des-pos/validate
- Опублікувати подію продажу або анулювання після фіскалізації POST /api/des-pos/block
- Підписання
- Запустити асинхронну дію підписання POST /api/des-sign/v2/signature/actions/{actionName}
- Отримати стан дії підписання GET /api/des-sign/v2/signature/actions/{actionName}/status
- Отримати заявку на підпис GET /api/des-sign/v2/signature/signature-requests/{requestId}
- Inbox заявок на підпис GET /api/des-sign/v2/signature/signature-requests
- Подати підписи за заявкою POST /api/des-sign/v2/signature/signature-requests/{requestId}/signatures
- Відхилити заявку на підпис POST /api/des-sign/v2/signature/signature-requests/{requestId}/reject
- Створити або оновити клієнта ENIGMA POST /api/des-sign/v2/signature/clients
- УГІ
- Перевірка складу УГІ POST /api/v1/{ugiCode}/actions/validate
- Перелік створених УГІ GET /api/v1/ugi
- Отримати УГІ за ugiCode DES-796 GET /api/des-ugi/ugis/{ugiCode}
- АЕД
- Отримання АЕД GET /api/v1/eed/{docId}
- Перевірка складу АЕД POST /api/v1/eed/{docId}/actions/validate
- Об'єкти API продукту Е-Акциз
- Об'єкт externalIds (masterdata_BusinessUnitExternalIds)
- Об'єкт item (masterdata_BusinessUnit)
- Об'єкт business (masterdata_Business)
- Об'єкт legalUnit (masterdata_LegalUnit)
- Об'єкт macroRegion (masterdata_MacroRegion)
- Об'єкт externalIds (masterdata_LegalUnitExternalIds)
- Об'єкт subBusiness (masterdata_SubBusiness)
- Об'єкт supervisorsGroup (masterdata_SupervisorsGroup)
- Об'єкт included (masterdata_BusinessUnitIncluded)
- Об'єкт items (UgiItemResponse)
- Масив UGIs list
- Об'єкт EMItem
- Дані УГІ
- Об'єкт (EedCounterpartyProps)
- Об'єкт counterparties
- Об'єкт items (для АЕД)
- Дані АЕД
- Об'єкт relations
- Об'єкт ProtocolLookupOperationDocument
- Об'єкт CreateScanningProtocolItem
- Об'єкт CreateScanningProtocolRequestItem
- Об'єкт CreateScanningProtocolOperationDocumentRequest
- Об'єкт CreateScanningProtocolRequest
- Об'єкт JsonNodeOptions
- Об'єкт JsonNode
- Об'єкт CreatedScanningProtocolItem
- Об'єкт EedValidationInfo
- Об'єкт FailedItemDetail
- Об'єкт FailedItemValidationResult
- Об'єкт FillScanningProtocolRequest
- Об'єкт FillScanningProtocolResponse
- Об'єкт HttpValidationProblemDetails
- Об'єкт InventoryArticleDetail
- Об'єкт InventoryFailedTokenGroup
- Об'єкт InventoryItemsDetailsResponse
- Об'єкт OperationDocumentItemRequest
- Об'єкт OperationDocumentItemResponse
- Об'єкт OperationDocumentRequest
- Об'єкт OperationDocumentResponse
- Об'єкт OperationalDocumentValidationInfo
- Об'єкт ProblemDetails
- Об'єкт ProtocolDetailedValidationResponse
- Об'єкт ProtocolItemsListResponse
- Об'єкт ProtocolLookupItem
- Об'єкт ProtocolReturnDocumentResponse
- Об'єкт ProtocolValidationInfo
- Об'єкт ValidationItemsTotal
- Об'єкт ProtocolValidationTotal
- Об'єкт ProtocolValidationResponse
- Об'єкт ResolveItemInput
- Об'єкт ResolveItemResponse
- Об'єкт ResolveItemsRequest
- Об'єкт ScanningProtocolDocumentResponse
- Об'єкт ScanningProtocolItemResponse
- Об'єкт ScanningProtocolOperationDocumentResponse
- Об'єкт ValidationError
- Об'єкт ValidationWarning
- Об'єкт ScanningProtocolValidations
- Об'єкт ScanningProtocolResponse
- Об'єкт ValidateItemInput
- Об'єкт ValidateItemsRequest
- Об'єкт ValidatedItem
- Об'єкт ValidationMatchingDataProtocolInfo
- Об'єкт ValidationMatchingDataRecord
- Об'єкт ValidationMatchingDataResponse
- Об'єкт UpdateScanningProtocolRequest
- Об'єкт UpdateProtocolItemRequest
- Об'єкт ValidateStampsRequest
- Об'єкт ValidationErrorModel
- Об'єкт ExciseCodeValidationResultModel
- Об'єкт ValidateStampsResult
- Об'єкт BlockStampsRequest
- Об'єкт BlockStampsResponse
- Об'єкт CreateSignatureClientRequest
- Об'єкт DocumentForSigning
- Об'єкт ExecuteSigningActionRequest
- Об'єкт RejectSignatureRequest
- Об'єкт SignatureClientResponse
- Об'єкт SubmittedSignatureItem
- Об'єкт SubmitSignaturesRequest
- Об'єкт FirstOwnerResponse
- Об'єкт CustodianResponse
- Об'єкт CurrentResponse
- Об'єкт PackerResponse
- Об'єкт RecipientResponse
- Об'єкт ArticleResponse
- Об'єкт EMResponse
- Об'єкт UIResponse
- Об'єкт ItemsResponse
- Об'єкт UGIResponse
- Об'єкт DeactivateUgisRequest
- Об'єкти API для довідників продукту Е-Акциз
Алгоритми роботи з API продукту Е-Акциз
Клієнти
Довідники
Створити запис у довіднику POST /api/v1/business-units
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/business-units |
|
URL параметри |
tenant (string) - Tenant identifier |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
Об'єкт item (masterdata_BusinessUnit)
|
JSON приклад запиту
{
"item": {
"tenant": "string",
"businessUnitId": "string",
"name": "string",
"parentBusinessUnitId": "string",
"businessId": "string",
"legalUnitId": "string",
"statusId": "string",
"addressId": "string",
"openingDate": "2019-08-24",
"phoneNumber": "string",
"externalIds": {
"sapId": "string",
"counterPartyId": "string"
},
"macroRegionId": "string",
"buldingNumber": "string",
"supervisorsGroupId": "string",
"parentBusinessId": "string",
"subBusinessId": "string"
}
}
RESPONSE
Статус 200.
Об'єкт item (masterdata_BusinessUnit).
Об'єкт included (masterdata_BusinessUnitIncluded)
Протоколи сканування
Перелік методів API для протоколу сканування
PROTOCOL
Створення, отримання, оновлення, видалення протоколів сканування
|
Знайти протоколи за зв'язком операційного документа |
|
|
Створити новий протокол сканування |
|
|
Отримати протокол сканування за protocolId |
|
|
Оновити протокол сканування |
|
|
Видалити протокол сканування за protocolId |
ITEMS
Додавання, перелік, заміна, видалення, перевірка просканованих позицій
|
Створити позиції протоколу |
|
|
Отримати позиції протоколу |
|
|
Видалити позиції для протоколу сканування |
|
|
Частково оновити кількість позицій протоколу |
|
|
Оновити позиції протоколу |
|
|
Перевірити позиції протоколу |
|
ACTIONS
Синхронна перевірка, закриття, відкриття та внутрішня асинхронна перевірка.
|
Закрити протокол сканування за protocolId |
|
|
Відкрити протокол сканування за protocolId |
|
|
Валідація протоколу сканування |
CORRECTION AND RETURNS
Режим коригування та документи для повернення.
|
Отримати документи для повернення протоколу сканування |
|
|
Корекція протоколу сканування |
POST /api/des-pscan/protocols/{protocolId}/action/correction |
OPERATION DOCUMENTS
Додавання, заміна та видалення товарних документів в протоколі.
|
Отримати товарні документи протоколу сканування |
GET /api/des-pscan/protocols/{protocolId}/operation-documents |
|
Додати товарні документи до протоколу сканування |
POST /api/des-pscan/protocols/{protocolId}/operation-documents |
|
Повністю замінити товарний документ у протоколі сканування |
PUT /api/des-pscan/protocols/{protocolId}/operation-documents/{documentId} |
|
Видалити товарний документ з протоколу сканування |
DELETE /api/des-pscan/protocols/{protocolId}/operation-documents/{documentId} |
VALIDATION
Результати перевірки.
|
Скорочені результати валідації |
|
|
Детальні результати валідації |
GET /api/des-pscan/protocols/validation-results/protocol/detail |
|
GET /api/des-pscan/protocols/validation-results/operational/detail |
|
Знайти протоколи за зв'язком операційного документа GET /api/des-scan/protocols/lookup
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-scan/protocols/lookup |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор, чиї протоколи потрібно знайти relationType (string) обов'язково - зв'язок для пошуку. Enum:
relatedCode (string) обов'язково - non-empty Точний ідентифікатор, чутливий до регістру, в межах tenant. Max 255 символів лише для relationType=order; без обмежень за довжиною для relationType=operation-document.
|
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Масив з даними:
| protocolId |
string or null
|
| protocolType |
string or null
|
| protocolStatus |
string or null
|
| operationDocuments |
Array of objects or null (ProtocolLookupOperationDocument)
|
- Статус 400 - Bad request
Масив з даними:
| type |
string or null
|
| title |
string or null
|
| status |
integer or null <int32>
|
| detail |
string or null
|
| instance |
string or null
|
| property name*
additional property
|
any
|
JSON приклад відповіді:
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}
Створити новий протокол сканування POST /api/des-pscan/protocols
Філія чи обʼєкт заголовка поза обмеженням користувача.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор, чиї протоколи потрібно знайти closeProtocol (boolean) необов'язково - |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
Request body |
RESPONSE
- Статус 200 - Created.
Об'єкт ScanningProtocolResponse
- Статус 403 - Forbidden. Філія чи обʼєкт заголовка поза обмеженням користувача.
Отримати протокол сканування за protocolId GET /api/des-pscan/protocols/{protocolId}
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/{protocolId} |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
JSON приклад відповіді
{
"protocolId": "string",
"protocolType": "string",
"operationType": "string",
"protocolStatus": "string",
"ugiCode": "string",
"protocolCreatedBy": "string",
"protocolCreatedAt": "2026-11-16T10:24:53.992Z",
"protocolUpdatedBy": "string",
"protocolUpdatedAt": "2026-11-16T10:24:53.992Z",
"protocolClosedBy": "string",
"protocolClosedAt": "2026-11-16T10:24:53.992Z",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"senderBusinessUnitId": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"receiverBusinessUnitId": "string",
"operatorObjectCode": "string",
"businessUnitId": "string",
"operationDocuments": [
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"operationDocumentId": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
],
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-16T10:24:53.992Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"docs": [
{
"documentId": "string",
"desState": "string",
"validationResult": "string"
}
],
"emValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
},
"generalValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
Оновити протокол сканування PUT /api/des-pscan/protocols/{protocolId}
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/des-pscan/protocols/{protocolId} |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON body |
Об'єкт UpdateScanningProcolRequest |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
- Статус 403 - Forbidden. Новий власник протоколу (філія чи обʼєкт заголовка) поза обмеженням користувача.
- Статус 404 - Not Found.
Видалити протокол сканування за protocolId DELETE /api/des-pscan/protocols/{protocolId}
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/des-pscan/protocols/{protocolId} |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) необов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 204 - No Content.
Масив з даними:
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
Створити позиції протоколу POST /api/des-pscan/protocols/{protocolId}/items
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/items |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор dryRun (boolean) необов'язково |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
об'єкт FillScanningProtocolRequest
JSON приклад запиту:
|
RESPONSE
- Статус 202 - Accepted.
Об'єкт FillScanningProtocolResponse.
- Статус 400 - Bad request
- Статус 404 - Not Found.
Некоректне тіло запиту.
JSON приклад відповіді:
{
"businessUnitId": "string",
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-16T15:46:18.053Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"documentIds": [
"string"
]
}
Отримати позиції протоколу GET /api/des-pscan/protocols/{protocolId}/items
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/items |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор PageSize (integer($int32)) опційно
PageToken (string) опційно ItemType (string) опційно ValidationStatus (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ProtocolItemsListResponse.
JSON приклад відповіді
{
"businessUnitId": "string",
"pageToken": "string",
"totalCount": 0,
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-16T17:20:08.973Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
]
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
Видалити позиції для протоколу сканування DELETE /api/des-pscan/protocols/{protocolId}/items
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/items |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) необов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
обов'язково, масив об'єктів [string] |
RESPONSE
- Статус 204 - No Content.
- Статус 404 - Not Found
Частково оновити кількість позицій протоколу PATCH /api/des-pscan/protocols/{protocolId}/items
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/items |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
масив об'єктів UpdateProtocolItemRequest |
RESPONSE
- Статус 200.
Масив об'єктів CreatedScanningProtocolItem.
- Статус 404 - Not Found.
- Статус 422 - Unprocessable Content.
Оновити позиції протоколу PUT /api/des-pscan/protocols/{protocolId}/items
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/items |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
масив об'єктів CreateScanningProtocolItem
JSON приклад запиту:
|
RESPONSE
- Статус 200.
Об'єкт FillScanningProtocolResponse.
JSON приклад відповіді
{
"businessUnitId": "string",
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-16T17:57:30.132Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"documentIds": [
"string"
]
}
- Статус 404 - Not Found
- Статус 422 - Unprocessable Content
Некоректне тіло запиту.
Перевірити позиції протоколу POST /api/des-pscan/protocols/validate-items
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/validate-items |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
об'єкт ValidateItemsRequest |
RESPONSE
- Статус 200.
Масив об'єктів ValidatedItem.
JSON приклад відповіді
[
{
"exciseCode": "string",
"barcode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"articleId": "string",
"itemType": "string",
"validationStatus": "string",
"validationMessage": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
]
- Статус 400 - Bad request
- Статус 403 - Forbidden. Філія чи обʼєкт заголовка поза обмеженням користувача.
POST /api/des-pscan/protocols/resolve-items
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/resolve-items |
|
URL параметри |
tenant (string) необов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
обов'язково, об'єкт ResolveItemsRequest
JSON приклад запиту:
|
RESPONSE
- Статус 200.
Масив об'єктів ResolveItemResponse.
JSON приклад відповіді
[
{
"index": 0,
"exciseCode": "string",
"readableCode": "string",
"itemType": "string"
}
]
- Статус 422 - Unprocessable Content
Об'єкт HttpValidationProblemDetails.
JSON приклад відповіді
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"errors": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
Закрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/close
Закриває протокол сканування та повертає його оновлений стан.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/action/close |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
JSON приклад відповіді
{
"protocolId": "string",
"protocolType": "string",
"operationType": "string",
"protocolStatus": "string",
"ugiCode": "string",
"protocolCreatedBy": "string",
"protocolCreatedAt": "2026-11-17T09:02:17.778Z",
"protocolUpdatedBy": "string",
"protocolUpdatedAt": "2026-11-17T09:02:17.778Z",
"protocolClosedBy": "string",
"protocolClosedAt": "2026-11-17T09:02:17.778Z",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"senderBusinessUnitId": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"receiverBusinessUnitId": "string",
"operatorObjectCode": "string",
"businessUnitId": "string",
"operationDocuments": [
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"operationDocumentId": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
],
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-17T09:02:17.778Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"docs": [
{
"documentId": "string",
"desState": "string",
"validationResult": "string"
}
],
"emValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
},
"generalValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
}
}
- Статус 404 - Not Found
Відкрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/open
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має бути точною, з урахуванням регістру та в межах tenant; значення не нормалізуються. Для `relationType=order` параметр `relatedCode` може містити щонайбільше 255 символів. Для `relationType=operation-document` додаткові обмеження щодо довжини не застосовуються.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/action/open |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
JSON приклад відповіді
{
"protocolId": "string",
"protocolType": "string",
"operationType": "string",
"protocolStatus": "string",
"ugiCode": "string",
"protocolCreatedBy": "string",
"protocolCreatedAt": "2026-11-17T09:07:28.180Z",
"protocolUpdatedBy": "string",
"protocolUpdatedAt": "2026-11-17T09:07:28.181Z",
"protocolClosedBy": "string",
"protocolClosedAt": "2026-11-17T09:07:28.181Z",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"senderBusinessUnitId": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"receiverBusinessUnitId": "string",
"operatorObjectCode": "string",
"businessUnitId": "string",
"operationDocuments": [
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"operationDocumentId": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
],
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-17T09:07:28.181Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"docs": [
{
"documentId": "string",
"desState": "string",
"validationResult": "string"
}
],
"emValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
},
"generalValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
Валідація протоколу сканування POST /api/des-pscan/protocols/{protocolId}/action/validate
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/action/validate |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) необов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
JSON приклад відповіді
{
"protocols": {
"additionalProp1": {
"successItems": 0,
"failedItems": 0,
"eed": [
"string"
],
"operationalDocuments": [
"string"
],
"operatorObjectCode": "string",
"businessUnitId": "string"
},
"additionalProp2": {
"successItems": 0,
"failedItems": 0,
"eed": [
"string"
],
"operationalDocuments": [
"string"
],
"operatorObjectCode": "string",
"businessUnitId": "string"
},
"additionalProp3": {
"successItems": 0,
"failedItems": 0,
"eed": [
"string"
],
"operationalDocuments": [
"string"
],
"operatorObjectCode": "string",
"businessUnitId": "string"
}
},
"eed": {
"additionalProp1": {
"successItems": 0,
"failedItems": 0
},
"additionalProp2": {
"successItems": 0,
"failedItems": 0
},
"additionalProp3": {
"successItems": 0,
"failedItems": 0
}
},
"operationalDocuments": {
"additionalProp1": {
"successItems": 0,
"failedItems": 0
},
"additionalProp2": {
"successItems": 0,
"failedItems": 0
},
"additionalProp3": {
"successItems": 0,
"failedItems": 0
}
},
"total": {
"protocols": {
"successItems": 0,
"failedItems": 0
},
"eed": {
"successItems": 0,
"failedItems": 0
},
"operationalDocuments": {
"successItems": 0,
"failedItems": 0
}
}
}
- Статус 404 - Not Found
Отримати документи для повернення протоколу сканування GET /api/des-pscan/protocols/{protocolId}/return-documents
Повертає кількість артикулів за новими ЕМ у розрізі АЕД, що є підставою для повернення, разом з їхніми товарними документами. Доступно лише для протоколів з видом операції return та типом sending або receiving; інакше повертає 422. Параметр protocolId ідентифікує протокол, а tenant визначає його орендаря.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/return-documents |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) необов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Масив об'єктів ProtocolReturnDocumentResponse
JSON приклад відповіді
[
{
"documentId": "string",
"documentType": "string",
"operationDocuments": [
"string"
],
"articleId": "string",
"quantity": 0
}
]
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
- Статус 422 - Unprocessable Content.
Об'єкт ProblemDetails
JSON приклад відповіді
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
Корекція протоколу сканування POST /api/des-pscan/protocols/{protocolId}/action/correction
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/action/correction |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
X-Idempotency-Key |
string |
RESPONSE
- Статус 200.
Об'єкт ScanningProtocolResponse
JSON приклад відповіді
{
"protocolId": "string",
"protocolType": "string",
"operationType": "string",
"protocolStatus": "string",
"ugiCode": "string",
"protocolCreatedBy": "string",
"protocolCreatedAt": "2026-11-17T09:46:31.248Z",
"protocolUpdatedBy": "string",
"protocolUpdatedAt": "2026-11-17T09:46:31.248Z",
"protocolClosedBy": "string",
"protocolClosedAt": "2026-11-17T09:46:31.248Z",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"senderBusinessUnitId": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"receiverBusinessUnitId": "string",
"operatorObjectCode": "string",
"businessUnitId": "string",
"operationDocuments": [
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"operationDocumentId": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
],
"items": [
{
"itemId": "string",
"scannedBy": "string",
"scannedAt": "2026-11-17T09:46:31.248Z",
"exciseCode": "string",
"barcode": "string",
"ssccCode": "string",
"readableCode": "string",
"legacyExciseCode": "string",
"quantity": 0,
"itemSource": "string",
"itemType": "string",
"articleId": "string",
"validationStatus": "string",
"validationMessage": "string",
"documentId": "string",
"validations": {
"additionalProp1": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp2": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
},
"additionalProp3": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": "string",
"root": "string"
}
}
}
],
"docs": [
{
"documentId": "string",
"desState": "string",
"validationResult": "string"
}
],
"emValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
},
"generalValidation": {
"errors": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"type": "Business",
"details": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"warnings": [
{
"ruleId": "string",
"message": "string",
"params": [
"string"
],
"token": "string",
"propertyNames": [
"string"
],
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"decision": "Valid"
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
- Статус 409 - Conflict
Отримати товарні документи протоколу сканування GET /api/des-pscan/protocols/{protocolId}/operation-documents
Повертає всі товарні документи, прив'язані до протоколу. Параметр protocolId ідентифікує протокол, а tenant визначає його орендаря.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/operation-documents |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Масив об'єктів OperationDocumentResponse
JSON приклад відповіді
[
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"businessUnitId": "string",
"senderBusinessUnitId": "string",
"receiverBusinessUnitId": "string",
"documentId": "string",
"operationDocumentType": "string",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
]
- Статус 404 - Not Found.
Додати товарні документи до протоколу сканування POST /api/des-pscan/protocols/{protocolId}/operation-documents
Додає один або кілька товарних документів лише до протоколу у стані opened. documentId має бути унікальним у межах протоколу.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/operation-documents |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
X-Idempotency-Key |
string |
|
REQUEST |
|
|
JSON Body |
Масив об'єктів OperationDocumentRequest |
JSON приклад запиту
[
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"documentId": "string",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
]
RESPONSE
- Статус 201 - Created.
Масив об'єктів OperationDocumentResponse
JSON приклад відповіді
[
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"businessUnitId": "string",
"senderBusinessUnitId": "string",
"receiverBusinessUnitId": "string",
"documentId": "string",
"operationDocumentType": "string",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
]
- Статус 404 - Not Found.
- Статус 409 - Conflict.
Повністю замінити товарний документ у протоколі сканування PUT /api/des-pscan/protocols/{protocolId}/operation-documents/{documentId}
Замінює товарний документ з documentId у вказаному протоколі повним тілом запиту. Операція дозволена лише для протоколу у стані opened; documentId у URL та тілі запиту мають посилатися на один документ.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/operation-documents/{documentId} |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола documentId (string) обов'язково - ідентифікатор документа |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
X-Idempotency-Key |
string |
|
REQUEST |
|
|
JSON Body |
Обов'язково. Об'єкт OperationDocumentRequest |
JSON приклад запиту
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"operationDocumentType": "string",
"documentId": "string",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
RESPONSE
- Статус 200.
Об'єкт OperationDocumentResponse
JSON приклад відповіді
{
"relations": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"businessUnitId": "string",
"senderBusinessUnitId": "string",
"receiverBusinessUnitId": "string",
"documentId": "string",
"operationDocumentType": "string",
"senderEconomicOperatorCode": "string",
"senderEconomicOperatorObjectCode": "string",
"receiverEconomicOperatorCode": "string",
"receiverEconomicOperatorObjectCode": "string",
"items": [
{
"articleId": "string",
"quantity": 0
}
]
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
- Статус 409 - Conflict
Видалити товарний документ з протоколу сканування DELETE /api/des-pscan/protocols/{protocolId}/operation-documents/{documentId}
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/des-pscan/protocols/{protocolId}/operation-documents/{documentId} |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола documentId (string) обов'язково - ідентифікатор документа |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 204 - No Content.
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
- Статус 409 - Conflict.
Скорочені результати валідації GET /api/des-pscan/protocols/validation-results/brief
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/validation-results/brief |
|
URL параметри |
tenant (string) опційно - Tenant ідентифікатор DocumentId (string) опційно ProtocolId (string) опційно OperationDocumentId (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ProtocolValidationResponse
JSON приклад відповіді
{
"protocols": {
"additionalProp1": {
"successItems": 0,
"failedItems": 0,
"eed": [
"string"
],
"operationalDocuments": [
"string"
],
"operatorObjectCode": "string",
"businessUnitId": "string"
},
"additionalProp2": {
"successItems": 0,
"failedItems": 0,
"eed": [
"string"
],
"operationalDocuments": [
"string"
],
"operatorObjectCode": "string",
"businessUnitId": "string"
},
"additionalProp3": {
"successItems": 0,
"failedItems": 0,
"eed": [
"string"
],
"operationalDocuments": [
"string"
],
"operatorObjectCode": "string",
"businessUnitId": "string"
}
},
"eed": {
"additionalProp1": {
"successItems": 0,
"failedItems": 0
},
"additionalProp2": {
"successItems": 0,
"failedItems": 0
},
"additionalProp3": {
"successItems": 0,
"failedItems": 0
}
},
"operationalDocuments": {
"additionalProp1": {
"successItems": 0,
"failedItems": 0
},
"additionalProp2": {
"successItems": 0,
"failedItems": 0
},
"additionalProp3": {
"successItems": 0,
"failedItems": 0
}
},
"total": {
"protocols": {
"successItems": 0,
"failedItems": 0
},
"eed": {
"successItems": 0,
"failedItems": 0
},
"operationalDocuments": {
"successItems": 0,
"failedItems": 0
}
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
Детальні результати валідації GET /api/des-pscan/protocols/validation-results/protocol/detail
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/validation-results/protocol/detail |
|
URL параметри |
tenant (string) опційно - Tenant ідентифікатор id (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ProtocolDetailedValidationResponse
JSON приклад відповіді
{
"successItems": 0,
"failedItems": {
"additionalProp1": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
},
"additionalProp2": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
},
"additionalProp3": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
}
},
"operatorObjectCode": "string",
"businessUnitId": "string",
"inventoryItemsDetails": {
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
},
"failedItems": {
"additionalProp1": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
},
"additionalProp2": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
},
"additionalProp3": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
}
}
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
GET /api/des-pscan/protocols/validation-results/eed/detail
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/validation-results/eed/detail |
|
URL параметри |
tenant (string) опційно - Tenant ідентифікатор id (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ProtocolDetailedValidationResponse
JSON приклад відповіді
{
"successItems": 0,
"failedItems": {
"additionalProp1": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
},
"additionalProp2": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
},
"additionalProp3": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
}
},
"operatorObjectCode": "string",
"businessUnitId": "string",
"inventoryItemsDetails": {
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
},
"failedItems": {
"additionalProp1": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
},
"additionalProp2": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
},
"additionalProp3": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
}
}
}
}
GET /api/des-pscan/protocols/validation-results/operational/detail
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/validation-results/operational/detail |
|
URL параметри |
tenant (string) опційно - Tenant ідентифікатор id (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ProtocolDetailedValidationResponse
JSON приклад відповіді
{
"successItems": 0,
"failedItems": {
"additionalProp1": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
},
"additionalProp2": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
},
"additionalProp3": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": [
"string"
],
"itemsDetails": [
{
"articleId": "string",
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0
}
]
}
},
"operatorObjectCode": "string",
"businessUnitId": "string",
"inventoryItemsDetails": {
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
},
"failedItems": {
"additionalProp1": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
},
"additionalProp2": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
},
"additionalProp3": {
"totalCount": 0,
"message": "string",
"token": "string",
"items": {
"additionalProp1": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp2": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
},
"additionalProp3": {
"successItems": 0,
"barcodes": [
"string"
],
"operationalDocumentsQuantity": 0,
"protocolQuantity": 0,
"eedQuantity": 0,
"operationalDocuments": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"protocols": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"eeds": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
}
}
}
}
}
GET /api/des-pscan/protocols/validation/matching-data
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-pscan/protocols/validation/matching-data |
|
PATH параметри |
protocolId (string) обов'язково - ідентифікатор протокола |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор DocumentId (string) опційно ProtocolId (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200.
Об'єкт ValidationMatchingDataResponse
JSON приклад відповіді
{
"protocols": {
"additionalProp1": {
"protocolType": "string",
"businessUnitId": "string"
},
"additionalProp2": {
"protocolType": "string",
"businessUnitId": "string"
},
"additionalProp3": {
"protocolType": "string",
"businessUnitId": "string"
}
},
"documents": {
"additionalProp1": [
{
"recordId": "string",
"itemCode": "string",
"readableCode": "string",
"itemType": "string",
"itemPath": "string",
"matchingStatus": "string",
"protocolId": "string",
"createdAt": "2026-11-17T16:11:49.733Z"
}
],
"additionalProp2": [
{
"recordId": "string",
"itemCode": "string",
"readableCode": "string",
"itemType": "string",
"itemPath": "string",
"matchingStatus": "string",
"protocolId": "string",
"createdAt": "2026-11-17T16:11:49.733Z"
}
],
"additionalProp3": [
{
"recordId": "string",
"itemCode": "string",
"readableCode": "string",
"itemType": "string",
"itemPath": "string",
"matchingStatus": "string",
"protocolId": "string",
"createdAt": "2026-11-17T16:11:49.733Z"
}
]
}
}
- Статус 404 - Not Found. Протокол сканування за вказаним protocolId не знайдено.
- Статус 422 - Unprocessable Content.
Об'єкт ProblemDetails
JSON приклад відповіді
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
Каса
Публічний API POS для перевірки та блокування акцизних марок.
Перевірка акцизних марок /api/des-pos/validate
Перевіряє одну або кілька акцизних марок (EM) або унікальних групових ідентифікаторів (УГІ) у режимі реального часу. Потребує operationType sale|reversal. Для sale введені УГІ розширюються на member stamps; для reversal введені УГІ відхиляються (лише EM). Приймає повні коди та опційні 12-символьні коди для зчитування пошкодженої упаковки.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pos/validate |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
об'єкт ValidateStampsRequest |
RESPONSE
- Статус 200.
Об'єкт ValidateStampsResult.
JSON приклад відповіді
{
"overallValid": true,
"items": [
{
"exciseCode": "string",
"readableCode": "string",
"itemType": "Em",
"validationStatus": "Valid",
"validationMessage": "string",
"validationErrors": [
{
"ruleId": "string",
"code": "string",
"message": "string"
}
],
"expandedStamps": [
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
],
"expandedCount": 0,
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
],
"validationTimestamp": "2026-11-17T18:34:26.513Z"
}
- Статус 401 - Unauthorized
- Статус 403 - Forbidden.
- Статус 422 - Unprocessable Content. Об'єкт ProblemDetails
- Статус 500 - Internal Server Error. Об'єкт ProblemDetails
JSON приклад відповіді
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
Опублікувати подію продажу або анулювання після фіскалізації POST /api/des-pos/block
Приймає запит на обробку після фіскалізації. Підтримує типи операцій «sale»/«reversal» ): для «sale» генерується подія «SoldAtPosEvent», а для «reversal» — «ReversalAtPosEvent». Обробка виконується асинхронно. Операція є ідемпотентною відносно «receiptId» (гарантується виконання принаймні один раз). Бажано використовувати коди EM, отримані в результаті попередньої валідації, якщо чек містив УГІ.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-pos/block |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
об'єкт BlockStampsRequest
JSON приклад запиту:
|
RESPONSE
- Статус 202 - Accepted.
Об'єкт BlockStampsResponse.
JSON приклад відповіді
{
"accepted": true,
"receiptId": "string",
"message": "string",
"trackingId": "string",
"timestamp": "2026-11-18T09:28:23.139Z"
}
- Статус 401 - Unauthorized
- Статус 403 - Forbidden
- Статус 422 - Unprocessable Content
Об'єкт ProblemDetails
- Статус 500 - Internal Server Error
Об'єкт ProblemDetails
Підписання
API процесу підписання акцизних електронних документів АЕД v2.
Запустити асинхронну дію підписання POST /api/des-sign/v2/signature/actions/{actionName}
Створює процес підписання переданих хешів документів. Передайте унікальний X-Idempotency-Key, щоб повторний запит не створив новий процес.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-sign/v2/signature/actions/{actionName} |
|
PATH параметри |
actionName (string) обов'язково |
|
URL параметри |
tenant (string) опційно - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
X-Idempotency-Key |
string |
|
REQUEST |
|
|
JSON body |
Об'єкт ExecuteSigningActionRequest
|
RESPONSE
- Статус 404 - Not Found
- Статус 409 - Conflict
Отримати стан дії підписання GET /api/des-sign/v2/signature/actions/{actionName}/status
Повертає поточний стан асинхронного процесу підписання за його ідентифікатором.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-sign/v2/signature/actions/{actionName}/status |
|
PATH параметри |
actionName (string) обов'язково |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор processId (string) обов'язково |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 404 - Not Found
- Статус 409 - Conflict
Отримати заявку на підпис GET /api/des-sign/v2/signature/signature-requests/{requestId}
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-sign/v2/signature/signature-requests/{requestId} |
|
PATH параметри |
requestId (string) обов'язково |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 404 - Not Found
Inbox заявок на підпис GET /api/des-sign/v2/signature/signature-requests
Створює процес підписання переданих хешів документів. Передайте унікальний X-Idempotency-Key, щоб повторний запит не створив новий процес.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/des-sign/v2/signature/signature-requests |
|
URL параметри |
tenant (string) опційно status (string) опційно |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 404 - Not Found
Подати підписи за заявкою POST /api/des-sign/v2/signature/signature-requests/{requestId}/signatures
Створює процес підписання переданих хешів документів. Передайте унікальний X-Idempotency-Key, щоб повторний запит не створив новий процес.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-sign/v2/signature/signature-requests/{requestId}/signatures |
|
PATH параметри |
requestId (string) обов'язково |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
X-Idempotency-Key |
string |
|
REQUEST |
|
|
JSON body |
Обов'язково. Об'єкт SubmitSignatureRequest
|
RESPONSE
- Статус 409 - Conflict
- Статус 410 - Gone
- Статус 422 - Unprocessable Content
Відхилити заявку на підпис POST /api/des-sign/v2/signature/signature-requests/{requestId}/reject
Створює процес підписання переданих хешів документів. Передайте унікальний X-Idempotency-Key, щоб повторний запит не створив новий процес.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-sign/v2/signature/signature-requests/{requestId}/reject |
|
PATH параметри |
requestId (string) обов'язково |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON body |
Об'єкт RejectSignatureRequest
|
RESPONSE
- Статус 409 - Conflict
- Статус 410 - Gone
Створити або оновити клієнта ENIGMA POST /api/des-sign/v2/signature/clients
Створює або оновлює прив'язку клієнта Enigma до оператора DES. Повертає 201 для нової прив'язки та 200 для оновленої.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/des-sign/v2/signature/clients |
|
URL параметри |
tenant (string) обов'язково - Tenant ідентифікатор |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
|
X-Idempotency-Key |
string |
|
REQUEST |
|
|
JSON body |
Об'єкт CreateSignatureClientRequest
|
RESPONSE
- Статус 200 - OK
- Статус 201 - Created
Об'єкт SignatureClientResponse
- Статус 422 - Unprocessable Content
УГІ
Перевірка складу УГІ POST /api/v1/{ugiCode}/actions/validate
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/{ugiCode}/actions/validate |
|
Path параметри |
ugiCode (string) обов'язково - Код УГІ для пошуку Приклад: AА0222A0224101012YWQ4ZjUyYz
|
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200 - protocol validation result.
- Статус 400 - invalid request.
Перелік створених УГІ GET /api/v1/ugi
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/ugi |
|
Headers |
|
|
Authorization |
Bearer |
RESPONSE
- Статус 200. Масив UGIs list
- Статус 400 - Invalid request.
JSON приклад відповіді:
[
{
"ugiId": "string",
"ugiCode": "string",
"businessUnitId": "string",
"ugiStatus": "Draft",
"desState": "Draft",
"ugiCreatedBy": "string",
"ugiCreatedAt": "2019-08-24T14:15:22Z",
"ugiDeletedBy": "string",
"ugiDeletedAt": "2019-08-24T14:15:22Z",
"items": [
{
"ugiCode": "string",
"groupLevelId": "string",
"parentUgiCode": "string"
}
]
}
]
Отримати УГІ за ugiCode DES-796 GET /api/des-ugi/ugis/{ugiCode}
REQUEST
|
URL |
https://des-client.stage.akcyz.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/des-ugi/ugis/{ugiCode} |
|
PATH параметри |
ugiCode (string) обов'язково - код УГІ для пошуку Example: AА0222A0224101012YWQ4ZjUyYz |
|
URL параметри |
tenant (string) опційно - Tenant ідентифікатор hierarchy (boolean) опційно - ознака завантаження повного дерева ієрархії, за замовчуванням false |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200 OK.
Об'єкт з UGIResponse.
- Статус 404 - Not Found
АЕД
Базові операції з акцизними електронними документами.
Отримання АЕД GET /api/v1/eed/{docId}
REQUEST
|
URL |
https://des-client.stage.akcyz.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/eed/{docId} |
|
PATH параметри |
docId (string <guid>) обов'язково - Ідентифікатор АЕД Example: 34a13eb1-62a9-4bbd-a12a-285347701b07 |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
- Статус 200. Об'єкт з даними АЕД.
- Статус 400 - Invalid request.
JSON приклад відповіді
{
"documentId": "string",
"documentState": "Draft",
"documentNumber": "string",
"operationCode": "string",
"eExciseStatus": "string",
"eExciseId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedAt": "2019-08-24T14:15:22Z",
"counterparties": {
"sender": {
"operatorCode": "string",
"operatorName": "string",
"objectCode": "string",
"objectName": "string",
"objectType": "Factory",
"signedAt": "2019-08-24T14:15:22Z",
"signedBy": "string"
},
"recipient": {
"operatorCode": "string",
"operatorName": "string",
"objectCode": "string",
"objectName": "string",
"objectType": "Factory",
"signedAt": "2019-08-24T14:15:22Z",
"signedBy": "string"
},
"custodian": {
"operatorCode": "string",
"operatorName": "string",
"objectCode": "string",
"objectName": "string",
"objectType": "Factory",
"signedAt": "2019-08-24T14:15:22Z",
"signedBy": "string"
}
},
"items": {
"ems": [
{
"stampId": "string",
"uniqueIdentifier": "string",
"serialNumber": "string",
"readableNumber": "string",
"typeId": "string",
"articleId": "string",
"barcode": "string",
"name": "string"
}
],
"ugis": [
{
"ugiCode": "string",
"groupLevelId": "string",
"parentUgiCode": "string"
}
]
}
}
Перевірка складу АЕД POST /api/v1/eed/{docId}/actions/validate
REQUEST
|
URL |
https://des-client.stage.akcyz.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/eed/{docId}/actions/validate |
|
PATH параметри |
docId (string <guid>) обов'язково - Ідентифікатор АЕД Example: 34a13eb1-62a9-4bbd-a12a-285347701b07 |
|
Headers |
|
|
Authorization |
Bearer |
|
Content-Type |
application/json |
RESPONSE
Статус 200.
Об'єкти API продукту Е-Акциз
Об'єкт externalIds (masterdata_BusinessUnitExternalIds)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| sapId |
string or null
|
| counterPartyId |
string or null
|
Об'єкт item (masterdata_BusinessUnit)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| tenant |
string or null
|
| businessUnitId |
string or null
|
| name |
string or null
|
| parentBusinessUnitId |
string or null
|
| businessId |
string or null
|
| legalUnitId |
string or null
|
| statusId |
string or null
|
| addressId |
string or null
|
| openingDate |
string or null <date>
|
| phoneNumber |
string or null
|
| externalIds |
об'єкт (masterdata_BusinessUnitExternalIds)
|
| macroRegionId |
string or null
|
| buldingNumber |
string or null
|
| supervisorsGroupId |
string or null
|
| parentBusinessId |
string or null
|
| subBusinessId |
string or null
|
Об'єкт business (masterdata_Business)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| businessId |
string or null
|
| name |
string or null
|
| tenant |
string or null
|
Об'єкт legalUnit (masterdata_LegalUnit)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| tenant |
string or null
|
| legalUnitId |
string or null
|
| name |
string or null
|
| countryId |
string or null
|
| currencyId |
string or null
|
| externalIds |
object (masterdata_LegalUnitExternalIds)
|
Об'єкт macroRegion (masterdata_MacroRegion)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| tenant |
string or null
|
| macroRegionId |
string or null
|
| name |
string or null
|
Об'єкт externalIds (masterdata_LegalUnitExternalIds)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| sapId |
string or null
|
Об'єкт subBusiness (masterdata_SubBusiness)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| subBusinessId |
string or null
|
| name |
string or null
|
| tenant |
string or null
|
Об'єкт supervisorsGroup (masterdata_SupervisorsGroup)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| tenant |
string or null
|
| supervisorsGroupId |
string or null
|
| supervisorId |
string or null
|
Об'єкт included (masterdata_BusinessUnitIncluded)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| business |
object (masterdata_Business)
|
| legalUnit |
object (masterdata_LegalUnit)
|
| macroRegion |
object (masterdata_MacroRegion)
|
| subBusiness |
object (masterdata_SubBusiness)
|
| supervisorGroup |
object (masterdata_SupervisorsGroup)
|
Об'єкт items (UgiItemResponse)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| ugiCode |
string
|
| groupLevelId |
string
|
| parentUgiCode |
string
|
Масив UGIs list
Опис параметрів
|
Параметр |
Тип |
|---|---|
| ugiId |
string <guid>
|
| ugiCode |
string
|
| businessUnitId |
string
|
| ugiStatus |
string. Enum: "Draft" "Activated" "Deactivated"
|
| desState |
string. Enum: "Draft" "Activated" "Deactivated"
|
| ugiCreatedBy |
string
|
| ugiCreatedAt |
string <date-time>
|
| ugiDeletedBy |
string or null
|
| ugiDeletedAt |
string or null <date-time>
|
| items |
|
Об'єкт EMItem
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| stampId |
string
|
| uniqueIdentifier |
string
|
| serialNumber |
string
|
| readableNumber |
string
|
| typeId |
string
|
| articleId |
string
|
| barcode |
string
|
| name |
string
|
Дані УГІ
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| ugiId |
string <guid>
|
| ugiCode |
string
|
| businessUnitId |
string
|
| ugiStatus |
string. Enum: "Draft" "Activated" "Deactivated"
|
| desState |
string. Enum: "Draft" "Activated" "Deactivated"
|
| description |
string
|
| otherInfo |
string
|
| ugiCreatedBy |
string
|
| ugiCreatedAt |
string <date-time>
|
| ugiDeletedBy |
string or null
|
| ugiDeletedAt |
string or null <date-time>
|
| ems |
Array of objects (EMItem)
|
| ugis |
Array of objects (UgiItemResponse)
|
Об'єкт (EedCounterpartyProps)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| operatorCode |
string
|
| operatorName |
string
|
| objectCode |
string
|
| objectName |
string
|
| objectType |
string. Enum: "Factory" "Warehouse" "Store"
|
| signedAt |
string <date-time>
|
| signedBy |
string
|
Об'єкт counterparties
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| sender |
object (EedCounterpartyProps)
|
| recipient |
object (EedCounterpartyProps)
|
| custodian |
object (EedCounterpartyProps)
|
Об'єкт items (для АЕД)
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| ems |
|
| ugis |
|
Дані АЕД
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| documentId |
string <guid>
|
| documentState |
string. Enum: "Draft" "Published" "SigningBySender" "SigningByRecipient" "SigningByCustodian" "Rejected" "Corrections"
|
| documentNumber |
string
|
| operationCode |
string
|
| eExciseStatus |
string
|
| eExciseId |
string <guid>
|
| createdBy |
string
|
| createdAt |
string <date-time>
|
| deletedBy |
string
|
| deletedAt |
string <date-time>
|
| counterparties |
object
|
| items |
object
|
Об'єкт relations
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| property name*
additional property
|
Array of strings or null
|
Об'єкт ProtocolLookupOperationDocument
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| operationDocumentId |
string or null
|
| operationDocumentType |
string or null
|
| relations |
object or null
|
Об'єкт CreateScanningProtocolItem
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| exciseCode | string or null |
| barcode | string or null |
| ssccCode | string or null |
| readableCode | string or null |
| legacyExciseCode | string or null |
| scannedAt | string($date-time) |
| quantity | number($double) or null |
Об'єкт CreateScanningProtocolRequestItem
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| articleId* | string or null |
| quantity | number($double) |
Об'єкт CreateScanningProtocolOperationDocumentRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| relations | {
|
||
| operationDocumentType | string or null | ||
| operationDocumentId | string or null | ||
| items | масив об'єктів CreateScanningProtocolRequestItem |
Об'єкт CreateScanningProtocolRequest
Використовується для запиту на створення протоколу сканування.
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| protocolType | string or null |
| operationType | string or null |
| operatorObjectCode | string or null |
| businessUnitId | string or null |
| ugiCode | string or null |
| senderEconomicOperatorCode | string or null |
| senderEconomicOperatorObjectCode | string or null |
| senderBusinessUnitId | string or null |
| receiverEconomicOperatorCode | string or null |
| receiverEconomicOperatorObjectCode | string or null |
| receiverBusinessUnitId | string or null |
| operationDocuments | масив об'єктів CreateScanningProtocolOperationDocumentRequest |
|
items |
масив об'єктів CreateScanningProtocolItem |
Об'єкт JsonNodeOptions
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| propertyNameCaseInsensitive | boolean |
Об'єкт JsonNode
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| options | об'єкт JsonNodeOptions |
| parent | об'єкт JsonNode |
| root | об'єкт JsonNode |
Об'єкт CreatedScanningProtocolItem
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| itemId* | string or null | ||
| scannedBy* | string or null | ||
| scannedAt | string($date-time) | ||
| exciseCode | string or null | ||
| barcode | string or null | ||
| ssccCode | string or null | ||
| readableCode | string or null | ||
| legacyExciseCode | string or null | ||
| quantity | number($double) or null | ||
| itemSource* | string or null | ||
| itemType* | string or null | ||
| articleId | string or null | ||
| validationStatus | string or null | ||
| validationMessage | string or null | ||
| documentId | string or null | ||
| validations | {
nullable: true |
Об'єкт EedValidationInfo
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| successItems | integer($int32) |
| failedItems | integer($int32) |
Об'єкт FailedItemDetail
Per-article quantity pair backing Temabit.Des.ScanningProtocol.Contracts.Responses.FailedItemValidationResult.ItemsDetails. Temabit.Des.ScanningProtocol.Contracts.Responses.FailedItemDetail.OperationalDocumentsQuantity / Temabit.Des.ScanningProtocol.Contracts.Responses.FailedItemDetail.ProtocolQuantity are null when that side has no quantity for the article (tokens articleMissingInProtocol / articleNotInDocument). Temabit.Des.ScanningProtocol.Contracts.Responses.FailedItemDetail.OperationalDocumentsQuantity is also null for documentQuantityConflict (protocol copies of the same operational document disagree on the quantity).
|
Parameter |
Type |
|---|---|
| articleId | string or null |
| barcodes |
array of barcodes (string)
Distinct barcodes found for the article in the scanning protocol (order of first appearance). Always serialized; empty when none are available. |
| operationalDocumentsQuantity |
number($double) or null
Always serialized; null when the article is absent from operational documents (token |
| protocolQuantity |
number($double) or null
Always serialized; null when the article is absent from scanning protocols (token |
Об'єкт FailedItemValidationResult
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| totalCount | integer($int32) |
| message | string or null |
| token | string or null |
| items | array of items (string) or null |
| itemsDetails | array of objects (FailedItemDetail) or null |
Об'єкт FillScanningProtocolRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| items | array of objects (CreateScanningProtocolItem) or null |
Об'єкт FillScanningProtocolResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| businessUnitId | string or null |
| items | array of objects (CreatedScanningProtocolItem) or null |
| documentIds | array of document identifiers (string) or null |
Об'єкт HttpValidationProblemDetails
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| type | string or null | ||
| title | string or null | ||
| status | integer($int32) or null | ||
| detail | string or null | ||
| instance | string or null | ||
| errors | {
nullable: true |
Об'єкт InventoryArticleDetail
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| successItems | integer($int32) | ||
| barcodes |
array of barcodes (string) or null
Distinct barcodes found for the article (old barcode scans or scanned marks), in order of first appearance. Always serialized; empty when none are available. |
||
| operationalDocumentsQuantity | number($double) | ||
| protocolQuantity | number($double) | ||
| eedQuantity | number($double) or null | ||
| operationalDocuments | {
nullable: true |
||
| protocols | {
nullable: true |
||
| eeds | {
nullable: true |
Об'єкт InventoryFailedTokenGroup
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| totalCount | integer($int32) | ||
| message | string or null | ||
| token | string or null | ||
| items | {
nullable: true |
Об'єкт InventoryItemsDetailsResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| items | {
nullable: true |
||
| failedItems | {
nullable: true |
Об'єкт OperationDocumentItemRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| articleId | string or null. Ідентифікатор товарної позиції (article) у master data. |
| quantity | number($double). Кількість товару за цією позицією. |
Об'єкт OperationDocumentItemResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| articleId | string or null. Ідентифікатор товарної позиції (article) у master data. |
| quantity | number($double). Кількість товару за цією позицією. |
Об'єкт OperationDocumentRequest
Товарний документ, що додається до протоколу сканування або повністю замінює наявний документ.
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| relations |
Ідентифікатори клієнтів. Явно присвойте значення null, щоб видалити наявні зв’язки. {
nullable: true |
||
| operationDocumentType |
string or null. Тип товарного документа, наприклад |
||
| documentId | string or null. Бізнес-ідентифікатор товарного документа, унікальний у межах протоколу. Для PUT має відповідати значенню параметра documentId у URL. |
||
| senderEconomicOperatorCode | string or null. Код економічного оператора-відправника; використовується для звірки з даними протоколу. | ||
| senderEconomicOperatorObjectCode | string or null. Код об'єкта економічного оператора-відправника; використовується для звірки з даними протоколу. | ||
| receiverEconomicOperatorCode | string or null. Код економічного оператора-одержувача; використовується для звірки з даними протоколу. | ||
| receiverEconomicOperatorObjectCode | string or null. Код об'єкта економічного оператора-одержувача; використовується для звірки з даними протоколу. | ||
| items |
Масив об'єктів OperationDocumentItemRequest Позиції товарного документа: ідентифікатор товару та кількість. |
Об'єкт OperationDocumentResponse
Один операційний документ, що повертається методом GET/POST/PUT для операційних документів.
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| relations | {
nullable: true |
||
| businessUnitId | string or null. Ідентифікатор бізнес-одиниці, до якої належить товарний документ. | ||
| senderBusinessUnitId | string or null. Ідентифікатор бізнес-одиниці відправника. | ||
| receiverBusinessUnitId | string or null. Ідентифікатор бізнес-одиниці одержувача. | ||
| documentId | string or null. Бізнес-ідентифікатор товарного документа, унікальний у межах протоколу. | ||
| operationDocumentType | string or null. Тип товарного документа. | ||
| senderEconomicOperatorCode | string or null. Код економічного оператора-відправника. | ||
| senderEconomicOperatorObjectCode | string or null. Код об'єкта економічного оператора-відправника. | ||
| receiverEconomicOperatorCode | string or null. Код економічного оператора-одержувача. | ||
| receiverEconomicOperatorObjectCode | string or null. Код об'єкта економічного оператора-одержувача. | ||
| items |
array of objects OperationDocumentItemResponse or null. Позиції товарного документа. |
Об'єкт OperationalDocumentValidationInfo
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| successItems | integer($int32) |
| failedItems | integer($int32) |
Об'єкт ProblemDetails
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| type | string or null |
| title | string or null |
| status | integer($int32) or null |
| detail | string or null |
| instance | string or null |
JSON приклад:
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
Об'єкт ProtocolDetailedValidationResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| successItems | integer($int32) | ||
| failedItems | {
nullable: true |
||
| operatorObjectCode | string or null | ||
| businessUnitId | string or null | ||
| inventoryItemsDetails | об'єкт InventoryItemsDetailsResponse |
Об'єкт ProtocolItemsListResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| businessUnitId | string or null |
| pageToken | string or null |
| totalCount | integer($int32) |
| items | array of objects CreatedScanningProtocolItem or null |
Об'єкт ProtocolLookupItem
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| protocolId | string or null |
| protocolType | string or null |
| protocolStatus | string or null |
| operationDocuments | Array of objects or null (ProtocolLookupOperationDocument) |
Об'єкт ProtocolReturnDocumentResponse
Один рядок для однієї позиції в результаті виклику GET protocols/{protocolId}/return-documents: AED, що є підставою для повернення, разом із супровідною документацією до операції. Якщо в одному AED міститься кілька позицій, це призводить до створення кількох рядків, у яких значення полів DocumentId/DocumentType/OperationDocuments збігаються.
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| documentId | string or null |
| documentType | string or null |
| operationDocuments |
array [ string or null] |
| articleId | string or null |
| quantity | number($double) |
Об'єкт ProtocolValidationInfo
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| successItems | integer($int32) |
| failedItems | integer($int32) |
| eed |
array [ string] |
| operationalDocuments | array
[ string] |
| operatorObjectCode | string or null |
| businessUnitId | string or null |
Об'єкт ValidationItemsTotal
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| successItems | integer($int32) |
| failedItems | integer($int32) |
Об'єкт ProtocolValidationTotal
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| protocols |
об'єкт ValidationItemsTotal |
| eed | об'єкт ValidationItemsTotal |
| operationalDocuments | об'єкт ValidationItemsTotal |
Об'єкт ProtocolValidationResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| protocols | {
nullable: true |
||
| eed | {
nullable: true |
||
| operationalDocuments | {
nullable: true |
||
| total |
Об'єкт ProtocolValidationTotal |
Об'єкт ResolveItemInput
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| exciseCode | string or null |
| readableCode | string or null |
Об'єкт ResolveItemResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| index | integer($int32) |
| exciseCode | string or null |
| readableCode | string or null |
| itemType* | string or null |
Об'єкт ResolveItemsRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| items | array of objects ResolveItemInput or null |
Об'єкт ScanningProtocolDocumentResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| documentId | string or null |
| desState | string or null |
| validationResult | string or null |
Об'єкт ScanningProtocolItemResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| articleId | string or null |
| quantity | number($double) |
Об'єкт ScanningProtocolOperationDocumentResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| relations | {
nullable: true |
||
| operationDocumentType | string or null | ||
| operationDocumentId | string or null | ||
| items | {
nullable: true |
Об'єкт ValidationError
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| ruleId | string or null | ||
| message | string or null | ||
| params | [string or null] | ||
| token | string or null | ||
| propertyNames | [string or null] | ||
| type |
ValidationErrorType string Enum: |
||
| details | string or null | ||
| metadata | {
nullable: true |
Об'єкт ValidationWarning
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| ruleId | string or null | ||
| message | string or null | ||
| params | [string or null] | ||
| token | string or null | ||
| propertyNames | [string or null] | ||
| metadata | {
nullable: true |
Об'єкт ScanningProtocolValidations
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| errors | array of objects ValidationError or null |
| warnings |
array of objects ValidationWarning or null |
| decision | ValidationDecision string Enum: [ Valid, NotValid, NotApplicable ] |
Об'єкт ScanningProtocolResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| protocolId | string or null |
| protocolType | string or null |
| operationType | string or null |
| protocolStatus | string or null |
| ugiCode | string or null |
| protocolCreatedBy | string or null |
| protocolCreatedAt | string($date-time) |
| protocolUpdatedBy | string or null |
| protocolUpdatedAt | string($date-time) |
| protocolClosedBy | string or null |
| protocolClosedAt | string($date-time) |
| senderEconomicOperatorCode | string or null |
| senderEconomicOperatorObjectCode | string or null |
| senderBusinessUnitId | string or null |
| receiverEconomicOperatorCode | string or null |
| receiverEconomicOperatorObjectCode | string or null |
| receiverBusinessUnitId | string or null |
| operatorObjectCode | string or null |
| businessUnitId | string or null |
| operationDocuments | array of objects ScanningProtocolOperationDocumentResponse or null |
| items | array of objects CreatedScanningProtocolItem or null |
| docs | array of objects ScanningProtocolDocumentResponse or null |
| emValidation | object ScanningProtocolValidations |
| generalValidation | object ScanningProtocolValidations |
Об'єкт ValidateItemInput
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| exciseCode | string or null |
| barcode | string or null |
| readableCode | string or null |
| legacyExciseCode | string or null |
| scannedAt | string($date-time) |
| quantity | number($double) or null |
Об'єкт ValidateItemsRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| operatorObjectCode | string or null |
| protocolType | string or null |
| operationType | string or null |
| businessUnitId | string or null |
| senderBusinessUnitId | string or null |
| receiverBusinessUnitId | string or null |
| senderEconomicOperatorCode | string or null |
| receiverEconomicOperatorCode | string or null |
| items | array of objects ValidateItemInput or null |
Об'єкт ValidatedItem
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| exciseCode | string or null | ||
| barcode | string or null | ||
| readableCode | string or null | ||
| legacyExciseCode | string or null | ||
| quantity | number($double) or null | ||
| articleId | string or null | ||
| itemType | string or null | ||
| validationStatus | string or null | ||
| validationMessage | string or null | ||
| validations | {
nullable: true |
Об'єкт ValidationMatchingDataProtocolInfo
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| protocolType | string or null |
| businessUnitId | string or null |
Об'єкт ValidationMatchingDataRecord
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| recordId | string or null |
| itemCode | string or null |
| readableCode | string or null |
| itemType | string or null |
| itemPath | string or null |
| matchingStatus | string or null |
| protocolId | string or null |
| createdAt | string($date-time) |
Об'єкт ValidationMatchingDataResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| protocols | {
nullable: true |
||
| documents | {
nullable: true |
Об'єкт UpdateScanningProtocolRequest
Запит на оновлення заголовка протоколу сканування. Управління операційними документами здійснюється через спеціальні ендпоінти операційних документів. Невідомі властивості (наприклад, legacy operationDocuments) мовчки ігноруються для забезпечення зворотної сумісності, навіть якщо глобальне значення за замовчуванням — заборонено.
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| businessUnitId | string or null |
| operatorObjectCode | string or null |
| senderEconomicOperatorCode | string or null |
| senderEconomicOperatorObjectCode | string or null |
| senderBusinessUnitId | string or null |
| receiverEconomicOperatorCode | string or null |
| receiverEconomicOperatorObjectCode | string or null |
| receiverBusinessUnitId | string or null |
| ugiCode | string or null |
Об'єкт UpdateProtocolItemRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| itemId* | string or null |
| quantity | number($double) |
Об'єкт ValidateStampsRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| businessUnitId | string or null | Ідентифікатор торговельного об’єкта, де виконується перевірка. |
| operationType |
PosOperationType string Enum: |
|
| exciseCodes | array [string] or null | Повні коди акцизних марок або УГІ для перевірки. |
| readableCodes | array [string] or null | Коди, введені касиром вручну з пошкодженого маркування. |
Об'єкт ValidationErrorModel
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| ruleId | string or null |
| code | string or null |
| message | string or null |
Об'єкт ExciseCodeValidationResultModel
Опис параметрів об’єкта
|
Параметр |
Тип |
||
|---|---|---|---|
| exciseCode | string or null | ||
| readableCode | string or null | ||
| itemType |
array ItemType string Enum: |
||
| validationStatus |
array ValidationStatus string Enum: |
||
| validationMessage | string or null | ||
| validationErrors | array of objects ValidationErrorModel | ||
| expandedStamps | array [ nullable: true |
||
| expandedCount | integer($int32) or null | ||
| metadata | object {
|
Об'єкт ValidateStampsResult
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| overallValid | boolean |
| items | array of objects ExciseCodeValidationResultModel |
| validationTimestamp | string($date-time) |
Об'єкт BlockStampsRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| businessUnitId | string or null | Ідентифікатор торговельного об’єкта, що фіскалізував чек. |
| operationType |
PosOperationType string Enum: |
|
| receiptId | string or null | Ідентифікатор фіскалізованого чека |
| fiscalizationTimestamp | string($date-time) | Час фіскалізації чека |
| fiscalNumber | string or null | Фіскальний номер чека |
| exciseCodes | [ nullable: true |
Акцизні коди проданих товарів, які потрібно заблокувати. |
Об'єкт BlockStampsResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| accepted | boolean | Ознака прийняття запиту до асинхронної обробки |
| receiptId | string or null | Ідентифікатор фіскалізованого чека |
| message | string or null | Повідомлення про результат прийняття запиту |
| trackingId | string or null | Ідентифікатор для відстеження асинхронної обробки |
| timestamp | string($date-time) | Час прийняття запиту |
Об'єкт CreateSignatureClientRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| operatorCode | string or null |
| enigmaClientId | string or null |
| signatureUserId | string or null |
JSON приклад:
{
"operatorCode": "string",
"enigmaClientId": "string",
"signatureUserId": "string"
}
Об'єкт DocumentForSigning
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| documentId | string or null |
| documentHash | string or null |
| documentDescription | string or null |
| documentType | string or null |
Об'єкт ExecuteSigningActionRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| operatorCode | string or null |
| signatureUserId | string or null |
| callbackUrl | string or null |
| operationDescription | string or null |
| rootProcessId | string or null |
| documents |
array of objects DocumentForSigning or null |
JSON приклад:
{
"operatorCode": "string",
"signatureUserId": "string",
"callbackUrl": "string",
"operationDescription": "string",
"rootProcessId": "string",
"documents": [
{
"documentId": "string",
"documentHash": "string",
"documentDescription": "string",
"documentType": "string"
}
]
}
Об'єкт RejectSignatureRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| reason |
string or null
|
Об'єкт SignatureClientResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| tenant | string or null |
| operatorCode | string or null |
| operatorId | string or null |
| enigmaClientId | string or null |
| operatorUserId | string or null |
| clientLogin | string or null |
| createdAt | string($date-time) |
| updatedAt | string($date-time) or null |
JSON приклад:
{
"tenant": "string",
"operatorCode": "string",
"operatorId": "string",
"enigmaClientId": "string",
"operatorUserId": "string",
"clientLogin": "string",
"createdAt": "2026-11-18T11:00:50.298Z",
"updatedAt": "2026-11-18T11:00:50.298Z"
}
Об'єкт SubmittedSignatureItem
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| documentId | |
| signature | string or null |
Об'єкт SubmitSignaturesRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| documents | array of objects SubmittedSignatureItem or null |
JSON приклад:
{
"documents": [
{
"documentId": "string",
"signature": "string"
}
]
}
Об'єкт FirstOwnerResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| counterpartyId | string or null | Ідентифікатор першого власника |
| businessUnitId | string or null | Ідентифікатор підрозділу першого власника |
| operatorCode | string or null | Код економічного оператора першого власника |
| objectCode | string or null | Код об’єкта економічного оператора першого власника |
| objectType | string or null | Тип об’єкта економічного оператора першого власника |
| country | string or null | Код країни першого власника |
Об'єкт CustodianResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| counterpartyId | string or null | Ідентифікатор поточного зберігача |
| businessUnitId | string or null | Ідентифікатор підрозділу поточного зберігача |
| operatorCode | string or null | Код економічного оператора поточного зберігача |
| objectCode | string or null | Код об’єкта економічного оператора поточного зберігача |
Об'єкт CurrentResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| custodian | об'єкт CustodianResponse | Інформація про поточного зберігача |
| counterpartyId | string or null |
Ідентифікатор поточного власника. |
| businessUnitId | string or null |
Ідентифікатор підрозділу поточного власника. |
| operatorCode | string or null |
Код економічного оператора поточного власника. |
| objectCode | string or null |
Код об’єкта економічного оператора поточного власника. |
Об'єкт PackerResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| custodianOperatorId | string or null |
Ідентифікатор економічного оператора-пакувальника. |
| isCustodian | boolean | Ознака, що пакувальник є зберігачем УГІ. |
Об'єкт RecipientResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| businessUnitId | string or null |
Ідентифікатор підрозділу отримувача. |
| objectCode | string or null |
Код об’єкта економічного оператора отримувача. |
Об'єкт ArticleResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| articleId | string or null |
Ідентифікатор артикулу. |
| quantity | string or null |
Кількість одиниць артикулу в УГІ. |
| barcode | string or null |
Штрихкод артикулу. |
Об'єкт EMResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| stampId | string or null |
Ідентифікатор акцизної марки. |
| uniqueIdentifier | string or null |
Унікальний ідентифікатор акцизної марки. |
| barcode | string or null |
Штрихкод товару. |
| articleId | string or null |
Ідентифікатор артикулу. |
| readableCode | string or null |
Людиночитаний код акцизної марки. |
Об'єкт UIResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| stampId* | string or null |
| uniqueIdentifier* | string or null |
| articleId | string or null |
| barcode | string or null |
Об'єкт ItemsResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| ems | масив об'єктів EMResponse або null |
Акцизні марки у складі УГІ |
| uis | масив об'єктів UIResponse або null | |
| ugi | масив кодів без ієрархії або повні об’єкти УГІ з ієрархією |
Дочірні УГІ |
Об'єкт 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"
]
}
}
Об'єкт DeactivateUgisRequest
Опис параметрів об’єкта
|
Параметр |
Тип |
Опис |
|---|---|---|
| businessUnitId | string or null |
Business-unit context. Mutually exclusive with Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.OperatorCode/Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.ObjectCode (XOR: exactly one context variant required). |
| operatorCode | string or null |
Economic-operator code (pair context). Must be supplied together with Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.ObjectCode and without Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.BusinessUnitId. |
| objectCode | string or null |
Object code (pair context). Must be supplied together with Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.OperatorCode and without Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.BusinessUnitId. |
| ugiCodes |
array of UGI codes [string] or null |
UGI codes to deactivate. Optional when Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.ReadableCodes is non-empty after trim |
| readableCodes |
array of codes [string] or null |
Readable codes resolved to UGI codes (tenant-scoped) in the sync phase. Optional when Temabit.Des.UGI.Contracts.Requests.DeactivateUgisRequest.UgiCodes is non-empty after trim. |
Об'єкти API для довідників продукту Е-Акциз
Об'єкт Article
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| articleId | string or null |
| statusId | string or null |
| name | string or null |
| shortName | string or null |
| classifierId | string or null |
| unitTypeId | string or null |
| articleTypeId | string or null |
| macroId | string or null |
| vatId | string or null |
| unitId | string or null |
| quantity | number($float) or null |
| priceTagUnitId | string or null |
| shelfLifeDays | integer($int32) or null |
| evaluationClassId | string or null |
| tenant | string or null |
Обʼєкт ArticleArticleIncludedBaseCreateResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| item | Обʼєкт Article |
| articleId | string or null |
| statusId | string or null |
| name | string or null |
| shortName | string or null |
| classifierId | string or null |
| unitTypeId | string or null |
| articleTypeId | string or null |
| macroId | string or null |
| vatId | string or null |
| unitId | string or null |
| quantity | number($float) or null |
| priceTagUnitId | string or null |
| shelfLifeDays | integer($int32) or null |
| evaluationClassId | string or null |
| tenant | string or null |
Обʼєкт ArticleArticleIncludedBaseGetResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| item | Обʼєкт Article |
| articleId |
string or null |
| statusId | string or null |
| name | string or null |
| shortName | string or null |
| classifierId | string or null |
| unitTypeId | string or null |
| articleTypeId | string or null |
| macroId | string or null |
| vatId | string or null |
| unitId | string or null |
| quantity | number($float) or null |
| priceTagUnitId | string or null |
| shelfLifeDays | integer($int32) or null |
| evaluationClassId | string or null |
| tenant | string or null |
Обʼєкт ArticleArticleIncludedBaseUpdateResponse
Опис параметрів об’єкта
|
Параметр |
Тип |
|---|---|
| item | Обʼєкт Article |
| articleId | string or null |
| statusId | string or null |
| name | string or null |
| shortName | string or null |
| classifierId | string or null |
| unitTypeId | string or null |
| articleTypeId | string or null |
| macroId | string or null |
| vatId | string or null |
| unitId | string or null |
| quantity | number($float) or null |
| priceTagUnitId | string or null |
| shelfLifeDays | integer($int32) or null |
| evaluationClassId | string or null |
| tenant | string or null |