{ "openapi": "3.1.0", "info": { "title": "StuStaPay Administration API", "license": { "name": "AGPL-3.0" }, "version": "0.1.0" }, "paths": { "/products": { "get": { "tags": [ "products" ], "summary": "List Products", "operationId": "list_products", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Product_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "products" ], "summary": "Create Product", "operationId": "create_product", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProduct" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/products/{product_id}": { "get": { "tags": [ "products" ], "summary": "Get Product", "operationId": "get_product", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Product Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "products" ], "summary": "Update Product", "operationId": "update_product", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Product Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProduct" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "products" ], "summary": "Delete Product", "operationId": "delete_product", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Product Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users": { "get": { "tags": [ "users" ], "summary": "List Users", "operationId": "list_users", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "filter_privilege", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/Privilege" }, { "type": "null" } ], "title": "Filter Privilege" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_User_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "users" ], "summary": "Create User", "operationId": "create_user", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get User", "operationId": "get_user", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "users" ], "summary": "Update User", "operationId": "update_user", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete User", "operationId": "delete_user", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/users/{user_id}/change-password": { "post": { "tags": [ "users" ], "summary": "Change User Password", "operationId": "change_user_password", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPasswordPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-roles": { "get": { "tags": [ "user-roles" ], "summary": "List User Roles", "operationId": "list_user_roles", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_UserRole_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "user-roles" ], "summary": "Create User Role", "operationId": "create_user_role", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserRole" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRole" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-roles/{user_role_id}": { "post": { "tags": [ "user-roles" ], "summary": "Update User Role", "operationId": "update_user_role", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Role Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRolePrivilegesPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRole" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "user-roles" ], "summary": "Delete User Role", "operationId": "delete_user_role", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_role_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Role Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-to-roles": { "get": { "tags": [ "user-to-roles" ], "summary": "List User To Role", "operationId": "list_user_to_role", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserToRoles" }, "title": "Response List User To Role User To Roles Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "user-to-roles" ], "summary": "Update User To Roles", "operationId": "update_user_to_roles", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserToRoles" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserToRoles" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tax-rates": { "get": { "tags": [ "tax-rates" ], "summary": "List Tax Rates", "operationId": "list_tax_rates", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_TaxRate_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tax-rates" ], "summary": "Create Tax Rate", "operationId": "create_tax_rate", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTaxRate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tax-rates/{tax_rate_id}": { "get": { "tags": [ "tax-rates" ], "summary": "Get Tax Rate", "operationId": "get_tax_rate", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "tax_rate_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tax Rate Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tax-rates" ], "summary": "Update Tax Rate", "operationId": "update_tax_rate", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "tax_rate_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tax Rate Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTaxRate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tax-rates" ], "summary": "Delete Tax Rate", "operationId": "delete_tax_rate", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "tax_rate_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tax Rate Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/login": { "post": { "tags": [ "auth" ], "summary": "login with username and password", "operationId": "login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/auth/change-password": { "post": { "tags": [ "auth" ], "summary": "change password", "operationId": "change_password", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/auth/logout": { "post": { "tags": [ "auth" ], "summary": "sign out of the current session", "operationId": "logout", "responses": { "204": { "description": "Successful Response" }, "404": { "description": "Not found" } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/tills": { "get": { "tags": [ "tills" ], "summary": "List Tills", "operationId": "list_tills", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Till_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tills" ], "summary": "Create Till", "operationId": "create_till", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTill" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Till" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tills/{till_id}": { "get": { "tags": [ "tills" ], "summary": "Get Till", "operationId": "get_till", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "till_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Till Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Till" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tills" ], "summary": "Update Till", "operationId": "update_till", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "till_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Till Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTill" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Till" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tills" ], "summary": "Delete Till", "operationId": "delete_till", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "till_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Till Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tills/{till_id}/remove-from-terminal": { "post": { "tags": [ "tills", "tills", "terminals" ], "summary": "Remove From Terminal", "operationId": "remove_from_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "till_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Till Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tills/{till_id}/switch-terminal": { "post": { "tags": [ "tills", "tills", "terminals" ], "summary": "Switch Terminal", "operationId": "switch_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "till_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Till Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchTerminalPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-layouts": { "get": { "tags": [ "till-layouts" ], "summary": "List Till Layouts", "operationId": "list_till_layouts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_TillLayout_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-layouts" ], "summary": "Create Till Layout", "operationId": "create_till_layout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillLayout" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillLayout" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-layouts/{layout_id}": { "get": { "tags": [ "till-layouts" ], "summary": "Get Till Layout", "operationId": "get_till_layout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "layout_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Layout Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TillLayout" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-layouts" ], "summary": "Update Till Layout", "operationId": "update_till_layout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "layout_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Layout Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillLayout" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TillLayout" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "till-layouts" ], "summary": "Delete Till Layout", "operationId": "delete_till_layout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "layout_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Layout Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-profiles": { "get": { "tags": [ "till-profiles" ], "summary": "List Till Profiles", "operationId": "list_till_profiles", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_TillProfile_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-profiles" ], "summary": "Create Till Profile", "operationId": "create_till_profile", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillProfile" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillProfile" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-profiles/{profile_id}": { "get": { "tags": [ "till-profiles" ], "summary": "Get Till Profile", "operationId": "get_till_profile", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TillProfile" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-profiles" ], "summary": "Update Till Profile", "operationId": "update_till_profile", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillProfile" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TillProfile" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "till-profiles" ], "summary": "Delete Till Profile", "operationId": "delete_till_profile", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-buttons": { "get": { "tags": [ "till-buttons" ], "summary": "List Till Buttons", "operationId": "list_till_buttons", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_TillButton_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-buttons" ], "summary": "Create Till Button", "operationId": "create_till_button", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillButton" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillButton" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-buttons/{button_id}": { "get": { "tags": [ "till-buttons" ], "summary": "Get Till Button", "operationId": "get_till_button", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "button_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Button Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TillButton" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-buttons" ], "summary": "Update Till Button", "operationId": "update_till_button", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "button_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Button Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTillButton" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TillButton" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "till-buttons" ], "summary": "Delete Till Button", "operationId": "delete_till_button", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "button_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Button Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-register-stockings": { "get": { "tags": [ "till-register-stockings" ], "summary": "List Register Stockings", "operationId": "list_register_stockings", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_CashRegisterStocking_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-register-stockings" ], "summary": "Create Register Stocking", "operationId": "create_register_stocking", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCashRegisterStocking" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashRegisterStocking" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-register-stockings/{stocking_id}": { "post": { "tags": [ "till-register-stockings" ], "summary": "Update Register Stocking", "operationId": "update_register_stocking", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "stocking_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Stocking Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCashRegisterStocking" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashRegisterStocking" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "till-register-stockings" ], "summary": "Delete Register Stocking", "operationId": "delete_register_stocking", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "stocking_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Stocking Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-registers": { "get": { "tags": [ "till-registers" ], "summary": "List Cash Registers Admin", "operationId": "list_cash_registers_admin", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_CashRegister_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-registers" ], "summary": "Create Register", "operationId": "create_register", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCashRegister" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashRegister" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-registers/{register_id}": { "get": { "tags": [ "till-registers" ], "summary": "Get Cash Register Admin", "operationId": "get_cash_register_admin", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "register_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Register Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashRegister" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "till-registers" ], "summary": "Update Register", "operationId": "update_register", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "register_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Register Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCashRegister" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "till-registers" ], "summary": "Delete Register", "operationId": "delete_register", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "register_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Register Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-registers/{register_id}/cashier-shifts": { "get": { "tags": [ "till-registers" ], "summary": "Get Cashier Shifts For Register", "operationId": "get_cashier_shifts_for_register", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "register_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Register Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_CashierShift_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-registers/{register_id}/transactions": { "get": { "tags": [ "till-registers" ], "summary": "List Transactions", "operationId": "list_transactions", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "register_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Register Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Transaction_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/till-registers/transfer-register": { "post": { "tags": [ "till-registers" ], "summary": "Transfer Register", "operationId": "transfer_register", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRegisterPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public-config": { "get": { "tags": [ "config" ], "summary": "Get Public Config", "operationId": "get_public_config", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Config" } } } }, "404": { "description": "Not found" } } } }, "/config": { "get": { "tags": [ "config" ], "summary": "List Config Entries", "operationId": "list_config_entries", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_ConfigEntry_str_" } } } }, "404": { "description": "Not found" } }, "security": [ { "OAuth2PasswordBearer": [] } ] }, "post": { "tags": [ "config" ], "summary": "Set Config Entry", "operationId": "set_config_entry", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigEntry" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigEntry" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/system-accounts": { "get": { "tags": [ "accounts" ], "summary": "List System Accounts", "operationId": "list_system_accounts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Account_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounts/find-accounts": { "post": { "tags": [ "accounts" ], "summary": "Find Accounts", "operationId": "find_accounts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindAccountPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Account_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounts/{account_id}": { "get": { "tags": [ "accounts" ], "summary": "Get Account", "operationId": "get_account", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Account Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounts/{account_id}/disable": { "post": { "tags": [ "accounts" ], "summary": "Disable Account", "operationId": "disable_account", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Account Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounts/{account_id}/update-balance": { "post": { "tags": [ "accounts" ], "summary": "Update Balance", "operationId": "update_balance", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Account Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBalancePayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounts/{account_id}/update-voucher-amount": { "post": { "tags": [ "accounts" ], "summary": "Update Voucher Amount", "operationId": "update_voucher_amount", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Account Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoucherAmountPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/accounts/{account_id}/update-comment": { "post": { "tags": [ "accounts" ], "summary": "Update Account Comment", "operationId": "update_account_comment", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Account Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountCommentPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/orders/by-till/{till_id}": { "get": { "tags": [ "orders" ], "summary": "List Orders By Till", "operationId": "list_orders_by_till", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "till_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Till Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Order_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/orders": { "get": { "tags": [ "orders" ], "summary": "List Orders", "operationId": "list_orders", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "customer_account_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Customer Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Order_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/orders/{order_id}": { "get": { "tags": [ "orders" ], "summary": "Get Order", "operationId": "get_order", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Order Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "orders" ], "summary": "Cancel Order", "operationId": "cancel_order", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Order Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/orders/{order_id}/bon": { "get": { "tags": [ "orders" ], "summary": "Get Order Bon", "operationId": "get_order_bon", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Order Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BonJson" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/orders/{order_id}/edit": { "post": { "tags": [ "orders" ], "summary": "Edit Order", "operationId": "edit_order", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Order Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditSaleProducts" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedSaleProducts" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cashiers": { "get": { "tags": [ "cashiers" ], "summary": "List Cashiers", "operationId": "list_cashiers", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Cashier_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cashiers/{cashier_id}": { "get": { "tags": [ "cashiers" ], "summary": "Get Cashier", "operationId": "get_cashier", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "cashier_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cashier Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cashier" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cashiers/{cashier_id}/shifts": { "get": { "tags": [ "cashiers" ], "summary": "Get Cashier Shifts", "operationId": "get_cashier_shifts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "cashier_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cashier Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_CashierShift_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cashiers/{cashier_id}/shift-stats": { "get": { "tags": [ "cashiers" ], "summary": "Get Cashier Shift Stats", "operationId": "get_cashier_shift_stats", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "cashier_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cashier Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "shift_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shift Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashierShiftStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/cashiers/{cashier_id}/close-out": { "post": { "tags": [ "cashiers" ], "summary": "Close Out Cashier", "operationId": "close_out_cashier", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "cashier_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Cashier Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseOut" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseOutResult" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stats/products": { "get": { "tags": [ "stats" ], "summary": "Get Product Stats", "operationId": "get_product_stats", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "to_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Timestamp" } }, { "name": "from_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Timestamp" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stats/vouchers": { "get": { "tags": [ "stats" ], "summary": "Get Voucher Stats", "operationId": "get_voucher_stats", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "to_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Timestamp" } }, { "name": "from_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Timestamp" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoucherStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stats/entries": { "get": { "tags": [ "stats" ], "summary": "Get Entry Stats", "operationId": "get_entry_stats", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "to_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Timestamp" } }, { "name": "from_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Timestamp" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stats/top-ups": { "get": { "tags": [ "stats" ], "summary": "Get Top Up Stats", "operationId": "get_top_up_stats", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "to_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Timestamp" } }, { "name": "from_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Timestamp" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/stats/pay-outs": { "get": { "tags": [ "stats" ], "summary": "Get Pay Out Stats", "operationId": "get_pay_out_stats", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } }, { "name": "to_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To Timestamp" } }, { "name": "from_timestamp", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From Timestamp" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeseriesStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tickets": { "get": { "tags": [ "tickets" ], "summary": "List Tickets", "operationId": "list_tickets", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Ticket_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tickets" ], "summary": "Create Ticket", "operationId": "create_ticket", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTicket" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tickets/external-tickets": { "get": { "tags": [ "tickets" ], "summary": "List External Tickets", "operationId": "list_external_tickets", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTicket" }, "title": "Response List External Tickets Tickets External Tickets Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tickets/{ticket_id}": { "get": { "tags": [ "tickets" ], "summary": "Get Ticket", "operationId": "get_ticket", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Ticket Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tickets" ], "summary": "Update Ticket", "operationId": "update_ticket", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Ticket Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTicket" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tickets" ], "summary": "Delete Ticket", "operationId": "delete_ticket", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Ticket Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-tag-secrets": { "post": { "tags": [ "user_tags" ], "summary": "Create User Tag Secret", "operationId": "create_user_tag_secret", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserTagSecret" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTagSecret" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "user_tags" ], "summary": "List User Tag Secrets", "operationId": "list_user_tag_secrets", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserTagSecret" }, "title": "Response List User Tag Secrets User Tag Secrets Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-tags": { "post": { "tags": [ "user_tags" ], "summary": "Create User Tags", "operationId": "create_user_tags", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewUserTag" }, "title": "New User Tags" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-tags/find-user-tags": { "post": { "tags": [ "user_tags" ], "summary": "Find User Tags", "operationId": "find_user_tags", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindUserTagPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_UserTagDetail_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-tags/{user_tag_id}": { "get": { "tags": [ "user_tags" ], "summary": "Get User Tag Detail", "operationId": "get_user_tag_detail", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_tag_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Tag Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTagDetail" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/user-tags/{user_tag_id}/update-comment": { "post": { "tags": [ "user_tags" ], "summary": "Update User Tag Comment", "operationId": "update_user_tag_comment", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "user_tag_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "User Tag Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTagDetail" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tses/": { "get": { "tags": [ "tses" ], "summary": "List Tses", "operationId": "list_tses", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Tse_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tses" ], "summary": "Create Tse", "operationId": "create_tse", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTse" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tses/{tse_id}": { "post": { "tags": [ "tses" ], "summary": "Update Tse", "operationId": "update_tse", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "tse_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Tse Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTse" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/": { "get": { "tags": [ "payouts" ], "summary": "List Payout Runs", "operationId": "list_payout_runs", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_PayoutRunWithStats_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "payouts" ], "summary": "Create Payout Run", "operationId": "create_payout_run", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPayoutRun" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutRunWithStats" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/pending-payout-detail": { "get": { "tags": [ "payouts" ], "summary": "Pending Payout Detail", "operationId": "pending_payout_detail", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingPayoutDetail" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/{payout_run_id}/payouts": { "get": { "tags": [ "payouts" ], "summary": "Payout Run Payouts", "operationId": "payout_run_payouts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "payout_run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Payout Run Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" }, "title": "Response Payout Run Payouts Payouts Payout Run Id Payouts Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/{payout_run_id}/csv": { "post": { "tags": [ "payouts" ], "summary": "Payout Run Csv Export", "operationId": "payout_run_csv_export", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "payout_run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Payout Run Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Payout Run Csv Export Payouts Payout Run Id Csv Post" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/{payout_run_id}/sepa_xml": { "post": { "tags": [ "payouts" ], "summary": "Payout Run Sepa Xml", "operationId": "payout_run_sepa_xml", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "payout_run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Payout Run Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSepaXMLPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Payout Run Sepa Xml Payouts Payout Run Id Sepa Xml Post" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/{payout_run_id}/previous_sepa_xml": { "post": { "tags": [ "payouts" ], "summary": "Previous Payout Run Sepa Xml", "operationId": "previous_payout_run_sepa_xml", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "payout_run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Payout Run Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Previous Payout Run Sepa Xml Payouts Payout Run Id Previous Sepa Xml Post" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/{payout_run_id}/set-as-done": { "post": { "tags": [ "payouts" ], "summary": "Set Payout Run As Done", "operationId": "set_payout_run_as_done", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "payout_run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Payout Run Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/payouts/{payout_run_id}/revoke": { "post": { "tags": [ "payouts" ], "summary": "Revoke Payout Run", "operationId": "revoke_payout_run", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "payout_run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Payout Run Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/": { "get": { "tags": [ "tree" ], "summary": "Get Tree For Current User", "operationId": "get_tree_for_current_user", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NodeSeenByUser" } } } }, "404": { "description": "Not found" } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/tree/nodes/{node_id}/create-node": { "post": { "tags": [ "tree" ], "summary": "Create Node", "operationId": "create_node", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewNode" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Node" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}/settings": { "post": { "tags": [ "tree" ], "summary": "Update Node", "operationId": "update_node", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewNode" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Node" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}/archive-node": { "post": { "tags": [ "tree" ], "summary": "Archive Node", "operationId": "archive_node", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}/create-event": { "post": { "tags": [ "tree" ], "summary": "Create Event", "operationId": "create_event", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEvent" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Node" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/event-settings": { "post": { "tags": [ "tree" ], "summary": "Update Event", "operationId": "update_event", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEvent" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Node" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/event-design/bon-logo": { "post": { "tags": [ "tree" ], "summary": "Update Bon Logo", "operationId": "update_bon_logo", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBlob" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/event-design": { "get": { "tags": [ "tree" ], "summary": "Get Event Design", "operationId": "get_event_design", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDesign" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/settings": { "get": { "tags": [ "tree" ], "summary": "Get Restricted Event Settings", "operationId": "get_restricted_event_settings", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestrictedEventSettings" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}": { "delete": { "tags": [ "tree" ], "summary": "Delete Node", "operationId": "delete_node", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/generate-test-bon": { "post": { "tags": [ "tree" ], "summary": "Generate Test Bon", "operationId": "generate_test_bon", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BonJson" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/check-pretix-connection": { "post": { "tags": [ "tree" ], "summary": "Check Pretix Connection", "operationId": "check_pretix_connection", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/fetch-pretix-products": { "post": { "tags": [ "tree" ], "summary": "Fetch Pretix Products", "operationId": "fetch_pretix_products", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PretixFetchProductsPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PretixProduct" }, "title": "Response Fetch Pretix Products Tree Events Node Id Fetch Pretix Products Post" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/generate-webhook-url": { "post": { "tags": [ "tree" ], "summary": "Generate Webhook Url", "operationId": "generate_webhook_url", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateWebhookPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateWebhookResponse" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/events/{node_id}/generate-test-report": { "post": { "tags": [ "tree" ], "summary": "Generate Test Report", "operationId": "generate_test_report", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "application/pdf": {} } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}/generate-revenue-report": { "post": { "tags": [ "tree" ], "summary": "Generate Revenue Report", "operationId": "generate_revenue_report", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "application/pdf": {} } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}/configure-sumup-token": { "post": { "tags": [ "tree" ], "summary": "Configure Sumup Token", "operationId": "configure_sumup_token", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SumUpTokenPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tree/nodes/{node_id}/audit-logs": { "get": { "tags": [ "tree" ], "summary": "List Audit Logs", "operationId": "list_audit_logs", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLog" }, "title": "Response List Audit Logs Tree Nodes Node Id Audit Logs Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sumup/checkouts": { "get": { "tags": [ "sumup" ], "summary": "List Sumup Checkouts", "operationId": "list_sumup_checkouts", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SumUpCheckout" }, "title": "Response List Sumup Checkouts Sumup Checkouts Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sumup/transactions": { "get": { "tags": [ "sumup" ], "summary": "List Sumup Transactions", "operationId": "list_sumup_transactions", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SumUpTransaction" }, "title": "Response List Sumup Transactions Sumup Transactions Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/sumup/checkouts/{checkout_id}": { "get": { "tags": [ "sumup" ], "summary": "Get Sumup Checkout", "operationId": "get_sumup_checkout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "checkout_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Checkout Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SumUpCheckout" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/customers/find-customers": { "post": { "tags": [ "accounts" ], "summary": "Find Customers", "operationId": "find_customers", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindCustomerPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" }, "title": "Response Find Customers Customers Find Customers Post" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/customers/{customer_id}": { "get": { "tags": [ "accounts" ], "summary": "Get Customer", "operationId": "get_customer", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "customer_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Customer Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/customers-with-blocked-payout": { "get": { "tags": [ "accounts" ], "summary": "Get Customers With Blocked Payout", "operationId": "get_customers_with_blocked_payout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" }, "title": "Response Get Customers With Blocked Payout Customers With Blocked Payout Get" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/customers/{customer_id}/prevent-payout": { "post": { "tags": [ "accounts" ], "summary": "Prevent Customer Payout", "operationId": "prevent_customer_payout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "customer_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Customer Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/customers/{customer_id}/allow-payout": { "post": { "tags": [ "accounts" ], "summary": "Allow Customer Payout", "operationId": "allow_customer_payout", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "customer_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Customer Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/terminal": { "get": { "tags": [ "terminals" ], "summary": "List Terminals", "operationId": "list_terminals", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NormalizedList_Terminal_int_" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "terminals" ], "summary": "Create Terminal", "operationId": "create_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTerminal" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/terminal/{terminal_id}": { "get": { "tags": [ "terminals" ], "summary": "Get Terminal", "operationId": "get_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "terminal_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Terminal Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "terminals" ], "summary": "Update Terminal", "operationId": "update_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "terminal_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Terminal Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTerminal" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "terminals" ], "summary": "Delete Terminal", "operationId": "delete_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "terminal_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Terminal Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/terminal/{terminal_id}/logout": { "post": { "tags": [ "terminals" ], "summary": "Logout Terminal", "operationId": "logout_terminal", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "terminal_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Terminal Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/terminal/{terminal_id}/switch-till": { "post": { "tags": [ "terminals", "tills", "terminals" ], "summary": "Switch Till", "operationId": "switch_till", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "terminal_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Terminal Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchTillPayload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/terminal/{terminal_id}/force-logout-user": { "post": { "tags": [ "terminals" ], "summary": "Force Logout User", "operationId": "force_logout_user", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "terminal_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Terminal Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/transactions/{transaction_id}": { "get": { "tags": [ "transactions" ], "summary": "Get Transaction", "operationId": "get_transaction", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Transaction Id" } }, { "name": "node_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Node Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/webhooks/hook": { "post": { "tags": [ "webhooks" ], "summary": "Trigger Webhook", "operationId": "trigger_webhook", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/media/blob/{blob_id}": { "get": { "tags": [ "media" ], "summary": "Get Blob", "operationId": "get_blob", "parameters": [ { "name": "blob_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Blob Id" } } ], "responses": { "200": { "description": "Successful Response" }, "404": { "description": "Not found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "Account": { "properties": { "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "type": { "$ref": "#/components/schemas/AccountType" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "balance": { "type": "number", "title": "Balance" }, "vouchers": { "type": "integer", "title": "Vouchers" }, "user_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Id" }, "user_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Uid" }, "user_tag_comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Comment" }, "restriction": { "anyOf": [ { "$ref": "#/components/schemas/ProductRestriction" }, { "type": "null" } ] }, "tag_history": { "items": { "$ref": "#/components/schemas/UserTagHistoryEntry" }, "type": "array", "title": "Tag History" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "node_id", "id", "type", "name", "comment", "balance", "vouchers", "user_tag_id", "user_tag_uid", "restriction", "tag_history", "user_tag_uid_hex" ], "title": "Account" }, "AccountType": { "type": "string", "enum": [ "private", "sale_exit", "cash_entry", "cash_exit", "cash_topup_source", "cash_imbalance", "cash_vault", "sumup_entry", "sumup_online_entry", "transport", "voucher_create", "donation_exit", "sepa_exit", "cash_register" ], "title": "AccountType" }, "AuditLog": { "properties": { "id": { "type": "integer", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "node_id": { "type": "integer", "title": "Node Id" }, "log_type": { "type": "string", "title": "Log Type" }, "originating_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Originating User Id" }, "originating_terminal_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Originating Terminal Id" } }, "type": "object", "required": [ "id", "created_at", "node_id", "log_type", "originating_user_id", "originating_terminal_id" ], "title": "AuditLog" }, "BonConfig": { "properties": { "title": { "type": "string", "title": "Title" }, "issuer": { "type": "string", "title": "Issuer" }, "address": { "type": "string", "title": "Address" }, "ust_id": { "type": "string", "title": "Ust Id" } }, "type": "object", "required": [ "title", "issuer", "address", "ust_id" ], "title": "BonConfig" }, "BonJson": { "properties": { "order": { "$ref": "#/components/schemas/OrderWithTse" }, "tax_rate_aggregations": { "items": { "$ref": "#/components/schemas/TaxRateAggregation" }, "type": "array", "title": "Tax Rate Aggregations" }, "config": { "$ref": "#/components/schemas/BonConfig" }, "currency_identifier": { "type": "string", "title": "Currency Identifier" } }, "type": "object", "required": [ "order", "tax_rate_aggregations", "config", "currency_identifier" ], "title": "BonJson" }, "BookedProduct": { "properties": { "product_id": { "type": "integer", "title": "Product Id" }, "quantity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quantity" }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price" } }, "type": "object", "required": [ "product_id" ], "title": "BookedProduct" }, "CashRegister": { "properties": { "name": { "type": "string", "title": "Name" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "current_cashier_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current Cashier Id" }, "current_till_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current Till Id" }, "balance": { "type": "number", "title": "Balance" }, "account_id": { "type": "integer", "title": "Account Id" } }, "type": "object", "required": [ "name", "node_id", "id", "current_cashier_id", "current_till_id", "balance", "account_id" ], "title": "CashRegister" }, "CashRegisterStocking": { "properties": { "name": { "type": "string", "title": "Name" }, "euro200": { "type": "integer", "title": "Euro200", "default": 0 }, "euro100": { "type": "integer", "title": "Euro100", "default": 0 }, "euro50": { "type": "integer", "title": "Euro50", "default": 0 }, "euro20": { "type": "integer", "title": "Euro20", "default": 0 }, "euro10": { "type": "integer", "title": "Euro10", "default": 0 }, "euro5": { "type": "integer", "title": "Euro5", "default": 0 }, "euro2": { "type": "integer", "title": "Euro2", "default": 0 }, "euro1": { "type": "integer", "title": "Euro1", "default": 0 }, "cent50": { "type": "integer", "title": "Cent50", "default": 0 }, "cent20": { "type": "integer", "title": "Cent20", "default": 0 }, "cent10": { "type": "integer", "title": "Cent10", "default": 0 }, "cent5": { "type": "integer", "title": "Cent5", "default": 0 }, "cent2": { "type": "integer", "title": "Cent2", "default": 0 }, "cent1": { "type": "integer", "title": "Cent1", "default": 0 }, "variable_in_euro": { "type": "number", "title": "Variable In Euro", "default": 0.0 }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "total": { "type": "number", "title": "Total" } }, "type": "object", "required": [ "name", "node_id", "id", "total" ], "title": "CashRegisterStocking" }, "Cashier": { "properties": { "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "login": { "type": "string", "title": "Login" }, "display_name": { "type": "string", "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "user_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Id" }, "user_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Uid" }, "transport_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Transport Account Id" }, "cash_register_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cash Register Id" }, "cash_drawer_balance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash Drawer Balance" }, "terminal_ids": { "items": { "type": "integer" }, "type": "array", "title": "Terminal Ids" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "node_id", "id", "login", "display_name", "cash_drawer_balance", "terminal_ids", "user_tag_uid_hex" ], "title": "Cashier" }, "CashierProductStats": { "properties": { "product": { "$ref": "#/components/schemas/Product" }, "quantity": { "type": "integer", "title": "Quantity" } }, "type": "object", "required": [ "product", "quantity" ], "title": "CashierProductStats" }, "CashierShift": { "properties": { "id": { "type": "integer", "title": "Id" }, "comment": { "type": "string", "title": "Comment" }, "cashier_id": { "type": "integer", "title": "Cashier Id" }, "cash_register_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cash Register Id" }, "closing_out_user_id": { "type": "integer", "title": "Closing Out User Id" }, "actual_cash_drawer_balance": { "type": "number", "title": "Actual Cash Drawer Balance" }, "expected_cash_drawer_balance": { "type": "number", "title": "Expected Cash Drawer Balance" }, "cash_drawer_imbalance": { "type": "number", "title": "Cash Drawer Imbalance" }, "started_at": { "type": "string", "format": "date-time", "title": "Started At" }, "ended_at": { "type": "string", "format": "date-time", "title": "Ended At" } }, "type": "object", "required": [ "id", "comment", "cashier_id", "cash_register_id", "closing_out_user_id", "actual_cash_drawer_balance", "expected_cash_drawer_balance", "cash_drawer_imbalance", "started_at", "ended_at" ], "title": "CashierShift" }, "CashierShiftStats": { "properties": { "booked_products": { "items": { "$ref": "#/components/schemas/CashierProductStats" }, "type": "array", "title": "Booked Products" }, "orders": { "items": { "$ref": "#/components/schemas/Order" }, "type": "array", "title": "Orders" } }, "type": "object", "required": [ "booked_products", "orders" ], "title": "CashierShiftStats" }, "ChangePasswordPayload": { "properties": { "old_password": { "type": "string", "title": "Old Password" }, "new_password": { "type": "string", "title": "New Password" } }, "type": "object", "required": [ "old_password", "new_password" ], "title": "ChangePasswordPayload" }, "ChangeUserPasswordPayload": { "properties": { "new_password": { "type": "string", "title": "New Password" } }, "type": "object", "required": [ "new_password" ], "title": "ChangeUserPasswordPayload" }, "CloseOut": { "properties": { "comment": { "type": "string", "title": "Comment" }, "actual_cash_drawer_balance": { "type": "number", "title": "Actual Cash Drawer Balance" }, "closing_out_user_id": { "type": "integer", "title": "Closing Out User Id" } }, "type": "object", "required": [ "comment", "actual_cash_drawer_balance", "closing_out_user_id" ], "title": "CloseOut" }, "CloseOutResult": { "properties": { "cashier_id": { "type": "integer", "title": "Cashier Id" }, "imbalance": { "type": "number", "title": "Imbalance" } }, "type": "object", "required": [ "cashier_id", "imbalance" ], "title": "CloseOutResult" }, "CompletedSaleProducts": { "properties": { "uuid": { "type": "string", "format": "uuid", "title": "Uuid" }, "old_balance": { "type": "number", "title": "Old Balance" }, "new_balance": { "type": "number", "title": "New Balance" }, "old_voucher_balance": { "type": "integer", "title": "Old Voucher Balance" }, "new_voucher_balance": { "type": "integer", "title": "New Voucher Balance" }, "customer_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Account Id" }, "payment_method": { "$ref": "#/components/schemas/PaymentMethod" }, "line_items": { "items": { "$ref": "#/components/schemas/PendingLineItem" }, "type": "array", "title": "Line Items" }, "products": { "items": { "$ref": "#/components/schemas/BookedProduct" }, "type": "array", "title": "Products" }, "id": { "type": "integer", "title": "Id" }, "booked_at": { "type": "string", "format": "date-time", "title": "Booked At" }, "cashier_id": { "type": "integer", "title": "Cashier Id" }, "till_id": { "type": "integer", "title": "Till Id" }, "used_vouchers": { "type": "integer", "title": "Used Vouchers", "readOnly": true }, "item_count": { "type": "integer", "title": "Item Count", "readOnly": true }, "total_price": { "type": "number", "title": "Total Price", "readOnly": true } }, "type": "object", "required": [ "uuid", "old_balance", "new_balance", "old_voucher_balance", "new_voucher_balance", "customer_account_id", "payment_method", "line_items", "products", "id", "booked_at", "cashier_id", "till_id", "used_vouchers", "item_count", "total_price" ], "title": "CompletedSaleProducts" }, "Config": { "properties": { "test_mode": { "type": "boolean", "title": "Test Mode" }, "test_mode_message": { "type": "string", "title": "Test Mode Message" }, "sumup_topup_enabled_globally": { "type": "boolean", "title": "Sumup Topup Enabled Globally" }, "terminal_api_endpoint": { "type": "string", "title": "Terminal Api Endpoint" } }, "type": "object", "required": [ "test_mode", "test_mode_message", "sumup_topup_enabled_globally", "terminal_api_endpoint" ], "title": "Config" }, "ConfigEntry": { "properties": { "key": { "type": "string", "title": "Key" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value" } }, "type": "object", "required": [ "key", "value" ], "title": "ConfigEntry" }, "CreateSepaXMLPayload": { "properties": { "execution_date": { "type": "string", "format": "date", "title": "Execution Date" } }, "type": "object", "required": [ "execution_date" ], "title": "CreateSepaXMLPayload" }, "CreateUserPayload": { "properties": { "login": { "type": "string", "title": "Login" }, "display_name": { "type": "string", "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "user_tag_pin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Pin" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex" }, "password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Password" } }, "type": "object", "required": [ "login", "display_name" ], "title": "CreateUserPayload" }, "CurrentUser": { "properties": { "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "login": { "type": "string", "title": "Login" }, "display_name": { "type": "string", "title": "Display Name" }, "active_role_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Active Role Id" }, "active_role_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active Role Name" }, "privileges": { "items": { "$ref": "#/components/schemas/Privilege" }, "type": "array", "title": "Privileges" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "user_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Id" }, "user_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Uid" }, "transport_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Transport Account Id" }, "cash_register_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cash Register Id" } }, "type": "object", "required": [ "node_id", "id", "login", "display_name", "privileges" ], "title": "CurrentUser", "description": "Describes a logged-in user in the system" }, "Customer": { "properties": { "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "type": { "$ref": "#/components/schemas/AccountType" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "balance": { "type": "number", "title": "Balance" }, "vouchers": { "type": "integer", "title": "Vouchers" }, "user_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Id" }, "user_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Uid" }, "user_tag_comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Comment" }, "restriction": { "anyOf": [ { "$ref": "#/components/schemas/ProductRestriction" }, { "type": "null" } ] }, "tag_history": { "items": { "$ref": "#/components/schemas/UserTagHistoryEntry" }, "type": "array", "title": "Tag History" }, "iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iban" }, "account_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "donation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Donation" }, "payout_export": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Payout Export" }, "user_tag_pin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Pin" }, "donate_all": { "type": "boolean", "title": "Donate All" }, "has_entered_info": { "type": "boolean", "title": "Has Entered Info" }, "payout": { "anyOf": [ { "$ref": "#/components/schemas/Payout" }, { "type": "null" } ] }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "node_id", "id", "type", "name", "comment", "balance", "vouchers", "user_tag_id", "user_tag_uid", "restriction", "tag_history", "iban", "account_name", "email", "donation", "payout_export", "user_tag_pin", "donate_all", "has_entered_info", "payout", "user_tag_uid_hex" ], "title": "Customer" }, "EditSaleProducts": { "properties": { "uuid": { "type": "string", "format": "uuid", "title": "Uuid" }, "used_vouchers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Used Vouchers" }, "products": { "items": { "$ref": "#/components/schemas/BookedProduct" }, "type": "array", "title": "Products" } }, "type": "object", "required": [ "uuid", "products" ], "title": "EditSaleProducts" }, "EventDesign": { "properties": { "bon_logo_blob_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bon Logo Blob Id" } }, "type": "object", "required": [ "bon_logo_blob_id" ], "title": "EventDesign" }, "ExternalTicket": { "properties": { "external_reference": { "type": "string", "title": "External Reference" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "token": { "type": "string", "title": "Token" }, "ticket_type": { "$ref": "#/components/schemas/ExternalTicketType" }, "external_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Link" }, "id": { "type": "integer", "title": "Id" }, "customer_account_id": { "type": "integer", "title": "Customer Account Id" }, "has_checked_in": { "type": "boolean", "title": "Has Checked In" } }, "type": "object", "required": [ "external_reference", "created_at", "token", "ticket_type", "id", "customer_account_id", "has_checked_in" ], "title": "ExternalTicket" }, "ExternalTicketType": { "type": "string", "enum": [ "pretix" ], "title": "ExternalTicketType" }, "FindAccountPayload": { "properties": { "search_term": { "type": "string", "title": "Search Term" } }, "type": "object", "required": [ "search_term" ], "title": "FindAccountPayload" }, "FindCustomerPayload": { "properties": { "search_term": { "type": "string", "title": "Search Term" } }, "type": "object", "required": [ "search_term" ], "title": "FindCustomerPayload" }, "FindUserTagPayload": { "properties": { "search_term": { "type": "string", "title": "Search Term" } }, "type": "object", "required": [ "search_term" ], "title": "FindUserTagPayload" }, "GenerateWebhookPayload": { "properties": { "webhook_type": { "$ref": "#/components/schemas/WebhookType" } }, "type": "object", "required": [ "webhook_type" ], "title": "GenerateWebhookPayload" }, "GenerateWebhookResponse": { "properties": { "webhook_url": { "type": "string", "title": "Webhook Url" } }, "type": "object", "required": [ "webhook_url" ], "title": "GenerateWebhookResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Language": { "type": "string", "enum": [ "en-US", "de-DE" ], "title": "Language" }, "LineItem": { "properties": { "quantity": { "type": "integer", "title": "Quantity" }, "product": { "$ref": "#/components/schemas/Product" }, "product_price": { "type": "number", "title": "Product Price" }, "tax_rate_id": { "type": "integer", "title": "Tax Rate Id" }, "tax_name": { "type": "string", "title": "Tax Name" }, "tax_rate": { "type": "number", "title": "Tax Rate" }, "item_id": { "type": "integer", "title": "Item Id" }, "total_tax": { "type": "number", "title": "Total Tax" }, "total_price": { "type": "number", "title": "Total Price", "readOnly": true } }, "type": "object", "required": [ "quantity", "product", "product_price", "tax_rate_id", "tax_name", "tax_rate", "item_id", "total_tax", "total_price" ], "title": "LineItem" }, "LoginPayload": { "properties": { "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "title": "Password" }, "node_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Node Id" } }, "type": "object", "required": [ "username", "password" ], "title": "LoginPayload" }, "NewBlob": { "properties": { "data": { "type": "string", "title": "Data" }, "mime_type": { "type": "string", "title": "Mime Type" } }, "type": "object", "required": [ "data", "mime_type" ], "title": "NewBlob" }, "NewCashRegister": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "NewCashRegister" }, "NewCashRegisterStocking": { "properties": { "name": { "type": "string", "title": "Name" }, "euro200": { "type": "integer", "title": "Euro200", "default": 0 }, "euro100": { "type": "integer", "title": "Euro100", "default": 0 }, "euro50": { "type": "integer", "title": "Euro50", "default": 0 }, "euro20": { "type": "integer", "title": "Euro20", "default": 0 }, "euro10": { "type": "integer", "title": "Euro10", "default": 0 }, "euro5": { "type": "integer", "title": "Euro5", "default": 0 }, "euro2": { "type": "integer", "title": "Euro2", "default": 0 }, "euro1": { "type": "integer", "title": "Euro1", "default": 0 }, "cent50": { "type": "integer", "title": "Cent50", "default": 0 }, "cent20": { "type": "integer", "title": "Cent20", "default": 0 }, "cent10": { "type": "integer", "title": "Cent10", "default": 0 }, "cent5": { "type": "integer", "title": "Cent5", "default": 0 }, "cent2": { "type": "integer", "title": "Cent2", "default": 0 }, "cent1": { "type": "integer", "title": "Cent1", "default": 0 }, "variable_in_euro": { "type": "number", "title": "Variable In Euro", "default": 0.0 } }, "type": "object", "required": [ "name" ], "title": "NewCashRegisterStocking" }, "NewEvent": { "properties": { "sumup_api_key": { "type": "string", "title": "Sumup Api Key", "default": "" }, "sumup_affiliate_key": { "type": "string", "title": "Sumup Affiliate Key", "default": "" }, "sumup_merchant_code": { "type": "string", "title": "Sumup Merchant Code", "default": "" }, "sumup_oauth_client_id": { "type": "string", "title": "Sumup Oauth Client Id", "default": "" }, "sumup_oauth_client_secret": { "type": "string", "title": "Sumup Oauth Client Secret", "default": "" }, "pretix_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Api Key" }, "email_smtp_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Password" }, "currency_identifier": { "type": "string", "title": "Currency Identifier" }, "max_account_balance": { "type": "number", "title": "Max Account Balance" }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date" }, "daily_end_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "Daily End Time" }, "sumup_topup_enabled": { "type": "boolean", "title": "Sumup Topup Enabled" }, "sumup_payment_enabled": { "type": "boolean", "title": "Sumup Payment Enabled" }, "customer_portal_url": { "type": "string", "title": "Customer Portal Url" }, "customer_portal_about_page_url": { "type": "string", "title": "Customer Portal About Page Url" }, "customer_portal_data_privacy_url": { "type": "string", "title": "Customer Portal Data Privacy Url" }, "customer_portal_contact_email": { "type": "string", "format": "email", "title": "Customer Portal Contact Email" }, "pretix_presale_enabled": { "type": "boolean", "title": "Pretix Presale Enabled" }, "pretix_shop_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Shop Url" }, "pretix_organizer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Organizer" }, "pretix_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Event" }, "pretix_ticket_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Pretix Ticket Ids" }, "ust_id": { "type": "string", "title": "Ust Id" }, "bon_issuer": { "type": "string", "title": "Bon Issuer" }, "bon_address": { "type": "string", "title": "Bon Address" }, "bon_title": { "type": "string", "title": "Bon Title" }, "sepa_enabled": { "type": "boolean", "title": "Sepa Enabled" }, "sepa_sender_name": { "type": "string", "title": "Sepa Sender Name" }, "sepa_sender_iban": { "type": "string", "title": "Sepa Sender Iban" }, "sepa_description": { "type": "string", "title": "Sepa Description" }, "sepa_max_num_payouts_in_run": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sepa Max Num Payouts In Run" }, "sepa_allowed_country_codes": { "items": { "type": "string" }, "type": "array", "title": "Sepa Allowed Country Codes" }, "email_enabled": { "type": "boolean", "title": "Email Enabled" }, "email_default_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Default Sender" }, "email_smtp_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Host" }, "email_smtp_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Email Smtp Port" }, "email_smtp_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Username" }, "payout_done_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Subject" }, "payout_done_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Message" }, "payout_registered_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Subject" }, "payout_registered_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Message" }, "payout_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Sender" }, "translation_texts": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "propertyNames": { "$ref": "#/components/schemas/Language" }, "type": "object", "title": "Translation Texts", "default": {} }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "forbidden_objects_at_node": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects At Node", "default": [] }, "forbidden_objects_in_subtree": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects In Subtree", "default": [] } }, "type": "object", "required": [ "pretix_api_key", "currency_identifier", "max_account_balance", "sumup_topup_enabled", "sumup_payment_enabled", "customer_portal_url", "customer_portal_about_page_url", "customer_portal_data_privacy_url", "customer_portal_contact_email", "pretix_presale_enabled", "pretix_shop_url", "pretix_organizer", "pretix_event", "pretix_ticket_ids", "ust_id", "bon_issuer", "bon_address", "bon_title", "sepa_enabled", "sepa_sender_name", "sepa_sender_iban", "sepa_description", "sepa_allowed_country_codes", "email_enabled", "name", "description" ], "title": "NewEvent" }, "NewNode": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "forbidden_objects_at_node": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects At Node", "default": [] }, "forbidden_objects_in_subtree": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects In Subtree", "default": [] } }, "type": "object", "required": [ "name", "description" ], "title": "NewNode" }, "NewPayoutRun": { "properties": { "max_payout_sum": { "type": "number", "title": "Max Payout Sum" }, "max_num_payouts": { "type": "integer", "title": "Max Num Payouts" } }, "type": "object", "required": [ "max_payout_sum", "max_num_payouts" ], "title": "NewPayoutRun" }, "NewProduct": { "properties": { "name": { "type": "string", "title": "Name" }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price" }, "fixed_price": { "type": "boolean", "title": "Fixed Price", "default": true }, "price_in_vouchers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Price In Vouchers" }, "tax_rate_id": { "type": "integer", "title": "Tax Rate Id" }, "restrictions": { "items": { "$ref": "#/components/schemas/ProductRestriction" }, "type": "array", "title": "Restrictions", "default": [] }, "is_locked": { "type": "boolean", "title": "Is Locked", "default": false }, "is_returnable": { "type": "boolean", "title": "Is Returnable", "default": false }, "target_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Account Id" } }, "type": "object", "required": [ "name", "price", "tax_rate_id" ], "title": "NewProduct" }, "NewTaxRate": { "properties": { "name": { "type": "string", "title": "Name" }, "rate": { "type": "number", "title": "Rate" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "name", "rate", "description" ], "title": "NewTaxRate" }, "NewTerminal": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "name" ], "title": "NewTerminal" }, "NewTicket": { "properties": { "name": { "type": "string", "title": "Name" }, "price": { "type": "number", "title": "Price" }, "tax_rate_id": { "type": "integer", "title": "Tax Rate Id" }, "restrictions": { "items": { "$ref": "#/components/schemas/ProductRestriction" }, "type": "array", "title": "Restrictions" }, "is_locked": { "type": "boolean", "title": "Is Locked" }, "initial_top_up_amount": { "type": "number", "title": "Initial Top Up Amount" } }, "type": "object", "required": [ "name", "price", "tax_rate_id", "restrictions", "is_locked", "initial_top_up_amount" ], "title": "NewTicket" }, "NewTill": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "active_shift": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active Shift" }, "active_profile_id": { "type": "integer", "title": "Active Profile Id" }, "terminal_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Terminal Id" } }, "type": "object", "required": [ "name", "active_profile_id" ], "title": "NewTill" }, "NewTillButton": { "properties": { "name": { "type": "string", "title": "Name" }, "product_ids": { "items": { "type": "integer" }, "type": "array", "title": "Product Ids" } }, "type": "object", "required": [ "name", "product_ids" ], "title": "NewTillButton" }, "NewTillLayout": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "button_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Button Ids" }, "ticket_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Ticket Ids" } }, "type": "object", "required": [ "name", "description" ], "title": "NewTillLayout" }, "NewTillProfile": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "layout_id": { "type": "integer", "title": "Layout Id" }, "allow_top_up": { "type": "boolean", "title": "Allow Top Up" }, "allow_cash_out": { "type": "boolean", "title": "Allow Cash Out" }, "allow_ticket_sale": { "type": "boolean", "title": "Allow Ticket Sale" }, "allow_ticket_vouchers": { "type": "boolean", "title": "Allow Ticket Vouchers" }, "enable_ssp_payment": { "type": "boolean", "title": "Enable Ssp Payment" }, "enable_cash_payment": { "type": "boolean", "title": "Enable Cash Payment" }, "enable_card_payment": { "type": "boolean", "title": "Enable Card Payment" } }, "type": "object", "required": [ "name", "layout_id", "allow_top_up", "allow_cash_out", "allow_ticket_sale", "allow_ticket_vouchers", "enable_ssp_payment", "enable_cash_payment", "enable_card_payment" ], "title": "NewTillProfile" }, "NewTse": { "properties": { "name": { "type": "string", "title": "Name" }, "ws_url": { "type": "string", "title": "Ws Url" }, "ws_timeout": { "type": "number", "title": "Ws Timeout" }, "password": { "type": "string", "title": "Password" }, "type": { "$ref": "#/components/schemas/TseType" }, "serial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial" } }, "type": "object", "required": [ "name", "ws_url", "ws_timeout", "password", "type", "serial" ], "title": "NewTse" }, "NewUserRole": { "properties": { "name": { "type": "string", "title": "Name" }, "is_privileged": { "type": "boolean", "title": "Is Privileged", "default": false }, "privileges": { "items": { "$ref": "#/components/schemas/Privilege" }, "type": "array", "title": "Privileges" } }, "type": "object", "required": [ "name", "privileges" ], "title": "NewUserRole" }, "NewUserTag": { "properties": { "pin": { "type": "string", "title": "Pin" }, "restriction": { "anyOf": [ { "$ref": "#/components/schemas/ProductRestriction" }, { "type": "null" } ] }, "secret_id": { "type": "integer", "title": "Secret Id" } }, "type": "object", "required": [ "pin", "secret_id" ], "title": "NewUserTag" }, "NewUserTagSecret": { "properties": { "key0": { "type": "string", "title": "Key0" }, "key1": { "type": "string", "title": "Key1" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "key0", "key1", "description" ], "title": "NewUserTagSecret" }, "NewUserToRoles": { "properties": { "user_id": { "type": "integer", "title": "User Id" }, "role_ids": { "items": { "type": "integer" }, "type": "array", "title": "Role Ids" }, "terminal_only": { "type": "boolean", "title": "Terminal Only", "default": false } }, "type": "object", "required": [ "user_id", "role_ids" ], "title": "NewUserToRoles" }, "Node": { "properties": { "id": { "type": "integer", "title": "Id" }, "parent": { "type": "integer", "title": "Parent" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "read_only": { "type": "boolean", "title": "Read Only" }, "event": { "anyOf": [ { "$ref": "#/components/schemas/PublicEventSettings" }, { "type": "null" } ] }, "path": { "type": "string", "title": "Path" }, "parent_ids": { "items": { "type": "integer" }, "type": "array", "title": "Parent Ids" }, "event_node_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Event Node Id" }, "parents_until_event_node": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Parents Until Event Node" }, "forbidden_objects_at_node": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects At Node" }, "computed_forbidden_objects_at_node": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Computed Forbidden Objects At Node" }, "forbidden_objects_in_subtree": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects In Subtree" }, "computed_forbidden_objects_in_subtree": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Computed Forbidden Objects In Subtree" }, "children": { "items": { "$ref": "#/components/schemas/Node" }, "type": "array", "title": "Children" } }, "type": "object", "required": [ "id", "parent", "name", "description", "read_only", "event", "path", "parent_ids", "event_node_id", "parents_until_event_node", "forbidden_objects_at_node", "computed_forbidden_objects_at_node", "forbidden_objects_in_subtree", "computed_forbidden_objects_in_subtree", "children" ], "title": "Node" }, "NodeChoice": { "properties": { "node_id": { "type": "integer", "title": "Node Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "node_id", "name", "description" ], "title": "NodeChoice" }, "NodeSeenByUser": { "properties": { "id": { "type": "integer", "title": "Id" }, "parent": { "type": "integer", "title": "Parent" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "read_only": { "type": "boolean", "title": "Read Only" }, "event": { "anyOf": [ { "$ref": "#/components/schemas/PublicEventSettings" }, { "type": "null" } ] }, "path": { "type": "string", "title": "Path" }, "parent_ids": { "items": { "type": "integer" }, "type": "array", "title": "Parent Ids" }, "event_node_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Event Node Id" }, "parents_until_event_node": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Parents Until Event Node" }, "forbidden_objects_at_node": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects At Node" }, "computed_forbidden_objects_at_node": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Computed Forbidden Objects At Node" }, "forbidden_objects_in_subtree": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Forbidden Objects In Subtree" }, "computed_forbidden_objects_in_subtree": { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array", "title": "Computed Forbidden Objects In Subtree" }, "children": { "items": { "$ref": "#/components/schemas/NodeSeenByUser" }, "type": "array", "title": "Children" }, "privileges_at_node": { "items": { "$ref": "#/components/schemas/Privilege" }, "type": "array", "uniqueItems": true, "title": "Privileges At Node" } }, "type": "object", "required": [ "id", "parent", "name", "description", "read_only", "event", "path", "parent_ids", "event_node_id", "parents_until_event_node", "forbidden_objects_at_node", "computed_forbidden_objects_at_node", "forbidden_objects_in_subtree", "computed_forbidden_objects_in_subtree", "children", "privileges_at_node" ], "title": "NodeSeenByUser" }, "NormalizedList_Account_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Account" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Account, int]" }, "NormalizedList_CashRegisterStocking_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/CashRegisterStocking" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[CashRegisterStocking, int]" }, "NormalizedList_CashRegister_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/CashRegister" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[CashRegister, int]" }, "NormalizedList_CashierShift_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/CashierShift" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[CashierShift, int]" }, "NormalizedList_Cashier_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Cashier" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Cashier, int]" }, "NormalizedList_ConfigEntry_str_": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/ConfigEntry" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[ConfigEntry, str]" }, "NormalizedList_Order_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Order" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Order, int]" }, "NormalizedList_PayoutRunWithStats_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/PayoutRunWithStats" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[PayoutRunWithStats, int]" }, "NormalizedList_Product_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Product" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Product, int]" }, "NormalizedList_TaxRate_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/TaxRate" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[TaxRate, int]" }, "NormalizedList_Terminal_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Terminal" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Terminal, int]" }, "NormalizedList_Ticket_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Ticket" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Ticket, int]" }, "NormalizedList_TillButton_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/TillButton" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[TillButton, int]" }, "NormalizedList_TillLayout_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/TillLayout" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[TillLayout, int]" }, "NormalizedList_TillProfile_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/TillProfile" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[TillProfile, int]" }, "NormalizedList_Till_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Till" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Till, int]" }, "NormalizedList_Transaction_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Transaction" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Transaction, int]" }, "NormalizedList_Tse_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/Tse" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[Tse, int]" }, "NormalizedList_UserRole_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/UserRole" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[UserRole, int]" }, "NormalizedList_UserTagDetail_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/UserTagDetail" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[UserTagDetail, int]" }, "NormalizedList_User_int_": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array", "title": "Ids" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/User" }, "type": "object", "title": "Entities" } }, "type": "object", "required": [ "ids", "entities" ], "title": "NormalizedList[User, int]" }, "ObjectType": { "type": "string", "enum": [ "user", "product", "ticket", "till", "user_role", "tax_rate", "user_tag", "tse", "account", "terminal" ], "title": "ObjectType" }, "Order": { "properties": { "id": { "type": "integer", "title": "Id" }, "uuid": { "type": "string", "format": "uuid", "title": "Uuid" }, "total_price": { "type": "number", "title": "Total Price" }, "total_tax": { "type": "number", "title": "Total Tax" }, "total_no_tax": { "type": "number", "title": "Total No Tax" }, "cancels_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cancels Order" }, "booked_at": { "type": "string", "format": "date-time", "title": "Booked At" }, "payment_method": { "$ref": "#/components/schemas/PaymentMethod" }, "order_type": { "$ref": "#/components/schemas/OrderType" }, "cashier_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cashier Id" }, "till_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Till Id" }, "cash_register_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cash Register Id" }, "customer_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Account Id" }, "customer_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Tag Uid" }, "customer_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Tag Id" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array", "title": "Line Items" }, "customer_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "id", "uuid", "total_price", "total_tax", "total_no_tax", "cancels_order", "booked_at", "payment_method", "order_type", "cashier_id", "till_id", "cash_register_id", "customer_account_id", "customer_tag_uid", "customer_tag_id", "line_items", "customer_tag_uid_hex" ], "title": "Order", "description": "represents a completely finished order with all relevant data" }, "OrderType": { "type": "string", "enum": [ "sale", "cancel_sale", "top_up", "pay_out", "ticket", "money_transfer", "money_transfer_imbalance", "cashier_shift_start", "cashier_shift_end" ], "title": "OrderType" }, "OrderWithTse": { "properties": { "id": { "type": "integer", "title": "Id" }, "uuid": { "type": "string", "format": "uuid", "title": "Uuid" }, "total_price": { "type": "number", "title": "Total Price" }, "total_tax": { "type": "number", "title": "Total Tax" }, "total_no_tax": { "type": "number", "title": "Total No Tax" }, "cancels_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cancels Order" }, "booked_at": { "type": "string", "format": "date-time", "title": "Booked At" }, "payment_method": { "$ref": "#/components/schemas/PaymentMethod" }, "order_type": { "$ref": "#/components/schemas/OrderType" }, "cashier_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cashier Id" }, "till_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Till Id" }, "cash_register_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cash Register Id" }, "customer_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Account Id" }, "customer_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Tag Uid" }, "customer_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Customer Tag Id" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array", "title": "Line Items" }, "signature_status": { "type": "string", "title": "Signature Status" }, "transaction_process_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Process Type" }, "transaction_process_data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Process Data" }, "tse_transaction": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Transaction" }, "tse_signaturenr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Signaturenr" }, "tse_start": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Start" }, "tse_end": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse End" }, "tse_hashalgo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Hashalgo" }, "tse_time_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Time Format" }, "tse_signature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Signature" }, "tse_public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Public Key" }, "node_id": { "type": "integer", "title": "Node Id" }, "customer_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Tag Uid Hex", "readOnly": true }, "tse_qr_code_text": { "type": "string", "title": "Tse Qr Code Text", "readOnly": true } }, "type": "object", "required": [ "id", "uuid", "total_price", "total_tax", "total_no_tax", "cancels_order", "booked_at", "payment_method", "order_type", "cashier_id", "till_id", "cash_register_id", "customer_account_id", "customer_tag_uid", "customer_tag_id", "line_items", "signature_status", "node_id", "customer_tag_uid_hex", "tse_qr_code_text" ], "title": "OrderWithTse" }, "PaymentMethod": { "type": "string", "enum": [ "cash", "sumup", "tag", "sumup_online" ], "title": "PaymentMethod" }, "Payout": { "properties": { "id": { "type": "integer", "title": "Id" }, "customer_account_id": { "type": "integer", "title": "Customer Account Id" }, "iban": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iban" }, "account_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "user_tag_id": { "type": "integer", "title": "User Tag Id" }, "user_tag_uid": { "type": "integer", "title": "User Tag Uid" }, "amount": { "type": "number", "title": "Amount" }, "donation": { "type": "number", "title": "Donation" }, "payout_run_id": { "type": "integer", "title": "Payout Run Id" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "id", "customer_account_id", "iban", "account_name", "email", "user_tag_id", "user_tag_uid", "amount", "donation", "payout_run_id", "user_tag_uid_hex" ], "title": "Payout" }, "PayoutRunWithStats": { "properties": { "id": { "type": "integer", "title": "Id" }, "node_id": { "type": "integer", "title": "Node Id" }, "created_by": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "set_done_by": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Set Done By" }, "set_done_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Set Done At" }, "done": { "type": "boolean", "title": "Done" }, "revoked": { "type": "boolean", "title": "Revoked" }, "sepa_was_generated": { "type": "boolean", "title": "Sepa Was Generated" }, "total_donation_amount": { "type": "number", "title": "Total Donation Amount" }, "total_payout_amount": { "type": "number", "title": "Total Payout Amount" }, "n_payouts": { "type": "integer", "title": "N Payouts" } }, "type": "object", "required": [ "id", "node_id", "created_by", "created_at", "set_done_by", "set_done_at", "done", "revoked", "sepa_was_generated", "total_donation_amount", "total_payout_amount", "n_payouts" ], "title": "PayoutRunWithStats" }, "PendingLineItem": { "properties": { "quantity": { "type": "integer", "title": "Quantity" }, "product": { "$ref": "#/components/schemas/Product" }, "product_price": { "type": "number", "title": "Product Price" }, "tax_rate_id": { "type": "integer", "title": "Tax Rate Id" }, "tax_name": { "type": "string", "title": "Tax Name" }, "tax_rate": { "type": "number", "title": "Tax Rate" }, "total_price": { "type": "number", "title": "Total Price", "readOnly": true } }, "type": "object", "required": [ "quantity", "product", "product_price", "tax_rate_id", "tax_name", "tax_rate", "total_price" ], "title": "PendingLineItem" }, "PendingPayoutDetail": { "properties": { "total_payout_amount": { "type": "number", "title": "Total Payout Amount" }, "total_donation_amount": { "type": "number", "title": "Total Donation Amount" }, "n_payouts": { "type": "integer", "title": "N Payouts" } }, "type": "object", "required": [ "total_payout_amount", "total_donation_amount", "n_payouts" ], "title": "PendingPayoutDetail" }, "PretixFetchProductsPayload": { "properties": { "organizer": { "type": "string", "title": "Organizer" }, "event": { "type": "string", "title": "Event" }, "apiKey": { "type": "string", "title": "Apikey" }, "url": { "type": "string", "title": "Url" } }, "type": "object", "required": [ "organizer", "event", "apiKey", "url" ], "title": "PretixFetchProductsPayload" }, "PretixProduct": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Name" }, "default_price": { "type": "number", "title": "Default Price" } }, "type": "object", "required": [ "id", "name", "default_price" ], "title": "PretixProduct" }, "Privilege": { "type": "string", "enum": [ "node_administration", "customer_management", "payout_management", "create_user", "allow_privileged_role_assignment", "user_management", "view_node_stats", "cash_transport", "terminal_login", "supervised_terminal_login", "can_book_orders", "grant_free_tickets", "grant_vouchers" ], "title": "Privilege" }, "Product": { "properties": { "name": { "type": "string", "title": "Name" }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price" }, "fixed_price": { "type": "boolean", "title": "Fixed Price" }, "price_in_vouchers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Price In Vouchers" }, "tax_rate_id": { "type": "integer", "title": "Tax Rate Id" }, "restrictions": { "items": { "$ref": "#/components/schemas/ProductRestriction" }, "type": "array", "title": "Restrictions" }, "is_locked": { "type": "boolean", "title": "Is Locked" }, "is_returnable": { "type": "boolean", "title": "Is Returnable" }, "target_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Account Id" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "tax_name": { "type": "string", "title": "Tax Name" }, "tax_rate": { "type": "number", "title": "Tax Rate" }, "type": { "$ref": "#/components/schemas/ProductType" }, "price_per_voucher": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Per Voucher" } }, "type": "object", "required": [ "name", "price", "fixed_price", "tax_rate_id", "restrictions", "is_locked", "is_returnable", "node_id", "id", "tax_name", "tax_rate", "type" ], "title": "Product" }, "ProductOverallStats": { "properties": { "product_id": { "type": "integer", "title": "Product Id" }, "product_name": { "type": "string", "title": "Product Name" }, "count": { "type": "integer", "title": "Count" }, "revenue": { "type": "number", "title": "Revenue" } }, "type": "object", "required": [ "product_id", "product_name", "count", "revenue" ], "title": "ProductOverallStats" }, "ProductRestriction": { "type": "string", "enum": [ "under_16", "under_18" ], "title": "ProductRestriction" }, "ProductStats": { "properties": { "from_time": { "type": "string", "format": "date-time", "title": "From Time" }, "to_time": { "type": "string", "format": "date-time", "title": "To Time" }, "daily_intervals": { "items": { "$ref": "#/components/schemas/StatInterval" }, "type": "array", "title": "Daily Intervals" }, "hourly_intervals": { "items": { "$ref": "#/components/schemas/StatInterval" }, "type": "array", "title": "Hourly Intervals" }, "product_hourly_intervals": { "items": { "$ref": "#/components/schemas/ProductTimeseries" }, "type": "array", "title": "Product Hourly Intervals" }, "product_overall_stats": { "items": { "$ref": "#/components/schemas/ProductOverallStats" }, "type": "array", "title": "Product Overall Stats" }, "deposit_hourly_intervals": { "items": { "$ref": "#/components/schemas/ProductTimeseries" }, "type": "array", "title": "Deposit Hourly Intervals" }, "deposit_overall_stats": { "items": { "$ref": "#/components/schemas/ProductOverallStats" }, "type": "array", "title": "Deposit Overall Stats" } }, "type": "object", "required": [ "from_time", "to_time", "daily_intervals", "hourly_intervals", "product_hourly_intervals", "product_overall_stats", "deposit_hourly_intervals", "deposit_overall_stats" ], "title": "ProductStats" }, "ProductTimeseries": { "properties": { "product_id": { "type": "integer", "title": "Product Id" }, "product_name": { "type": "string", "title": "Product Name" }, "intervals": { "items": { "$ref": "#/components/schemas/StatInterval" }, "type": "array", "title": "Intervals" } }, "type": "object", "required": [ "product_id", "product_name", "intervals" ], "title": "ProductTimeseries" }, "ProductType": { "type": "string", "enum": [ "discount", "topup", "payout", "money_transfer", "imbalance", "user_defined", "ticket" ], "title": "ProductType" }, "PublicEventSettings": { "properties": { "currency_identifier": { "type": "string", "title": "Currency Identifier" }, "max_account_balance": { "type": "number", "title": "Max Account Balance" }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date" }, "daily_end_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "Daily End Time" }, "sumup_topup_enabled": { "type": "boolean", "title": "Sumup Topup Enabled" }, "sumup_payment_enabled": { "type": "boolean", "title": "Sumup Payment Enabled" }, "customer_portal_url": { "type": "string", "title": "Customer Portal Url" }, "customer_portal_about_page_url": { "type": "string", "title": "Customer Portal About Page Url" }, "customer_portal_data_privacy_url": { "type": "string", "title": "Customer Portal Data Privacy Url" }, "customer_portal_contact_email": { "type": "string", "format": "email", "title": "Customer Portal Contact Email" }, "pretix_presale_enabled": { "type": "boolean", "title": "Pretix Presale Enabled" }, "pretix_shop_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Shop Url" }, "pretix_organizer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Organizer" }, "pretix_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Event" }, "pretix_ticket_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Pretix Ticket Ids" }, "ust_id": { "type": "string", "title": "Ust Id" }, "bon_issuer": { "type": "string", "title": "Bon Issuer" }, "bon_address": { "type": "string", "title": "Bon Address" }, "bon_title": { "type": "string", "title": "Bon Title" }, "sepa_enabled": { "type": "boolean", "title": "Sepa Enabled" }, "sepa_sender_name": { "type": "string", "title": "Sepa Sender Name" }, "sepa_sender_iban": { "type": "string", "title": "Sepa Sender Iban" }, "sepa_description": { "type": "string", "title": "Sepa Description" }, "sepa_max_num_payouts_in_run": { "type": "integer", "title": "Sepa Max Num Payouts In Run" }, "sepa_allowed_country_codes": { "items": { "type": "string" }, "type": "array", "title": "Sepa Allowed Country Codes" }, "email_enabled": { "type": "boolean", "title": "Email Enabled" }, "email_default_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Default Sender" }, "email_smtp_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Host" }, "email_smtp_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Email Smtp Port" }, "email_smtp_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Username" }, "payout_done_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Subject" }, "payout_done_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Message" }, "payout_registered_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Subject" }, "payout_registered_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Message" }, "payout_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Sender" }, "translation_texts": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "propertyNames": { "$ref": "#/components/schemas/Language" }, "type": "object", "title": "Translation Texts", "default": {} }, "id": { "type": "integer", "title": "Id" }, "languages": { "items": { "$ref": "#/components/schemas/Language" }, "type": "array", "title": "Languages" } }, "type": "object", "required": [ "currency_identifier", "max_account_balance", "sumup_topup_enabled", "sumup_payment_enabled", "customer_portal_url", "customer_portal_about_page_url", "customer_portal_data_privacy_url", "customer_portal_contact_email", "pretix_presale_enabled", "pretix_shop_url", "pretix_organizer", "pretix_event", "pretix_ticket_ids", "ust_id", "bon_issuer", "bon_address", "bon_title", "sepa_enabled", "sepa_sender_name", "sepa_sender_iban", "sepa_description", "sepa_max_num_payouts_in_run", "sepa_allowed_country_codes", "email_enabled", "id", "languages" ], "title": "PublicEventSettings" }, "RestrictedEventSettings": { "properties": { "sumup_api_key": { "type": "string", "title": "Sumup Api Key", "default": "" }, "sumup_affiliate_key": { "type": "string", "title": "Sumup Affiliate Key", "default": "" }, "sumup_merchant_code": { "type": "string", "title": "Sumup Merchant Code", "default": "" }, "sumup_oauth_client_id": { "type": "string", "title": "Sumup Oauth Client Id", "default": "" }, "sumup_oauth_client_secret": { "type": "string", "title": "Sumup Oauth Client Secret", "default": "" }, "pretix_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Api Key" }, "email_smtp_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Password" }, "currency_identifier": { "type": "string", "title": "Currency Identifier" }, "max_account_balance": { "type": "number", "title": "Max Account Balance" }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date" }, "daily_end_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "Daily End Time" }, "sumup_topup_enabled": { "type": "boolean", "title": "Sumup Topup Enabled" }, "sumup_payment_enabled": { "type": "boolean", "title": "Sumup Payment Enabled" }, "customer_portal_url": { "type": "string", "title": "Customer Portal Url" }, "customer_portal_about_page_url": { "type": "string", "title": "Customer Portal About Page Url" }, "customer_portal_data_privacy_url": { "type": "string", "title": "Customer Portal Data Privacy Url" }, "customer_portal_contact_email": { "type": "string", "format": "email", "title": "Customer Portal Contact Email" }, "pretix_presale_enabled": { "type": "boolean", "title": "Pretix Presale Enabled" }, "pretix_shop_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Shop Url" }, "pretix_organizer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Organizer" }, "pretix_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Event" }, "pretix_ticket_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Pretix Ticket Ids" }, "ust_id": { "type": "string", "title": "Ust Id" }, "bon_issuer": { "type": "string", "title": "Bon Issuer" }, "bon_address": { "type": "string", "title": "Bon Address" }, "bon_title": { "type": "string", "title": "Bon Title" }, "sepa_enabled": { "type": "boolean", "title": "Sepa Enabled" }, "sepa_sender_name": { "type": "string", "title": "Sepa Sender Name" }, "sepa_sender_iban": { "type": "string", "title": "Sepa Sender Iban" }, "sepa_description": { "type": "string", "title": "Sepa Description" }, "sepa_max_num_payouts_in_run": { "type": "integer", "title": "Sepa Max Num Payouts In Run" }, "sepa_allowed_country_codes": { "items": { "type": "string" }, "type": "array", "title": "Sepa Allowed Country Codes" }, "email_enabled": { "type": "boolean", "title": "Email Enabled" }, "email_default_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Default Sender" }, "email_smtp_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Host" }, "email_smtp_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Email Smtp Port" }, "email_smtp_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Username" }, "payout_done_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Subject" }, "payout_done_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Message" }, "payout_registered_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Subject" }, "payout_registered_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Message" }, "payout_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Sender" }, "translation_texts": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "propertyNames": { "$ref": "#/components/schemas/Language" }, "type": "object", "title": "Translation Texts", "default": {} }, "id": { "type": "integer", "title": "Id" }, "languages": { "items": { "$ref": "#/components/schemas/Language" }, "type": "array", "title": "Languages" }, "sumup_oauth_refresh_token": { "type": "string", "title": "Sumup Oauth Refresh Token" } }, "type": "object", "required": [ "pretix_api_key", "currency_identifier", "max_account_balance", "sumup_topup_enabled", "sumup_payment_enabled", "customer_portal_url", "customer_portal_about_page_url", "customer_portal_data_privacy_url", "customer_portal_contact_email", "pretix_presale_enabled", "pretix_shop_url", "pretix_organizer", "pretix_event", "pretix_ticket_ids", "ust_id", "bon_issuer", "bon_address", "bon_title", "sepa_enabled", "sepa_sender_name", "sepa_sender_iban", "sepa_description", "sepa_max_num_payouts_in_run", "sepa_allowed_country_codes", "email_enabled", "id", "languages", "sumup_oauth_refresh_token" ], "title": "RestrictedEventSettings" }, "StatInterval": { "properties": { "from_time": { "type": "string", "format": "date-time", "title": "From Time" }, "to_time": { "type": "string", "format": "date-time", "title": "To Time" }, "count": { "type": "integer", "title": "Count" }, "revenue": { "type": "number", "title": "Revenue" } }, "type": "object", "required": [ "from_time", "to_time", "count", "revenue" ], "title": "StatInterval" }, "SumUpCheckout": { "properties": { "checkout_reference": { "type": "string", "format": "uuid", "title": "Checkout Reference" }, "amount": { "type": "number", "title": "Amount" }, "currency": { "type": "string", "title": "Currency" }, "merchant_code": { "type": "string", "title": "Merchant Code" }, "description": { "type": "string", "title": "Description" }, "id": { "type": "string", "title": "Id" }, "status": { "$ref": "#/components/schemas/SumUpCheckoutStatus" }, "valid_until": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Valid Until" }, "date": { "type": "string", "format": "date-time", "title": "Date" }, "transaction_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Code" }, "transaction_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Id" }, "transactions": { "items": { "$ref": "#/components/schemas/SumUpTransaction" }, "type": "array", "title": "Transactions", "default": [] } }, "type": "object", "required": [ "checkout_reference", "amount", "currency", "merchant_code", "description", "id", "status", "date" ], "title": "SumUpCheckout" }, "SumUpCheckoutStatus": { "type": "string", "enum": [ "PENDING", "FAILED", "PAID" ], "title": "SumUpCheckoutStatus" }, "SumUpTokenPayload": { "properties": { "authorization_code": { "type": "string", "title": "Authorization Code" } }, "type": "object", "required": [ "authorization_code" ], "title": "SumUpTokenPayload" }, "SumUpTransaction": { "properties": { "amount": { "type": "number", "title": "Amount" }, "currency": { "type": "string", "title": "Currency" }, "id": { "type": "string", "title": "Id" }, "payment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payment Type" }, "product_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Summary" }, "card_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Card Type" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "status": { "type": "string", "title": "Status" }, "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp" }, "transaction_code": { "type": "string", "title": "Transaction Code" } }, "type": "object", "required": [ "amount", "currency", "id", "status", "timestamp", "transaction_code" ], "title": "SumUpTransaction" }, "SwitchTerminalPayload": { "properties": { "new_terminal_id": { "type": "integer", "title": "New Terminal Id" } }, "type": "object", "required": [ "new_terminal_id" ], "title": "SwitchTerminalPayload" }, "SwitchTillPayload": { "properties": { "new_till_id": { "type": "integer", "title": "New Till Id" } }, "type": "object", "required": [ "new_till_id" ], "title": "SwitchTillPayload" }, "TaxRate": { "properties": { "name": { "type": "string", "title": "Name" }, "rate": { "type": "number", "title": "Rate" }, "description": { "type": "string", "title": "Description" }, "id": { "type": "integer", "title": "Id" }, "node_id": { "type": "integer", "title": "Node Id" } }, "type": "object", "required": [ "name", "rate", "description", "id", "node_id" ], "title": "TaxRate" }, "TaxRateAggregation": { "properties": { "tax_name": { "type": "string", "title": "Tax Name" }, "tax_rate": { "type": "number", "title": "Tax Rate" }, "total_price": { "type": "number", "title": "Total Price" }, "total_tax": { "type": "number", "title": "Total Tax" }, "total_no_tax": { "type": "number", "title": "Total No Tax" } }, "type": "object", "required": [ "tax_name", "tax_rate", "total_price", "total_tax", "total_no_tax" ], "title": "TaxRateAggregation" }, "Terminal": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "type": "integer", "title": "Id" }, "node_id": { "type": "integer", "title": "Node Id" }, "till_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Till Id" }, "session_uuid": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Session Uuid" }, "registration_uuid": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Registration Uuid" }, "active_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Active User Id" }, "active_user_role_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Active User Role Id" }, "last_seen": { "type": "string", "format": "date-time", "title": "Last Seen" } }, "type": "object", "required": [ "name", "id", "node_id", "till_id", "session_uuid", "registration_uuid", "last_seen" ], "title": "Terminal" }, "Ticket": { "properties": { "name": { "type": "string", "title": "Name" }, "price": { "type": "number", "title": "Price" }, "tax_rate_id": { "type": "integer", "title": "Tax Rate Id" }, "restrictions": { "items": { "$ref": "#/components/schemas/ProductRestriction" }, "type": "array", "title": "Restrictions" }, "is_locked": { "type": "boolean", "title": "Is Locked" }, "initial_top_up_amount": { "type": "number", "title": "Initial Top Up Amount" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "tax_name": { "type": "string", "title": "Tax Name" }, "tax_rate": { "type": "number", "title": "Tax Rate" }, "total_price": { "type": "number", "title": "Total Price" } }, "type": "object", "required": [ "name", "price", "tax_rate_id", "restrictions", "is_locked", "initial_top_up_amount", "node_id", "id", "tax_name", "tax_rate", "total_price" ], "title": "Ticket" }, "Till": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "active_shift": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active Shift" }, "active_profile_id": { "type": "integer", "title": "Active Profile Id" }, "terminal_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Terminal Id" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "z_nr": { "type": "integer", "title": "Z Nr" }, "active_cash_register_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Active Cash Register Id" }, "current_cash_register_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Cash Register Name" }, "current_cash_register_balance": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Cash Register Balance" }, "tse_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tse Id" }, "tse_serial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tse Serial" } }, "type": "object", "required": [ "name", "active_profile_id", "node_id", "id", "z_nr" ], "title": "Till" }, "TillButton": { "properties": { "name": { "type": "string", "title": "Name" }, "product_ids": { "items": { "type": "integer" }, "type": "array", "title": "Product Ids" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "price": { "type": "number", "title": "Price" } }, "type": "object", "required": [ "name", "product_ids", "node_id", "id", "price" ], "title": "TillButton" }, "TillLayout": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "button_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Button Ids" }, "ticket_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Ticket Ids" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" } }, "type": "object", "required": [ "name", "description", "node_id", "id" ], "title": "TillLayout" }, "TillProfile": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "layout_id": { "type": "integer", "title": "Layout Id" }, "allow_top_up": { "type": "boolean", "title": "Allow Top Up" }, "allow_cash_out": { "type": "boolean", "title": "Allow Cash Out" }, "allow_ticket_sale": { "type": "boolean", "title": "Allow Ticket Sale" }, "allow_ticket_vouchers": { "type": "boolean", "title": "Allow Ticket Vouchers" }, "enable_ssp_payment": { "type": "boolean", "title": "Enable Ssp Payment" }, "enable_cash_payment": { "type": "boolean", "title": "Enable Cash Payment" }, "enable_card_payment": { "type": "boolean", "title": "Enable Card Payment" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" } }, "type": "object", "required": [ "name", "layout_id", "allow_top_up", "allow_cash_out", "allow_ticket_sale", "allow_ticket_vouchers", "enable_ssp_payment", "enable_cash_payment", "enable_card_payment", "node_id", "id" ], "title": "TillProfile" }, "TimeseriesStats": { "properties": { "from_time": { "type": "string", "format": "date-time", "title": "From Time" }, "to_time": { "type": "string", "format": "date-time", "title": "To Time" }, "daily_intervals": { "items": { "$ref": "#/components/schemas/StatInterval" }, "type": "array", "title": "Daily Intervals" }, "hourly_intervals": { "items": { "$ref": "#/components/schemas/StatInterval" }, "type": "array", "title": "Hourly Intervals" } }, "type": "object", "required": [ "from_time", "to_time", "daily_intervals", "hourly_intervals" ], "title": "TimeseriesStats" }, "Transaction": { "properties": { "id": { "type": "integer", "title": "Id" }, "conducting_user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Conducting User Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "source_account": { "type": "integer", "title": "Source Account" }, "target_account": { "type": "integer", "title": "Target Account" }, "order": { "anyOf": [ { "$ref": "#/components/schemas/Order" }, { "type": "null" } ] }, "booked_at": { "type": "string", "format": "date-time", "title": "Booked At" }, "amount": { "type": "number", "title": "Amount" }, "vouchers": { "type": "integer", "title": "Vouchers" } }, "type": "object", "required": [ "id", "conducting_user_id", "description", "source_account", "target_account", "order", "booked_at", "amount", "vouchers" ], "title": "Transaction" }, "TransferRegisterPayload": { "properties": { "source_cashier_id": { "type": "integer", "title": "Source Cashier Id" }, "target_cashier_id": { "type": "integer", "title": "Target Cashier Id" } }, "type": "object", "required": [ "source_cashier_id", "target_cashier_id" ], "title": "TransferRegisterPayload" }, "Tse": { "properties": { "name": { "type": "string", "title": "Name" }, "ws_url": { "type": "string", "title": "Ws Url" }, "ws_timeout": { "type": "number", "title": "Ws Timeout" }, "password": { "type": "string", "title": "Password" }, "type": { "$ref": "#/components/schemas/TseType" }, "serial": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serial" }, "node_id": { "type": "integer", "title": "Node Id" }, "id": { "type": "integer", "title": "Id" }, "status": { "$ref": "#/components/schemas/TseStatus" }, "hashalgo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hashalgo" }, "time_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time Format" }, "public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Key" }, "certificate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Certificate" }, "process_data_encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Process Data Encoding" } }, "type": "object", "required": [ "name", "ws_url", "ws_timeout", "password", "type", "serial", "node_id", "id", "status", "hashalgo", "time_format", "public_key", "certificate", "process_data_encoding" ], "title": "Tse" }, "TseStatus": { "type": "string", "enum": [ "new", "active", "disabled", "failed" ], "title": "TseStatus" }, "TseType": { "type": "string", "enum": [ "diebold_nixdorf" ], "title": "TseType" }, "UpdateAccountCommentPayload": { "properties": { "comment": { "type": "string", "title": "Comment" } }, "type": "object", "required": [ "comment" ], "title": "UpdateAccountCommentPayload" }, "UpdateBalancePayload": { "properties": { "new_balance": { "type": "number", "title": "New Balance" } }, "type": "object", "required": [ "new_balance" ], "title": "UpdateBalancePayload" }, "UpdateCommentPayload": { "properties": { "comment": { "type": "string", "title": "Comment" } }, "type": "object", "required": [ "comment" ], "title": "UpdateCommentPayload" }, "UpdateEvent": { "properties": { "sumup_api_key": { "type": "string", "title": "Sumup Api Key", "default": "" }, "sumup_affiliate_key": { "type": "string", "title": "Sumup Affiliate Key", "default": "" }, "sumup_merchant_code": { "type": "string", "title": "Sumup Merchant Code", "default": "" }, "sumup_oauth_client_id": { "type": "string", "title": "Sumup Oauth Client Id", "default": "" }, "sumup_oauth_client_secret": { "type": "string", "title": "Sumup Oauth Client Secret", "default": "" }, "pretix_api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Api Key" }, "email_smtp_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Password" }, "currency_identifier": { "type": "string", "title": "Currency Identifier" }, "max_account_balance": { "type": "number", "title": "Max Account Balance" }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date" }, "end_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date" }, "daily_end_time": { "anyOf": [ { "type": "string", "format": "time" }, { "type": "null" } ], "title": "Daily End Time" }, "sumup_topup_enabled": { "type": "boolean", "title": "Sumup Topup Enabled" }, "sumup_payment_enabled": { "type": "boolean", "title": "Sumup Payment Enabled" }, "customer_portal_url": { "type": "string", "title": "Customer Portal Url" }, "customer_portal_about_page_url": { "type": "string", "title": "Customer Portal About Page Url" }, "customer_portal_data_privacy_url": { "type": "string", "title": "Customer Portal Data Privacy Url" }, "customer_portal_contact_email": { "type": "string", "format": "email", "title": "Customer Portal Contact Email" }, "pretix_presale_enabled": { "type": "boolean", "title": "Pretix Presale Enabled" }, "pretix_shop_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Shop Url" }, "pretix_organizer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Organizer" }, "pretix_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pretix Event" }, "pretix_ticket_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Pretix Ticket Ids" }, "ust_id": { "type": "string", "title": "Ust Id" }, "bon_issuer": { "type": "string", "title": "Bon Issuer" }, "bon_address": { "type": "string", "title": "Bon Address" }, "bon_title": { "type": "string", "title": "Bon Title" }, "sepa_enabled": { "type": "boolean", "title": "Sepa Enabled" }, "sepa_sender_name": { "type": "string", "title": "Sepa Sender Name" }, "sepa_sender_iban": { "type": "string", "title": "Sepa Sender Iban" }, "sepa_description": { "type": "string", "title": "Sepa Description" }, "sepa_max_num_payouts_in_run": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sepa Max Num Payouts In Run" }, "sepa_allowed_country_codes": { "items": { "type": "string" }, "type": "array", "title": "Sepa Allowed Country Codes" }, "email_enabled": { "type": "boolean", "title": "Email Enabled" }, "email_default_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Default Sender" }, "email_smtp_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Host" }, "email_smtp_port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Email Smtp Port" }, "email_smtp_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Smtp Username" }, "payout_done_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Subject" }, "payout_done_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Done Message" }, "payout_registered_subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Subject" }, "payout_registered_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Registered Message" }, "payout_sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payout Sender" }, "translation_texts": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "propertyNames": { "$ref": "#/components/schemas/Language" }, "type": "object", "title": "Translation Texts", "default": {} } }, "type": "object", "required": [ "pretix_api_key", "currency_identifier", "max_account_balance", "sumup_topup_enabled", "sumup_payment_enabled", "customer_portal_url", "customer_portal_about_page_url", "customer_portal_data_privacy_url", "customer_portal_contact_email", "pretix_presale_enabled", "pretix_shop_url", "pretix_organizer", "pretix_event", "pretix_ticket_ids", "ust_id", "bon_issuer", "bon_address", "bon_title", "sepa_enabled", "sepa_sender_name", "sepa_sender_iban", "sepa_description", "sepa_allowed_country_codes", "email_enabled" ], "title": "UpdateEvent" }, "UpdateTse": { "properties": { "name": { "type": "string", "title": "Name" }, "ws_url": { "type": "string", "title": "Ws Url" }, "ws_timeout": { "type": "number", "title": "Ws Timeout" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "name", "ws_url", "ws_timeout", "password" ], "title": "UpdateTse" }, "UpdateUserPayload": { "properties": { "login": { "type": "string", "title": "Login" }, "display_name": { "type": "string", "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "user_tag_pin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Pin" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex" } }, "type": "object", "required": [ "login", "display_name" ], "title": "UpdateUserPayload" }, "UpdateUserRolePrivilegesPayload": { "properties": { "is_privileged": { "type": "boolean", "title": "Is Privileged" }, "privileges": { "items": { "$ref": "#/components/schemas/Privilege" }, "type": "array", "title": "Privileges" } }, "type": "object", "required": [ "is_privileged", "privileges" ], "title": "UpdateUserRolePrivilegesPayload" }, "UpdateVoucherAmountPayload": { "properties": { "new_voucher_amount": { "type": "integer", "title": "New Voucher Amount" } }, "type": "object", "required": [ "new_voucher_amount" ], "title": "UpdateVoucherAmountPayload" }, "User": { "properties": { "login": { "type": "string", "title": "Login" }, "display_name": { "type": "string", "title": "Display Name" }, "user_tag_pin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Pin" }, "user_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Uid" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "node_id": { "type": "integer", "title": "Node Id" }, "user_tag_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Id" }, "transport_account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Transport Account Id" }, "id": { "type": "integer", "title": "Id" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "login", "display_name", "node_id", "id", "user_tag_uid_hex" ], "title": "User" }, "UserLoginResult": { "properties": { "success": { "anyOf": [ { "$ref": "#/components/schemas/UserLoginSuccess" }, { "type": "null" } ] }, "available_nodes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/NodeChoice" }, "type": "array" }, { "type": "null" } ], "title": "Available Nodes" } }, "type": "object", "required": [ "success", "available_nodes" ], "title": "UserLoginResult" }, "UserLoginSuccess": { "properties": { "user": { "$ref": "#/components/schemas/CurrentUser" }, "token": { "type": "string", "title": "Token" } }, "type": "object", "required": [ "user", "token" ], "title": "UserLoginSuccess" }, "UserRole": { "properties": { "name": { "type": "string", "title": "Name" }, "is_privileged": { "type": "boolean", "title": "Is Privileged", "default": false }, "privileges": { "items": { "$ref": "#/components/schemas/Privilege" }, "type": "array", "title": "Privileges" }, "id": { "type": "integer", "title": "Id" }, "node_id": { "type": "integer", "title": "Node Id" } }, "type": "object", "required": [ "name", "privileges", "id", "node_id" ], "title": "UserRole" }, "UserTagAccountAssociation": { "properties": { "account_id": { "type": "integer", "title": "Account Id" }, "mapping_was_valid_until": { "type": "string", "format": "date-time", "title": "Mapping Was Valid Until" } }, "type": "object", "required": [ "account_id", "mapping_was_valid_until" ], "title": "UserTagAccountAssociation" }, "UserTagDetail": { "properties": { "id": { "type": "integer", "title": "Id" }, "pin": { "type": "string", "title": "Pin" }, "uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Uid" }, "node_id": { "type": "integer", "title": "Node Id" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "account_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Account Id" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id" }, "account_history": { "items": { "$ref": "#/components/schemas/UserTagAccountAssociation" }, "type": "array", "title": "Account History" }, "uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uid Hex", "readOnly": true } }, "type": "object", "required": [ "id", "pin", "uid", "node_id", "account_history", "uid_hex" ], "title": "UserTagDetail" }, "UserTagHistoryEntry": { "properties": { "user_tag_id": { "type": "integer", "title": "User Tag Id" }, "user_tag_pin": { "type": "string", "title": "User Tag Pin" }, "user_tag_uid": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Tag Uid" }, "account_id": { "type": "integer", "title": "Account Id" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "mapping_was_valid_until": { "type": "string", "format": "date-time", "title": "Mapping Was Valid Until" }, "user_tag_uid_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Tag Uid Hex", "readOnly": true } }, "type": "object", "required": [ "user_tag_id", "user_tag_pin", "user_tag_uid", "account_id", "mapping_was_valid_until", "user_tag_uid_hex" ], "title": "UserTagHistoryEntry" }, "UserTagSecret": { "properties": { "key0": { "type": "string", "title": "Key0" }, "key1": { "type": "string", "title": "Key1" }, "description": { "type": "string", "title": "Description" }, "id": { "type": "integer", "title": "Id" }, "node_id": { "type": "integer", "title": "Node Id" } }, "type": "object", "required": [ "key0", "key1", "description", "id", "node_id" ], "title": "UserTagSecret" }, "UserToRoles": { "properties": { "user_id": { "type": "integer", "title": "User Id" }, "role_ids": { "items": { "type": "integer" }, "type": "array", "title": "Role Ids" }, "terminal_only": { "type": "boolean", "title": "Terminal Only", "default": false }, "node_id": { "type": "integer", "title": "Node Id" } }, "type": "object", "required": [ "user_id", "role_ids", "node_id" ], "title": "UserToRoles" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VoucherStats": { "properties": { "vouchers_issued": { "type": "integer", "title": "Vouchers Issued" }, "vouchers_spent": { "type": "integer", "title": "Vouchers Spent" } }, "type": "object", "required": [ "vouchers_issued", "vouchers_spent" ], "title": "VoucherStats" }, "WebhookType": { "type": "string", "enum": [ "pretix" ], "title": "WebhookType" } }, "securitySchemes": { "OAuth2PasswordBearer": { "type": "oauth2", "flows": { "password": { "scopes": {}, "tokenUrl": "auth/login" } } } } } }