{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.line_for_edit.json","title":"nakl.line_for_edit","description":"Повертає та блокує товарну позицію накладної для редагування.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.line_for_edit"},"params":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","maxLength":512,"minLength":1,"title":"Код запису","example":"1001","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","x-api13-group":"Основні"},"nn":{"type":"string","maxLength":512,"minLength":1,"title":"Номер накладної","example":"ПН-1001","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","x-api13-group":"Основні"}},"required":["code","nn"]},"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":"nakl.line_for_edit"},"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":["cost","markup","price","quantity","name"],"additionalProperties":false,"properties":{"cost":{"type":"string","title":"Собівартість","description":"Точне повернене значення «Собівартість» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"currency-of-operation"},"markup":{"type":"string","title":"Націнка","description":"Точне повернене значення «Націнка» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"percent"},"price":{"type":"string","title":"Ціна","description":"Точне повернене значення «Ціна» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"currency-of-operation"},"quantity":{"type":"string","title":"Кількість","description":"Точне повернене значення «Кількість» як десятковий рядок із крапкою.","format":"decimal-string","example":"1.000","x-api13-unit":"product-unit"},"name":{"type":"string","title":"Назва","description":"Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.","example":"Тестовий товар"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Повертає та блокує товарну позицію накладної для редагування.","scope":"inventory.write","params":{"code":{"type":"string","max":512,"required":true,"title":"Код запису","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"nn":{"type":"string","max":512,"required":true,"title":"Номер накладної","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","group":"Основні","example":"ПН-1001"}},"result":{"mode":"rows","columns":["cost","markup","price","quantity","name"],"field_specs":{"cost":{"title":"Собівартість","description":"Точне повернене значення «Собівартість» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"markup":{"title":"Націнка","description":"Точне повернене значення «Націнка» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"percent","example":"100.00"},"price":{"title":"Ціна","description":"Точне повернене значення «Ціна» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"quantity":{"title":"Кількість","description":"Точне повернене значення «Кількість» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"product-unit","example":"1.000"},"name":{"title":"Назва","description":"Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Тестовий товар"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["nakl","line for edit","Повертає та блокує товарну позицію накладної для редагування.","накладна","документ складу"],"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":[]}}