{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.update_header.json","title":"nakl.update_header","description":"Оновлює заголовок, дати та контрагента накладної.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.update_header"},"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":"Дати й час"},"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":"Фіскалізація"},"kurs":{"type":"string","maxLength":4096,"default":"0","title":"Курс валюти","format":"decimal-string","example":"100.00","description":"Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.","x-api13-group":"Суми та кількості","x-api13-unit":"ratio"},"nn":{"type":"string","maxLength":512,"minLength":1,"title":"Номер накладної","example":"ПН-1001","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","x-api13-group":"Основні"},"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"},"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"},"side":{"type":"string","maxLength":4096,"default":"","title":"Сторона документа","example":"","description":"Поле «Сторона документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"vnum":{"type":"string","maxLength":4096,"default":"","title":"Зовнішній номер документа","example":"","description":"Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"}},"required":["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.update_header"},"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","affected","detail"],"additionalProperties":false,"properties":{"code":{"const":"OK"},"operation":{"type":"string"},"affected":{"type":"string","title":"Змінено записів","description":"Кількість записів, які upstream фактично змінив.","example":"Приклад"},"detail":{"type":"string","title":"Деталі результату","description":"Безпечні додаткові відомості про виконання операції.","example":"Приклад"}}},"rows":{"type":"array","items":{},"maxItems":0}}},"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"},"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},"kurs":{"type":"string","max":4096,"default":"0","title":"Курс валюти","description":"Курс валюти як десятковий рядок. Для гривні зазвичай передається 1.0000.","group":"Суми та кількості","format":"decimal-string","unit":"ratio","example":"100.00"},"nn":{"type":"string","max":512,"required":true,"title":"Номер накладної","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","group":"Основні","example":"ПН-1001"},"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"},"psum":{"type":"string","max":4096,"default":"0","title":"Загальна сума документа","description":"Точне числове значення «Загальна сума документа» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"side":{"type":"string","max":4096,"default":"","title":"Сторона документа","description":"Поле «Сторона документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"vnum":{"type":"string","max":4096,"default":"","title":"Зовнішній номер документа","description":"Поле «Зовнішній номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""}},"result":{"mode":"status","fields":["affected","detail"],"field_specs":{"affected":{"title":"Змінено записів","description":"Кількість записів, які upstream фактично змінив.","type":"string","example":"Приклад"},"detail":{"title":"Деталі результату","description":"Безпечні додаткові відомості про виконання операції.","type":"string","example":"Приклад"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["nakl","update header","Оновлює заголовок, дати та контрагента накладної.","накладна","документ складу"],"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":[]}}