Робота з API продукту Е-Акциз
УГІ: базовий API
Перевірка складу УГІ POST /api/v1/{ugiCode}/actions/validate
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/v1/{ugiCode}...
Перелік створених УГІ GET /api/v1/ugi
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту GET URL запиту /api/v1/ugi Header...
Отримання/перегляд УГІ GET /api/v1/ugi/{ugiCode}
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту GET URL запиту /api/v1/ugi/{ugiCo...
АЕД: базовий API
Базові операції з акцизними електронними документами.
Отримання АЕД GET /api/v1/eed/{docId}
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту GET URL запиту /api/v1/eed/{docI...
Перевірка складу АЕД POST /api/v1/eed/{docId}/actions/validate
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/v1/eed/{docI...
Підписання: базовий API
Запуск процесу підписання АЕД POST /api/v1/signature
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/v1/signature...
Отримання результату підпису АЕД GET /api/v1/signature/{signatureRequestId}
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту GET URL запиту /api/v1/signature/...
Обробка нотифікації про підпис АЕД POST /api/v1/signature/notification
REQUEST URL https://des-client.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/v1/signature...
Протоколи сканування
Знайти протоколи за зв'язком операційного документа GET /api/des-scan/protocols/lookup
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має...
Створити новий протокол сканування POST /api/des-pscan/protocols
Філія чи обʼєкт заголовка поза обмеженням користувача. REQUEST URL https://des-pscan.stage.akcyz....
Отримати протокол сканування за protocolId GET /api/des-pscan/protocols/{protocolId}
REQUEST URL https://des-pscan.stage.akcyz.edin.ua Метод запиту GET URL запиту /api/des-pscan/pro...
Оновити протокол сканування PUT /api/des-pscan/protocols/{protocolId}
REQUEST URL https://des-pscan.stage.akcyz.edin.ua/ Метод запиту PUT URL запиту /api/des-pscan/pr...
Видалити протокол сканування за protocolId DELETE /api/des-pscan/protocols/{protocolId}
REQUEST URL https://des-pscan.stage.akcyz.edin.ua/ Метод запиту DELETE URL запиту /api/des-pscan/...
Створити позиції протоколу POST /api/des-pscan/protocols/{protocolId}/items
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має...
Отримати позиції протоколу GET /api/des-pscan/protocols/{protocolId}/items
REQUEST URL https://des-pscan.stage.akcyz.edin.ua/ Метод запиту GET URL запиту /api/des-pscan/pr...
Видалити позиції для протоколу сканування DELETE /api/des-pscan/protocols/{protocolId}/items
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має...
Частково оновити кількість позицій протоколу PATCH /api/des-pscan/protocols/{protocolId}/items
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має...
Оновити позиції протоколу PUT /api/des-pscan/protocols/{protocolId}/items
REQUEST URL https://des-pscan.stage.akcyz.edin.ua/ Метод запиту PUT URL запиту /api/des-pscan/pro...
Перевірити позиції протоколу POST /api/des-pscan/protocols/validate-items
REQUEST URL https://des-pscan.stage.akcyz.edin.ua/ Метод запиту POST URL запиту /api/des-pscan/pr...
POST /api/des-pscan/protocols/resolve-items
REQUEST URL https://des-pscan.stage.akcyz.edin.ua/ Метод запиту POST URL запиту /api/des-pscan/pr...
Закрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/close
Закриває протокол сканування та повертає його оновлений стан. REQUEST URL https://des-pscan.stage...
Відкрити протокол сканування за protocolId POST /api/des-pscan/protocols/{protocolId}/action/open
Повертає протоколи, операційні документи яких відповідають заданому відношенню. Відповідність має...
Валідація протоколу сканування POST /api/des-pscan/protocols/{protocolId}/action/validate
REQUEST URL https://des-pscan.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/des-pscan/pro...
Отримати документи для повернення протоколу сканування GET /api/des-pscan/protocols/{protocolId}/return-documents
Повертає кількість артикулів за новими ЕМ у розрізі АЕД, що є підставою для повернення, разом з ї...
Корекція протоколу сканування POST /api/des-pscan/protocols/{protocolId}/action/correction
REQUEST URL https://des-pscan.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/des-pscan/pro...
Отримати товарні документи протоколу сканування GET /api/des-pscan/protocols/{protocolId}/operation-documents
Повертає всі товарні документи, прив'язані до протоколу. Параметр protocolId ідентифікує протокол...
Додати товарні документи до протоколу сканування POST /api/des-pscan/protocols/{protocolId}/operation-documents
REQUEST URL https://des-pscan.stage.akcyz.edin.ua Метод запиту POST URL запиту /api/des-pscan/pro...
Довідники Masterdata
POS: Перевірка та блокування марок
Підписання АЕД v2
Підписання: публічний API
DES Clients: Onboarding
АЕД v2
Об'єкти API продукту Е-Акциз
Об'єкт externalIds (masterdata_BusinessUnitExternalIds)
Опис параметрів об’єкта Параметр Тип sapId string or null counterPartyId string or null
Об'єкт item (masterdata_BusinessUnit)
Опис параметрів об’єкта Параметр Тип tenant string or null businessUnitId string or null name str...
Об'єкт business (masterdata_Business)
Опис параметрів об’єкта Параметр Тип businessId string or null name string or null tenant string ...
Об'єкт legalUnit (masterdata_LegalUnit)
Опис параметрів об’єкта Параметр Тип tenant string or null legalUnitId string or null name string...
Об'єкт macroRegion (masterdata_MacroRegion)
Опис параметрів об’єкта Параметр Тип tenant string or null macroRegionId string or null name stri...
Об'єкт externalIds (masterdata_LegalUnitExternalIds)
Опис параметрів об’єкта Параметр Тип sapId string or null
Об'єкт subBusiness (masterdata_SubBusiness)
Опис параметрів об’єкта Параметр Тип subBusinessId string or null name string or null tenant stri...
Об'єкт supervisorsGroup (masterdata_SupervisorsGroup)
Опис параметрів об’єкта Параметр Тип tenant string or null supervisorsGroupId string or null supe...
Об'єкт included (masterdata_BusinessUnitIncluded)
Опис параметрів об’єкта Параметр Тип business object (masterdata_Business) legalUnit object (mast...
Об'єкт items (UgiItemResponse)
Опис параметрів об’єкта Параметр Тип ugiCode string groupLevelId string parentUgiCode string
Масив UGIs list
Опис параметрів Параметр Тип ugiId string <guid> ugiCode string businessUnitId string ugiStatus ...
Об'єкт EMItem
Опис параметрів об’єкта Параметр Тип stampId string uniqueIdentifier string serialNumber string r...
Дані УГІ
Опис параметрів об’єкта Параметр Тип ugiId string <guid> ugiCode string businessUnitId string ugi...
Об'єкт (EedCounterpartyProps)
Опис параметрів об’єкта Параметр Тип operatorCode string operatorName string objectCode string ob...
Об'єкт counterparties
Опис параметрів об’єкта Параметр Тип sender object (EedCounterpartyProps) recipient object (EedCo...
Об'єкт items (для АЕД)
Опис параметрів об’єкта Параметр Тип ems Array of objects (EMItem) ugis Array of objects (UgiItem...
Дані АЕД
Опис параметрів об’єкта Параметр Тип documentId string <guid> documentState string. Enum: "Draft"...
Об'єкт relations
Опис параметрів об’єкта Параметр Тип property name* additional property Array of strings or null
Об'єкт ProtocolLookupOperationDocument
Опис параметрів об’єкта Параметр Тип operationDocumentId string or null operationDocumentType str...
Об'єкт CreateScanningProtocolItem
Опис параметрів об’єкта Параметр Тип exciseCode string or null barcode string or null ssccCode st...
Об'єкт CreateScanningProtocolRequestItem
Опис параметрів об’єкта Параметр Тип articleId* string or null quantity number($double)
Об'єкт CreateScanningProtocolOperationDocumentRequest
Опис параметрів об’єкта Параметр Тип relations { < * >: [ nullable: true string] } operationDocum...
Об'єкт CreateScanningProtocolRequest
Використовується для запиту на створення протоколу сканування. Опис параметрів об’єкта Параметр Т...
Об'єкт JsonNodeOptions
Опис параметрів об’єкта Параметр Тип propertyNameCaseInsensitive boolean
Об'єкт JsonNode
Опис параметрів об’єкта Параметр Тип options об'єкт JsonNodeOptions parent об'єкт JsonNode root о...
Об'єкт CreatedScanningProtocolItem
Опис параметрів об’єкта Параметр Тип itemId* string or null scannedBy* string or null scannedAt s...
Об'єкт EedValidationInfo
Опис параметрів об’єкта Параметр Тип successItems integer($int32) failedItems integer($int32)
Об'єкт FailedItemDetail
Per-article quantity pair backing Temabit.Des.ScanningProtocol.Contracts.Responses.FailedItemVali...
Об'єкт FailedItemValidationResult
Опис параметрів об’єкта Параметр Тип totalCount integer($int32) message string or null token stri...
Об'єкт FillScanningProtocolRequest
Опис параметрів об’єкта Параметр Тип items array of objects (CreateScanningProtocolItem) or null
Об'єкт FillScanningProtocolResponse
Опис параметрів об’єкта Параметр Тип businessUnitId string or null items array of objects (Create...
Об'єкт HttpValidationProblemDetails
Опис параметрів об’єкта Параметр Тип type string or null title string or null status integer($int...
Об'єкт InventoryArticleDetail
Опис параметрів об’єкта Параметр Тип successItems integer($int32) barcodes array of barcodes (str...
Об'єкт InventoryFailedTokenGroup
Опис параметрів об’єкта Параметр Тип totalCount integer($int32) message string or null token stri...
Об'єкт InventoryItemsDetailsResponse
Опис параметрів об’єкта Параметр Тип items { < * >: InventoryArticleDetail } nullable: true faile...
Об'єкт OperationDocumentItemRequest
Опис параметрів об’єкта Параметр Тип articleId string or null. Ідентифікатор товарної позиції (ar...
Об'єкт OperationDocumentItemResponse
Опис параметрів об’єкта Параметр Тип articleId string or null. Ідентифікатор товарної позиції (ar...
Об'єкт OperationDocumentRequest
Товарний документ, що додається до протоколу сканування або повністю замінює наявний документ. Оп...
Об'єкт OperationDocumentResponse
Один операційний документ, що повертається методом GET/POST/PUT для операційних документів. Опис ...
Об'єкт OperationalDocumentValidationInfo
Опис параметрів об’єкта Параметр Тип successItems integer($int32) failedItems integer($int32)
Об'єкт ProblemDetails
Опис параметрів об’єкта Параметр Тип type string or null title string or null status integer($int...
Об'єкт ProtocolDetailedValidationResponse
Опис параметрів об’єкта Параметр Тип successItems integer($int32) failedItems { < * >: FailedItem...
Об'єкт ProtocolItemsListResponse
Опис параметрів об’єкта Параметр Тип businessUnitId string or null pageToken string or null total...
Об'єкт ProtocolLookupItem
Опис параметрів об’єкта Параметр Тип protocolId string or null protocolType string or null protoc...
Об'єкт ProtocolReturnDocumentResponse
Один рядок для однієї позиції в результаті виклику GET protocols/{protocolId}/return-documents: A...
Об'єкт ProtocolValidationInfo
Опис параметрів об’єкта Параметр Тип successItems integer($int32) failedItems integer($int32) eed...
Об'єкт ValidationItemsTotal
Опис параметрів об’єкта Параметр Тип successItems integer($int32) failedItems integer($int32)
Об'єкт ProtocolValidationTotal
Опис параметрів об’єкта Параметр Тип protocols об'єкт ValidationItemsTotal eed об'єкт ValidationI...
Об'єкт ProtocolValidationResponse
Опис параметрів об’єкта Параметр Тип protocols { < * >: ProtocolValidationInfo } nullable: true e...
Об'єкт ResolveItemInput
Опис параметрів об’єкта Параметр Тип exciseCode string or null readableCode string or null
Об'єкт ResolveItemResponse
Опис параметрів об’єкта Параметр Тип index integer($int32) exciseCode string or null readableCode...
Об'єкт ResolveItemsRequest
Опис параметрів об’єкта Параметр Тип items array of objects ResolveItemInput or null
Об'єкт ScanningProtocolDocumentResponse
Опис параметрів об’єкта Параметр Тип documentId string or null desState string or null validation...
Об'єкт ScanningProtocolItemResponse
Опис параметрів об’єкта Параметр Тип articleId string or null quantity number($double)
Об'єкт ScanningProtocolOperationDocumentResponse
Опис параметрів об’єкта Параметр Тип relations { < * >: [string or null] } nullable: true operati...
Об'єкт ValidationError
Опис параметрів об’єкта Параметр Тип ruleId string or null message string or null params [string ...
Об'єкт ValidationWarning
Опис параметрів об’єкта Параметр Тип ruleId string or null message string or null params [string ...
Об'єкт ScanningProtocolValidations
Опис параметрів об’єкта Параметр Тип errors array of objects ValidationError or null warnings arr...
Об'єкт ScanningProtocolResponse
Опис параметрів об’єкта Параметр Тип protocolId string or null protocolType string or null operat...
Об'єкт ValidateItemInput
Опис параметрів об’єкта Параметр Тип exciseCode string or null barcode string or null readableCod...
Об'єкт ValidateItemsRequest
Опис параметрів об’єкта Параметр Тип operatorObjectCode string or null protocolType string or nul...
Об'єкт ValidatedItem
Опис параметрів об’єкта Параметр Тип exciseCode string or null barcode string or null readableCod...
Об'єкт ValidationMatchingDataProtocolInfo
Опис параметрів об’єкта Параметр Тип protocolType string or null businessUnitId string or null
Об'єкт ValidationMatchingDataRecord
Опис параметрів об’єкта Параметр Тип recordId string or null itemCode string or null readableCode...
Об'єкт ValidationMatchingDataResponse
Опис параметрів об’єкта Параметр Тип protocols { < * >: ValidationMatchingDataProtocolInfo } null...
Об'єкт UpdateScanningProtocolRequest
Запит на оновлення заголовка протоколу сканування. Управління операційними документами здійснюєть...
Об'єкт UpdateProtocolItemRequest
Опис параметрів об’єкта Параметр Тип itemId* string or null quantity number($double)
Об'єкти API для довідників продукту Е-Акциз
Об'єкт Article
Опис параметрів об’єкта Параметр Тип articleId string or null statusId string or null name string...
Обʼєкт ArticleArticleIncludedBaseCreateResponse
Опис параметрів об’єкта Параметр Тип item Обʼєкт Article articleId string or null statusId string...
Обʼєкт ArticleArticleIncludedBaseGetResponse
Опис параметрів об’єкта Параметр Тип item Обʼєкт Article articleId string or null statusId string...
Обʼєкт ArticleArticleIncludedBaseUpdateResponse
Опис параметрів об’єкта Параметр Тип item Обʼєкт Article articleId string or null statusId string...