{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.prro_inline_enqueue.json","title":"pos.prro_inline_enqueue","description":"Ставить фіскальний документ у чергу онлайн-обміну з ПРРО.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"pos.prro_inline_enqueue"},"params":{"type":"object","additionalProperties":false,"properties":{"control_code":{"type":"string","maxLength":512,"default":"","title":"Контрольний код ПРРО","example":"","description":"Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"doc_hash":{"type":"string","maxLength":4096,"default":"","title":"Хеш документа","format":"sha256","example":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","description":"Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Фіскалізація"},"doc_type":{"type":"string","maxLength":512,"default":"0","title":"Тип документа","example":"0","description":"Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"fiscal_number":{"type":"string","maxLength":4096,"default":"","title":"Фіскальний номер","example":"4000000001","description":"Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Фіскалізація"},"kasm":{"type":"string","maxLength":512,"minLength":1,"title":"Номер каси","example":"Приклад","description":"Числовий номер каси, налаштований у Windows Касі.","x-api13-group":"Додаткові"},"local_doc_number":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Локальний номер документа","example":1,"description":"Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"local_num":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Локальний порядковий номер","example":1,"description":"Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"numprro":{"type":"string","maxLength":4096,"minLength":1,"title":"Номер ПРРО","example":"4000000001","description":"Фіскальний номер ПРРО, налаштований для каси у Windows.","x-api13-group":"Фіскалізація"},"offline_session_id":{"type":"string","maxLength":4096,"default":"","title":"Ідентифікатор офлайн-сесії","example":"","description":"Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.","x-api13-group":"Додаткові"},"prev_doc_hash":{"type":"string","maxLength":4096,"default":"","title":"Prev doc hash","format":"sha256","example":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","description":"Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Фіскалізація"},"xml_body_b64":{"type":"string","maxLength":60000,"minLength":1,"title":"XML документа у Base64","format":"byte","example":"PHhtbD5leGFtcGxlPC94bWw+","description":"Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Фіскалізація"}},"required":["kasm","numprro","xml_body_b64"]},"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":"pos.prro_inline_enqueue"},"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":["id"],"additionalProperties":false,"properties":{"id":{"type":"string","title":"Ідентифікатор запису","description":"Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.","example":"Приклад"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Ставить фіскальний документ у чергу онлайн-обміну з ПРРО.","scope":"pos.write","params":{"control_code":{"type":"string","max":512,"default":"","title":"Контрольний код ПРРО","description":"Поле «Контрольний код ПРРО» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"doc_hash":{"type":"string","max":4096,"default":"","title":"Хеш документа","description":"Поле «Хеш документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Фіскалізація","format":"sha256","example":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},"doc_type":{"type":"string","max":512,"default":"0","title":"Тип документа","description":"Поле «Тип документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"0"},"fiscal_number":{"type":"string","max":4096,"default":"","title":"Фіскальний номер","description":"Поле «Фіскальний номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Фіскалізація","example":"4000000001"},"kasm":{"type":"string","max":512,"required":true,"title":"Номер каси","description":"Числовий номер каси, налаштований у Windows Касі.","group":"Додаткові","example":"Приклад"},"local_doc_number":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Локальний номер документа","description":"Поле «Локальний номер документа» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"local_num":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Локальний порядковий номер","description":"Поле «Локальний порядковий номер» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":1},"numprro":{"type":"string","max":4096,"required":true,"title":"Номер ПРРО","description":"Фіскальний номер ПРРО, налаштований для каси у Windows.","group":"Фіскалізація","example":"4000000001"},"offline_session_id":{"type":"string","max":4096,"default":"","title":"Ідентифікатор офлайн-сесії","description":"Ідентифікатор «Ідентифікатор офлайн-сесії», отриманий із результату відповідного методу читання цієї бази.","group":"Додаткові","example":""},"prev_doc_hash":{"type":"string","max":4096,"default":"","title":"Prev doc hash","description":"Поле «Prev doc hash» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Фіскалізація","format":"sha256","example":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},"xml_body_b64":{"type":"string","max":60000,"required":true,"title":"XML документа у Base64","description":"Поле «XML документа у Base64» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Фіскалізація","format":"byte","example":"PHhtbD5leGFtcGxlPC94bWw+"}},"result":{"mode":"rows","columns":["id"],"field_specs":{"id":{"title":"Ідентифікатор запису","description":"Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","prro inline enqueue","Ставить фіскальний документ у чергу онлайн-обміну з ПРРО.","Windows Каса"],"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":["pos.prro_fiscal_error_move_empty_order","pos.prro_fiscal_lookup","pos.prro_fiscal_order_tax_update","pos.prro_fiscal_restore_from_error"]}}