{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.excise_shortage_check.json","title":"pos.excise_shortage_check","description":"Перевіряє наявність потрібних акцизних марок для продажу.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"pos.excise_shortage_check"},"params":{"type":"object","additionalProperties":false,"properties":{"kasm":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Номер каси","example":1,"description":"Числовий номер каси, налаштований у Windows Касі.","x-api13-group":"Додаткові"},"pref_disc":{"type":"string","maxLength":4096,"default":"","title":"Префікс дисконтної картки","example":"","description":"Префікс, за яким відсканований код розпізнається як дисконтна картка.","x-api13-group":"Додаткові"},"sk":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Номер складу або філії","example":1,"description":"Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.","x-api13-group":"Додаткові"},"storage":{"type":"string","enum":["main","branch"],"default":"main","title":"Склад","example":"main","description":"Логічний склад: main — основний, branch — філіальний.","x-api13-group":"Основні","x-enumDescriptions":["основний склад","філіальний склад"],"x-api13-enum-labels":{"main":"основний склад","branch":"філіальний склад"}},"rows":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","maxLength":190,"minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F]{1,190}$","title":"Код товару або акцизної марки","example":"1001","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","x-api13-group":"Основні"},"nt":{"type":"string","maxLength":512,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$","title":"Назва товару","example":"Тестовий товар","description":"Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Основні"},"quant":{"type":"string","maxLength":32,"minLength":1,"pattern":"^(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,3})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,3})?|0\\.(?=[0-9]{0,2}[1-9])[0-9]{1,3}))$","x-api13-scale":3,"x-api13-numeric-minimum":0,"x-api13-exclusive-minimum":true,"x-api13-numeric-maximum":1000000,"x-api13-exclusive-maximum":false,"description":"Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина. Decimal encoded as a JSON string; at most 3 fractional digits. Value > 0. Value <= 1000000.","title":"Кількість","format":"decimal-string","example":"1.000","x-api13-group":"Суми та кількості","x-api13-unit":"product-unit"}},"required":["code","quant"]},"minItems":1,"maxItems":300,"title":"Рядки операції","example":[],"description":"Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.","x-api13-group":"Колекції"}},"required":["rows"]},"id":{"type":["string","integer","null"]}}}]},"response":{"oneOf":[{"type":"object","required":["ok","data","request_id"],"additionalProperties":false,"properties":{"ok":{"const":true},"data":{"type":"object","required":["method","result","id"],"additionalProperties":false,"properties":{"method":{"const":"pos.excise_shortage_check"},"result":{"type":"object","required":["upstream","status","rows"],"additionalProperties":false,"properties":{"upstream":{"type":"object","required":["name","version","resource"],"additionalProperties":false,"properties":{"name":{"const":"UPMAPI"},"version":{"type":"string"},"resource":{"type":"string"}}},"status":{"type":"object","required":["code","operation","value"],"additionalProperties":false,"properties":{"code":{"const":"OK"},"operation":{"type":"string"},"value":{"type":"string"}}},"rows":{"type":"array","items":{"type":"object","required":["code","name","required_count","available_count","row_number","pending_debug"],"additionalProperties":false,"properties":{"code":{"type":"string","title":"Код товару або акцизної марки","description":"Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20.","example":"1001"},"name":{"type":"string","title":"Назва","description":"Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.","example":"Тестовий товар"},"required_count":{"type":"string","title":"Required count","description":"Повернене значення «Required count» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"available_count":{"type":"string","title":"Available count","description":"Повернене значення «Available count» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"row_number":{"type":"string","title":"Row number","description":"Повернене значення «Row number» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"pending_debug":{"type":"string","title":"Pending debug","description":"Повернене значення «Pending debug» відповідного запису, документа або підсумку ARM20.","example":"Приклад"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Перевіряє наявність потрібних акцизних марок для продажу.","scope":"pos.read","params":{"kasm":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Номер каси","description":"Числовий номер каси, налаштований у Windows Касі.","group":"Додаткові","example":1},"pref_disc":{"type":"string","max":4096,"default":"","title":"Префікс дисконтної картки","description":"Префікс, за яким відсканований код розпізнається як дисконтна картка.","group":"Додаткові","example":""},"sk":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Номер складу або філії","description":"Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.","group":"Додаткові","example":1},"storage":{"type":"enum","values":["main","branch"],"default":"main","title":"Склад","description":"Логічний склад: main — основний, branch — філіальний.","group":"Основні","example":"main","enum_labels":{"main":"основний склад","branch":"філіальний склад"}},"rows":{"type":"array","required":true,"min_items":1,"max_items":300,"items":{"type":"object","fields":{"code":{"type":"string","required":true,"max":190,"pattern":"/^[^\\x00-\\x1F\\x7F]{1,190}$/uD","title":"Код товару або акцизної марки","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"nt":{"type":"string","max":512,"pattern":"/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD","title":"Назва товару","description":"Поле «Назва товару» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Основні","example":"Тестовий товар"},"quant":{"type":"decimal","required":true,"max":32,"scale":3,"numeric_min":0,"exclusive_min":true,"numeric_max":1000000,"title":"Кількість","description":"Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.","group":"Суми та кількості","format":"decimal-string","unit":"product-unit","example":"1.000"}}},"title":"Рядки операції","description":"Структурований масив рядків. Невідомі поля та порушення схеми відхиляються gateway.","group":"Колекції","example":[]}},"result":{"mode":"rows","columns":["code","name","required_count","available_count","row_number","pending_debug"],"field_specs":{"code":{"title":"Код товару або акцизної марки","description":"Повернене значення «Код товару або акцизної марки» відповідного запису, документа або підсумку ARM20.","type":"string","example":"1001"},"name":{"title":"Назва","description":"Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Тестовий товар"},"required_count":{"title":"Required count","description":"Повернене значення «Required count» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"available_count":{"title":"Available count","description":"Повернене значення «Available count» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"row_number":{"title":"Row number","description":"Повернене значення «Row number» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"pending_debug":{"title":"Pending debug","description":"Повернене значення «Pending debug» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"}}},"mutating":false,"idempotency_required":false,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","excise shortage check","Перевіряє наявність потрібних акцизних марок для продажу.","Windows Каса"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Дозволений повтор із backoff."}],"related_methods":["pos.excise_add_mark","pos.excise_bind_pending","pos.excise_clear_pending","pos.excise_duplicate"]}}