{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.post.json","title":"nakl.post","description":"Проводить накладну та застосовує її зміни до обліку товарів і розрахунків.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.post"},"params":{"type":"object","additionalProperties":false,"properties":{"allow_minus":{"type":"boolean","default":false,"title":"Дозволити від’ємний залишок","example":false,"description":"Визначає, чи застосовувати параметр «Дозволити від’ємний залишок». Передавайте JSON true або false.","x-api13-group":"Додаткові"},"cost_mode":{"type":"string","enum":["no_update","average","as_doc"],"default":"no_update","title":"Режим перерахунку собівартості","example":"no_update","description":"Варіант «Режим перерахунку собівартості». Використовуйте лише одне зі значень, розшифрованих нижче.","x-api13-group":"Додаткові","x-enumDescriptions":["не змінювати собівартість","розрахувати середню собівартість","взяти собівартість із документа"],"x-api13-enum-labels":{"no_update":"не змінювати собівартість","average":"розрахувати середню собівартість","as_doc":"взяти собівартість із документа"}},"exped":{"type":"string","maxLength":4096,"title":"Експедиція","example":"Приклад","description":"Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"nn":{"type":"string","maxLength":512,"minLength":1,"title":"Номер накладної","example":"ПН-1001","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","x-api13-group":"Основні"},"payment_mode":{"type":"string","enum":["cash_out","supplier_debt","cash_in","cashless_in","contrag_debt","pay_supplier_debt","no_payment"],"default":"no_payment","title":"Режим оплати","example":"cash_out","description":"Варіант «Режим оплати». Використовуйте лише одне зі значень, розшифрованих нижче.","x-api13-group":"Оплата","x-enumDescriptions":["вилучення готівки","борг постачальнику","внесення готівки","безготівкове надходження","борг контрагента","погашення боргу постачальнику","без реєстрації оплати"],"x-api13-enum-labels":{"cash_out":"вилучення готівки","supplier_debt":"борг постачальнику","cash_in":"внесення готівки","cashless_in":"безготівкове надходження","contrag_debt":"борг контрагента","pay_supplier_debt":"погашення боргу постачальнику","no_payment":"без реєстрації оплати"}},"payment_sum":{"type":"string","maxLength":512,"default":"","title":"Сума оплати","format":"decimal-string","example":"100.00","description":"Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"}},"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.post"},"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":{"allow_minus":{"type":"bool","default":false,"title":"Дозволити від’ємний залишок","description":"Визначає, чи застосовувати параметр «Дозволити від’ємний залишок». Передавайте JSON true або false.","group":"Додаткові","example":false},"cost_mode":{"type":"enum","values":["no_update","average","as_doc"],"default":"no_update","title":"Режим перерахунку собівартості","description":"Варіант «Режим перерахунку собівартості». Використовуйте лише одне зі значень, розшифрованих нижче.","group":"Додаткові","example":"no_update","enum_labels":{"no_update":"не змінювати собівартість","average":"розрахувати середню собівартість","as_doc":"взяти собівартість із документа"}},"exped":{"type":"string","max":4096,"title":"Експедиція","description":"Поле «Експедиція» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"Приклад"},"nn":{"type":"string","max":512,"required":true,"title":"Номер накладної","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","group":"Основні","example":"ПН-1001"},"payment_mode":{"type":"enum","values":["cash_out","supplier_debt","cash_in","cashless_in","contrag_debt","pay_supplier_debt","no_payment"],"default":"no_payment","title":"Режим оплати","description":"Варіант «Режим оплати». Використовуйте лише одне зі значень, розшифрованих нижче.","group":"Оплата","example":"cash_out","enum_labels":{"cash_out":"вилучення готівки","supplier_debt":"борг постачальнику","cash_in":"внесення готівки","cashless_in":"безготівкове надходження","contrag_debt":"борг контрагента","pay_supplier_debt":"погашення боргу постачальнику","no_payment":"без реєстрації оплати"}},"payment_sum":{"type":"string","max":512,"default":"","title":"Сума оплати","description":"Точне числове значення «Сума оплати» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"}},"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","post","Проводить накладну та застосовує її зміни до обліку товарів і розрахунків.","накладна","документ складу"],"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":[]}}