{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/nakl.header.json","title":"nakl.header","description":"Повертає заголовок, тип, дати та контрагента накладної.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"nakl.header"},"params":{"type":"object","additionalProperties":false,"properties":{"nn":{"type":"string","maxLength":512,"minLength":1,"title":"Номер накладної","example":"ПН-1001","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","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.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","value"],"additionalProperties":false,"properties":{"code":{"const":"OK"},"operation":{"type":"string"},"value":{"type":"string"}}},"rows":{"type":"array","items":{"type":"object","required":["created_at","posted_at","created_user","posted_user","side_name","status","external_number","declared_sum","paid_sum","expedition","fiscal_sum","side_details","fiscal","payment_date","exchange_rate","currency","writeoff_reason","inventory_reason","inventory_type","inventory_time","inventory_last_stock"],"additionalProperties":false,"properties":{"created_at":{"type":"string","title":"Дата й час створення","description":"Повернені дата й час «Дата й час створення» у форматі ISO 8601.","format":"date-time","example":"2026-07-23T12:00:00+03:00"},"posted_at":{"type":"string","title":"Posted at","description":"Повернена дата «Posted at» у форматі YYYY-MM-DD.","format":"date","example":"2026-07-23"},"created_user":{"type":"string","title":"Created user","description":"Повернене значення «Created user» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"posted_user":{"type":"string","title":"Posted user","description":"Повернене значення «Posted user» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"side_name":{"type":"string","title":"Назва сторони документа","description":"Повернене значення «Назва сторони документа» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"status":{"type":"string","title":"Статус","description":"Повернене значення «Статус» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"external_number":{"type":"string","title":"External number","description":"Повернене значення «External number» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"declared_sum":{"type":"string","title":"Declared sum","description":"Точне повернене значення «Declared sum» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"currency-of-operation"},"paid_sum":{"type":"string","title":"Paid sum","description":"Точне повернене значення «Paid sum» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"currency-of-operation"},"expedition":{"type":"string","title":"Expedition","description":"Повернене значення «Expedition» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"fiscal_sum":{"type":"string","title":"Fiscal sum","description":"Точне повернене значення «Fiscal sum» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"currency-of-operation"},"side_details":{"type":"string","title":"Side details","description":"Повернене значення «Side details» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"fiscal":{"type":"string","title":"Фіскальна ознака","description":"Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"payment_date":{"type":"string","title":"Payment date","description":"Повернена дата «Payment date» у форматі YYYY-MM-DD.","format":"date","example":"2026-07-23"},"exchange_rate":{"type":"string","title":"Exchange rate","description":"Точне повернене значення «Exchange rate» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"ratio"},"currency":{"type":"string","title":"Валюта","description":"Повернене значення «Валюта» відповідного запису, документа або підсумку ARM20.","example":"UAH"},"writeoff_reason":{"type":"string","title":"Writeoff reason","description":"Повернене значення «Writeoff reason» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"inventory_reason":{"type":"string","title":"Inventory reason","description":"Повернене значення «Inventory reason» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"inventory_type":{"type":"string","title":"Inventory type","description":"Повернене значення «Inventory type» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"inventory_time":{"type":"string","title":"Inventory time","description":"Повернений час «Inventory time» у форматі HH:MM:SS.","format":"time","example":"12:00:00"},"inventory_last_stock":{"type":"string","title":"Inventory last stock","description":"Точне повернене значення «Inventory last stock» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"currency-of-operation"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Повертає заголовок, тип, дати та контрагента накладної.","scope":"inventory.read","params":{"nn":{"type":"string","max":512,"required":true,"title":"Номер накладної","description":"Номер накладної у Windows Складі. Для створення нової накладної номер може згенерувати upstream.","group":"Основні","example":"ПН-1001"}},"result":{"mode":"rows","columns":["created_at","posted_at","created_user","posted_user","side_name","status","external_number","declared_sum","paid_sum","expedition","fiscal_sum","side_details","fiscal","payment_date","exchange_rate","currency","writeoff_reason","inventory_reason","inventory_type","inventory_time","inventory_last_stock"],"field_specs":{"created_at":{"title":"Дата й час створення","description":"Повернені дата й час «Дата й час створення» у форматі ISO 8601.","type":"string","format":"date-time","example":"2026-07-23T12:00:00+03:00"},"posted_at":{"title":"Posted at","description":"Повернена дата «Posted at» у форматі YYYY-MM-DD.","type":"string","format":"date","example":"2026-07-23"},"created_user":{"title":"Created user","description":"Повернене значення «Created user» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"posted_user":{"title":"Posted user","description":"Повернене значення «Posted user» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"side_name":{"title":"Назва сторони документа","description":"Повернене значення «Назва сторони документа» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"status":{"title":"Статус","description":"Повернене значення «Статус» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"external_number":{"title":"External number","description":"Повернене значення «External number» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"declared_sum":{"title":"Declared sum","description":"Точне повернене значення «Declared sum» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"paid_sum":{"title":"Paid sum","description":"Точне повернене значення «Paid sum» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"expedition":{"title":"Expedition","description":"Повернене значення «Expedition» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"fiscal_sum":{"title":"Fiscal sum","description":"Точне повернене значення «Fiscal sum» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"side_details":{"title":"Side details","description":"Повернене значення «Side details» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"fiscal":{"title":"Фіскальна ознака","description":"Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"payment_date":{"title":"Payment date","description":"Повернена дата «Payment date» у форматі YYYY-MM-DD.","type":"string","format":"date","example":"2026-07-23"},"exchange_rate":{"title":"Exchange rate","description":"Точне повернене значення «Exchange rate» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"ratio","example":"100.00"},"currency":{"title":"Валюта","description":"Повернене значення «Валюта» відповідного запису, документа або підсумку ARM20.","type":"string","example":"UAH"},"writeoff_reason":{"title":"Writeoff reason","description":"Повернене значення «Writeoff reason» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"inventory_reason":{"title":"Inventory reason","description":"Повернене значення «Inventory reason» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"inventory_type":{"title":"Inventory type","description":"Повернене значення «Inventory type» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"inventory_time":{"title":"Inventory time","description":"Повернений час «Inventory time» у форматі HH:MM:SS.","type":"string","format":"time","example":"12:00:00"},"inventory_last_stock":{"title":"Inventory last stock","description":"Точне повернене значення «Inventory last stock» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"}}},"mutating":false,"idempotency_required":false,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["nakl","header","Повертає заголовок, тип, дати та контрагента накладної.","накладна","документ складу"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Дозволений повтор із backoff."}],"related_methods":[]}}