{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.pos_return_apply_line.json","title":"pos.pos_return_apply_line","description":"Записує одну повернену товарну позицію до чека повернення.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"pos.pos_return_apply_line"},"params":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","maxLength":512,"minLength":1,"title":"Код товару","example":"1001","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","x-api13-group":"Основні"},"fil":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Номер філії","example":1,"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.0001,"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.0001. Value <= 1000000.","title":"Кількість","format":"decimal-string","example":"1.000","x-api13-group":"Суми та кількості","x-api13-unit":"product-unit"},"return_check":{"type":"integer","minimum":1,"maximum":2147483647,"title":"Номер чека повернення","example":1,"description":"Поле «Номер чека повернення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"sk":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Номер складу або філії","example":1,"description":"Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.","x-api13-group":"Додаткові"},"source_check":{"type":"integer","minimum":1,"maximum":2147483647,"title":"Номер початкового чека","example":1,"description":"Поле «Номер початкового чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","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":"філіальний склад"}}},"required":["code","quant","return_check","source_check"]},"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.pos_return_apply_line"},"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":["return_check_number","restored_quantity"],"additionalProperties":false,"properties":{"return_check_number":{"type":"string","title":"Return check number","description":"Повернене значення «Return check number» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"restored_quantity":{"type":"string","title":"Restored quantity","description":"Точне повернене значення «Restored quantity» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"product-unit"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Записує одну повернену товарну позицію до чека повернення.","scope":"pos.write","params":{"code":{"type":"string","max":512,"required":true,"title":"Код товару","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"fil":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Номер філії","description":"Поле «Номер філії» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"quant":{"type":"decimal","required":true,"max":32,"scale":3,"numeric_min":0.0001,"exclusive_min":true,"numeric_max":1000000,"title":"Кількість","description":"Кількість товару як десятковий рядок; для вагового товару дозволена дробова частина.","group":"Суми та кількості","format":"decimal-string","unit":"product-unit","example":"1.000"},"return_check":{"type":"int","required":true,"min":1,"max":2147483647,"title":"Номер чека повернення","description":"Поле «Номер чека повернення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"sk":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Номер складу або філії","description":"Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.","group":"Додаткові","example":1},"source_check":{"type":"int","required":true,"min":1,"max":2147483647,"title":"Номер початкового чека","description":"Поле «Номер початкового чека» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"storage":{"type":"enum","values":["main","branch"],"default":"main","title":"Склад","description":"Логічний склад: main — основний, branch — філіальний.","group":"Основні","example":"main","enum_labels":{"main":"основний склад","branch":"філіальний склад"}}},"result":{"mode":"rows","columns":["return_check_number","restored_quantity"],"field_specs":{"return_check_number":{"title":"Return check number","description":"Повернене значення «Return check number» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"restored_quantity":{"title":"Restored quantity","description":"Точне повернене значення «Restored quantity» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"product-unit","example":"100.00"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","pos return apply line","Записує одну повернену товарну позицію до чека повернення.","Windows Каса"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт."},{"code":"IDEMPOTENCY_KEY_REQUIRED","http":422,"description":"Для виконання запису не передано Idempotency-Key.","retry":"Створити ключ для цієї бізнес-операції та повторити."},{"code":"IDEMPOTENCY_RESULT_UNKNOWN","http":409,"description":"Результат попередньої спроби невідомий; gateway не виконав запис повторно.","retry":"Звірити документ, чек або платіж; не створювати новий ключ автоматично."}],"related_methods":["pos.prro_revision_check_lines","pos.reports_check_print_rows"]}}