{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.import_prepare.json","title":"nakl.import_prepare","description":"Готує тимчасовий набір даних для імпорту до накладної.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.import_prepare"},"params":{"type":"object","additionalProperties":false,"properties":{"nn":{"type":"string","maxLength":512,"default":"","title":"Номер накладної","example":"ПН-1001","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","x-api13-group":"Основні"},"lines":{"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":"Основні"},"name":{"type":"string","maxLength":512,"minLength":1,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$","title":"Назва","example":"Тестовий товар","description":"Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Основні"},"cost":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Собівартість","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"markup":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Націнка","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"percent"},"price":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Ціна за одиницю товару як десятковий рядок без символу валюти. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Ціна","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"unit_type":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"title":"Одиниця виміру","example":1,"description":"Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"quantity":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Кількість товару як десятковий рядок; одиниця залежить від картки товару. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Кількість","format":"decimal-string","example":"1.000","x-api13-group":"Суми та кількості","x-api13-unit":"product-unit"},"shelf_life_days":{"type":"integer","minimum":0,"maximum":36500,"default":0,"title":"Строк придатності, днів","example":1,"description":"Поле «Строк придатності, днів» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"category_id":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"title":"Ідентифікатор категорії","example":1,"description":"Ідентифікатор «Ідентифікатор категорії», отриманий із результату відповідного методу читання цієї бази.","x-api13-group":"Додаткові"},"no_discount":{"type":"boolean","default":false,"title":"Заборонити знижку","example":false,"description":"Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.","x-api13-group":"Додаткові"},"source_document":{"type":"string","maxLength":512,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$","default":"","title":"Документ-джерело","example":"","description":"Поле «Документ-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"inventory_quantity":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Кількість за інвентаризацією» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Кількість за інвентаризацією","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"product-unit"}},"required":["code","name"]},"minItems":1,"maxItems":80,"title":"Позиції документа","example":[],"description":"Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче.","x-api13-group":"Колекції"},"products":{"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":"Основні"},"name":{"type":"string","maxLength":512,"minLength":1,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$","title":"Назва","example":"Тестовий товар","description":"Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Основні"},"cost":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Собівартість","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"markup":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Націнка","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"percent"},"price":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Ціна за одиницю товару як десятковий рядок без символу валюти. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Ціна","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"unit_type":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"title":"Одиниця виміру","example":1,"description":"Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"quantity":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Кількість товару як десятковий рядок; одиниця залежить від картки товару. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Кількість","format":"decimal-string","example":"1.000","x-api13-group":"Суми та кількості","x-api13-unit":"product-unit"},"date_added":{"type":"string","maxLength":30,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$","default":"","title":"Дата додавання","format":"date","example":"2026-07-23","description":"Дата «Дата додавання» у календарному форматі YYYY-MM-DD.","x-api13-group":"Дати й час"},"shelf_life_days":{"type":"integer","minimum":0,"maximum":36500,"default":0,"title":"Строк придатності, днів","example":1,"description":"Поле «Строк придатності, днів» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"supplier":{"type":"string","maxLength":512,"pattern":"^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$","default":"","title":"Постачальник","example":"","description":"Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"critical_quantity":{"type":"string","maxLength":32,"pattern":"^(?:(?:(?:0|[1-9][0-9]*)(?:\\.[0-9]{1,8})?|-(?:[1-9][0-9]*(?:\\.[0-9]{1,8})?|0\\.(?=[0-9]{0,7}[1-9])[0-9]{1,8})))?$","x-api13-scale":8,"description":"Точне числове значення «Критичний залишок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається. Decimal encoded as a JSON string; at most 8 fractional digits.","default":"0","title":"Критичний залишок","format":"decimal-string","example":"100.00","x-api13-group":"Суми та кількості","x-api13-unit":"product-unit"},"category_id":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"title":"Ідентифікатор категорії","example":1,"description":"Ідентифікатор «Ідентифікатор категорії», отриманий із результату відповідного методу читання цієї бази.","x-api13-group":"Додаткові"},"no_discount":{"type":"boolean","default":false,"title":"Заборонити знижку","example":false,"description":"Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.","x-api13-group":"Додаткові"},"c2":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"title":"C2","example":1,"description":"Поле «C2» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"additional_info":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"title":"Додаткова інформація","example":1,"description":"Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"}},"required":["code","name"]},"minItems":0,"maxItems":80,"title":"Товари","example":[],"description":"Список «Товари». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.","x-api13-group":"Колекції"}},"required":["lines"]},"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.import_prepare"},"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","title":"Значення","description":"Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.","example":"Приклад"}}},"rows":{"type":"array","items":{},"maxItems":0}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Готує тимчасовий набір даних для імпорту до накладної.","scope":"inventory.write","params":{"nn":{"type":"string","max":512,"default":"","title":"Номер накладної","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","group":"Основні","example":"ПН-1001"},"lines":{"type":"array","required":true,"min_items":1,"max_items":80,"items":{"type":"object","fields":{"code":{"type":"string","required":true,"max":190,"pattern":"/^[^\\x00-\\x1F\\x7F]{1,190}$/uD","title":"Код запису","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"name":{"type":"string","required":true,"max":512,"pattern":"/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$/uD","title":"Назва","description":"Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Основні","example":"Тестовий товар"},"cost":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Собівартість","description":"Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"markup":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Націнка","description":"Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"percent","example":"100.00"},"price":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Ціна","description":"Ціна за одиницю товару як десятковий рядок без символу валюти.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"unit_type":{"type":"int","min":0,"max":2147483647,"default":0,"title":"Одиниця виміру","description":"Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"quantity":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Кількість","description":"Кількість товару як десятковий рядок; одиниця залежить від картки товару.","group":"Суми та кількості","format":"decimal-string","unit":"product-unit","example":"1.000"},"shelf_life_days":{"type":"int","min":0,"max":36500,"default":0,"title":"Строк придатності, днів","description":"Поле «Строк придатності, днів» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"category_id":{"type":"int","min":0,"max":2147483647,"default":0,"title":"Ідентифікатор категорії","description":"Ідентифікатор «Ідентифікатор категорії», отриманий із результату відповідного методу читання цієї бази.","group":"Додаткові","example":1},"no_discount":{"type":"bool","default":false,"title":"Заборонити знижку","description":"Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.","group":"Додаткові","example":false},"source_document":{"type":"string","max":512,"pattern":"/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD","default":"","title":"Документ-джерело","description":"Поле «Документ-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"inventory_quantity":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Кількість за інвентаризацією","description":"Точне числове значення «Кількість за інвентаризацією» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"product-unit","example":"100.00"}}},"title":"Позиції документа","description":"Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче.","group":"Колекції","example":[]},"products":{"type":"array","required":false,"min_items":0,"max_items":80,"items":{"type":"object","fields":{"code":{"type":"string","required":true,"max":190,"pattern":"/^[^\\x00-\\x1F\\x7F]{1,190}$/uD","title":"Код запису","description":"Публічний код товару, картки або іншого запису, як він відображається у програмі.","group":"Основні","example":"1001"},"name":{"type":"string","required":true,"max":512,"pattern":"/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]{1,512}$/uD","title":"Назва","description":"Поле «Назва» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Основні","example":"Тестовий товар"},"cost":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Собівартість","description":"Точне числове значення «Собівартість» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"markup":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Націнка","description":"Точне числове значення «Націнка» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"percent","example":"100.00"},"price":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Ціна","description":"Ціна за одиницю товару як десятковий рядок без символу валюти.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"unit_type":{"type":"int","min":0,"max":2147483647,"default":0,"title":"Одиниця виміру","description":"Поле «Одиниця виміру» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"quantity":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Кількість","description":"Кількість товару як десятковий рядок; одиниця залежить від картки товару.","group":"Суми та кількості","format":"decimal-string","unit":"product-unit","example":"1.000"},"date_added":{"type":"string","max":30,"pattern":"/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD","default":"","title":"Дата додавання","description":"Дата «Дата додавання» у календарному форматі YYYY-MM-DD.","group":"Дати й час","format":"date","example":"2026-07-23"},"shelf_life_days":{"type":"int","min":0,"max":36500,"default":0,"title":"Строк придатності, днів","description":"Поле «Строк придатності, днів» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"supplier":{"type":"string","max":512,"pattern":"/^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$/uD","default":"","title":"Постачальник","description":"Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"critical_quantity":{"type":"decimal","max":32,"scale":8,"default":"0","title":"Критичний залишок","description":"Точне числове значення «Критичний залишок» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"product-unit","example":"100.00"},"category_id":{"type":"int","min":0,"max":2147483647,"default":0,"title":"Ідентифікатор категорії","description":"Ідентифікатор «Ідентифікатор категорії», отриманий із результату відповідного методу читання цієї бази.","group":"Додаткові","example":1},"no_discount":{"type":"bool","default":false,"title":"Заборонити знижку","description":"Визначає, чи застосовувати параметр «Заборонити знижку». Передавайте JSON true або false.","group":"Додаткові","example":false},"c2":{"type":"int","min":0,"max":2147483647,"default":0,"title":"C2","description":"Поле «C2» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"additional_info":{"type":"int","min":0,"max":2147483647,"default":0,"title":"Додаткова інформація","description":"Поле «Додаткова інформація» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1}}},"title":"Товари","description":"Список «Товари». Структуру одного елемента, обов’язкові поля та межі кількості наведено нижче.","group":"Колекції","example":[]}},"result":{"mode":"scalar","value_type":"string","value_spec":{"title":"Значення","description":"Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["nakl","import prepare","Готує тимчасовий набір даних для імпорту до накладної.","накладна","документ складу"],"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":["nakl.import_android_tsd","nakl.import_cancel","nakl.import_confirm","nakl.import_main_add_line"]}}