{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.create.json","title":"nakl.create","description":"Створює нову накладну та автоматично присвоює їй номер.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.create"},"params":{"type":"object","additionalProperties":false,"properties":{"cdat":{"type":"string","maxLength":4096,"default":"","title":"Дата документа","format":"date","example":"2026-07-23","description":"Дата створюваного або редагованого документа у форматі YYYY-MM-DD.","x-api13-group":"Дати й час"},"contrag":{"type":"string","maxLength":512,"default":"","title":"Контрагент","example":"","description":"Поле «Контрагент» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"copy_from_nn":{"type":"string","maxLength":512,"default":"","title":"Номер документа-джерела","example":"ПН-1001","description":"Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"currency":{"type":"string","maxLength":4096,"default":"","title":"Валюта","example":"UAH","description":"Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"exp":{"type":"string","maxLength":4096,"default":"","title":"Експедиція","example":"","description":"Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"fiscal":{"type":"boolean","default":false,"title":"Фіскальна ознака","example":false,"description":"Визначає, чи застосовувати параметр «Фіскальна ознака». Передавайте JSON true або false.","x-api13-group":"Фіскалізація"},"from_store":{"type":"string","maxLength":4096,"default":"","title":"Склад-джерело","example":"","description":"Поле «Склад-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"inv_time":{"type":"string","maxLength":512,"default":"","title":"Час інвентаризації","format":"time","example":"12:00:00","description":"Час «Час інвентаризації» у форматі HH:MM:SS.","x-api13-group":"Дати й час"},"inv_type":{"type":"string","maxLength":512,"default":"","title":"Тип інвентаризації","example":"","description":"Поле «Тип інвентаризації» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"kurs":{"type":"string","maxLength":4096,"default":"0","title":"Курс валюти","format":"decimal-string","example":"100.00","description":"Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.","x-api13-group":"Суми та кількості","x-api13-unit":"ratio"},"pay_date":{"type":"string","maxLength":512,"default":"","title":"Дата оплати","format":"date","example":"2026-07-23","description":"Дата «Дата оплати» у календарному форматі YYYY-MM-DD.","x-api13-group":"Дати й час"},"pay_sum":{"type":"string","maxLength":4096,"title":"Сума оплати","format":"decimal-string","example":"100.00","description":"Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"post":{"type":"string","maxLength":4096,"default":"","title":"Постачальник","example":"","description":"Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"psum":{"type":"string","maxLength":4096,"default":"0","title":"Загальна сума документа","format":"decimal-string","example":"100.00","description":"Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"reason":{"type":"string","maxLength":4096,"default":"","title":"Причина операції","example":"","description":"Поле «Причина операції» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"to_store":{"type":"string","maxLength":4096,"default":"","title":"Склад-призначення","example":"","description":"Поле «Склад-призначення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"type":{"type":"string","enum":["PN","RN","VN","SN","IV","MN"],"minLength":1,"title":"Тип накладної","example":"PN","description":"Код виду документа або режиму. Розшифрування кожного допустимого значення наведено нижче.","x-api13-group":"Основні","x-enumDescriptions":["прибуткова накладна","видаткова накладна","повернення постачальнику","списання","інвентаризація","переміщення між складами"],"x-api13-enum-labels":{"PN":"прибуткова накладна","RN":"видаткова накладна","VN":"повернення постачальнику","SN":"списання","IV":"інвентаризація","MN":"переміщення між складами"}},"vnum":{"type":"string","maxLength":4096,"default":"","title":"Зовнішній номер документа","example":"","description":"Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"lines":{"type":"array","items":{"type":"string","maxLength":190,"minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F]{1,190}$","title":"Lines item","example":"Приклад","description":"Поле «Lines item» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"minItems":0,"maxItems":300,"uniqueItems":true,"title":"Позиції документа","example":[],"description":"Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче.","x-api13-group":"Колекції"}},"required":["type"]},"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.create"},"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":["document_number"],"additionalProperties":false,"properties":{"document_number":{"type":"string","title":"Номер документа","description":"Номер документа у базі поточного клієнта.","example":"ПН-1001"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Створює нову накладну та автоматично присвоює їй номер.","scope":"inventory.write","params":{"cdat":{"type":"string","max":4096,"default":"","title":"Дата документа","description":"Дата створюваного або редагованого документа у форматі YYYY-MM-DD.","group":"Дати й час","format":"date","example":"2026-07-23"},"contrag":{"type":"string","max":512,"default":"","title":"Контрагент","description":"Поле «Контрагент» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"copy_from_nn":{"type":"string","max":512,"default":"","title":"Номер документа-джерела","description":"Поле «Номер документа-джерела» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"ПН-1001"},"currency":{"type":"string","max":4096,"default":"","title":"Валюта","description":"Поле «Валюта» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"UAH"},"exp":{"type":"string","max":4096,"default":"","title":"Експедиція","description":"Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"fiscal":{"type":"bool","default":false,"title":"Фіскальна ознака","description":"Визначає, чи застосовувати параметр «Фіскальна ознака». Передавайте JSON true або false.","group":"Фіскалізація","example":false},"from_store":{"type":"string","max":4096,"default":"","title":"Склад-джерело","description":"Поле «Склад-джерело» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"inv_time":{"type":"string","max":512,"default":"","title":"Час інвентаризації","description":"Час «Час інвентаризації» у форматі HH:MM:SS.","group":"Дати й час","format":"time","example":"12:00:00"},"inv_type":{"type":"string","max":512,"default":"","title":"Тип інвентаризації","description":"Поле «Тип інвентаризації» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"kurs":{"type":"string","max":4096,"default":"0","title":"Курс валюти","description":"Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.","group":"Суми та кількості","format":"decimal-string","unit":"ratio","example":"100.00"},"pay_date":{"type":"string","max":512,"default":"","title":"Дата оплати","description":"Дата «Дата оплати» у календарному форматі YYYY-MM-DD.","group":"Дати й час","format":"date","example":"2026-07-23"},"pay_sum":{"type":"string","max":4096,"title":"Сума оплати","description":"Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"post":{"type":"string","max":4096,"default":"","title":"Постачальник","description":"Поле «Постачальник» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"psum":{"type":"string","max":4096,"default":"0","title":"Загальна сума документа","description":"Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"reason":{"type":"string","max":4096,"default":"","title":"Причина операції","description":"Поле «Причина операції» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"to_store":{"type":"string","max":4096,"default":"","title":"Склад-призначення","description":"Поле «Склад-призначення» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"type":{"type":"enum","required":true,"values":["PN","RN","VN","SN","IV","MN"],"title":"Тип накладної","description":"Код виду документа або режиму. Розшифрування кожного допустимого значення наведено нижче.","group":"Основні","example":"PN","enum_labels":{"PN":"прибуткова накладна","RN":"видаткова накладна","VN":"повернення постачальнику","SN":"списання","IV":"інвентаризація","MN":"переміщення між складами"}},"vnum":{"type":"string","max":4096,"default":"","title":"Зовнішній номер документа","description":"Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"lines":{"type":"array","required":false,"min_items":0,"max_items":300,"unique":true,"items":{"type":"string","required":true,"max":190,"pattern":"/^[^\\x00-\\x1F\\x7F]{1,190}$/uD","title":"Lines item","description":"Поле «Lines item» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"Приклад"},"title":"Позиції документа","description":"Позиції, які треба додати до документа. Формат елемента наведено в схемі нижче.","group":"Колекції","example":[]}},"result":{"mode":"rows","columns":["document_number"],"field_specs":{"document_number":{"title":"Номер документа","description":"Номер документа у базі поточного клієнта.","type":"string","example":"ПН-1001"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["nakl","create","Створює нову накладну та автоматично присвоює їй номер.","накладна","документ складу"],"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.add_lines","nakl.header","nakl.save_line","nakl.update_header"]}}